Skip to content

Secure, Fast, and Extensible Sandbox runtime for AI agents.

8.8 KB
Raw Blame
// Copyright 2026 The OpenSandbox Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package runtime

import (
	"fmt"
	"os"
	"path/filepath"
	"strings"
	"testing"

	"github.com/stretchr/testify/require"

	"github.com/alibaba/opensandbox/execd/pkg/binding"
	"github.com/alibaba/opensandbox/execd/pkg/isolation"
)

func TestLoadExtraEnvFromFileUnset(t *testing.T) {
	t.Setenv("EXECD_ENVS", "")
	require.Nil(t, loadExtraEnvFromFile(), "expected nil when EXECD_ENVS unset")
}

func TestLoadExtraEnvFromFileParsesAndExpands(t *testing.T) {
	dir := t.TempDir()
	envFile := filepath.Join(dir, "env")

	t.Setenv("EXECD_ENVS", envFile)
	t.Setenv("BASE_DIR", "/opt/base")

	content := strings.Join([]string{
		"# comment",
		"FOO=bar",
		"PATH=$BASE_DIR/bin",
		"MALFORMED",
		"EMPTY=",
		"",
	}, "\n")

	require.NoError(t, os.WriteFile(envFile, []byte(content), 0o644))

	got := loadExtraEnvFromFile()
	require.Len(t, got, 3)
	require.Equal(t, "bar", got["FOO"])
	require.Equal(t, "/opt/base/bin", got["PATH"])
	val, ok := got["EMPTY"]
	require.True(t, ok)
	require.Equal(t, "", val)
}

func TestLoadExtraEnvFromFileMissingFile(t *testing.T) {
	dir := t.TempDir()
	envFile := filepath.Join(dir, "does-not-exist")
	t.Setenv("EXECD_ENVS", envFile)

	require.Nil(t, loadExtraEnvFromFile(), "expected nil for missing file")
}

func TestParseEnvFileSingleQuotedIsLiteral(t *testing.T) {
	data := strings.Join([]string{
		"MULTI='line1",
		"line2  '",
		"SPACEY='  padded  '",
		"DOLLAR='$HOME and ${HOME}'",
		"EMPTY=''",
		"BACKSLASH='a\\nb'",
		"SQUOTE='it''s'",
		"NEXT=ok",
	}, "\n")

	got := parseEnvFile(data)
	require.Equal(t, "line1\nline2  ", got["MULTI"])
	require.Equal(t, "  padded  ", got["SPACEY"])
	require.Equal(t, "$HOME and ${HOME}", got["DOLLAR"])
	require.Equal(t, "", got["EMPTY"])
	require.Equal(t, "a\\nb", got["BACKSLASH"])
	require.NotContains(t, got, "SQUOTE")
	require.Equal(t, "ok", got["NEXT"])
}

func TestParseEnvFileDoubleQuotedEscapesAndExpands(t *testing.T) {
	dir := t.TempDir()
	t.Setenv("EXECD_ENVS", filepath.Join(dir, "env"))
	t.Setenv("BASE_DIR", "/opt/base")

	data := strings.Join([]string{
		`PATH="$BASE_DIR/bin"`,
		`MULTI="line1\nline2"`,
		`PADDED="  kept  "`,
		`LITERAL="$HOME"`,
		`QUOTED="a \"b\" c"`,
		`BACKSLASH="a\\b"`,
		`SPANNING="first`,
		`second"`,
	}, "\n")

	got := parseEnvFile(data)
	require.Equal(t, "/opt/base/bin", got["PATH"])
	require.Equal(t, "line1\nline2", got["MULTI"])
	require.Equal(t, "  kept  ", got["PADDED"])
	require.Equal(t, os.Getenv("HOME"), got["LITERAL"])
	require.Equal(t, `a "b" c`, got["QUOTED"])
	require.Equal(t, `a\b`, got["BACKSLASH"])
	require.Equal(t, "first\nsecond", got["SPANNING"])
}

// formatEnvFileEntry mirrors the lossless writer strategy for EXECD_ENVS values.
func formatEnvFileEntry(key, value string) string {
	if !strings.Contains(value, "'") {
		return key + "='" + value + "'"
	}
	escaped := strings.ReplaceAll(value, "\\", "\\\\")
	escaped = strings.ReplaceAll(escaped, "\"", "\\\"")
	return key + "=\"" + escaped + "\""
}

func TestParseEnvFileRoundTripsLosslessly(t *testing.T) {
	values := []string{
		"line1\nline2\nline3",
		"  leading and trailing  ",
		"$HOME ${HOME} $$ literal dollar",
		`back\slash and "quotes" and $dollar`,
		"it's got 'single' and \"double\" quotes",
		"tab\tseparated",
		"",
	}

	var b strings.Builder
	for i, v := range values {
		b.WriteString(formatEnvFileEntry(fmt.Sprintf("KEY_%d", i), v))
		b.WriteByte('\n')
	}

	got := parseEnvFile(b.String())
	for i, v := range values {
		require.Equal(t, v, got[fmt.Sprintf("KEY_%d", i)], "round-trip mismatch for KEY_%d", i)
	}
}

func TestParseEnvFileMalformedQuotedEntriesAreSkipped(t *testing.T) {
	data := strings.Join([]string{
		"UNTERM_S='no close",
		"UNTERM_D=\"no close",
		"TRAILING='v' junk",
		"AFTER=ok1",
		"=BARE",
	}, "\n")

	got := parseEnvFile(data)
	require.NotContains(t, got, "UNTERM_S")
	require.NotContains(t, got, "UNTERM_D")
	require.NotContains(t, got, "TRAILING")
	require.NotContains(t, got, "")
	require.Equal(t, "ok1", got["AFTER"])
}

func TestParseEnvFileHandlesCRLF(t *testing.T) {
	data := "FOO=bar\r\nSPACEY='  kept  '\r\nEXPANDED='$HOME'\r\n"

	got := parseEnvFile(data)
	require.Equal(t, "bar", got["FOO"])
	require.Equal(t, "  kept  ", got["SPACEY"])
	require.Equal(t, "$HOME", got["EXPANDED"])
}

func TestParseEnvFilePreservesLegacyUnquotedBehavior(t *testing.T) {
	dir := t.TempDir()
	t.Setenv("EXECD_ENVS", filepath.Join(dir, "env"))
	t.Setenv("BASE_DIR", "/opt/base")

	data := strings.Join([]string{
		"# comment",
		"TRIMMED=   padded   ",
		"EXPAND=$BASE_DIR/bin",
		"HASH=bar#not-comment",
		"MALFORMED",
		"EMPTY=",
	}, "\n")

	got := parseEnvFile(data)
	require.Equal(t, "padded", got["TRIMMED"])
	require.Equal(t, "/opt/base/bin", got["EXPAND"])
	require.Equal(t, "bar#not-comment", got["HASH"])
	require.NotContains(t, got, "MALFORMED")
	require.Equal(t, "", got["EMPTY"])
}

func TestLoadExtraEnvFromFileSupportsHomePath(t *testing.T) {
	home := t.TempDir()
	t.Setenv("HOME", home)
	t.Setenv("USERPROFILE", home)

	envFile := filepath.Join(home, "extra.env")
	require.NoError(t, os.WriteFile(envFile, []byte("FOO=bar\n"), 0o644))
	t.Setenv("EXECD_ENVS", "~/extra.env")

	got := loadExtraEnvFromFile()
	require.Equal(t, "bar", got["FOO"])
}

func TestMergeEnvsOverlaysExtra(t *testing.T) {
	base := []string{"A=1", "B=2"}
	extra := map[string]string{"B": "override", "C": "3"}

	merged := mergeEnvs(base, extra)
	got := make(map[string]string)
	for _, kv := range merged {
		parts := strings.SplitN(kv, "=", 2)
		if len(parts) == 2 {
			got[parts[0]] = parts[1]
		}
	}

	require.Len(t, got, 3)
	require.Equal(t, "1", got["A"])
	require.Equal(t, "override", got["B"])
	require.Equal(t, "3", got["C"])
}

// applyTestBinding installs a RuntimeBinding for the duration of the test and
// restores the previous state afterwards.
func applyTestBinding(t *testing.T, b *binding.RuntimeBinding) {
	t.Helper()
	previous := binding.Apply(b)
	t.Cleanup(func() { binding.Apply(previous) })
}

func TestUserEnvOverlayEmptyWithoutBinding(t *testing.T) {
	t.Setenv("EXECD_ENVS", "")
	applyTestBinding(t, nil)

	got := UserEnvOverlay(map[string]string{"REQ": "1"})
	require.Equal(t, map[string]string{"REQ": "1"}, got)
}

func TestUserEnvOverlayLayersBindingFileRequest(t *testing.T) {
	dir := t.TempDir()
	require.NoError(t, os.WriteFile(filepath.Join(dir, "env"), []byte("FILE_ONLY=f1\nSHARED=file\n"), 0o644))
	t.Setenv("EXECD_ENVS", filepath.Join(dir, "env"))

	applyTestBinding(t, &binding.RuntimeBinding{
		SandboxID: "sandbox-1",
		Envs:      map[string]string{"SANDBOX_ONLY": "s1", "SHARED": "sandbox"},
	})

	// Sandbox env < file env; request env beats both.
	got := UserEnvOverlay(map[string]string{"SHARED": "request"})
	require.Equal(t, "s1", got["SANDBOX_ONLY"])
	require.Equal(t, "f1", got["FILE_ONLY"])
	require.Equal(t, "request", got["SHARED"])

	// The runtime (.env file) layer overrides the sandbox layer.
	require.Equal(t, "file", UserEnvOverlay()["SHARED"])
}

func TestUserEnvOverlayForcesSandboxID(t *testing.T) {
	t.Setenv("EXECD_ENVS", "")
	applyTestBinding(t, &binding.RuntimeBinding{SandboxID: "authoritative"})

	got := UserEnvOverlay(map[string]string{"OPENSANDBOX_ID": "spoofed"})
	require.Equal(t, "authoritative", got["OPENSANDBOX_ID"])
}

func TestUserEnvOverlayNoBindingKeepsFileLayer(t *testing.T) {
	dir := t.TempDir()
	require.NoError(t, os.WriteFile(filepath.Join(dir, "env"), []byte("FOO=bar\n"), 0o644))
	t.Setenv("EXECD_ENVS", filepath.Join(dir, "env"))
	applyTestBinding(t, nil)

	got := UserEnvOverlay()
	require.Equal(t, "bar", got["FOO"])
	require.NotContains(t, got, "OPENSANDBOX_ID")
}

func TestFilterEnvNamesRemovesConfigVars(t *testing.T) {
	env := []string{"PATH=/usr/bin", "EXECD_ACCESS_TOKEN=secret", "JUPYTER_TOKEN=tok", "KEEP=1"}

	filtered := filterEnvNames(env, isolation.ExecdConfigEnvBlacklist())

	require.Contains(t, filtered, "PATH=/usr/bin")
	require.Contains(t, filtered, "KEEP=1")
	require.Len(t, filtered, 2)
}

func TestUserProcessEnvironmentFiltersBlacklist(t *testing.T) {
	t.Setenv("EXECD_ACCESS_TOKEN", "secret")
	t.Setenv("EXECD_ENVS", "")
	applyTestBinding(t, &binding.RuntimeBinding{
		SandboxID: "sandbox-1",
		Envs:      map[string]string{"SANDBOX_ONLY": "s1"},
	})

	env := UserProcessEnvironment()
	joined := strings.Join(env, "\n")
	require.Contains(t, joined, "SANDBOX_ONLY=s1")
	require.Contains(t, joined, "OPENSANDBOX_ID=sandbox-1")
	require.NotContains(t, joined, "EXECD_ACCESS_TOKEN")
}