Using jenkinsci/workflow-step-api-plugin#149

jglick · jglick · commit 08714a47386a · 2024-01-18T12:01:42.000-05:00
diff --git a/plugin/pom.xml b/plugin/pom.xml
@@ -54,6 +54,12 @@
                 <scope>import</scope>
                 <type>pom</type>
             </dependency>
+            <!-- TODO until in BOM: -->
+            <dependency>
+                <groupId>org.jenkins-ci.plugins.workflow</groupId>
+                <artifactId>workflow-step-api</artifactId>
+                <version>656.v54853706d987</version> <!-- TODO https://github.com/jenkinsci/workflow-step-api-plugin/pull/149 -->
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>
@@ -104,12 +110,6 @@
                 </exclusion>
             </exclusions>
         </dependency>
-        <dependency>
-            <groupId>org.jenkins-ci.plugins.workflow</groupId>
-            <artifactId>workflow-step-api</artifactId>
-            <classifier>tests</classifier>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-support</artifactId>
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/ContextVariableSetTest.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/ContextVariableSetTest.java
@@ -39,7 +39,6 @@
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 import org.jenkinsci.plugins.workflow.log.TaskListenerDecorator;
-import org.jenkinsci.plugins.workflow.steps.BodyInvoker;
 import org.jenkinsci.plugins.workflow.steps.DynamicContext;
 import org.jenkinsci.plugins.workflow.steps.Step;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
@@ -155,21 +154,20 @@ private static final class DecoratorImpl extends TaskListenerDecorator {
         }
     }
     private static final class YesPleaseDecorate implements Serializable {}
-    public static final class DecoratorStep extends Step implements Serializable {
+    public static final class DecoratorStep extends Step {
         @DataBoundConstructor public DecoratorStep() {}
         @DataBoundSetter public @CheckForNull String message;
         @Override public StepExecution start(StepContext context) throws Exception {
-            return StepExecutions.block(context, this::start);
-        }
-        private void start(StepContext context, BodyInvoker invoker) throws Exception {
-            if (message != null) {
-                TaskListenerDecorator original = context.get(TaskListenerDecorator.class);
-                DecoratorImpl subsequent = new DecoratorImpl(message);
-                LOGGER.log(Level.INFO, "merging {0} with {1}", new Object[] {original, subsequent});
-                invoker.withContext(TaskListenerDecorator.merge(original, subsequent));
-            } else {
-                invoker.withContext(new YesPleaseDecorate());
-            }
+            return StepExecutions.block(context, (c, invoker) -> {
+                if (message != null) {
+                    TaskListenerDecorator original = c.get(TaskListenerDecorator.class);
+                    DecoratorImpl subsequent = new DecoratorImpl(message);
+                    LOGGER.log(Level.INFO, "merging {0} with {1}", new Object[] {original, subsequent});
+                    invoker.withContext(TaskListenerDecorator.merge(original, subsequent));
+                } else {
+                    invoker.withContext(new YesPleaseDecorate());
+                }
+            });
         }
         @TestExtension("smokes") public static final class DescriptorImpl extends StepDescriptor {
             @Override public String getFunctionName() {
@@ -213,11 +211,10 @@ private static final class Message implements Serializable {
     public static final class GetMessageStep extends Step {
         @DataBoundConstructor public GetMessageStep() {}
         @Override public StepExecution start(StepContext context) throws Exception {
-            return StepExecutions.synchronous(context, GetMessageStep::run);
-        }
-        private static Object run(StepContext context) throws Exception {
-            Message message = context.get(Message.class);
-            return message != null ? message.text : null;
+            return StepExecutions.synchronous(context, c -> {
+                Message message = c.get(Message.class);
+                return message != null ? message.text : null;
+            });
         }
         @TestExtension("dynamicVsStatic") public static final class DescriptorImpl extends StepDescriptor {
             @Override public String getFunctionName() {
@@ -228,7 +225,7 @@ private static Object run(StepContext context) throws Exception {
             }
         }
     }
-    public static final class WithStaticMessageStep extends Step implements Serializable {
+    public static final class WithStaticMessageStep extends Step {
         public final String text;
         @DataBoundConstructor public WithStaticMessageStep(String text) {
             this.text = text;
@@ -266,7 +263,7 @@ private static final class DynamicMessage implements Serializable {
             return dynamicMessage != null ? new Message(dynamicMessage.text) : null;
         }
     }
-    public static final class WithDynamicMessageStep extends Step implements Serializable {
+    public static final class WithDynamicMessageStep extends Step {
         public final String text;
         @DataBoundConstructor public WithDynamicMessageStep(String text) {
             this.text = text;
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinition2Test.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/CpsFlowDefinition2Test.java
@@ -30,7 +30,6 @@
 import hudson.model.Describable;
 import hudson.model.Executor;
 import hudson.model.Result;
-import java.io.Serializable;
 import java.util.Collections;
 import java.util.Set;
 import java.util.logging.Level;
@@ -927,17 +926,14 @@ public void scriptInitializerCallsCpsTransformedMethod() throws Exception {
         jenkins.assertLogContains("Scripts not permitted to use field Test metaClass", b);
     }
 
-    public static class UnsafeParameterStep extends Step implements Serializable {
+    public static class UnsafeParameterStep extends Step {
         private final UnsafeDescribable val;
         @DataBoundConstructor
         public UnsafeParameterStep(UnsafeDescribable val) {
             this.val = val;
         }
-        public StepExecution start(StepContext context) throws Exception {
-            return StepExecutions.synchronousNonBlocking(context, c -> {
-                val.doSomething();
-                return null;
-            });
+        @Override public StepExecution start(StepContext context) throws Exception {
+            return StepExecutions.synchronousNonBlockingVoid(context, c -> val.doSomething());
         }
         @TestExtension
         public static class DescriptorImpl extends StepDescriptor {
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImplTest.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/cps/actions/ArgumentsActionImplTest.java
@@ -700,7 +700,7 @@ public static class NopStep extends Step {
         public NopStep(Object value) {}
         @Override
         public StepExecution start(StepContext context) throws Exception {
-            return StepExecutions.synchronous(context, unused -> null);
+            return StepExecutions.synchronousVoid(context, c -> {});
         }
         @TestExtension
         public static class DescriptorImpl extends StepDescriptor {
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicListStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicListStep.java
@@ -27,11 +27,10 @@ public MonomorphicListStep(List<MonomorphicData> data) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> {
             for (MonomorphicData d : data) {
                 c.get(TaskListener.class).getLogger().println(d.getArgs());
             }
-            return null;
         });
     }
 
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicListWithSymbolStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicListWithSymbolStep.java
@@ -27,11 +27,10 @@ public MonomorphicListWithSymbolStep(List<MonomorphicDataWithSymbol> data) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> {
             for (MonomorphicDataWithSymbol d : data) {
                 c.get(TaskListener.class).getLogger().println(d.getArgs());
             }
-            return null;
         });
     }
 
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicStep.java
@@ -27,10 +27,7 @@ public MonomorphicStep(MonomorphicData data) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
-            c.get(TaskListener.class).getLogger().println(data.getArgs());
-            return null;
-        });
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println(data.getArgs()));
     }
 
     @Extension
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicWithSymbolStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/MonomorphicWithSymbolStep.java
@@ -25,10 +25,7 @@ public MonomorphicWithSymbolStep(MonomorphicDataWithSymbol data) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
-            c.get(TaskListener.class).getLogger().println(data.getArgs());
-            return null;
-        });
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println(data.getArgs()));
     }
 
     @Extension
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/StateMetaStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/StateMetaStep.java
@@ -39,13 +39,12 @@ public void setModerate(boolean m) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> {
             TaskListener listener = c.get(TaskListener.class);
             if (moderate) {
                 listener.getLogger().println("Introducing " + SymbolLookup.getSymbolValue(state).iterator().next());
             }
             state.sayHello(listener);
-            return null;
         });
     }
 
diff --git a/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/chemical/DetectionMetaStep.java b/plugin/src/test/java/org/jenkinsci/plugins/workflow/testMetaStep/chemical/DetectionMetaStep.java
@@ -26,10 +26,7 @@ public DetectionMetaStep(Chemical compound) {
     }
 
     @Override public StepExecution start(StepContext context) throws Exception {
-        return StepExecutions.synchronousNonBlocking(context, c -> {
-            c.get(TaskListener.class).getLogger().println("Detecting " + compound.getClass().getName());
-            return null;
-        });
+        return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println("Detecting " + compound.getClass().getName()));
     }
 
     @Extension(ordinal=100)

Original file line number	Diff line number	Diff line change
`@@ -700,7 +700,7 @@ public static class NopStep extends Step {`
`700`	`700`	`public NopStep(Object value) {}`
`701`	`701`	`@Override`
`702`	`702`	`public StepExecution start(StepContext context) throws Exception {`
`703`		`- return StepExecutions.synchronous(context, unused -> null);`
	`703`	`+ return StepExecutions.synchronousVoid(context, c -> {});`
`704`	`704`	`}`
`705`	`705`	`@TestExtension`
`706`	`706`	`public static class DescriptorImpl extends StepDescriptor {`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,10 @@ public MonomorphicListStep(List<MonomorphicData> data) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override public StepExecution start(StepContext context) throws Exception {`
`30`		`- return StepExecutions.synchronousNonBlocking(context, c -> {`
	`30`	`+ return StepExecutions.synchronousNonBlockingVoid(context, c -> {`
`31`	`31`	`for (MonomorphicData d : data) {`
`32`	`32`	`c.get(TaskListener.class).getLogger().println(d.getArgs());`
`33`	`33`	`}`
`34`		`- return null;`
`35`	`34`	`});`
`36`	`35`	`}`
`37`	`36`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,7 @@ public MonomorphicStep(MonomorphicData data) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override public StepExecution start(StepContext context) throws Exception {`
`30`		`- return StepExecutions.synchronousNonBlocking(context, c -> {`
`31`		`- c.get(TaskListener.class).getLogger().println(data.getArgs());`
`32`		`- return null;`
`33`		`- });`
	`30`	`+ return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println(data.getArgs()));`
`34`	`31`	`}`
`35`	`32`
`36`	`33`	`@Extension`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,7 @@ public MonomorphicWithSymbolStep(MonomorphicDataWithSymbol data) {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`@Override public StepExecution start(StepContext context) throws Exception {`
`28`		`- return StepExecutions.synchronousNonBlocking(context, c -> {`
`29`		`- c.get(TaskListener.class).getLogger().println(data.getArgs());`
`30`		`- return null;`
`31`		`- });`
	`28`	`+ return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println(data.getArgs()));`
`32`	`29`	`}`
`33`	`30`
`34`	`31`	`@Extension`
Original file line number	Diff line number	Diff line change
`@@ -39,13 +39,12 @@ public void setModerate(boolean m) {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@Override public StepExecution start(StepContext context) throws Exception {`
`42`		`- return StepExecutions.synchronousNonBlocking(context, c -> {`
	`42`	`+ return StepExecutions.synchronousNonBlockingVoid(context, c -> {`
`43`	`43`	`TaskListener listener = c.get(TaskListener.class);`
`44`	`44`	`if (moderate) {`
`45`	`45`	`listener.getLogger().println("Introducing " + SymbolLookup.getSymbolValue(state).iterator().next());`
`46`	`46`	`}`
`47`	`47`	`state.sayHello(listener);`
`48`		`- return null;`
`49`	`48`	`});`
`50`	`49`	`}`
`51`	`50`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,7 @@ public DetectionMetaStep(Chemical compound) {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Override public StepExecution start(StepContext context) throws Exception {`
`29`		`- return StepExecutions.synchronousNonBlocking(context, c -> {`
`30`		`- c.get(TaskListener.class).getLogger().println("Detecting " + compound.getClass().getName());`
`31`		`- return null;`
`32`		`- });`
	`29`	`+ return StepExecutions.synchronousNonBlockingVoid(context, c -> c.get(TaskListener.class).getLogger().println("Detecting " + compound.getClass().getName()));`
`33`	`30`	`}`
`34`	`31`
`35`	`32`	`@Extension(ordinal=100)`