Improve logs to help discerning what is being looked for, when and where

jenkinsci · Oct 8, 2018 · 1341ff8 · 1341ff8
1 parent d9d842f
commit 1341ff8
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 18 deletions.
diff --git a/src/main/java/hudson/plugins/textfinder/TextFinderPublisher.java b/src/main/java/hudson/plugins/textfinder/TextFinderPublisher.java
@@ -129,21 +129,27 @@ private void findText(Run<?, ?> run, FilePath workspace, TaskListener listener)
 
             if (alsoCheckConsoleOutput) {
                 // Do not mention the pattern we are looking for to avoid false positives
-                logger.println("Looking for a specific pattern in the console output");
+                logger.println("[TextFinder plugin] Scanning console output...");
                 foundText |=
                         checkFile(
                                 run.getLogFile(),
                                 compilePattern(logger, regexp),
                                 logger,
                                 run.getCharset(),
                                 true);
+                logger.println(
+                        "[TextFinder plugin] Finished looking for pattern "
+                                + "'"
+                                + regexp
+                                + "'"
+                                + " in the console output");
             }
 
             final RemoteOutputStream ros = new RemoteOutputStream(logger);
 
             if (fileSet != null) {
                 logger.println(
-                        "Looking for pattern "
+                        "[TextFinder plugin] Looking for pattern "
                                 + "'"
                                 + regexp
                                 + "'"

diff --git a/src/test/java/hudson/plugins/textfinder/TextFinderPublisherAgentTest.java b/src/test/java/hudson/plugins/textfinder/TextFinderPublisherAgentTest.java
@@ -63,7 +63,12 @@ public void failureIfFoundInFileOnAgent() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern " + "'" + UNIQUE_TEXT + "'" + " in the files at", build);
+                "[TextFinder plugin] Looking for pattern "
+                        + "'"
+                        + UNIQUE_TEXT
+                        + "'"
+                        + " in the files at",
+                build);
         assertLogContainsMatch(new File(getWorkspace(build), "out.txt"), UNIQUE_TEXT, build, false);
         rule.assertBuildStatus(Result.FAILURE, build);
     }
@@ -80,7 +85,12 @@ public void failureIfFoundInConsoleOnAgent() throws Exception {
                                 agent.getNodeName(), agent.getNodeName())));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.FAILURE, build);
     }

diff --git a/src/test/java/hudson/plugins/textfinder/TextFinderPublisherFreestyleTest.java b/src/test/java/hudson/plugins/textfinder/TextFinderPublisherFreestyleTest.java
@@ -48,7 +48,12 @@ public void successIfFoundInConsole() throws Exception {
         project.getPublishersList().add(textFinder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.SUCCESS, build);
     }
@@ -66,7 +71,12 @@ public void failureIfFoundInConsole() throws Exception {
         project.getPublishersList().add(textFinder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.FAILURE, build);
     }
@@ -85,7 +95,12 @@ public void unstableIfFoundInConsole() throws Exception {
         project.getPublishersList().add(textFinder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.UNSTABLE, build);
     }
@@ -98,7 +113,12 @@ public void notFoundInConsole() throws Exception {
         project.getPublishersList().add(textFinder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         rule.assertBuildStatus(Result.SUCCESS, build);
     }
 }
diff --git a/src/test/java/hudson/plugins/textfinder/TextFinderPublisherPipelineTest.java b/src/test/java/hudson/plugins/textfinder/TextFinderPublisherPipelineTest.java
@@ -68,7 +68,12 @@ public void successIfFoundInFile() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern '" + UNIQUE_TEXT + "' in the files at " + "'" + fileSet + "'",
+                "[TextFinder plugin] Looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the files at "
+                        + "'"
+                        + fileSet
+                        + "'",
                 build);
         assertLogContainsMatch(new File(getWorkspace(build), fileSet), UNIQUE_TEXT, build, false);
         rule.assertBuildStatus(Result.SUCCESS, build);
@@ -92,7 +97,12 @@ public void failureIfFoundInFile() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern '" + UNIQUE_TEXT + "' in the files at " + "'" + fileSet + "'",
+                "[TextFinder plugin] Looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the files at "
+                        + "'"
+                        + fileSet
+                        + "'",
                 build);
         assertLogContainsMatch(new File(getWorkspace(build), fileSet), UNIQUE_TEXT, build, false);
         rule.assertBuildStatus(Result.FAILURE, build);
@@ -116,7 +126,12 @@ public void unstableIfFoundInFile() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern '" + UNIQUE_TEXT + "' in the files at " + "'" + fileSet + "'",
+                "[TextFinder plugin] Looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the files at "
+                        + "'"
+                        + fileSet
+                        + "'",
                 build);
         assertLogContainsMatch(new File(getWorkspace(build), fileSet), UNIQUE_TEXT, build, false);
         rule.assertBuildStatus(Result.UNSTABLE, build);
@@ -140,7 +155,12 @@ public void notBuiltIfFoundInFile() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern '" + UNIQUE_TEXT + "' in the files at " + "'" + fileSet + "'",
+                "[TextFinder plugin] Looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the files at "
+                        + "'"
+                        + fileSet
+                        + "'",
                 build);
         assertLogContainsMatch(new File(getWorkspace(build), fileSet), UNIQUE_TEXT, build, false);
         rule.assertBuildStatus(Result.NOT_BUILT, build);
@@ -162,7 +182,12 @@ public void notFoundInFile() throws Exception {
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
         rule.assertLogContains(
-                "Looking for pattern '" + UNIQUE_TEXT + "' in the files at " + "'" + fileSet + "'",
+                "[TextFinder plugin] Looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the files at "
+                        + "'"
+                        + fileSet
+                        + "'",
                 build);
         rule.assertBuildStatus(Result.SUCCESS, build);
     }
@@ -182,7 +207,12 @@ public void successIfFoundInConsole() throws Exception {
                                 + "', succeedIfFound: true, alsoCheckConsoleOutput: true}\n"));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.SUCCESS, build);
     }
@@ -202,7 +232,12 @@ public void failureIfFoundInConsole() throws Exception {
                                 + "', alsoCheckConsoleOutput: true}\n"));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.FAILURE, build);
     }
@@ -222,7 +257,12 @@ public void unstableIfFoundInConsole() throws Exception {
                                 + "', unstableIfFound: true, alsoCheckConsoleOutput: true}\n"));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.UNSTABLE, build);
     }
@@ -242,7 +282,12 @@ public void notBuiltIfFoundInConsole() throws Exception {
                                 + "', notBuiltIfFound: true, alsoCheckConsoleOutput: true}\n"));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         assertLogContainsMatch(build.getLogFile(), ECHO_UNIQUE_TEXT, build, true);
         rule.assertBuildStatus(Result.NOT_BUILT, build);
     }
@@ -257,7 +302,12 @@ public void notFoundInConsole() throws Exception {
                                 + "', alsoCheckConsoleOutput: true}\n"));
         WorkflowRun build = project.scheduleBuild2(0).get();
         rule.waitForCompletion(build);
-        rule.assertLogContains("Looking for a specific pattern in the console output", build);
+        rule.assertLogContains("[TextFinder plugin] Scanning console output...");
+        rule.assertLogContains(
+                "[TextFinder plugin] Finished looking for pattern '"
+                        + UNIQUE_TEXT
+                        + "' in the console output",
+                build);
         rule.assertBuildStatus(Result.SUCCESS, build);
     }
 }