Ensure that scm env variables are set for declarative pipeline.

.gitignore

@@ -7,3 +7,4 @@
 /.idea/
 *.iml
 nbactions.xml
+/.vscode/

pom.xml

@@ -112,6 +112,38 @@
     </dependency>
 
     <!-- for testing -->
+    <dependency> <!-- KubernetesDeclarativeAgentTest -->
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>git</artifactId>
+      <version>2.6.0</version>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>org.apache.httpcomponents</groupId>
+          <artifactId>httpclient</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+    <dependency> <!-- KubernetesDeclarativeAgentTest -->
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>git</artifactId>
+      <version>2.6.0</version>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>org.apache.httpcomponents</groupId>
+          <artifactId>httpclient</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+    <dependency> <!-- KubernetesDeclarativeAgentTest -->
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-scm-step</artifactId>
+      <version>${jenkins-workflow-scm-step.version}</version>
+      <scope>test</scope>
+      <classifier>tests</classifier>
+    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins.workflow</groupId>
       <artifactId>workflow-job</artifactId>

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgentScript.groovy

@@ -40,18 +40,27 @@ public class KubernetesDeclarativeAgentScript extends DeclarativeAgentScript<Kub
             try {
                 script.podTemplate(describable.asArgs) {
                     script.node(describable.label) {
+                        def checkoutMap = [:]
                         if (describable.isDoCheckout() && describable.hasScmContext(script)) {
-                            if (!describable.inStage) {
-                                script.stage(SyntheticStageNames.checkout()) {
-                                    script.checkout script.scm
+                            String subDir = describable.subdirectory
+                            if (subDir != null && subDir != "") {
+                                script.dir(subDir) {
+                                    checkoutMap.putAll(performCheckout(script, describable))
                                 }
                             } else {
-                                // No stage when we're in a nested stage already
-                                script.checkout script.scm
+                                checkoutMap.putAll(performCheckout(script, describable))
                             }
                         }
-                        script.container(describable.containerTemplate.asArgs) {
-                            body.call()
+                        if (checkoutMap) {
+                            script.withEnv(checkoutMap.collect { k, v -> "${k}=${v}" }) {
+                                script.container(describable.containerTemplate.name) {
+                                    body.call()
+                                }
+                            }
+                        } else {
+                            script.container(describable.containerTemplate.asArgs) {
+                                body.call()
+                            }
                         }
                     }
                 }
@@ -61,4 +70,18 @@ public class KubernetesDeclarativeAgentScript extends DeclarativeAgentScript<Kub
             }
         }
     }
+
+    private static Map performCheckout(CpsScript script, KubernetesDeclarativeAgent agent) {
+        def checkoutMap = [:]
+        if (!agent.inStage) {
+            script.stage(SyntheticStageNames.checkout()) {
+                checkoutMap.putAll(script.checkout(script.scm) ?: [:])
+            }
+        } else {
+            // No stage when we're in a nested stage already
+            checkoutMap.putAll(script.checkout(script.scm) ?: [:])
+        }
+
+        return checkoutMap
+    }
 }

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/AbstractKubernetesPipelineTest.java

@@ -32,6 +32,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+
 import org.apache.commons.compress.utils.IOUtils;
 import org.csanchez.jenkins.plugins.kubernetes.ContainerEnvVar;
 import org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate;
@@ -47,6 +48,7 @@
 import org.jvnet.hudson.test.BuildWatcher;
 import org.jvnet.hudson.test.JenkinsRuleNonLocalhost;
 import org.jvnet.hudson.test.LoggerRule;
+import jenkins.plugins.git.GitSampleRepoRule;
 
 import com.google.common.collect.ImmutableMap;
 
@@ -77,6 +79,15 @@ public class AbstractKubernetesPipelineTest {
     @Rule
     public LoggerRule logs = new LoggerRule().record(Logger.getLogger(KubernetesCloud.class.getPackage().getName()),
             Level.ALL);
+    @Rule
+    public GitSampleRepoRule sampleRepo = new GitSampleRepoRule();
+
+    protected void prepRepoWithJenkinsfile(String pipelineName) throws Exception {
+        sampleRepo.init();
+        sampleRepo.write("Jenkinsfile", loadPipelineScript(pipelineName));
+        sampleRepo.git("add", "Jenkinsfile");
+        sampleRepo.git("commit", "--message=files");
+    }
 
     @BeforeClass
     public static void isKubernetesConfigured() throws Exception {

src/test/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/KubernetesDeclarativeAgentTest.java

@@ -27,6 +27,8 @@
 import static org.junit.Assert.*;
 
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+import org.jenkinsci.plugins.workflow.cps.CpsScmFlowDefinition;
+import jenkins.plugins.git.GitStep;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 import org.junit.Test;
@@ -47,4 +49,16 @@ public void declarative() throws Exception {
         r.assertLogContains("OUTSIDE_CONTAINER_ENV_VAR = " + CONTAINER_ENV_VAR_VALUE + "\n", b);
     }
 
+    @Test
+    public void declarativeWithSCMEnvVars() throws Exception {
+        prepRepoWithJenkinsfile("declarativeWithSCMEnvVars.groovy");
+        WorkflowJob p = r.jenkins.createProject(WorkflowJob.class, "job with dir");
+        p.setDefinition(new CpsScmFlowDefinition(new GitStep(sampleRepo.toString()).createSCM(), "Jenkinsfile"));
+        WorkflowRun b = p.scheduleBuild2(0).waitForStart();
+        assertNotNull(b);
+        r.assertBuildStatusSuccess((r.waitForCompletion(b)));
+        r.assertLogNotContains("GIT_COMMIT is null", b);
+        r.assertLogContains("GIT_COMMIT is ", b);
+    }
+
 }

src/test/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/declarativeWithSCMEnvVars.groovy

@@ -0,0 +1,10 @@
+pipeline {
+    agent any
+    stages {
+        stage("foo") {
+            steps {
+                echo "GIT_COMMIT is ${env.GIT_COMMIT}"
+            }
+        }
+    }
+}