Merge pull request #10 from abayer/jenkins-44456

[FIXED JENKINS-44456] Add STAGE_NAME to environment
jenkinsci · May 25, 2017 · 850947f · 850947f
2 parents 0218206 + 59df6d1
commit 850947f
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 10 deletions.
diff --git a/pom.xml b/pom.xml
@@ -39,13 +39,23 @@
     </pluginRepositories>
     <properties>
         <jenkins.version>1.642.3</jenkins.version>
-        <workflow-step-api-plugin.version>2.9</workflow-step-api-plugin.version>
+        <workflow-step-api-plugin.version>2.10</workflow-step-api-plugin.version>
     </properties>
     <dependencies>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-api</artifactId>
-            <version>2.11</version>
+            <version>2.15</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>structs</artifactId>
+            <version>1.6</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>scm-api</artifactId>
+            <version>2.0.7</version>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
@@ -62,44 +72,44 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-support</artifactId>
-            <version>2.12</version>
+            <version>2.14</version>
             <classifier>tests</classifier>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-cps</artifactId>
-            <version>2.2</version>
+            <version>2.31</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-job</artifactId>
-            <version>2.9</version>
+            <version>2.11</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-basic-steps</artifactId>
-            <version>2.3</version>
+            <version>2.4</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-durable-task-step</artifactId>
-            <version>2.8</version>
+            <version>2.11</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-scm-step</artifactId>
-            <version>2.2</version>
+            <version>2.4</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>script-security</artifactId>
-            <version>1.26</version>
+            <version>1.27</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

diff --git a/src/main/java/org/jenkinsci/plugins/workflow/support/steps/StageStepExecution.java b/src/main/java/org/jenkinsci/plugins/workflow/support/steps/StageStepExecution.java
@@ -2,6 +2,7 @@
 
 import com.google.inject.Inject;
 import hudson.AbortException;
+import hudson.EnvVars;
 import hudson.Extension;
 import hudson.XmlFile;
 import hudson.model.InvisibleAction;
@@ -35,6 +36,7 @@
 import org.jenkinsci.plugins.workflow.graph.FlowStartNode;
 import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
 import org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback;
+import org.jenkinsci.plugins.workflow.steps.EnvironmentExpander;
 import org.jenkinsci.plugins.workflow.steps.FlowInterruptedException;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
@@ -64,7 +66,12 @@ public boolean start() throws Exception {
             if (step.concurrency != null) {
                 throw new AbortException(Messages.StageStepExecution_concurrency_not_supported_in_block_mode());
             }
-            getContext().newBodyInvoker().withCallback(BodyExecutionCallback.wrap(getContext())).withDisplayName(step.name).start();
+            getContext().newBodyInvoker()
+                    .withContexts(EnvironmentExpander.merge(getContext().get(EnvironmentExpander.class),
+                            new ExpanderImpl(step.name)))
+                    .withCallback(BodyExecutionCallback.wrap(getContext()))
+                    .withDisplayName(step.name)
+                    .start();
             return false;
         }
         getContext().get(TaskListener.class).getLogger().println(Messages.StageStepExecution_non_block_mode_deprecated());
@@ -339,6 +346,18 @@ void unblock(String message) {
         }
     }
 
+    private static final class ExpanderImpl extends EnvironmentExpander {
+        private static final long serialVersionUID = 1;
+        private final String stageName;
+        private ExpanderImpl(String stageName) {
+            this.stageName = stageName;
+        }
+        @Override public void expand(EnvVars env) throws IOException, InterruptedException {
+            env.override("STAGE_NAME", stageName);
+        }
+    }
+
+
     @Extension
     public static final class Listener extends RunListener<Run<?,?>> {
         @Override public void onCompleted(Run<?,?> r, TaskListener listener) {

diff --git a/src/test/java/org/jenkinsci/plugins/workflow/support/steps/StageStepTest.java b/src/test/java/org/jenkinsci/plugins/workflow/support/steps/StageStepTest.java
@@ -67,6 +67,19 @@ public class StageStepTest {
         });
     }
 
+    @Issue("JENKINS-44456")
+    @Test public void stageNameInEnv() throws Exception {
+        story.addStep(new Statement() {
+            @Override public void evaluate() throws Throwable {
+                WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "p");
+                p.setDefinition(new CpsFlowDefinition("stage('foo-stage') {echo \"STAGE_NAME is ${STAGE_NAME}\"}", true));
+                WorkflowRun b = story.j.assertBuildStatusSuccess(p.scheduleBuild2(0));
+                story.j.assertLogContains("STAGE_NAME is foo-stage", b);
+                story.j.assertLogNotContains(Messages.StageStepExecution_non_block_mode_deprecated(), b);
+            }
+        });
+    }
+
     @Test public void basics() throws Exception {
         // Timeline (A has concurrency 2, B 1):
         // #1 o-A--------------B-----------------o