Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better log output to console #21

Merged
merged 11 commits into from
May 28, 2019
Merged

Better log output to console #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f4e0c0d
Improve logs to help discerning what is being looked for and where
chipironcin Jun 18, 2018
b8b8738
Update tests
chipironcin Jun 18, 2018
ae92ff3
Use the correct object to get log file
chipironcin Jul 6, 2018
85d38e5
mvn fmt:format
chipironcin Jul 6, 2018
d782908
Fix wrong test
chipironcin Jul 6, 2018
f58e8bd
Fix wrong test
chipironcin Jul 8, 2018
f26a1b6
mvn fmt:format
chipironcin Jul 8, 2018
32661ee
Fix wrong test
chipironcin Jul 9, 2018
d9d842f
Fix pattern appearing in console logs and use global variables in som…
chipironcin Jul 13, 2018
1341ff8
Improve logs to help discerning what is being looked for, when and where
chipironcin Oct 8, 2018
608539c
Fix missing argument
chipironcin Oct 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions src/main/java/hudson/plugins/textfinder/TextFinderPublisher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,24 +128,35 @@ private void findText(Run<?, ?> run, FilePath workspace, TaskListener listener)
boolean foundText = false;

if (alsoCheckConsoleOutput) {
logger.println("Checking console output");
// Do not mention the pattern we are looking for to avoid false positives
logger.println("[TextFinder plugin] Scanning console output...");
foundText |=
checkFile(
run.getLogFile(),
compilePattern(logger, regexp),
logger,
run.getCharset(),
true);
} else {
// printing this when checking console output will cause the plugin
// to find this line, which would be pointless.
// doing this only when fileSet!=null to avoid
logger.println("Checking " + regexp);
logger.println(
"[TextFinder plugin] Finished looking for pattern "
+ "'"
+ regexp
+ "'"
+ " in the console output");
}

final RemoteOutputStream ros = new RemoteOutputStream(logger);

if (fileSet != null) {
logger.println(
"[TextFinder plugin] Looking for pattern "
+ "'"
+ regexp
+ "'"
+ " in the files at "
+ "'"
+ fileSet
+ "'");
foundText |= workspace.act(new FileChecker(ros, fileSet, regexp));
}

Expand Down
15 changes: 13 additions & 2 deletions src/test/java/hudson/plugins/textfinder/TextFinderPublisherAgentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,13 @@ public void failureIfFoundInFileOnAgent() throws Exception {
agent.getNodeName(), agent.getNodeName())));
WorkflowRun build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking foobar", build);
rule.assertLogContains(
"[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);
}
Expand All @@ -79,7 +85,12 @@ public void failureIfFoundInConsoleOnAgent() throws Exception {
agent.getNodeName(), agent.getNodeName())));
WorkflowRun build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking console output", build);
rule.assertLogContains("[TextFinder plugin] Scanning console output...", build);
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);
}
Expand Down
28 changes: 24 additions & 4 deletions src/test/java/hudson/plugins/textfinder/TextFinderPublisherFreestyleTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,12 @@ public void successIfFoundInConsole() throws Exception {
project.getPublishersList().add(textFinder);
FreeStyleBuild build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking console output", build);
rule.assertLogContains("[TextFinder plugin] Scanning console output...", build);
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);
}
Expand All @@ -66,7 +71,12 @@ public void failureIfFoundInConsole() throws Exception {
project.getPublishersList().add(textFinder);
FreeStyleBuild build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking console output", build);
rule.assertLogContains("[TextFinder plugin] Scanning console output...", build);
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);
}
Expand All @@ -85,7 +95,12 @@ public void unstableIfFoundInConsole() throws Exception {
project.getPublishersList().add(textFinder);
FreeStyleBuild build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking console output", build);
rule.assertLogContains("[TextFinder plugin] Scanning console output...", build);
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);
}
Expand All @@ -98,7 +113,12 @@ public void notFoundInConsole() throws Exception {
project.getPublishersList().add(textFinder);
FreeStyleBuild build = project.scheduleBuild2(0).get();
rule.waitForCompletion(build);
rule.assertLogContains("Checking console output", build);
rule.assertLogContains("[TextFinder plugin] Scanning console output...", build);
rule.assertLogContains(
"[TextFinder plugin] Finished looking for pattern '"
+ UNIQUE_TEXT
+ "' in the console output",
build);
rule.assertBuildStatus(Result.SUCCESS, build);
}
}
Loading