feat(script): allow to pass custom environment variables (#226)

Signed-off-by: Thomas Bétrancourt <thomas@betrancourt.net>
ovh · Oct 28, 2022 · d31b5cb · d31b5cb
1 parent fac4e9e
commit d31b5cb
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 8 deletions.
diff --git a/engine/engine_test.go b/engine/engine_test.go
@@ -1123,6 +1123,10 @@ func TestScriptPluginEnvironmentVariables(t *testing.T) {
 	assert.Equal(t, res.PublicID, environment["UTASK_RESOLUTION_ID"])
 	assert.NotNil(t, environment["UTASK_STEP_NAME"])
 	assert.Equal(t, "stepOne", environment["UTASK_STEP_NAME"])
+	assert.NotNil(t, environment["static_value"])
+	assert.Equal(t, "foo", environment["static_value"])
+	assert.NotNil(t, environment["variable_value"])
+	assert.Equal(t, "bar", environment["variable_value"])
 }
 
 func TestBaseBaseConfiguration(t *testing.T) {

diff --git a/engine/templates_tests/execScriptWithEnvironment.yaml b/engine/templates_tests/execScriptWithEnvironment.yaml
@@ -2,6 +2,10 @@ name: exec-script-with-environment
 description: Executing a shell script that returns environment variables
 title_format: "[test] a simple task for script-plugin to verify environment variables"
 
+variables:
+- name: foo
+  value: bar
+
 steps:
     stepOne:
         description: first step
@@ -29,4 +33,7 @@ steps:
                 # In production, `file` will be prefixed by the utask.FScriptsFolder variable ("./scripts" by default)
                 # You can specify your file's path relative to that location
                 file_path: "./scripts_tests/env-vars.py"
-                timeout_seconds: "25"
+                timeout_seconds: "25"
+                environment:
+                    static_value: foo
+                    variable_value: '{{ eval `foo` }}'
diff --git a/hack/template-schema.json b/hack/template-schema.json
@@ -363,6 +363,9 @@
                         "argv": {
                             "type": "array"
                         },
+                        "environment": {
+                            "type": "object"
+                        },
                         "stdin": {
                             "type": "string"
                         },

diff --git a/pkg/plugins/builtin/script/README.md b/pkg/plugins/builtin/script/README.md
@@ -17,6 +17,7 @@ The step will be considered successful if the script returns exit code 0, otherw
 |---|---
 | `file_path` | file name under scripts folder
 | `argv` | a collection of script argv
+| `environment` | a map of environment variables passed to the script
 | `timeout` | timeout of the script execution
 | `stdin` | inject stdin in your script
 | `output_mode` | indicates how to retrieve the output values ; valid values are: `manual-lastline` (default), `disabled`, `manual-delimiters`
@@ -50,6 +51,8 @@ action:
       - "1-10"
       - "100"
       - "110"
+    environment:
+      FOO: '{{eval `foo`}}'
 ```
 
 ## Note

diff --git a/pkg/plugins/builtin/script/script.go b/pkg/plugins/builtin/script/script.go
@@ -46,13 +46,14 @@ type Metadata struct {
 
 // Config is the configuration needed to execute a script
 type Config struct {
-	File                   string   `json:"file_path"`
-	Argv                   []string `json:"argv,omitempty"`
-	Timeout                string   `json:"timeout,omitempty"`
-	Stdin                  string   `json:"stdin,omitempty"`
-	OutputMode             string   `json:"output_mode"`
-	OutputManualDelimiters []string `json:"output_manual_delimiters"`
-	ExitCodesUnrecoverable []string `json:"exit_codes_unrecoverable"`
+	File                   string                 `json:"file_path"`
+	Argv                   []string               `json:"argv,omitempty"`
+	Timeout                string                 `json:"timeout,omitempty"`
+	Stdin                  string                 `json:"stdin,omitempty"`
+	OutputMode             string                 `json:"output_mode"`
+	OutputManualDelimiters []string               `json:"output_manual_delimiters"`
+	ExitCodesUnrecoverable []string               `json:"exit_codes_unrecoverable"`
+	Environment            map[string]interface{} `json:"environment,omitempty"`
 }
 
 // ScriptContext is the metadata inherited from the task
@@ -168,6 +169,10 @@ func exec(stepName string, config interface{}, ctx interface{}) (interface{}, in
 	cmd.Dir = utask.FScriptsFolder
 	cmd.Stdin = strings.NewReader(cfg.Stdin)
 
+	for k, v := range cfg.Environment {
+		cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", k, v))
+	}
+
 	exitCode := 0
 	metaError := ""