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

Flush overall Pipeline log stream when shutting down Jenkins #669

Merged
merged 5 commits into from
Mar 7, 2023
Merged

Flush overall Pipeline log stream when shutting down Jenkins #669

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4169906
Flush overall Pipeline log stream when shutting down Jenkins
dwnusbaum Mar 3, 2023
479665f
Add regression test using RealJenkinsRule
dwnusbaum Mar 3, 2023
c144a2b
Enhance logging to diagnose CpsFlowDefinitionRJRTest.flushLogsOnShutd…
dwnusbaum Mar 6, 2023
d49313e
Update Jenkins version to try to diagnose CpsFlowDefinitionRJRTest.fl…
dwnusbaum Mar 6, 2023
6888d82
Skip CpsFlowDefinitionRJRTest.flushLogsOnShutdown on Windows for now
dwnusbaum Mar 6, 2023
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
1 change: 1 addition & 0 deletions plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
<node.version>18.13.0</node.version>
<npm.version>8.19.3</npm.version>
<yarn.version>1.22.19</yarn.version>
<jenkins-test-harness.version>1926.v9b_323a_4da_421</jenkins-test-harness.version> <!-- Temporary, required to diagnose RJR issues due to https://github.com/jenkinsci/jenkins-test-harness/pull/544#issuecomment-1456707299 -->
dwnusbaum marked this conversation as resolved.
Show resolved Hide resolved
</properties>
<dependencyManagement>
<dependencies>
Expand Down
1 change: 1 addition & 0 deletions plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1694,6 +1694,7 @@ public void pause(final boolean v) throws IOException {
LOGGER.log(Level.WARNING, null, t);
}
});
cpsExec.getOwner().getListener().getLogger().close();
Copy link
Member Author

@dwnusbaum dwnusbaum Mar 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also just flush (I tested both options), but I'm not really sure that it matters either way.

Suggested change
cpsExec.getOwner().getListener().getLogger().close();
cpsExec.getOwner().getListener().getLogger().flush();

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is getOwner() guaranteed to be non-null? getListener()? In principle SpotBugs should know but sometimes it seems to miss these things.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think CpsFlowExecution.owner is guaranteed to be non-null. It's set here and here (called here).

getListener may return WorkflowRun.NULL_LISTENER, which is harmless to close, or throw an exception, but this code already handles exceptions, and I made this be the final operation in the try block so that other more important cleanup still runs even if this throws.

}
} catch (Exception ex) {
LOGGER.log(Level.WARNING, "Error persisting Pipeline execution at shutdown: "+((CpsFlowExecution) execution).owner, ex);
Expand Down
25 changes: 25 additions & 0 deletions plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinitionRJRTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package org.jenkinsci.plugins.workflow.cps;

import java.util.logging.Level;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.JenkinsRule;
Expand All @@ -21,4 +23,27 @@ private static void doesItSmoke(JenkinsRule r) throws Exception {
p.setDefinition(new CpsFlowDefinition("print Jenkins.get().getRootDir().toString()", false));
r.assertBuildStatusSuccess(p.scheduleBuild2(0));
}

@Test
public void flushLogsOnShutdown() throws Throwable {
rjr.withLogger(CpsFlowExecution.class, Level.FINER);
rjr.then(CpsFlowDefinitionRJRTest::flushLogsOnShutdownPreRestart);
rjr.then(CpsFlowDefinitionRJRTest::flushLogsOnShutdownPostRestart);
}

private static void flushLogsOnShutdownPreRestart(JenkinsRule r) throws Exception {
WorkflowJob p = r.createProject(WorkflowJob.class, "p");
p.setDefinition(new CpsFlowDefinition("sleep 10\n", true));
WorkflowRun b = p.scheduleBuild2(0).waitForStart();
r.waitForMessage("Sleeping for 10 sec", b);
r.jenkins.doQuietDown();
}

private static void flushLogsOnShutdownPostRestart(JenkinsRule r) throws Exception {
WorkflowJob p = r.jenkins.getItemByFullName("p", WorkflowJob.class);
WorkflowRun b = p.getLastBuild();
r.assertBuildStatusSuccess(r.waitForCompletion(b));
r.assertLogContains("Resuming build at ", b);
r.assertLogContains("Pausing (Preparing for shutdown)", b);
Comment on lines +49 to +50
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first assertion here passes with or without the fix, since that message is printed after the restart. However, the second assertion is printed right before Jenkins shuts down, and it is missing from the log if you revert the fix.

}
}