Merge pull request #308 from jglick/catchError

Log a note when `catchError` sets build result
jenkinsci · Apr 26, 2024 · cbfc1e3 · cbfc1e3
2 parents bf550f7 + 6a6e341
commit cbfc1e3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/main/java/org/jenkinsci/plugins/workflow/steps/CatchErrorStep.java b/src/main/java/org/jenkinsci/plugins/workflow/steps/CatchErrorStep.java
@@ -248,7 +248,12 @@ public Object readResolve() {
                         Functions.printStackTrace(t, listener.getLogger());
                     }
                     if (buildResult.isWorseThan(Result.SUCCESS)) {
-                        context.get(Run.class).setResult(buildResult);
+                        Run<?, ?> build = context.get(Run.class);
+                        Result currentResult = build.getResult();
+                        if (currentResult == null || buildResult.isWorseThan(currentResult)) {
+                            listener.getLogger().println("Setting overall build result to " + buildResult);
+                        } // otherwise WorkflowRun.setResult should be a no-op, so do not log anything
+                        build.setResult(buildResult);
                     }
                     if (stepResult.isWorseThan(Result.SUCCESS)) {
                         context.get(FlowNode.class).addOrReplaceAction(new WarningAction(stepResult).withMessage(message));

diff --git a/src/test/java/org/jenkinsci/plugins/workflow/steps/CatchErrorStepTest.java b/src/test/java/org/jenkinsci/plugins/workflow/steps/CatchErrorStepTest.java
@@ -118,6 +118,7 @@ public class CatchErrorStepTest {
                 "}", true));
         WorkflowRun b = p.scheduleBuild2(0).waitForStart();
         assertCatchError(r, b, Result.UNSTABLE, null, true);
+        r.assertLogContains("Setting overall build result to UNSTABLE", b);
     }
 
     @Test public void invalidBuildResult() throws Exception {