Escape env vars in shellenv the same way as in shellrc (#731)

## Summary
Before, running `eval $(devbox shellenv)` would fail for me, because my `PS1` var wasn't being escaped properly. Now it is and we reuse the function.

## How was it tested?
Ran `eval $(devbox shellenv)`

Author: ipince

internal/impl/devbox.go

@@ -233,14 +233,7 @@ func (d *Devbox) PrintEnv() (string, error) {
 		return "", err
 	}
 
-	script := ""
-	for k, v := range envs {
-		// %q is for escaping quotes in env variables that
-		// have quotes in them e.g., shellHook
-		script += fmt.Sprintf("export %s=%q\n", k, v)
-	}
-
-	return script, nil
+	return exportify(envs), nil
 }
 
 func (d *Devbox) Info(pkg string, markdown bool) error {

internal/impl/envvars.go

@@ -0,0 +1,55 @@
+package impl
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+func mapToPairs(m map[string]string) []string {
+	pairs := []string{}
+	for k, v := range m {
+		pairs = append(pairs, fmt.Sprintf("%s=%s", k, v))
+	}
+	return pairs
+}
+
+func pairsToMap(pairs []string) map[string]string {
+	vars := map[string]string{}
+	for _, p := range pairs {
+		k, v, ok := strings.Cut(p, "=")
+		if !ok {
+			continue
+		}
+		vars[k] = v
+	}
+	return vars
+}
+
+// exportify takes an array of strings of the form VAR=VAL and returns a bash script
+// that exports all the vars after properly escaping them.
+func exportify(vars map[string]string) string {
+	keys := make([]string, 0, len(vars))
+	for k := range vars {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+
+	strb := strings.Builder{}
+	for _, k := range keys {
+		strb.WriteString("export ")
+		strb.WriteString(k)
+		strb.WriteString(`="`)
+		for _, r := range vars[k] {
+			switch r {
+			// Special characters inside double quotes:
+			// https://pubs.opengroup.org/onlinepubs/009604499/utilities/xcu_chap02.html#tag_02_02_03
+			case '$', '`', '"', '\\', '\n':
+				strb.WriteRune('\\')
+			}
+			strb.WriteRune(r)
+		}
+		strb.WriteString("\"\n")
+	}
+	return strings.TrimSpace(strb.String())
+}

internal/impl/shell.go

@@ -12,7 +12,6 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
-	"sort"
 	"strings"
 	"text/template"
 
@@ -58,7 +57,7 @@ type DevboxShell struct {
 	binPath         string
 	projectDir      string // path to where devbox.json config resides
 	pkgConfigDir    string
-	env             []string
+	env             map[string]string
 	userShellrcPath string
 	pluginInitHook  string
 
@@ -218,15 +217,7 @@ func WithHistoryFile(historyFile string) ShellOption {
 // via wrapper scripts.
 func WithEnvVariables(envVariables map[string]string) ShellOption {
 	return func(s *DevboxShell) {
-		keys := make([]string, 0, len(envVariables))
-		for k := range envVariables {
-			keys = append(keys, k)
-		}
-		sort.Strings(keys)
-
-		for _, k := range keys {
-			s.env = append(s.env, fmt.Sprintf("%s=%s", k, envVariables[k]))
-		}
+		s.env = envVariables
 	}
 }
 
@@ -277,9 +268,13 @@ func (s *DevboxShell) Run() error {
 	// Link other files that affect the shell settings and environments.
 	s.linkShellStartupFiles(filepath.Dir(shellrc))
 	extraEnv, extraArgs := s.shellRCOverrides(shellrc)
+	env := s.env
+	for k, v := range extraEnv {
+		env[k] = v
+	}
 
 	cmd = exec.Command(s.binPath)
-	cmd.Env = append(s.env, extraEnv...)
+	cmd.Env = mapToPairs(env)
 	cmd.Args = append(cmd.Args, extraArgs...)
 	cmd.Stdin = os.Stdin
 	cmd.Stdout = os.Stdout
@@ -309,16 +304,16 @@ func (s *DevboxShell) Run() error {
 	return errors.WithStack(err)
 }
 
-func (s *DevboxShell) shellRCOverrides(shellrc string) (extraEnv []string, extraArgs []string) {
+func (s *DevboxShell) shellRCOverrides(shellrc string) (extraEnv map[string]string, extraArgs []string) {
 	// Shells have different ways of overriding the shellrc, so we need to
 	// look at the name to know which env vars or args to set when launching the shell.
 	switch s.name {
 	case shBash:
 		extraArgs = []string{"--rcfile", shellescape.Quote(shellrc)}
 	case shZsh:
-		extraEnv = []string{fmt.Sprintf(`ZDOTDIR=%s`, shellescape.Quote(filepath.Dir(shellrc)))}
+		extraEnv = map[string]string{"ZDOTDIR": shellescape.Quote(filepath.Dir(shellrc))}
 	case shKsh, shPosix:
-		extraEnv = []string{fmt.Sprintf(`ENV=%s`, shellescape.Quote(shellrc))}
+		extraEnv = map[string]string{"ENV": shellescape.Quote(shellrc)}
 	case shFish:
 		extraArgs = []string{"-C", ". " + shellrc}
 	}
@@ -369,29 +364,6 @@ func (s *DevboxShell) writeDevboxShellrc() (path string, err error) {
 		tmpl = fishrcTmpl
 	}
 
-	exportEnv := ""
-	strb := strings.Builder{}
-	for _, kv := range s.env {
-		k, v, ok := strings.Cut(kv, "=")
-		if !ok {
-			continue
-		}
-		strb.WriteString("export ")
-		strb.WriteString(k)
-		strb.WriteString(`="`)
-		for _, r := range v {
-			switch r {
-			// Special characters inside double quotes:
-			// https://pubs.opengroup.org/onlinepubs/009604499/utilities/xcu_chap02.html#tag_02_02_03
-			case '$', '`', '"', '\\', '\n':
-				strb.WriteRune('\\')
-			}
-			strb.WriteRune(r)
-		}
-		strb.WriteString("\"\n")
-	}
-	exportEnv = strings.TrimSpace(strb.String())
-
 	err = tmpl.Execute(shellrcf, struct {
 		ProjectDir       string
 		OriginalInit     string
@@ -413,7 +385,7 @@ func (s *DevboxShell) writeDevboxShellrc() (path string, err error) {
 		ScriptCommand:    strings.TrimSpace(s.ScriptCommand),
 		ShellStartTime:   s.shellStartTime,
 		HistoryFile:      strings.TrimSpace(s.historyFile),
-		ExportEnv:        exportEnv,
+		ExportEnv:        exportify(s.env),
 	})
 	if err != nil {
 		return "", fmt.Errorf("execute shellrc template: %v", err)

internal/impl/shell_test.go

@@ -33,11 +33,11 @@ func TestWriteDevboxShellrcWithUnifiedEnv(t *testing.T) {
 }
 
 func testWriteDevboxShellrc(t *testing.T, testdirs []string) {
-	// Load up all the necessary data from each testdata/shellrc directory
+	// Load up all the necessary data from each internal/nix/testdata/shellrc directory
 	// into a slice of tests cases.
 	tests := make([]struct {
 		name            string
-		env             []string
+		env             map[string]string
 		hook            string
 		shellrcPath     string
 		goldShellrcPath string
@@ -48,7 +48,7 @@ func testWriteDevboxShellrc(t *testing.T, testdirs []string) {
 		test := &tests[i]
 		test.name = filepath.Base(path)
 		if b, err := os.ReadFile(filepath.Join(path, "env")); err == nil {
-			test.env = strings.Split(string(b), "\n")
+			test.env = pairsToMap(strings.Split(string(b), "\n"))
 		}
 		if b, err := os.ReadFile(filepath.Join(path, "hook")); err == nil {
 			test.hook = string(b)