Merge pull request #233 from cloudogu/feature/additional-run-args

schnatterer · web-flow · commit d456b92bfc20 · 2024-10-15T18:12:40.000+02:00
adding additionalEnv param to jenkins config allowing setting custom …
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,5 +1,5 @@
 #!groovy
-@Library('github.com/cloudogu/ces-build-lib@1.65.1')
+@Library('github.com/cloudogu/ces-build-lib@2.5.0')
 import com.cloudogu.ces.cesbuildlib.*
 
 String getDockerRegistryBaseUrl() { 'ghcr.io' }
@@ -115,24 +115,25 @@ node('high-cpu') {
                             returnStdout: true
                     ).trim()
 
+                    int ret=0
                     new Docker(this).image(groovyImage)
                     // Avoids errors ("unable to resolve class") probably due to missing HOME for container in JVM.
                             .mountJenkinsUser()
                             .inside("--network=${k3dNetwork}") {
                                 // removing m2 and grapes avoids issues where grapes primarily resolves local m2 and fails on missing versions
                                 sh "rm -rf .m2/"
                                 sh "rm -rf .groovy/grapes"
-                                int ret = sh(returnStatus: true, 
+                                ret = sh(returnStatus: true, 
                                         script: "groovy ./scripts/e2e.groovy --url http://${k3dAddress}:9090 --user admin --password admin --writeFailedLog --fail --retry 2")
-                                
-                                if (ret > 0 ) {
-                                    if (fileExists('playground-logs-of-failed-jobs')) {
-                                        archiveArtifacts artifacts: 'playground-logs-of-failed-jobs/*.log'
-                                    }
-                                    unstable "Integration tests failed, see logs appended to jobs and cluster status in logs"
-                                    sh "docker exec -it k3d-${clusterName}-server-0 kubectl get all -A"
-                                }
                             }
+
+                    if (ret > 0 ) {
+                        if (fileExists('playground-logs-of-failed-jobs')) {
+                            archiveArtifacts artifacts: 'playground-logs-of-failed-jobs/*.log'
+                        }
+                        unstable "Integration tests failed, see logs appended to jobs and cluster status in logs"
+                        sh "docker exec k3d-${clusterName}-server-0 kubectl get all -A"
+                    }
                 }
 
                 stage('Push image') {
diff --git a/README.md b/README.md
@@ -832,6 +832,8 @@ See [parameters](#additional-parameters) for examples.
 * `--jenkins-username`,
 * `--jenkins-password`
 
+To apply additional global environments for jenkins you can use `--jenkins-additional-envs "KEY1=value1,KEY2=value2"` parameter.
+
 Note that the [example applications](#example-applications) pipelines will only run on a Jenkins that uses agents that provide
 a docker host. That is, Jenkins must be able to run e.g. `docker ps` successfully on the agent.
 
diff --git a/applications/argocd/nginx/helm-jenkins/Jenkinsfile.ftl b/applications/argocd/nginx/helm-jenkins/Jenkinsfile.ftl
@@ -6,9 +6,9 @@ String getConfigRepositoryPRBaseUrl() { env.SCMM_URL }
 String getConfigRepositoryPRRepo() { '${namePrefix}argocd/example-apps' }
 <#noparse>
 String getCesBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/ces-build-lib/" }
-String getCesBuildLibVersion() { '1.64.1' }
+String getCesBuildLibVersion() { '2.5.0' }
 String getGitOpsBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/gitops-build-lib" }
-String getGitOpsBuildLibVersion() { '0.4.0'}
+String getGitOpsBuildLibVersion() { '0.7.0'}
 String getHelmChartRepository() { "https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami" }
 String getHelmChartName() { "nginx" }
 String getHelmChartVersion() { "13.2.21" }
diff --git a/applications/argocd/petclinic/helm/Jenkinsfile.ftl b/applications/argocd/petclinic/helm/Jenkinsfile.ftl
@@ -16,9 +16,9 @@ String getDockerRegistryProxyCredentials() { 'registry-proxy-user' }
 
 <#noparse>
 String getCesBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/ces-build-lib/" }
-String getCesBuildLibVersion() { '2.2.0' }
+String getCesBuildLibVersion() { '2.5.0' }
 String getGitOpsBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/gitops-build-lib" }
-String getGitOpsBuildLibVersion() { '0.4.0'}
+String getGitOpsBuildLibVersion() { '0.7.0'}
 String getHelmChartRepository() { "${env.SCMM_URL}/repo/3rd-party-dependencies/spring-boot-helm-chart-with-dependency" }
 String getHelmChartVersion() { "1.0.0" }
 String getMainBranch() { 'main' }
diff --git a/applications/argocd/petclinic/plain-k8s/Jenkinsfile.ftl b/applications/argocd/petclinic/plain-k8s/Jenkinsfile.ftl
@@ -16,9 +16,9 @@ String getDockerRegistryProxyCredentials() { 'registry-proxy-user' }
 
 <#noparse>
 String getCesBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/ces-build-lib" }
-String getCesBuildLibVersion() { '2.2.0' }
+String getCesBuildLibVersion() { '2.5.0' }
 String getGitOpsBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/gitops-build-lib" }
-String getGitOpsBuildLibVersion() { '0.4.0'}
+String getGitOpsBuildLibVersion() { '0.7.0'}
 
 loadLibraries()
 
diff --git a/docs/configuration.schema.json b/docs/configuration.schema.json
@@ -474,6 +474,13 @@
           "additionalProperties" : false,
           "description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
         },
+        "jenkinsAdditionalEnvs" : {
+          "type" : "object",
+          "additionalProperties" : {
+            "type" : "string"
+          },
+          "description" : "Set additional environments to Jenkins"
+        },
         "mavenCentralMirror" : {
           "type" : "string",
           "description" : "URL for maven mirror, used by applications built in Jenkins"
diff --git a/exercises/nginx-validation/Jenkinsfile.ftl b/exercises/nginx-validation/Jenkinsfile.ftl
@@ -6,9 +6,9 @@ String getConfigRepositoryPRBaseUrl() { env.SCMM_URL }
 String getConfigRepositoryPRRepo() { '${namePrefix}argocd/example-apps' }
 <#noparse>
 String getCesBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/ces-build-lib/" }
-String getCesBuildLibVersion() { '1.64.1' }
+String getCesBuildLibVersion() { '2.5.0' }
 String getGitOpsBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/gitops-build-lib" }
-String getGitOpsBuildLibVersion() { '0.4.0'}
+String getGitOpsBuildLibVersion() { '0.7.0'}
 String getHelmChartRepository() { "https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami" }
 String getHelmChartName() { "nginx" }
 String getHelmChartVersion() { "13.2.21" }
diff --git a/exercises/petclinic-helm/Jenkinsfile.ftl b/exercises/petclinic-helm/Jenkinsfile.ftl
@@ -15,7 +15,7 @@ String getDockerRegistryProxyBaseUrl() { env.${namePrefixForEnvVars}REGISTRY_PRO
 </#if>
 <#noparse>
 String getCesBuildLibRepo() { "${env.SCMM_URL}/repo/3rd-party-dependencies/ces-build-lib/" }
-String getCesBuildLibVersion() { '2.2.0' }
+String getCesBuildLibVersion() { '2.5.0' }
 String getHelmChartRepository() { "${env.SCMM_URL}/repo/3rd-party-dependencies/spring-boot-helm-chart-with-dependency" }
 String getHelmChartVersion() { "1.0.0" }
 String getMainBranch() { 'main' }
diff --git a/src/main/groovy/com/cloudogu/gitops/cli/GitopsPlaygroundCli.groovy b/src/main/groovy/com/cloudogu/gitops/cli/GitopsPlaygroundCli.groovy
@@ -67,6 +67,8 @@ class GitopsPlaygroundCli  implements Runnable {
     private String jenkinsMetricsPassword
     @Option(names = ['--maven-central-mirror'], description = MAVEN_CENTRAL_MIRROR_DESCRIPTION)
     private String mavenCentralMirror
+    @Option(names = ["--jenkins-additional-envs"], description = JENKINS_ADDITIONAL_ENVS_DESCRIPTION, split = ",", required = false)
+    Map<String, String> jenkinsAdditionalEnvs
 
     // args group scm
     @Option(names = ['--scmm-url'], description = SCMM_URL_DESCRIPTION)
@@ -395,6 +397,7 @@ class GitopsPlaygroundCli  implements Runnable {
                         metricsUsername: jenkinsMetricsUsername,
                         metricsPassword: jenkinsMetricsPassword,
                         mavenCentralMirror: mavenCentralMirror,
+                        jenkinsAdditionalEnvs: jenkinsAdditionalEnvs,
                 ],
                 scmm       : [
                         url     : scmmUrl,
diff --git a/src/main/groovy/com/cloudogu/gitops/config/ApplicationConfigurator.groovy b/src/main/groovy/com/cloudogu/gitops/config/ApplicationConfigurator.groovy
@@ -73,6 +73,7 @@ class ApplicationConfigurator {
                             version: '5.5.11'
                     ],
                     mavenCentralMirror: '',
+                    jenkinsAdditionalEnvs:  [:]
             ],
             scmm       : [
                     internal: true, // Set dynamically
diff --git a/src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy b/src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy
@@ -28,6 +28,7 @@ interface ConfigConstants {
     String JENKINS_METRICS_USERNAME_DESCRIPTION = 'Mandatory when jenkins-url is set and monitoring enabled'
     String JENKINS_METRICS_PASSWORD_DESCRIPTION = 'Mandatory when jenkins-url is set and monitoring enabled'
     String MAVEN_CENTRAL_MIRROR_DESCRIPTION = 'URL for maven mirror, used by applications built in Jenkins'
+    String JENKINS_ADDITIONAL_ENVS_DESCRIPTION = 'Set additional environments to Jenkins'
 
     // group scmm
     String SCMM_DESCRIPTION = 'Config parameters for SCMManager (Git repository Server, https://scm-manager.org/)'
diff --git a/src/main/groovy/com/cloudogu/gitops/config/schema/Schema.groovy b/src/main/groovy/com/cloudogu/gitops/config/schema/Schema.groovy
@@ -89,7 +89,8 @@ class Schema {
         String metricsPassword = ""
         @JsonPropertyDescription(MAVEN_CENTRAL_MIRROR_DESCRIPTION)
         String mavenCentralMirror = ""
-
+        @JsonPropertyDescription(JENKINS_ADDITIONAL_ENVS_DESCRIPTION)
+        Map<String, String> jenkinsAdditionalEnvs = [:]
 
         @JsonPropertyDescription(HELM_CONFIG_DESCRIPTION)
         JenkinsHelmSchema helm
diff --git a/src/main/groovy/com/cloudogu/gitops/features/Jenkins.groovy b/src/main/groovy/com/cloudogu/gitops/features/Jenkins.groovy
@@ -70,6 +70,12 @@ class Jenkins extends Feature {
 
         globalPropertyManager.setGlobalProperty('SCMM_URL', config.scmm['url'] as String)
 
+        if (config.jenkins['jenkinsAdditionalEnvs']) {
+            for (entry in (config.jenkins['jenkinsAdditionalEnvs'] as Map).entrySet()) {
+                globalPropertyManager.setGlobalProperty(entry.key.toString(), entry.value.toString())
+            }
+        }
+
         globalPropertyManager.setGlobalProperty("${config.application['namePrefixForEnvVars']}REGISTRY_URL", config.registry['url'] as String)
         globalPropertyManager.setGlobalProperty("${config.application['namePrefixForEnvVars']}REGISTRY_PATH", config.registry['path'] as String)
 
diff --git a/src/test/groovy/com/cloudogu/gitops/config/ConfigToConfigFileConverterTest.groovy b/src/test/groovy/com/cloudogu/gitops/config/ConfigToConfigFileConverterTest.groovy
@@ -36,6 +36,9 @@ class ConfigToConfigFileConverterTest {
                         helm  : [
                                 version: '5.0.17'
                         ],
+                        jenkinsAdditionalEnvs: [
+                                a: 'b'
+                        ],
                 ],
                 scmm       : [
                         url     : 'scmm-url',
@@ -194,6 +197,8 @@ jenkins:
   metricsUsername: "metricsUsername"
   metricsPassword: "metricsUsername"
   mavenCentralMirror: "mirror"
+  jenkinsAdditionalEnvs:
+    a: "b"
   helm:
     version: "5.0.17"
 scmm:
diff --git a/src/test/groovy/com/cloudogu/gitops/features/JenkinsTest.groovy b/src/test/groovy/com/cloudogu/gitops/features/JenkinsTest.groovy
@@ -152,6 +152,17 @@ class JenkinsTest {
         verify(userManager, never()).createUser(anyString(), anyString())
     }
 
+    @Test
+    void 'Global property is set for additional envs'() {
+
+        config.jenkins['jenkinsAdditionalEnvs'] = [
+                ADDITIONAL_DOCKER_RUN_ARGS: '-u0:0'
+        ]
+
+        createJenkins().install()
+        verify(globalPropertyManager).setGlobalProperty(eq('ADDITIONAL_DOCKER_RUN_ARGS'), eq('-u0:0'))
+    }
+
     @Test
     void 'Does not create create user if CAS security realm is used'() {
         config.features['argocd']['active'] = false
