Pass log level to executed script for more granular logging possibility

Improve logging format Try to read the script log level from config file, if that fails, use yggdrasil default log level, and if that's not set, use "INFO" as the default one.
oamg · Apr 12, 2024 · b96326d · b96326d
1 parent 4407b0e
commit b96326d
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 6 deletions.
diff --git a/rhc-worker-script.yml b/rhc-worker-script.yml
@@ -12,3 +12,6 @@ env:
   FOO: "some-string-value"
   BAR: "other-string-value"
   # ...
+
+# Script log level
+script_log_level: "info"
diff --git a/src/runner.go b/src/runner.go
@@ -80,7 +80,7 @@ func setEnvVariablesForCommand(cmd *exec.Cmd, variables map[string]string) {
 		prefixedKey := getEnvVarName(key)
 		envVarSetString := fmt.Sprintf("%s=%s", prefixedKey, value)
 		cmd.Env = append(cmd.Env, envVarSetString)
-		log.Infoln("Successfully set env variable ", prefixedKey)
+		log.Infoln("Successfully set env variable", prefixedKey)
 	}
 }
 
@@ -126,8 +126,11 @@ func processSignedScript(incomingContent []byte) string {
 	cmd := exec.Command(yamlContent.Vars.Interpreter, scriptFileName) //nolint:gosec
 	cmd.Env = os.Environ()
 
+	variables := yamlContent.Vars.ContentVars
+	variables["LOG_LEVEL"] = *config.ScriptLogLevel
+
 	// Set env vars from yaml envelope
-	setEnvVariablesForCommand(cmd, yamlContent.Vars.ContentVars)
+	setEnvVariablesForCommand(cmd, variables)
 
 	// Set env vars from config
 	if config.Env != nil {

diff --git a/src/runner_test.go b/src/runner_test.go
@@ -35,13 +35,15 @@ func TestProcessSignedScript(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
+			scriptLogLevel := "info"
 			shouldVerifyYaml := tc.verifyYAML
 			temporaryWorkerDirectory := t.TempDir()
 			envMap := map[string]string{"NAME": "Test"}
 			config = &Config{
 				VerifyYAML:               &shouldVerifyYaml,
 				TemporaryWorkerDirectory: &temporaryWorkerDirectory,
 				Env:                      &envMap,
+				ScriptLogLevel:           &scriptLogLevel,
 			}
 
 			defer os.RemoveAll(temporaryWorkerDirectory)

diff --git a/src/server_test.go b/src/server_test.go
@@ -112,12 +112,14 @@ func TestProcessData(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
+			scriptLogLevel := "info"
 			shouldVerifyYaml := false
 			temporaryWorkerDirectory := t.TempDir()
 			config = &Config{
 				VerifyYAML:               &shouldVerifyYaml,
 				TemporaryWorkerDirectory: &temporaryWorkerDirectory,
 				Env:                      &map[string]string{"NAME": "Test"},
+				ScriptLogLevel:           &scriptLogLevel,
 			}
 
 			returnURL := "bar"

diff --git a/src/util.go b/src/util.go
@@ -99,6 +99,7 @@ type Config struct {
 	VerifyYAML               *bool              `yaml:"verify_yaml,omitempty"`
 	TemporaryWorkerDirectory *string            `yaml:"temporary_worker_directory,omitempty"`
 	Env                      *map[string]string `yaml:"env,omitempty"`
+	ScriptLogLevel           *string            `yaml:"script_log_level"`
 }
 
 // Set default values for the Config struct
@@ -127,6 +128,16 @@ func setDefaultValues(config *Config) {
 		log.Infof("config 'env' value is empty default value (%s) will be used", defaultEnvMap)
 		config.Env = &defaultEnvMap
 	}
+
+	if config.ScriptLogLevel == nil {
+		defaultLogLevel := "info"
+		yggdLogLevel, ok := os.LookupEnv("YGG_LOG_LEVEL")
+		if ok {
+			config.ScriptLogLevel = &yggdLogLevel
+		} else {
+			config.ScriptLogLevel = &defaultLogLevel
+		}
+	}
 }
 
 // Load yaml config, if file doesn't exist or is invalid yaml then empty Config is returned

diff --git a/src/util_test.go b/src/util_test.go
@@ -242,13 +242,13 @@ func TestSetDefaultValues(t *testing.T) {
 	}{
 		{
 			name: "test default values",
-			args: args{config: &Config{nil, nil, nil, nil}},
-			want: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{})}},
+			args: args{config: &Config{nil, nil, nil, nil, nil}},
+			want: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{}), strPtr("INFO")}},
 		},
 		{
 			name: "test non default values",
-			args: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{"ENV_VAR1": "value1"})}},
-			want: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{"ENV_VAR1": "value1"})}},
+			args: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{"ENV_VAR1": "value1"}), strPtr("INFO")}},
+			want: args{config: &Config{strPtr("rhc-worker-script"), boolPtr(true), strPtr("/var/lib/rhc-worker-script"), mapStrPtr(map[string]string{"ENV_VAR1": "value1"}), strPtr("INFO")}},
 		},
 	}
 	for _, tt := range tests {