Handle skipped stages in parallel branches (#359)

Author: timja

pom.xml

@@ -119,4 +119,18 @@
       <url>https://repo.jenkins-ci.org/public/</url>
     </pluginRepository>
   </pluginRepositories>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.jenkins-ci.tools</groupId>
+        <artifactId>maven-hpi-plugin</artifactId>
+        <configuration>
+          <loggers>
+            <io.jenkins.plugins.pipelinegraphview>FINEST</io.jenkins.plugins.pipelinegraphview>
+          </loggers>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 </project>

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

@@ -3,6 +3,7 @@
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jenkins.plugins.pipelinegraphview.utils.NodeRunStatus;
+import io.jenkins.plugins.pipelinegraphview.utils.PipelineNodeUtil;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.List;
@@ -159,15 +160,16 @@ private void calculateTimings(WorkflowRun run) {
                 branchStartNode.getId(),
                 getBranchName(branchStartNode),
                 this.branchStatuses.get(getBranchName(branchStartNode)));
-        return new NodeRunStatus(this.branchStatuses.get(getBranchName(branchStartNode)));
+        boolean skippedStage = PipelineNodeUtil.isSkippedStage(branchStartNode);
+        return new NodeRunStatus(this.branchStatuses.get(getBranchName(branchStartNode)), skippedStage);
     }
 
     /*
      * Gets TimingInfo for relationship.
      */
     private void calculateStatuses(WorkflowRun run) {
         // The parallel API expects parallel end to be null if this is still running -
-        // so only pass it if it;s not the start node;
+        // so only pass it if its not the start node;
         FlowNode parallelEndNode = (this.start != this.end) ? this.end : null;
         this.branchStatuses = StatusAndTiming.computeBranchStatuses2(
                 run, this.start, this.branchStarts, this.branchEnds, parallelEndNode);

src/main/java/io/jenkins/plugins/pipelinegraphview/utils/NodeRunStatus.java

@@ -62,6 +62,10 @@ public BlueRun.BlueRunState getState() {
     }
 
     public NodeRunStatus(GenericStatus status) {
+        this(status, false);
+    }
+
+    public NodeRunStatus(GenericStatus status, boolean skipped) {
         GenericStatus coercedStatus = StatusAndTiming.coerceStatusApi(status, StatusAndTiming.CURRENT_API_VERSION);
         if (coercedStatus == null) {
             this.result = BlueRun.BlueRunResult.NOT_BUILT;
@@ -94,8 +98,13 @@ public NodeRunStatus(GenericStatus status) {
                 this.state = BlueRun.BlueRunState.FINISHED;
                 break;
             case NOT_EXECUTED:
-                this.result = BlueRun.BlueRunResult.NOT_BUILT;
-                this.state = BlueRun.BlueRunState.NOT_BUILT;
+                if (skipped) {
+                    this.result = BlueRun.BlueRunResult.NOT_BUILT;
+                    this.state = BlueRun.BlueRunState.SKIPPED;
+                } else {
+                    this.result = BlueRun.BlueRunResult.NOT_BUILT;
+                    this.state = BlueRun.BlueRunState.NOT_BUILT;
+                }
                 break;
             case QUEUED:
                 this.result = BlueRun.BlueRunResult.UNKNOWN;

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

@@ -379,4 +379,23 @@ public void stagesGetValidTimings() throws Exception {
             TestUtils.assertTimesInRange(n, checks.get(n.getName()));
         }
     }
+
+    @Issue("https://github.com/jenkinsci/pipeline-graph-view-plugin/issues/358")
+    @Test
+    public void gh_358_parallelStagesMarkedAsSkipped() throws Exception {
+        WorkflowRun run = TestUtils.createAndRunJob(
+                j,
+                "gh_358_parallelStagesMarkedAsSkipped",
+                "gh_358_parallelStagesMarkedAsSkipped.jenkinsfile",
+                Result.FAILURE);
+
+        List<PipelineStage> stages = new PipelineGraphApi(run).createTree().getStages();
+        String stagesString =
+                TestUtils.collectStagesAsString(stages, (PipelineStage s) -> TestUtils.nodeNameAndStatus(s));
+
+        assertThat(
+                stagesString,
+                equalTo(
+                        "foo{success},first-parallel{failure}[bar{skipped},baz{failure}],second-parallel{skipped},Post Actions{success}"));
+    }
 }

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

@@ -0,0 +1,55 @@
+pipeline {
+    agent none
+    stages {
+        stage("foo") {
+            steps {
+                echo "hello"
+            }
+        }
+
+        stage('first-parallel') {
+            parallel {
+                stage("bar") {
+                    when {
+                        expression {
+                            return false
+                        }
+                    }
+                    steps {
+                        echo "I will be skipped"
+                    }
+                }
+
+                stage("baz") {
+                    steps {
+                        error "I will not be skipped but I will fail"
+                    }
+                }
+            }
+        }
+
+        stage('second-parallel') {
+            parallel {
+                stage("bar2") {
+                    steps {
+                        echo "bar2 skipped for earlier failure"
+                    }
+                }
+                stage("baz2") {
+                    steps {
+                        echo "bar3 skipped for earlier failure"
+                    }
+                }
+            }
+        }
+    }
+
+    post {
+        failure {
+            echo "I have failed"
+        }
+        success {
+            echo "I have succeeded"
+        }
+    }
+}