fix JENKINS-68775 keep it simple, just use StageChunkFinder to dump a linear stages list

Author: fengxx

splunk-devops-extend/pom.xml

@@ -41,11 +41,6 @@
             <artifactId>pipeline-rest-api</artifactId>
             <version>2.8</version>
         </dependency>
-        <dependency>
-            <groupId>org.jenkins-ci.main</groupId>
-            <artifactId>jenkins-test-harness</artifactId>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>splunk-devops</artifactId>
@@ -88,7 +83,7 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-basic-steps</artifactId>
-            <version>2.4</version>
+            <version>2.24</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -104,6 +99,17 @@
             <version>1.2.1</version>
             <scope>test</scope>
         </dependency>
-
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>junit</artifactId>
+            <version>1.47</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+                <groupId>javax.mail</groupId>
+                <artifactId>mail</artifactId>
+                <version>1.4.4</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

splunk-devops-extend/src/main/java/com/splunk/splunkjenkins/PipelineRunSupport.java

@@ -8,18 +8,21 @@
 import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.plugins.workflow.flow.FlowExecution;
 import org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner;
-import org.jenkinsci.plugins.workflow.graphanalysis.LabelledChunkFinder;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jenkinsci.plugins.workflow.pipelinegraphanalysis.StageChunkFinder;
 
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 @SuppressWarnings("unused")
 @Extension
 public class PipelineRunSupport extends LoggingJobExtractor<WorkflowRun> {
+    private static final Logger LOG = Logger.getLogger(PipelineRunSupport.class.getName());
 
     @Override
     public Map<String, Object> extract(WorkflowRun workflowRun, boolean jobCompleted) {
@@ -28,28 +31,24 @@ public Map<String, Object> extract(WorkflowRun workflowRun, boolean jobCompleted
             FlowExecution execution = workflowRun.getExecution();
             if (execution != null) {
                 WorkspaceChunkVisitor visitor = new WorkspaceChunkVisitor(workflowRun);
-                //LabelledChunkFinder to find stages and parallel branches
-                ForkScanner.visitSimpleChunks(execution.getCurrentHeads(), visitor, new LabelledChunkFinder());
-                Collection<StageNodeExt> nodes = visitor.getStages();
+                ForkScanner.visitSimpleChunks(execution.getCurrentHeads(), visitor, new StageChunkFinder());
+                Collection<StageNodeExt> stages = visitor.getStages();
+                LOG.log(Level.FINE, "found stages count", stages.size());
                 Map<String, String> execNodes = visitor.getWorkspaceNodes();
-                Map<String, String> parallelNodeStages = visitor.getParallelNodes();
-                if (!nodes.isEmpty()) {
-                    List<Map> labeledChunks = new ArrayList<Map>(nodes.size());
-                    for (StageNodeExt stageNodeExt : nodes) {
+                if (!stages.isEmpty()) {
+                    List<Map> labeledStages = new ArrayList<Map>(stages.size());
+                    for (StageNodeExt stageNodeExt : stages) {
                         Map<String, Object> stage = flowNodeToMap(stageNodeExt, execNodes);
                         List<Map<String, Object>> children = new ArrayList<>();
                         for (FlowNodeExt childNode : stageNodeExt.getStageFlowNodes()) {
                             children.add(flowNodeToMap(childNode, execNodes));
                         }
                         if (!children.isEmpty()) {
                             stage.put("children", children);
-                            if (parallelNodeStages.containsKey(stageNodeExt.getId())) {
-                                stage.put("enclosing_stage", parallelNodeStages.get(stageNodeExt.getId()));
-                            }
                         }
-                        labeledChunks.add(stage);
+                        labeledStages.add(stage);
                     }
-                    info.put("stages", labeledChunks);
+                    info.put("stages", labeledStages);
                 }
             }
             SplunkTaskListenerFactory.removeCache(workflowRun);
@@ -77,7 +76,7 @@ private Map<String, Object> flowNodeToMap(FlowNodeExt node, Map<String, String>
         result.put("arguments", node.getParameterDescription());
         String execNodeName = node.getExecNode();
         if (StringUtils.isEmpty(execNodeName)) {
-            //lockup the workspace nodes
+            //lookup the workspace nodes
             execNodeName = execNodes.get(node.getId());
         }
         result.put("exec_node", execNodeName);

splunk-devops-extend/src/main/java/com/splunk/splunkjenkins/WorkspaceChunkVisitor.java

@@ -3,7 +3,6 @@
 import com.cloudbees.workflow.rest.external.ChunkVisitor;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.apache.commons.lang.StringUtils;
-import org.jenkinsci.plugins.workflow.actions.ArgumentsAction;
 import org.jenkinsci.plugins.workflow.actions.WorkspaceAction;
 import org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode;
 import org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode;
@@ -27,13 +26,8 @@ public class WorkspaceChunkVisitor extends ChunkVisitor {
     private static final Logger LOG = Logger.getLogger(WorkspaceChunkVisitor.class.getName());
     // key is node id, value is jenkins worker node name
     Map<String, String> workspaceNodes = new HashMap<>();
-    // key is flowode id, value is parent stage id
-    Map<String, String> parallelNodes = new HashMap<>();
     String execNodeName = null;
     String execNodeStartId = null;
-    String enclosingStageName = null;
-    String enclosingStageId = null;
-    String currentParallelNodeStartId = "";
 
     public WorkspaceChunkVisitor(@NonNull WorkflowRun run) {
         super(run);
@@ -44,38 +38,12 @@ public void atomNode(@CheckForNull FlowNode before, @NonNull FlowNode atomNode,
         //reverse-order, traverse from end node to start node
         try {
             recordExecNode(atomNode);
-            recordStageNode(atomNode);
-            recordParallelNode(scan);
         } catch (Exception ex) {
             LOG.log(Level.WARNING, "failed to extract pipeline info", ex);
         }
         super.atomNode(before, atomNode, after, scan);
     }
 
-    /**
-     * store stage node info
-     *
-     * @param atomNode flow node
-     */
-    private void recordStageNode(FlowNode atomNode) {
-        // record stage name for parallel run inside stage
-        if (enclosingStageName == null) {
-            StepStartNode stageNode = getPipelineBlockBoundaryStartNode(atomNode, "stage");
-            if (stageNode != null) {
-                ArgumentsAction argumentsAction = stageNode.getAction(ArgumentsAction.class);
-                if (argumentsAction != null) {
-                    enclosingStageName = "" + argumentsAction.getArgumentValue("name");
-                } else {
-                    enclosingStageName = "";
-                }
-                enclosingStageId = stageNode.getId();
-                LOG.log(Level.FINE, "found stage node id={0}, name={1}", new String[]{enclosingStageId, enclosingStageName});
-            }
-        } else if (atomNode instanceof StepStartNode && atomNode.getId().equals(enclosingStageId)) {
-            enclosingStageName = null;
-        }
-    }
-
     /**
      * store the jenkins node name where pipeline ran
      *
@@ -106,30 +74,7 @@ private void recordExecNode(FlowNode atomNode) {
     }
 
     /**
-     * store parallel node info
-     *
-     * @param scan Scanner
-     */
-    @SuppressFBWarnings("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
-    private void recordParallelNode(@NonNull ForkScanner scan) {
-        if (scan.getCurrentParallelStartNode() != null) {
-            //store parallel node start id
-            String nodeId = scan.getCurrentParallelStartNode().getId();
-            if (nodeId != null && !nodeId.equals(currentParallelNodeStartId)) {
-                currentParallelNodeStartId = nodeId;
-                //hacky way to calc the parallelBlockNodeId
-                try {
-                    String parallelBlockId = "" + (1 + Integer.parseInt(nodeId));
-                    parallelNodes.put(parallelBlockId, enclosingStageName);
-                } catch (NumberFormatException ex) {
-                    //ignore
-                }
-            }
-        }
-    }
-
-    /**
-     * Check whether it is an enclose functional node (with BodyInvocationAction)
+     * Check whether it is an enclosed functional node (with BodyInvocationAction)
      *
      * @param atomNode
      * @param functionName
@@ -161,8 +106,4 @@ private StepStartNode getPipelineBlockBoundaryStartNode(FlowNode atomNode, Strin
     public Map<String, String> getWorkspaceNodes() {
         return workspaceNodes;
     }
-
-    public Map<String, String> getParallelNodes() {
-        return parallelNodes;
-    }
 }

splunk-devops-extend/src/test/java/com/splunk/splunkjenkins/StageStepNodesTest.java

@@ -31,6 +31,19 @@ public class StageStepNodesTest {
             "      echo \"hello\"\n" +
             "    }\n" +
             "}";
+    private String nestedStage = "node{\n" +
+            "    stage('build') {\n" +
+            "        stage('linux'){\n" +
+            "            echo \"hello\"\n" +
+            "        }\n" +
+            "        stage('windows'){\n" +
+            "            echo \"hello\"\n" +
+            "            stage('build c'){\n" +
+            "                echo \"hello\"\n" +
+            "            }\n" +
+            "        }\n" +
+            "    }\n" +
+            "}";
 
     @Before
     public void setUp() throws Exception {
@@ -43,7 +56,7 @@ public void testStageNodes() throws Exception {
         DumbSlave node = r.createOnlineSlave(new LabelAtom("ci-1"));
         DumbSlave node1 = r.createOnlineSlave(new LabelAtom("ci-2"));
         WorkflowJob p = r.jenkins.createProject(WorkflowJob.class, "stage-node-job");
-        p.setDefinition(new CpsFlowDefinition(jobScript,true));
+        p.setDefinition(new CpsFlowDefinition(jobScript, true));
         WorkflowRun b1 = r.assertBuildStatusSuccess(p.scheduleBuild2(0));
         assertFalse(b1.isBuilding());
         r.assertLogContains("hello", b1);
@@ -52,4 +65,19 @@ public void testStageNodes() throws Exception {
         verifySplunkSearchResult("\"stages{}.children{}.exec_node\"=\"" + node.getNodeName() + "\"", startTime, 1);
         verifySplunkSearchResult("\"stages{}.children{}.exec_node\"=\"" + node1.getNodeName() + "\"", startTime, 1);
     }
+
+    @Test
+    public void testFlattenStageResult() throws Exception {
+        long startTime = System.currentTimeMillis();
+        WorkflowJob p = r.jenkins.createProject(WorkflowJob.class, "nested-stage-job");
+        p.setDefinition(new CpsFlowDefinition(nestedStage, true));
+        WorkflowRun b1 = r.assertBuildStatusSuccess(p.scheduleBuild2(0));
+        assertFalse(b1.isBuilding());
+        r.assertLogContains("hello", b1);
+        assertTrue(b1.getDuration() > 0);
+        //check stage count
+        verifySplunkSearchResult("type=completed build_url=" + b1.getUrl() + "|spath output=stages path=\"stages{}\"" +
+                "| mvexpand stages" +
+                "| table stages", startTime, 4);
+    }
 }