Test the known hosts verifier log message

Author: MarkEWaite

src/main/java/org/jenkinsci/plugins/gitclient/verifier/KnownHostsFileVerifier.java

@@ -72,9 +72,6 @@ private void logHint(TaskListener listener) {
                         'Manage Jenkins' -> 'Security' -> 'Git Host Key Verification Configuration' \
                         and configure host key verification.\
                         """));
-        LOGGER.log(
-                Level.FINEST,
-                "Known hosts file {0} not found, but verifying host keys with known hosts file",
-                new Object[] {SshHostKeyVerificationStrategy.KNOWN_HOSTS_DEFAULT});
+        LOGGER.finest("Verifying host keys with known hosts file, but known hosts file was not found");
     }
 }

src/test/java/org/jenkinsci/plugins/gitclient/verifier/KnownHostsFileVerifierTest.java

@@ -1,6 +1,7 @@
 package org.jenkinsci.plugins.gitclient.verifier;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasItem;
 import static org.hamcrest.Matchers.is;
 import static org.jenkinsci.plugins.gitclient.verifier.KnownHostsTestUtil.nonGitHubHost;
 import static org.jenkinsci.plugins.gitclient.verifier.KnownHostsTestUtil.runKnownHostsTests;
@@ -12,6 +13,12 @@
 import hudson.model.TaskListener;
 import java.io.File;
 import java.time.Duration;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.logging.Handler;
+import java.util.logging.Level;
+import java.util.logging.LogRecord;
+import java.util.logging.Logger;
 import org.awaitility.Awaitility;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -39,6 +46,37 @@ void assignVerifiers() throws Exception {
         fakeKnownHosts = knownHostsTestUtil.createFakeKnownHosts(FILE_CONTENT);
     }
 
+    @Test
+    void missingKnownHostsShouldLogWarning() throws Exception {
+        File folder = new File(testFolder, "folder");
+        File missingKnownHosts = new File(folder, "non_existent_known_hosts");
+        KnownHostsFileVerifier knownHostsFileVerifier = spy(new KnownHostsFileVerifier());
+        when(knownHostsFileVerifier.getKnownHostsFile()).thenReturn(missingKnownHosts);
+
+        Logger logger = Logger.getLogger(KnownHostsFileVerifier.class.getName());
+        LogHandler handler = new LogHandler();
+        handler.setLevel(Level.ALL);
+        logger.setUseParentHandlers(false);
+        logger.addHandler(handler);
+        logger.setLevel(Level.ALL);
+        KnownHostsTestUtil.connectToHost(
+                        nonGitHubHost(),
+                        22,
+                        missingKnownHosts,
+                        knownHostsFileVerifier.forJGit(StreamBuildListener.fromStdout()),
+                        "ssh-ed25519",
+                        s -> {
+                            assertThat(s.isOpen(), is(true));
+                            Awaitility.await().atMost(Duration.ofSeconds(37)).until(() -> s.getServerKey() != null);
+                            assertThat(KnownHostsTestUtil.checkKeys(s), is(false));
+                            return true;
+                        })
+                .close();
+        assertThat(
+                handler.getMessages(),
+                hasItem("Verifying host keys with known hosts file, but known hosts file was not found"));
+    }
+
     @Test
     void connectWhenHostKeyNotInKnownHostsFileForOtherHostNameThenShouldFail() throws Exception {
         assumeTrue(runKnownHostsTests());
@@ -114,4 +152,26 @@ void testVerifyHostKeyOptionWithDefaultFile() throws Exception {
         assertThat(
                 verifier.forCliGit(TaskListener.NULL).getVerifyHostKeyOption(null), is("-o StrictHostKeyChecking=yes"));
     }
+
+    private static class LogHandler extends Handler {
+
+        private List<String> messages = new ArrayList<>();
+
+        @Override
+        public void publish(LogRecord lr) {
+            messages.add(lr.getMessage());
+        }
+
+        @Override
+        public void flush() {}
+
+        @Override
+        public void close() throws SecurityException {
+            messages = new ArrayList<>();
+        }
+
+        List<String> getMessages() {
+            return messages;
+        }
+    }
 }