Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions internal/devbox/envvars.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,17 @@ func exportify(vars map[string]string) string {
strb.WriteString("export ")
strb.WriteString(key)
strb.WriteString(`="`)
// Escape the characters that are special inside double quotes:
// https://pubs.opengroup.org/onlinepubs/009604499/utilities/xcu_chap02.html#tag_02_02_03
//
// A newline is NOT special inside double quotes and must not be
// escaped. Writing a backslash before a newline produces a line
// continuation, which the shell removes entirely, joining adjacent
// lines together (e.g. a multi-line PROMPT_COMMAND would be silently
// mangled). Leaving the newline unescaped preserves it literally.
for _, r := range vars[key] {
switch r {
// Special characters inside double quotes:
// https://pubs.opengroup.org/onlinepubs/009604499/utilities/xcu_chap02.html#tag_02_02_03
case '$', '`', '"', '\\', '\n':
case '$', '`', '"', '\\':
strb.WriteRune('\\')
}
strb.WriteRune(r)
Expand Down
44 changes: 44 additions & 0 deletions internal/devbox/envvars_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2024 Jetify Inc. and contributors. All rights reserved.
// Use of this source code is governed by the license in the LICENSE file.

package devbox

import "testing"

func TestExportify(t *testing.T) {
tests := []struct {
name string
vars map[string]string
want string
}{
{
name: "simple value",
vars: map[string]string{"FOO": "bar"},
want: `export FOO="bar";`,
},
{
name: "escapes shell-special characters",
vars: map[string]string{"FOO": "a$b`c\"d\\e"},
want: `export FOO="a\$b\` + "`" + `c\"d\\e";`,
},
{
// Regression test for #2814: a multi-line value (e.g. a
// PROMPT_COMMAND set by bash-preexec) must keep its newlines
// literal. Escaping a newline with a backslash produces a line
// continuation that the shell removes, concatenating the lines and
// corrupting the value.
name: "preserves embedded newlines without escaping",
vars: map[string]string{"PROMPT_COMMAND": "__bp_precmd_invoke_cmd\ndbus-send >/dev/null 2>&1\n__bp_interactive_mode"},
want: "export PROMPT_COMMAND=\"__bp_precmd_invoke_cmd\ndbus-send >/dev/null 2>&1\n__bp_interactive_mode\";",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := exportify(tt.vars)
if got != tt.want {
t.Errorf("exportify() =\n%q\nwant\n%q", got, tt.want)
}
})
}
}
Loading