Merge pull request #2470 from semaphoreui/config_env_vars

Add config option  to provide environment variables for run apps

Author: fiftin

db_lib/AnsiblePlaybook.go

@@ -22,17 +22,12 @@ func (p AnsiblePlaybook) makeCmd(command string, args []string, environmentVars
 	cmd := exec.Command(command, args...) //nolint: gas
 	cmd.Dir = p.GetFullPath()
 
-	cmd.Env = []string{}
-
-	cmd.Env = append(cmd.Env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
-	cmd.Env = append(cmd.Env, fmt.Sprintf("PWD=%s", cmd.Dir))
 	cmd.Env = append(cmd.Env, "PYTHONUNBUFFERED=1")
 	cmd.Env = append(cmd.Env, "ANSIBLE_FORCE_COLOR=True")
-
-	// TODO: Following option doesn't work when password authentication used.
-	// 		 So, we need to check args for --ask-pass, --ask-become-pass or remove this code completely.
-	//       What reason to use this code: prevent hanging of semaphore when host key confirmation required.
-	//cmd.Env = append(cmd.Env, "ANSIBLE_SSH_ARGS=\"-o BatchMode=yes\"")
+	cmd.Env = append(cmd.Env, fmt.Sprintf("PATH=%s", os.Getenv("PATH")))
+	cmd.Env = append(cmd.Env, getEnvironmentVars()...)
+	cmd.Env = append(cmd.Env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
+	cmd.Env = append(cmd.Env, fmt.Sprintf("PWD=%s", cmd.Dir))
 
 	if environmentVars != nil {
 		cmd.Env = append(cmd.Env, *environmentVars...)

db_lib/LocalApp.go

@@ -1,11 +1,30 @@
 package db_lib
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/ansible-semaphore/semaphore/pkg/task_logger"
+	"github.com/ansible-semaphore/semaphore/util"
 )
 
+func getEnvironmentVars() []string {
+	res := []string{}
+
+	for _, e := range util.Config.ForwardedEnvVars {
+		v := os.Getenv(e)
+		if v != "" {
+			res = append(res, fmt.Sprintf("%s=%s", e, v))
+		}
+	}
+
+	for k, v := range util.Config.EnvVars {
+		res = append(res, fmt.Sprintf("%s=%s", k, v))
+	}
+
+	return res
+}
+
 type LocalApp interface {
 	SetLogger(logger task_logger.Logger) task_logger.Logger
 	InstallRequirements(environmentVars *[]string) error

db_lib/LocalApp_test.go

@@ -0,0 +1,50 @@
+package db_lib
+
+import (
+	"os"
+	"testing"
+
+	"github.com/ansible-semaphore/semaphore/util"
+)
+
+// contains checks if a slice contains a specific string
+func contains(slice []string, item string) bool {
+	for _, s := range slice {
+		if s == item {
+			return true
+		}
+	}
+	return false
+}
+
+func TestGetEnvironmentVars(t *testing.T) {
+
+	os.Setenv("SEMAPHORE_TEST", "test123")
+	os.Setenv("SEMAPHORE_TEST2", "test222")
+	os.Setenv("PASSWORD", "test222")
+
+	util.Config = &util.ConfigType{
+		ForwardedEnvVars: []string{"SEMAPHORE_TEST"},
+		EnvVars: map[string]string{
+			"ANSIBLE_FORCE_COLOR": "False",
+		},
+	}
+
+	res := getEnvironmentVars()
+
+	expected := []string{
+		"SEMAPHORE_TEST=test123",
+		"ANSIBLE_FORCE_COLOR=False",
+	}
+
+	if len(res) != len(expected) {
+		t.Errorf("Expected %v, got %v", expected, res)
+	}
+
+	for _, e := range expected {
+
+		if !contains(res, e) {
+			t.Errorf("Expected %v, got %v", expected, res)
+		}
+	}
+}

db_lib/ShellApp.go

@@ -45,7 +45,7 @@ func (t *ShellApp) makeCmd(command string, args []string, environmentVars *[]str
 	cmd := exec.Command(command, args...) //nolint: gas
 	cmd.Dir = t.GetFullPath()
 
-	cmd.Env = []string{}
+	cmd.Env = getEnvironmentVars()
 	cmd.Env = append(cmd.Env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
 	cmd.Env = append(cmd.Env, fmt.Sprintf("PWD=%s", cmd.Dir))
 

db_lib/TerraformApp.go

@@ -38,7 +38,7 @@ func (t *TerraformApp) makeCmd(command string, args []string, environmentVars *[
 	cmd := exec.Command(command, args...) //nolint: gas
 	cmd.Dir = t.GetFullPath()
 
-	cmd.Env = []string{}
+	cmd.Env = getEnvironmentVars()
 	cmd.Env = append(cmd.Env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
 	cmd.Env = append(cmd.Env, fmt.Sprintf("PWD=%s", cmd.Dir))
 

util/config.go

@@ -204,6 +204,10 @@ type ConfigType struct {
 	Apps map[string]App `json:"apps,omitempty" env:"SEMAPHORE_APPS"`
 
 	Runner *RunnerConfig `json:"runner,omitempty"`
+
+	EnvVars map[string]string `json:"env_vars,omitempty" env:"SEMAPHORE_ENV_VARS"`
+
+	ForwardedEnvVars []string `json:"forwarded_env_vars,omitempty" env:"SEMAPHORE_FORWARDED_ENV_VARS"`
 }
 
 func NewConfigType() *ConfigType {

util/config_test.go

@@ -30,6 +30,7 @@ func TestLoadEnvironmentToObject(t *testing.T) {
 		Subfield struct {
 			Value string `env:"TEST_VALUE_ENV_VAR"`
 		}
+		StringArr []string `env:"TEST_STRING_ARR"`
 	}
 
 	err := os.Setenv("TEST_FLAG", "yes")
@@ -47,6 +48,11 @@ func TestLoadEnvironmentToObject(t *testing.T) {
 		panic(err)
 	}
 
+	err = os.Setenv("TEST_STRING_ARR", "[\"test1\",\"test2\"]")
+	if err != nil {
+		panic(err)
+	}
+
 	err = loadEnvironmentToObject(&val)
 	if err != nil {
 		t.Error(err)
@@ -63,6 +69,18 @@ func TestLoadEnvironmentToObject(t *testing.T) {
 	if val.Subfield.Value != "test_value" {
 		t.Error("Invalid value")
 	}
+
+	if val.StringArr == nil {
+		t.Error("Invalid array value")
+	}
+
+	if val.StringArr[0] != "test1" {
+		t.Error("Invalid array item value")
+	}
+
+	if val.StringArr[1] != "test2" {
+		t.Error("Invalid array item value")
+	}
 }
 
 func TestCastStringToInt(t *testing.T) {