Use the result of a WarningAction set on a stage node instead of computing the chunk status (#617)

Author: stuartrowe

src/main/java/io/jenkins/plugins/pipelinegraphview/treescanner/NodeRelationship.java

@@ -5,8 +5,10 @@
 import io.jenkins.plugins.pipelinegraphview.utils.BlueRun;
 import io.jenkins.plugins.pipelinegraphview.utils.NodeRunStatus;
 import io.jenkins.plugins.pipelinegraphview.utils.PipelineNodeUtil;
+import org.jenkinsci.plugins.workflow.actions.WarningAction;
 import org.jenkinsci.plugins.workflow.graph.FlowNode;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jenkinsci.plugins.workflow.pipelinegraphanalysis.GenericStatus;
 import org.jenkinsci.plugins.workflow.pipelinegraphanalysis.StatusAndTiming;
 import org.jenkinsci.plugins.workflow.pipelinegraphanalysis.TimingInfo;
 import org.jenkinsci.plugins.workflow.support.actions.PauseAction;
@@ -108,6 +110,11 @@ public FlowNode getEnd() {
             return new NodeRunStatus(BlueRun.BlueRunResult.NOT_BUILT, BlueRun.BlueRunState.SKIPPED);
         } else if (PipelineNodeUtil.isPaused(this.end)) {
             return new NodeRunStatus(BlueRun.BlueRunResult.UNKNOWN, BlueRun.BlueRunState.PAUSED);
+        } else if (PipelineNodeUtil.isStage(start)) {
+            WarningAction warningAction = start.getPersistentAction(WarningAction.class);
+            if (warningAction != null) {
+                return new NodeRunStatus(GenericStatus.fromResult(warningAction.getResult()));
+            }
         }
         if (isDebugEnabled) {
             logger.debug(

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/legacy/PipelineNodeGraphVisitor.java

@@ -31,6 +31,7 @@
 import org.jenkinsci.plugins.workflow.actions.LabelAction;
 import org.jenkinsci.plugins.workflow.actions.NotExecutedNodeAction;
 import org.jenkinsci.plugins.workflow.actions.TimingAction;
+import org.jenkinsci.plugins.workflow.actions.WarningAction;
 import org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode;
 import org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode;
 import org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode;
@@ -238,12 +239,18 @@ protected void handleChunkDone(@NonNull MemoryFlowChunk chunk) {
         } else if (firstExecuted == null) {
             status = new NodeRunStatus(GenericStatus.NOT_EXECUTED);
         } else if (chunk.getLastNode() != null) {
+            WarningAction warningAction = chunk.getFirstNode().getPersistentAction(WarningAction.class);
+
             // StatusAndTiming.computeChunkStatus2 seems to return wrong status for parallel
             // sequential
             // stages
             // so check check if active and in the case of nested sequential
             if (parallelNestedStages && chunk.getFirstNode().isActive()) {
                 status = new NodeRunStatus(chunk.getFirstNode());
+            } else if (PipelineNodeUtil.isStage(chunk.getFirstNode()) && warningAction != null) {
+                // If the chunk is  a stage and there's a WarningAction on the stage start node use the
+                // associated result
+                status = new NodeRunStatus(GenericStatus.fromResult(warningAction.getResult()));
             } else {
                 FlowNode nodeBefore = chunk.getNodeBefore(),
                         firstNode = chunk.getFirstNode(),

src/test/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineGraphApiLegacyTest.java

@@ -149,4 +149,27 @@ void createLegacyTree_skippedParallel(JenkinsRule j) throws Exception {
                 (PipelineStage stage) -> String.format("{%s,%s}", stage.getName(), stage.getState()));
         assertThat(newStagesString, is(stagesString));
     }
+
+    @Issue("GH#616")
+    @Test
+    void createLegacyTree_stageResult(JenkinsRule j) throws Exception {
+        WorkflowRun run = TestUtils.createAndRunJob(
+                j, "gh616_stageResult", "gh616_stageResult.jenkinsfile", Result.UNSTABLE, false);
+        PipelineGraphApi api = new PipelineGraphApi(run);
+        PipelineGraph graph = api.createLegacyTree();
+
+        List<PipelineStage> stages = graph.getStages();
+
+        String stagesString = TestUtils.collectStagesAsString(
+                stages,
+                (PipelineStage stage) -> String.format(
+                        "{%s,%s,%s,%s}", stage.getName(), stage.getTitle(), stage.getType(), stage.getState()));
+        assertThat(
+                stagesString,
+                is(String.join(
+                        "",
+                        "{success-stage,success-stage,STAGE,success},",
+                        "{failure-stage,failure-stage,STAGE,failure},",
+                        "{unstable-stage,unstable-stage,STAGE,unstable}")));
+    }
 }

src/test/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineGraphApiTest.java

@@ -476,4 +476,27 @@ void getAgentForParallelPipelineWithExternalAgent() throws Exception {
         assertThat(externalStage.getName(), equalTo("External"));
         assertThat(externalStage.getAgent(), equalTo(agent.getNodeName()));
     }
+
+    @Issue("GH#616")
+    @Test
+    void createTree_stageResult() throws Exception {
+        WorkflowRun run =
+                TestUtils.createAndRunJob(j, "stageResult", "gh616_stageResult.jenkinsfile", Result.UNSTABLE, false);
+        PipelineGraphApi api = new PipelineGraphApi(run);
+        PipelineGraph graph = api.createTree();
+
+        List<PipelineStage> stages = graph.getStages();
+
+        String stagesString = TestUtils.collectStagesAsString(
+                stages,
+                (PipelineStage stage) -> String.format(
+                        "{%s,%s,%s,%s}", stage.getName(), stage.getTitle(), stage.getType(), stage.getState()));
+        assertThat(
+                stagesString,
+                equalTo(String.join(
+                        "",
+                        "{success-stage,success-stage,STAGE,success},",
+                        "{failure-stage,failure-stage,STAGE,failure},",
+                        "{unstable-stage,unstable-stage,STAGE,unstable}")));
+    }
 }

src/test/java/io/jenkins/plugins/pipelinegraphview/utils/TestUtils.java

@@ -26,23 +26,39 @@ public class TestUtils {
 
     public static WorkflowRun createAndRunJob(
             JenkinsRule jenkins, String jobName, String jenkinsFileName, Result expectedResult) throws Exception {
-        WorkflowJob job = TestUtils.createJob(jenkins, jobName, jenkinsFileName);
+        return createAndRunJob(jenkins, jobName, jenkinsFileName, expectedResult, true);
+    }
+
+    public static WorkflowRun createAndRunJob(
+            JenkinsRule jenkins, String jobName, String jenkinsFileName, Result expectedResult, boolean sandbox)
+            throws Exception {
+        WorkflowJob job = TestUtils.createJob(jenkins, jobName, jenkinsFileName, sandbox);
         jenkins.assertBuildStatus(expectedResult, job.scheduleBuild2(0));
         return job.getLastBuild();
     }
 
     public static QueueTaskFuture<WorkflowRun> createAndRunJobNoWait(
             JenkinsRule jenkins, String jobName, String jenkinsFileName) throws Exception {
-        WorkflowJob job = TestUtils.createJob(jenkins, jobName, jenkinsFileName);
+        return createAndRunJobNoWait(jenkins, jobName, jenkinsFileName, true);
+    }
+
+    public static QueueTaskFuture<WorkflowRun> createAndRunJobNoWait(
+            JenkinsRule jenkins, String jobName, String jenkinsFileName, boolean sandbox) throws Exception {
+        WorkflowJob job = TestUtils.createJob(jenkins, jobName, jenkinsFileName, sandbox);
         return job.scheduleBuild2(0);
     }
 
     public static WorkflowJob createJob(JenkinsRule jenkins, String jobName, String jenkinsFileName) throws Exception {
+        return createJob(jenkins, jobName, jenkinsFileName, true);
+    }
+
+    public static WorkflowJob createJob(JenkinsRule jenkins, String jobName, String jenkinsFileName, boolean sandbox)
+            throws Exception {
         WorkflowJob job = jenkins.createProject(WorkflowJob.class, jobName);
 
         URL resource = Resources.getResource(TestUtils.class, jenkinsFileName);
         String jenkinsFile = Resources.toString(resource, Charsets.UTF_8);
-        job.setDefinition(new CpsFlowDefinition(jenkinsFile, true));
+        job.setDefinition(new CpsFlowDefinition(jenkinsFile, sandbox));
         return job;
     }
 

src/test/resources/io/jenkins/plugins/pipelinegraphview/utils/gh616_stageResult.jenkinsfile

@@ -0,0 +1,26 @@
+import hudson.model.Result
+import io.jenkins.plugins.pipelinegraphview.utils.PipelineNodeUtil
+import org.jenkinsci.plugins.workflow.actions.WarningAction
+import org.jenkinsci.plugins.workflow.graph.FlowNode
+
+void setStageResult(Result result) {
+    FlowNode stageNode = getContext(FlowNode.class).getEnclosingBlocks().find { PipelineNodeUtil.isStage(it) }
+    if (stageNode) {
+        stageNode.addOrReplaceAction(new WarningAction(result));
+    }
+}
+
+stage("success-stage") {
+    unstable("unstable-step")
+    setStageResult(Result.SUCCESS)
+}
+
+stage("failure-stage") {
+    echo("foo")
+    setStageResult(Result.FAILURE)
+}
+
+stage("unstable-stage") {
+    echo("foo")
+    setStageResult(Result.UNSTABLE)
+}