Merge remote-tracking branch 'rudolfwalter/casc-env'

Author: daspilker

docs/Home.md

@@ -33,8 +33,10 @@ Browse the Jenkins issue tracker to see any [open issues](https://issues.jenkins
 
 ## Release Notes
 * 1.76 (unreleased)
-  * added documentation for pitfalls when using multiple Job DSL build steps in a single job
+  * Added documentation for pitfalls when using multiple Job DSL build steps in a single job
     ([JENKINS-44142](https://issues.jenkins-ci.org/browse/JENKINS-44142))
+  * Pass environment from CasC file to Job DSL script
+    ([JENKINS-59037](https://issues.jenkins-ci.org/browse/JENKINS-59037))
   * Fixed [[Dynamic DSL]] problem
     ([JENKINS-57817](https://issues.jenkins-ci.org/browse/JENKINS-57817))
   * Show items with same display name on job and build pages

docs/JCasC.md

@@ -1,4 +1,4 @@
-Via [configuration-as-code-plugin](https://plugins.jenkins.io/configuration-as-code) also known as JCasC
+~~~~Via [configuration-as-code-plugin](https://plugins.jenkins.io/configuration-as-code) also known as JCasC
 
 It is possible to configure initial seed jobs through a yaml config file.  
 The basics for job dsl is you have a root element called `jobs` that will be parsed to configure via job dsl
@@ -30,7 +30,7 @@ jobs:
   - url: https://raw.githubusercontent.com/jenkinsci/job-dsl-plugin/master/job-dsl-plugin/src/test/resources/javaposse/jobdsl/plugin/testjob.groovy
 ```
 
-you can reference multiple scripts, files, and urls
+You can reference multiple scripts, files, and urls
 
 ```yml
 jobs:
@@ -63,3 +63,19 @@ jobs:
   - file: ./jobdsl/job1.groovy
   - file: ./jobdsl/job2.groovy
 ```
+
+You can pass values from the yaml file to the job dsl script
+
+```yml
+jobs:
+  - providedEnv:
+      SUPERHERO: 'Midnighter'
+  - file: ./jobdsl/job.groovy
+```
+
+```groovy
+//job.groovy
+job('awesome-job') {
+    description("favorite job of ${SUPERHERO}")
+}
+```

job-dsl-plugin/src/main/groovy/javaposse/jobdsl/plugin/casc/SeedJobConfigurator.java

@@ -3,26 +3,28 @@
 import hudson.Extension;
 import io.jenkins.plugins.casc.Attribute;
 import io.jenkins.plugins.casc.ConfigurationContext;
-import io.jenkins.plugins.casc.ConfiguratorException;
 import io.jenkins.plugins.casc.Configurator;
+import io.jenkins.plugins.casc.ConfiguratorException;
 import io.jenkins.plugins.casc.RootElementConfigurator;
 import io.jenkins.plugins.casc.SecretSourceResolver;
 import io.jenkins.plugins.casc.impl.attributes.MultivaluedAttribute;
 import io.jenkins.plugins.casc.model.CNode;
 import io.jenkins.plugins.casc.model.Mapping;
-import java.util.Map;
 import javaposse.jobdsl.dsl.GeneratedItems;
 import javaposse.jobdsl.plugin.JenkinsDslScriptLoader;
 import javaposse.jobdsl.plugin.JenkinsJobManagement;
 import javaposse.jobdsl.plugin.LookupStrategy;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 
-import javax.annotation.Nonnull;
 import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
+import java.util.stream.Stream;
 
 import static io.vavr.API.Try;
 import static io.vavr.API.unchecked;
@@ -59,9 +61,11 @@ public GeneratedItems[] getTargetComponent(ConfigurationContext context) {
     @Override
     @SuppressWarnings("unchecked")
     public GeneratedItems[] configure(CNode config, ConfigurationContext context) throws ConfiguratorException {
-        JenkinsJobManagement management = new JenkinsJobManagement(System.out, System.getenv(), null, null, LookupStrategy.JENKINS_ROOT);
+        Map<String, String> env = new HashMap<>(System.getenv());
+        JenkinsJobManagement management = new JenkinsJobManagement(System.out, env, null, null, LookupStrategy.JENKINS_ROOT);
         Configurator<ScriptSource> configurator = context.lookupOrFail(ScriptSource.class);
         return config.asSequence().stream()
+            .flatMap(source -> processProvidedEnv(source, context, env))
             .map(source -> getActualValue(source, context))
             .map(source -> getScriptFromSource(source, context, configurator))
             .map(script -> generateFromScript(script, management))
@@ -85,6 +89,16 @@ public CNode describe(GeneratedItems[] instance, ConfigurationContext context) t
         return null;
     }
 
+    private Stream<CNode> processProvidedEnv(CNode source, ConfigurationContext context, Map<String, String> env) {
+        Map.Entry<String, CNode> entry = unchecked(() -> source.asMapping().entrySet().iterator().next()).apply();
+        if (entry.getKey().equals("providedEnv")) {
+            unchecked(entry.getValue()::asMapping).apply().entrySet().forEach(envEntry ->
+                env.put(envEntry.getKey(), revealSourceOrGetValue(envEntry, context)));
+            return Stream.empty();
+        }
+        return Stream.of(source);
+    }
+
     private CNode getActualValue(CNode config, ConfigurationContext context) {
         return unchecked(() -> config.asMapping().entrySet().stream().findFirst()).apply()
             .map(entry -> {

job-dsl-plugin/src/test/groovy/javaposse/jobdsl/plugin/ConfigurationAsCodeTest.java

@@ -17,5 +17,6 @@ public class ConfigurationAsCodeTest {
     public void configure_seed_job() {
         assertNotNull(j.jenkins.getItem("testJob1"));
         assertNotNull(j.jenkins.getItem("testJob2"));
+        assertNotNull(j.jenkins.getItem("testJob3"));
     }
 }

job-dsl-plugin/src/test/resources/javaposse/jobdsl/plugin/ConfigurationAsCodeTest.yaml

@@ -12,4 +12,14 @@ jobs:
           }
       }
 
-  - file: ./src/test/resources/javaposse/jobdsl/plugin/testjob.groovy
+  - file: ./src/test/resources/javaposse/jobdsl/plugin/testjob.groovy
+
+  - providedEnv:
+      JOB_NAME_FROM_ENV: testJob3
+
+  - script: >
+      job(JOB_NAME_FROM_ENV) {
+          steps {
+              shell('echo hello world')
+          }
+      }