Migrate pipeline-graph-analysis-plugin implementations (jenkinsci#803)

Author: stuartrowe

pom.xml

@@ -81,10 +81,6 @@
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>metrics</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.jenkins-ci.plugins</groupId>
-      <artifactId>pipeline-graph-analysis</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>pipeline-input-step</artifactId>
@@ -138,6 +134,12 @@
       <artifactId>pipeline-build-step</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-api</artifactId>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins.workflow</groupId>
       <artifactId>workflow-support</artifactId>

src/main/java/io/jenkins/plugins/pipelinegraphview/analysis/GenericStatus.java

@@ -0,0 +1,95 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package io.jenkins.plugins.pipelinegraphview.analysis;
+
+import hudson.model.Result;
+import java.util.Map;
+
+/**
+ * Statuses of a {@link org.jenkinsci.plugins.workflow.graphanalysis.FlowChunk} in increasing priority order
+ * Note, when adding new statuses you need to add a new {@link io.jenkins.plugins.pipelinegraphview.analysis.StatusAndTiming.StatusApiVersion}
+ *  and set the value of {@link StatusAndTiming#CURRENT_API_VERSION} to that,
+ *  and update {@link StatusAndTiming#coerceStatusMap(Map)} to do coercion for new codings to protect core APIs from unknown values
+ */
+public enum GenericStatus {
+    /**
+     * We resumed from checkpoint or {@link Result#NOT_BUILT} status - nothing ran in the chunk.
+     */
+    NOT_EXECUTED,
+
+    /**
+     * Completed & successful, ex {@link Result#SUCCESS}
+     */
+    SUCCESS,
+
+    /**
+     * Completed with recoverable failures, such as noncritical tests, ex {@link Result#UNSTABLE}
+     */
+    UNSTABLE,
+
+    /**
+     * Not complete: still executing, in a node block, but the node block is in queue.
+     */
+    QUEUED,
+
+    /**
+     * Not complete: still executing, waiting for a result
+     */
+    IN_PROGRESS,
+
+    /**
+     * Completed and explicitly failed, i.e. {@link Result#FAILURE}
+     */
+    FAILURE,
+
+    /**
+     * Aborted while running, no way to determine final outcome {@link Result#ABORTED}
+     */
+    ABORTED,
+
+    /**
+     * Not complete: we are waiting for user input to continue (special case of IN_PROGRESS)
+     */
+    PAUSED_PENDING_INPUT;
+
+    /**
+     * Create a {@link GenericStatus} from a {@link Result}
+     */
+    public static GenericStatus fromResult(Result result) {
+        if (result == Result.NOT_BUILT) {
+            return GenericStatus.NOT_EXECUTED;
+        } else if (result == Result.ABORTED) {
+            return GenericStatus.ABORTED;
+        } else if (result == Result.FAILURE) {
+            return GenericStatus.FAILURE;
+        } else if (result == Result.UNSTABLE) {
+            return GenericStatus.UNSTABLE;
+        } else if (result == Result.SUCCESS) {
+            return GenericStatus.SUCCESS;
+        } else {
+            return GenericStatus.NOT_EXECUTED;
+        }
+    }
+}

src/main/java/io/jenkins/plugins/pipelinegraphview/analysis/StageChunkFinder.java

@@ -0,0 +1,59 @@
+package io.jenkins.plugins.pipelinegraphview.analysis;
+
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import org.jenkinsci.plugins.workflow.actions.LabelAction;
+import org.jenkinsci.plugins.workflow.actions.StageAction;
+import org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode;
+import org.jenkinsci.plugins.workflow.cps.nodes.StepEndNode;
+import org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode;
+import org.jenkinsci.plugins.workflow.graph.BlockEndNode;
+import org.jenkinsci.plugins.workflow.graph.FlowNode;
+import org.jenkinsci.plugins.workflow.graph.StepNode;
+import org.jenkinsci.plugins.workflow.graphanalysis.ChunkFinder;
+import org.jenkinsci.plugins.workflow.support.steps.StageStep;
+
+/**
+ * Finds both block-scoped and legacy stages
+ * @author Sam Van Oort
+ */
+public class StageChunkFinder implements ChunkFinder {
+
+    @Override
+    public boolean isStartInsideChunk() {
+        return true;
+    }
+
+    @Override
+    public boolean isChunkStart(@NonNull FlowNode current, @CheckForNull FlowNode previous) {
+        if ((current instanceof StepAtomNode || current instanceof StepStartNode)
+                && !(((StepNode) current).getDescriptor() instanceof StageStep.DescriptorImpl)) {
+            // Faster than looking at actions
+            return false;
+        } else if (current instanceof BlockEndNode) {
+            return false;
+        } else if (current instanceof StepStartNode startNode) {
+            if (!(startNode.getDescriptor() instanceof StageStep.DescriptorImpl)) {
+                return false;
+            }
+            return startNode.getAction(LabelAction.class) != null;
+        }
+        return current.getAction(StageAction.class) != null;
+    }
+
+    /** End is where you have a label marker before it... or  */
+    @Override
+    public boolean isChunkEnd(@NonNull FlowNode current, @CheckForNull FlowNode previous) {
+        // First a block-scoped stage
+        if (current instanceof StepEndNode stepEndNode
+                && stepEndNode.getDescriptor() instanceof StageStep.DescriptorImpl) {
+            // We have to look for the labelaction because block-scoped stage creates two nested blocks
+            return stepEndNode.getStartNode().getAction(LabelAction.class) != null;
+        }
+        // Then a marker-scoped stage
+        if (previous != null) {
+            return isChunkStart(previous, null);
+        }
+        return false;
+    }
+}

src/main/java/io/jenkins/plugins/pipelinegraphview/analysis/StageStatus.java

@@ -0,0 +1,20 @@
+package io.jenkins.plugins.pipelinegraphview.analysis;
+
+/**
+ * Duplicates some string constants used in pipeline-stage-tags-metadata plugin to avoid introducing the dependency.
+ * See: https://github.com/jenkinsci/pipeline-model-definition-plugin/tree/master/pipeline-stage-tags-metadata
+ *
+ * @author cliffmeyers
+ */
+public class StageStatus {
+
+    public static final String TAG_NAME = "STAGE_STATUS";
+
+    public String getTagName() {
+        return TAG_NAME;
+    }
+
+    public static String getSkippedForConditional() {
+        return "SKIPPED_FOR_CONDITIONAL";
+    }
+}