Merge pull request #306 from gbhat618/support-step-display-function-name-and-exception-verification

Expose StepDescriptor in DefaultStepContext.get

Author: jglick

pom.xml

@@ -80,6 +80,13 @@
                 <scope>import</scope>
                 <type>pom</type>
             </dependency>
+            <!-- TODO remove this after bom is updated; currently required for code merged in
+                    https://github.com/jenkinsci/workflow-step-api-plugin/pull/204 -->
+            <dependency>
+                <groupId>org.jenkins-ci.plugins.workflow</groupId>
+                <artifactId>workflow-step-api</artifactId>
+                <version>700.v6e45cb_a_5a_a_21</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>

src/main/java/org/jenkinsci/plugins/workflow/support/DefaultStepContext.java

@@ -49,9 +49,11 @@
 import org.jenkinsci.plugins.workflow.flow.FlowExecution;
 import org.jenkinsci.plugins.workflow.flow.GraphListener;
 import org.jenkinsci.plugins.workflow.graph.FlowNode;
+import org.jenkinsci.plugins.workflow.graph.StepNode;
 import org.jenkinsci.plugins.workflow.log.TaskListenerDecorator;
 import org.jenkinsci.plugins.workflow.steps.EnvironmentExpander;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
 import org.jenkinsci.plugins.workflow.support.actions.EnvironmentAction;
 import org.jenkinsci.plugins.workflow.support.actions.LogStorageAction;
 
@@ -70,7 +72,7 @@ public abstract class DefaultStepContext extends StepContext {
     /**
      * Uses {@link #doGet} but automatically translates certain kinds of objects into others.
      * <p>Note that some basic types are handled directly by {@link #get} and cannot be overridden,
-     * such as {@link Run}, {@link Job}, {@link FlowExecution}, and {@link FlowNode}.
+     * such as {@link Run}, {@link Job}, {@link FlowExecution}, {@link FlowNode} and {@link StepDescriptor}.
      * <p>{@inheritDoc}
      */
     @Override public final <T> T get(Class<T> key) throws IOException, InterruptedException {
@@ -83,6 +85,11 @@ public abstract class DefaultStepContext extends StepContext {
             value = castOrNull(key, getExecution());
         } else if (FlowNode.class.isAssignableFrom(key)) {
             value = castOrNull(key, getNode());
+        } else if (StepDescriptor.class.isAssignableFrom(key)) {
+            var stepNode = castOrNull(StepNode.class, getNode());
+            if (stepNode != null) {
+                value = castOrNull(key, stepNode.getDescriptor());
+            }
         }
         if (value != null) {
             return value;

src/test/java/org/jenkinsci/plugins/workflow/test/steps/SynchronousResumeNotSupportedExceptionTest.java

@@ -0,0 +1,88 @@
+package org.jenkinsci.plugins.workflow.test.steps;
+
+import java.util.Set;
+
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.steps.Step;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
+import org.jenkinsci.plugins.workflow.steps.StepExecution;
+import org.jenkinsci.plugins.workflow.steps.StepExecutions;
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.BuildWatcher;
+import org.jvnet.hudson.test.JenkinsSessionRule;
+import org.jvnet.hudson.test.TestExtension;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+import hudson.model.TaskListener;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.allOf;
+import static org.hamcrest.Matchers.containsString;
+
+public class SynchronousResumeNotSupportedExceptionTest {
+
+    @ClassRule
+    public static BuildWatcher bw = new BuildWatcher();
+
+    @Rule
+    public JenkinsSessionRule rjr = new JenkinsSessionRule();
+
+    @Test
+    public void test_SynchronousResumeNotSupportedException_ShouldShowFailedStep_AndSuggestRetry() throws Throwable {
+        rjr.then(j -> {
+            WorkflowJob p = j.createProject(WorkflowJob.class, "p");
+            p.setDefinition(new CpsFlowDefinition("simulatedSleep 20", true));
+            var run = p.scheduleBuild2(0).waitForStart();
+            j.waitForMessage("Going to sleep for", run);
+        });
+        rjr.then(j -> {
+            var b = j.jenkins.getItemByFullName("p", WorkflowJob.class).getBuildByNumber(1);
+            j.waitForCompletion(b);
+            assertThat(b.getLog(), allOf(
+                containsString("nonresumable"),
+                containsString("retry"),
+                containsString("simulatedSleep"),
+                containsString("retries")));
+        });
+    }
+
+    @SuppressWarnings("unused")
+    public static class SimulatedSleepStep extends Step {
+
+        private final int sleepSeconds;
+
+        @DataBoundConstructor
+        public SimulatedSleepStep(int sleepSeconds) {
+            this.sleepSeconds = sleepSeconds;
+        }
+
+        @Override
+        public StepExecution start(StepContext context) throws Exception {
+            return StepExecutions.synchronousNonBlockingVoid(context, c -> {
+                var buildLogger = context.get(TaskListener.class).getLogger();
+                buildLogger.println("Simulated sleep step started");
+                buildLogger.println("Going to sleep for " + sleepSeconds + " seconds");
+                Thread.sleep(sleepSeconds * 1000L);
+                buildLogger.println("Simulated sleep step completed");
+            });
+        }
+
+        @TestExtension
+        public static final class DescriptorImpl extends StepDescriptor {
+
+            @Override
+            public Set<? extends Class<?>> getRequiredContext() {
+                return Set.of(TaskListener.class);
+            }
+
+            @Override
+            public String getFunctionName() {
+                return "simulatedSleep";
+            }
+        }
+    }
+}