commit 4badf83f9faecf97d29c5e52df92a4bca008b5ee
author Dmitry Teselkin <dteselkin@mirantis.com> Wed May 27 17:48:36 2020 +0300
committer azvyagintsev <azvyagintsev@mirantis.com> Thu May 28 12:51:15 2020 +0300
tree 5be5d51ab3a7c128618bb0607e4362a242aa11e2
parent bc8975135f1ce756976e926ff68e7ea8da01e3f9

Introduce setEnvDefaults function

  * This function set default values of a environment variables
  object. Existing keys are not modifies, missed keys added.
  * Misc: remove common.msg since it's not supported at JenkinsMaster

PRODX-5224

Change-Id: I4cbe7c0b430f349f0fb6b4e5f26140f45c7f92be

src/com/mirantis/mk/Common.groovy

diff --git a/src/com/mirantis/mk/Common.groovy b/src/com/mirantis/mk/Common.groovy
index bd42378..031cd03 100644
--- a/src/com/mirantis/mk/Common.groovy
+++ b/src/com/mirantis/mk/Common.groovy
@@ -6,6 +6,8 @@
 import com.cloudbees.groovy.cps.NonCPS
 import groovy.json.JsonSlurperClassic
 
+import org.jenkinsci.plugins.workflow.cps.EnvActionImpl
+
 /**
  *
  * Common functions
@@ -933,15 +935,14 @@
  *  @param extraVars - Multiline YAML text with extra vars
  */
 def mergeEnv(envVar, extraVars) {
-    def common = new com.mirantis.mk.Common()
     try {
         def extraParams = readYaml text: extraVars
         for(String key in extraParams.keySet()) {
             envVar[key] = extraParams[key]
-            common.warningMsg("Parameter ${key} is updated from EXTRA vars.")
+            println("INFO: Parameter ${key} is updated from EXTRA vars.")
         }
     } catch (Exception e) {
-        common.errorMsg("Can't update env parameteres, because: ${e.toString()}")
+        println("ERR: Can't update env parameteres, because: ${e.toString()}")
     }
 }
 
@@ -967,6 +968,29 @@
     }
 }
 
+def setEnvDefaults(Object envVar, Object defaults) {
+    /**
+     * Function to set default values of an environment variables object
+     * at runtime(patches existing 'env' instance).
+     * @param env - instance of either EnvActionImpl
+     * @param defaults - Map with default values
+     * Example: setEnvDefaults(env, ['ENV_NAME': 'newENV_NAME', 'newvar': 'newval'])
+     * */
+
+    if (!(envVar instanceof EnvActionImpl)) {
+        error("setEnvDefaults 'env' is not an instance of EnvActionImpl")
+    } else if (!(defaults instanceof Map)) {
+        error("setEnvDefaults 'defaults' is not a Map")
+    }
+    defaults.each { key, value ->
+        if (envVar.getEnvironment().containsKey(key)) {
+            println("INFO:setEnvDefaults env variable ${key} already exist, not overwriting")
+        } else {
+            envVar[key] = value
+            println("INFO:setEnvDefaults env variable ${key} has been added")
+        }
+    }
+}
 
 /**
  * Wrapper around parallel pipeline function