fix: support environment variables with equals sign and newlines in value (#1977)

Author: Stratus3D

internal/execenv/execenv.go

@@ -47,30 +47,26 @@ func Generate(plugin plugins.Plugin, callbackEnv map[string]string) (env map[str
 	expression.Stdout = &stdout
 	err = expression.Run()
 
-	return envMap(stdout.String()), err
-}
-
-func envMap(env string) map[string]string {
-	slice := map[string]string{}
-
-	for _, envVar := range strings.Split(env, "\n") {
-		varValue := strings.Split(envVar, "=")
-		if len(varValue) == 2 {
-			slice[varValue[0]] = varValue[1]
-		}
-	}
-
-	return slice
+	str := stdout.String()
+	return SliceToMap(strings.Split(str, "\n")), err
 }
 
 // SliceToMap converts an env map to env slice suitable for syscall.Exec
 func SliceToMap(env []string) map[string]string {
 	envMap := map[string]string{}
 
+	var previousKey string
+
 	for _, envVar := range env {
-		varValue := strings.Split(envVar, "=")
-		if len(varValue) >= 2 {
-			envMap[varValue[0]] = strings.Join(varValue[1:], "=")
+		varValue := strings.SplitN(envVar, "=", 2)
+		if len(varValue) == 2 {
+			// new var=value line
+			previousKey = varValue[0]
+			envMap[varValue[0]] = varValue[1]
+		} else {
+			// value from variable defined on a previous line, append
+			val := envMap[previousKey]
+			envMap[previousKey] = val + "\n" + varValue[0]
 		}
 	}
 

internal/execenv/execenv_test.go

@@ -49,9 +49,9 @@ func TestMergeEnv(t *testing.T) {
 }
 
 func TestGenerate(t *testing.T) {
-	testDataDir := t.TempDir()
 
 	t.Run("returns map of environment variables", func(t *testing.T) {
+		testDataDir := t.TempDir()
 		conf := config.Config{DataDir: testDataDir}
 		_, err := repotest.InstallPlugin("dummy_plugin", testDataDir, testPluginName)
 		assert.Nil(t, err)
@@ -64,6 +64,7 @@ func TestGenerate(t *testing.T) {
 	})
 
 	t.Run("returns error when plugin lacks exec-env callback", func(t *testing.T) {
+		testDataDir := t.TempDir()
 		conf := config.Config{DataDir: testDataDir}
 		_, err := repotest.InstallPlugin("dummy_plugin", testDataDir, testPluginName2)
 		assert.Nil(t, err)
@@ -73,6 +74,32 @@ func TestGenerate(t *testing.T) {
 		_, found := env["FOO"]
 		assert.False(t, found)
 	})
+
+	t.Run("preserves environment variables that contain equals sign in value", func(t *testing.T) {
+		testDataDir := t.TempDir()
+		conf := config.Config{DataDir: testDataDir}
+		_, err := repotest.InstallPlugin("dummy_plugin", testDataDir, testPluginName)
+		assert.Nil(t, err)
+		plugin := plugins.New(conf, testPluginName)
+		assert.Nil(t, repotest.WritePluginCallback(plugin.Dir, "exec-env", "#!/usr/bin/env bash\nexport BAZ=bar"))
+		env, err := Generate(plugin, map[string]string{"EQUALSTEST": "abc=123"})
+		assert.Nil(t, err)
+		assert.Equal(t, "bar", env["BAZ"])
+		assert.Equal(t, "abc=123", env["EQUALSTEST"])
+	})
+
+	t.Run("preserves environment variables that contain equals sign in value", func(t *testing.T) {
+		testDataDir := t.TempDir()
+		conf := config.Config{DataDir: testDataDir}
+		_, err := repotest.InstallPlugin("dummy_plugin", testDataDir, testPluginName)
+		assert.Nil(t, err)
+		plugin := plugins.New(conf, testPluginName)
+		assert.Nil(t, repotest.WritePluginCallback(plugin.Dir, "exec-env", "#!/usr/bin/env bash\nexport BAZ=bar"))
+		env, err := Generate(plugin, map[string]string{"EQUALSTEST": "abc\n123"})
+		assert.Nil(t, err)
+		assert.Equal(t, "bar", env["BAZ"])
+		assert.Equal(t, "abc\n123", env["EQUALSTEST"])
+	})
 }
 
 func TestSliceToMap(t *testing.T) {
@@ -92,6 +119,14 @@ func TestSliceToMap(t *testing.T) {
 			input:  []string{"MYVAR=some things = with = in it"},
 			output: map[string]string{"MYVAR": "some things = with = in it"},
 		},
+		{
+			input:  []string{"MYVAR=value\nwith\nnewlines"},
+			output: map[string]string{"MYVAR": "value\nwith\nnewlines"},
+		},
+		{
+			input:  []string{"MYVAR=value", "with", "newlines"},
+			output: map[string]string{"MYVAR": "value\nwith\nnewlines"},
+		},
 	}
 
 	for _, tt := range tests {