mire
Code Issues

feat: add mounts as an option in mire config + refactor default config generation

Browse Source
This commit is contained in:
ruinivist
2026-03-22 13:47:12 +00:00
parent f3b80ddf05
commit 517dc908bc
14 changed files with 189 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/root_test.go
+2 -2
View File
@@ -49,8 +49,8 @@ func TestRunInit(t *testing.T) {
return struct{}{}
})
if got := testutil.ReadFile(t, filepath.Join(root, "mire.toml")); got != testutil.DefaultWrittenConfig("e2e") {
t.Fatalf("config = %q, want %q", got, testutil.DefaultWrittenConfig("e2e"))
if _, err := os.Stat(filepath.Join(root, "mire.toml")); err != nil {
t.Fatalf("Stat(%q) error = %v", filepath.Join(root, "mire.toml"), err)
}
info, err := os.Stat(filepath.Join(root, "e2e", "shell.sh"))
if err != nil {
internal/config/config.go
+68 -28
View File
@@ -1,13 +1,12 @@
package config
import (
"bytes"
"embed"
"errors"
"fmt"
"os"
"path/filepath"
"regexp"
"sort"
"github.com/BurntSushi/toml"
)
@@ -24,17 +23,26 @@ var (
type Config struct {
TestDir string
Sandbox map[string]string
Mounts []string
}
type tomlConfig struct {
Mire tomlMireConfig `toml:"mire"`
Sandbox map[string]string `toml:"sandbox"`
Sandbox toml.Primitive `toml:"sandbox"`
}
type tomlMireConfig struct {
TestDir string `toml:"test_dir"`
}
type tomlSandboxConfig struct {
Home string `toml:"home"`
Mounts []string `toml:"mounts"`
}
//go:embed mire.toml
var defaultConfigFS embed.FS
func DefaultSandboxConfig() map[string]string {
return cloneSandbox(requiredSandboxDefaults)
}
@@ -62,8 +70,14 @@ func ReadConfig(path string) (Config, error) {
if !meta.IsDefined("sandbox") {
return Config{}, fmt.Errorf("failed to read %s: missing [sandbox] config", path)
}
if !meta.IsDefined("sandbox", "home") {
return Config{}, fmt.Errorf("failed to read %s: missing required sandbox.home", path)
}
if !meta.IsDefined("sandbox", "mounts") {
return Config{}, fmt.Errorf("failed to read %s: missing required sandbox.mounts", path)
}
sandbox, err := validateSandbox(path, raw.Sandbox)
sandbox, mounts, err := decodeSandbox(meta, path, raw.Sandbox)
if err != nil {
return Config{}, err
}
@@ -71,58 +85,73 @@ func ReadConfig(path string) (Config, error) {
return Config{
TestDir: raw.Mire.TestDir,
Sandbox: sandbox,
Mounts: mounts,
}, nil
}
// WriteConfig writes mire.toml.
func WriteConfig(path string, cfg Config) error {
if cfg.TestDir == "" {
return errors.New("empty mire.test_dir")
}
sandbox, err := validateSandbox(path, cfg.Sandbox)
// WriteDefaultConfig writes the embedded default mire.toml.
func WriteDefaultConfig(path string) error {
body, err := defaultConfigFS.ReadFile("mire.toml")
if err != nil {
return err
return fmt.Errorf("read embedded default mire.toml: %v", err)
}
var buf bytes.Buffer
fmt.Fprintf(&buf, "[mire]\n test_dir = %q\n\n[sandbox]\n", cfg.TestDir)
keys := make([]string, 0, len(sandbox))
for key := range sandbox {
keys = append(keys, key)
}
sort.Strings(keys)
for _, key := range keys {
fmt.Fprintf(&buf, " %s = %q\n", key, sandbox[key])
return os.WriteFile(path, body, 0o644)
}
return os.WriteFile(path, buf.Bytes(), 0o644)
func decodeSandbox(meta toml.MetaData, path string, raw toml.Primitive) (map[string]string, []string, error) {
var typed tomlSandboxConfig
if err := meta.PrimitiveDecode(raw, &typed); err != nil {
return nil, nil, fmt.Errorf("failed to read %s: %v", path, err)
}
func validateSandbox(path string, sandbox map[string]string) (map[string]string, error) {
var sandboxTable map[string]any
if err := meta.PrimitiveDecode(raw, &sandboxTable); err != nil {
return nil, nil, fmt.Errorf("failed to read %s: %v", path, err)
}
sandbox := map[string]string{
"home": typed.Home,
}
for key, value := range sandboxTable {
if key == "home" || key == "mounts" {
continue
}
str, ok := value.(string)
if !ok {
return nil, nil, fmt.Errorf("failed to read %s: sandbox.%s must be a string", path, key)
}
sandbox[key] = str
}
return validateSandbox(path, sandbox, typed.Mounts)
}
func validateSandbox(path string, sandbox map[string]string, mounts []string) (map[string]string, []string, error) {
validated := cloneSandbox(sandbox)
for key := range validated {
if !lowerSnakeCasePattern.MatchString(key) {
return nil, fmt.Errorf("failed to read %s: invalid sandbox key %q: must be lower_snake_case", path, key)
return nil, nil, fmt.Errorf("failed to read %s: invalid sandbox key %q: must be lower_snake_case", path, key)
}
}
for key := range requiredSandboxDefaults {
value, ok := validated[key]
if !ok {
return nil, fmt.Errorf("failed to read %s: missing required sandbox.%s", path, key)
return nil, nil, fmt.Errorf("failed to read %s: missing required sandbox.%s", path, key)
}
if value == "" {
return nil, fmt.Errorf("failed to read %s: empty sandbox.%s", path, key)
return nil, nil, fmt.Errorf("failed to read %s: empty sandbox.%s", path, key)
}
}
if !filepath.IsAbs(validated["home"]) {
return nil, fmt.Errorf("failed to read %s: sandbox.home must be an absolute path", path)
return nil, nil, fmt.Errorf("failed to read %s: sandbox.home must be an absolute path", path)
}
return validated, nil
return validated, cloneMounts(mounts), nil
}
func cloneSandbox(sandbox map[string]string) map[string]string {
@@ -137,3 +166,14 @@ func cloneSandbox(sandbox map[string]string) map[string]string {
return cloned
}
func cloneMounts(mounts []string) []string {
if len(mounts) == 0 {
return []string{}
}
cloned := make([]string, len(mounts))
copy(cloned, mounts)
return cloned
}
internal/config/config_test.go
+43 -47
View File
@@ -14,17 +14,19 @@ func TestReadConfig(t *testing.T) {
content string
wantDir string
wantSandbox map[string]string
wantMounts []string
wantErr string
wantMissing bool
}{
{
name: "with test dir and sandbox",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nkey_word = \"value\"\n",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nmounts = [\"/host/data:/sandbox/data\", \"/host/cache:/sandbox/cache\"]\nkey_word = \"value\"\n",
wantDir: "custom/suite",
wantSandbox: map[string]string{
"home": "/home/test",
"key_word": "value",
},
wantMounts: []string{"/host/data:/sandbox/data", "/host/cache:/sandbox/cache"},
},
{
name: "legacy top level key",
@@ -53,24 +55,39 @@ func TestReadConfig(t *testing.T) {
},
{
name: "without required home",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\n",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nmounts = []\n",
wantErr: "missing required sandbox.home",
},
{
name: "without required mounts",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\n",
wantErr: "missing required sandbox.mounts",
},
{
name: "empty required home",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"\"\n",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"\"\nmounts = []\n",
wantErr: "empty sandbox.home",
},
{
name: "relative home",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"home/test\"\n",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"home/test\"\nmounts = []\n",
wantErr: "sandbox.home must be an absolute path",
},
{
name: "invalid sandbox key",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nKeyWord = \"value\"\n",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nmounts = []\nKeyWord = \"value\"\n",
wantErr: "invalid sandbox key",
},
{
name: "non string sandbox value",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nmounts = []\nkey_word = 1\n",
wantErr: "sandbox.key_word must be a string",
},
{
name: "mounts wrong type",
content: "[mire]\ntest_dir = \"custom/suite\"\n\n[sandbox]\nhome = \"/home/test\"\nmounts = \"oops\"\n",
wantErr: "failed to read",
},
{
name: "invalid toml",
content: "[mire]\ntest_dir = [\n",
@@ -121,57 +138,36 @@ func TestReadConfig(t *testing.T) {
t.Fatalf("ReadConfig() Sandbox[%q] = %q, want %q", key, got.Sandbox[key], want)
}
}
if len(got.Mounts) != len(tt.wantMounts) {
t.Fatalf("ReadConfig() Mounts = %#v, want %#v", got.Mounts, tt.wantMounts)
}
for i, want := range tt.wantMounts {
if got.Mounts[i] != want {
t.Fatalf("ReadConfig() Mounts[%d] = %q, want %q", i, got.Mounts[i], want)
}
}
})
}
}
func TestWriteConfig(t *testing.T) {
func TestWriteDefaultConfig(t *testing.T) {
path := filepath.Join(t.TempDir(), "mire.toml")
if err := WriteConfig(path, Config{
TestDir: "e2e",
Sandbox: map[string]string{
"home": "/home/test",
"alpha_key": "a",
"zulu_key": "z",
},
}); err != nil {
t.Fatalf("WriteConfig() error = %v", err)
if err := WriteDefaultConfig(path); err != nil {
t.Fatalf("WriteDefaultConfig() error = %v", err)
}
got, err := os.ReadFile(path)
got, err := ReadConfig(path)
if err != nil {
t.Fatalf("ReadFile() error = %v", err)
t.Fatalf("ReadConfig() error = %v", err)
}
want := "[mire]\n test_dir = \"e2e\"\n\n[sandbox]\n alpha_key = \"a\"\n home = \"/home/test\"\n zulu_key = \"z\"\n"
if string(got) != want {
t.Fatalf("config = %q, want %q", string(got), want)
}
}
func TestWriteConfigEmptyTestDirFails(t *testing.T) {
path := filepath.Join(t.TempDir(), "mire.toml")
err := WriteConfig(path, Config{})
if err == nil {
t.Fatal("WriteConfig() error = nil, want error")
}
if err.Error() != "empty mire.test_dir" {
t.Fatalf("WriteConfig() error = %q, want %q", err.Error(), "empty mire.test_dir")
}
}
func TestWriteConfigMissingRequiredSandboxFails(t *testing.T) {
path := filepath.Join(t.TempDir(), "mire.toml")
err := WriteConfig(path, Config{
TestDir: "e2e",
Sandbox: map[string]string{},
})
if err == nil {
t.Fatal("WriteConfig() error = nil, want error")
}
if !strings.Contains(err.Error(), "missing required sandbox.home") {
t.Fatalf("WriteConfig() error = %q, want home error", err.Error())
if got.TestDir != "e2e" {
t.Fatalf("ReadConfig() TestDir = %q, want %q", got.TestDir, "e2e")
}
if got.Sandbox["home"] != DefaultVisibleHome {
t.Fatalf("ReadConfig() Sandbox[home] = %q, want %q", got.Sandbox["home"], DefaultVisibleHome)
}
if len(got.Mounts) != 0 {
t.Fatalf("ReadConfig() Mounts = %#v, want empty", got.Mounts)
}
}
internal/config/mire.toml
+9
View File
@@ -0,0 +1,9 @@
[mire]
# which folder to strore tests in
test_dir = "e2e"
[sandbox]
# home is where mire would drop you by default on record
home = "/home/test"
# read only paths from host, entry looks like "path on host:path on sanbox"
mounts = []
internal/mire/init.go
+1 -4
View File
@@ -26,10 +26,7 @@ func Init() error {
} else if !errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("failed to check %s: %v", configPath, err)
} else {
if err := mireconfig.WriteConfig(configPath, mireconfig.Config{
TestDir: defaultTestDir,
Sandbox: mireconfig.DefaultSandboxConfig(),
}); err != nil {
if err := mireconfig.WriteDefaultConfig(configPath); err != nil {
return fmt.Errorf("failed to write %s: %v", configPath, err)
}
}
internal/mire/record.go
+1 -1
View File
@@ -46,7 +46,7 @@ func Record(path string) (string, error) {
in: os.Stdin,
out: os.Stdout,
err: os.Stderr,
}, cfg.Sandbox, setupScripts); err != nil {
}, cfg.Sandbox, cfg.Mounts, setupScripts); err != nil {
return "", err
}
internal/mire/record_session.go
+4 -4
View File
@@ -18,7 +18,7 @@ type recordIO struct {
err io.Writer
}
func recordScenario(target, shellPath string, rio recordIO, sandboxConfig map[string]string, setupScripts []string) error {
func recordScenario(target, shellPath string, rio recordIO, sandboxConfig map[string]string, mounts, setupScripts []string) error {
rawIn, rawOut, cleanup, err := newRecordFiles()
if err != nil {
return err
@@ -43,7 +43,7 @@ func recordScenario(target, shellPath string, rio recordIO, sandboxConfig map[st
// this error is intentionally discarded to avoid non zero exit status inside record
// as an error
runRecordSession(target, rawIn, rawOut, shellPath, sandbox, rio, sandboxConfig, setupScripts)
runRecordSession(target, rawIn, rawOut, shellPath, sandbox, rio, sandboxConfig, mounts, setupScripts)
save, err := confirmRecordSave(rio)
if err != nil {
@@ -120,7 +120,7 @@ func newRecordSandboxForPathEnv(pathEnv string) (recordSandbox, func(), error) {
return sandbox, cleanup, nil
}
func runRecordSession(dir, rawIn, rawOut, shellPath string, sandbox recordSandbox, rio recordIO, sandboxConfig map[string]string, setupScripts []string) error {
func runRecordSession(dir, rawIn, rawOut, shellPath string, sandbox recordSandbox, rio recordIO, sandboxConfig map[string]string, mounts, setupScripts []string) error {
rawInFile, err := os.Create(rawIn)
if err != nil {
return err
@@ -135,7 +135,7 @@ func runRecordSession(dir, rawIn, rawOut, shellPath string, sandbox recordSandbo
cmd := exec.Command(shellPath)
cmd.Dir = dir
cmd.Env = recordSessionEnv(sandbox, sandboxConfig, setupScripts)
cmd.Env = recordSessionEnv(sandbox, sandboxConfig, mounts, setupScripts)
var tty *os.File
if file, ok := rio.in.(*os.File); ok {
internal/mire/record_shell.go
+5 -3
View File
@@ -13,6 +13,7 @@ import (
const recordShellName = "shell.sh"
const (
mountsEnvName = "MIRE_MOUNTS"
compareMarkerEnvName = "MIRE_COMPARE_MARKER"
compareMarkerEnabledValue = "1"
compareOutputMarker = "__MIRE_PROMPT_READY__"
@@ -79,16 +80,17 @@ func buildRecordShellScript() string {
return string(body)
}
func recordSessionEnv(sandbox recordSandbox, sandboxConfig map[string]string, setupScripts []string) []string {
return recordSessionEnvWithExtra(sandbox, sandboxConfig, setupScripts, nil)
func recordSessionEnv(sandbox recordSandbox, sandboxConfig map[string]string, mounts, setupScripts []string) []string {
return recordSessionEnvWithExtra(sandbox, sandboxConfig, mounts, setupScripts, nil)
}
func recordSessionEnvWithExtra(sandbox recordSandbox, sandboxConfig map[string]string, setupScripts []string, extraEnv map[string]string) []string {
func recordSessionEnvWithExtra(sandbox recordSandbox, sandboxConfig map[string]string, mounts, setupScripts []string, extraEnv map[string]string) []string {
env := append([]string{}, os.Environ()...)
env = append(env,
"MIRE_HOST_HOME="+sandbox.hostHome,
"MIRE_HOST_TMP="+sandbox.hostTmp,
"MIRE_PATH_ENV="+sandbox.pathEnv,
mountsEnvName+"="+strings.Join(mounts, "\n"),
setupScriptsEnvName+"="+strings.Join(setupScripts, "\n"),
)
for _, key := range sortedKeys(sandboxConfig) {
internal/mire/record_shell.sh
+11
View File
@@ -67,4 +67,15 @@ ${MIRE_SETUP_SCRIPTS-}
EOF
fi
if [ -n "${MIRE_MOUNTS:-}" ]; then
while IFS= read -r mount || [ -n "$mount" ]; do
[ -n "$mount" ] || continue
host_path=${mount%%:*}
sandbox_path=${mount#*:}
set -- "$@" --ro-bind "$host_path" "$sandbox_path"
done <<EOF
${MIRE_MOUNTS-}
EOF
fi
exec bwrap "$@" bash --noprofile --rcfile "$visible_bootstrap_rc" -i
internal/mire/record_test.go
+16 -8
View File
@@ -14,7 +14,7 @@ func TestRecordCreatesRelativePath(t *testing.T) {
root := t.TempDir()
testDir := filepath.Join(root, "e2e")
testutil.MustMkdirAll(t, testDir)
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("e2e"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "e2e")
mustWriteRecordShell(t, testDir)
testutil.AddFakeRecordDependencies(t, "bwrap", "bash")
@@ -60,7 +60,7 @@ func TestRecordReturnsDiscardedErrorWhenSaveDeclined(t *testing.T) {
target := filepath.Join(testDir, "a", "b", "c")
testutil.MustMkdirAll(t, target)
return withRecordStreams(t, "exit\nn\n", func(rio recordIO) error {
return recordScenario(target, recordShellPath(testDir), rio, defaultSandboxConfig(), nil)
return recordScenario(target, recordShellPath(testDir), rio, defaultSandboxConfig(), nil, nil)
})
})
@@ -87,7 +87,7 @@ func TestRecordReturnsDiscardedErrorWhenOverwriteDeclined(t *testing.T) {
err := testutil.WithWorkingDir(t, root, func() error {
return withRecordStreams(t, "n\n", func(rio recordIO) error {
return recordScenario(target, recordShellPath(testDir), rio, defaultSandboxConfig(), nil)
return recordScenario(target, recordShellPath(testDir), rio, defaultSandboxConfig(), nil, nil)
})
})
@@ -125,6 +125,12 @@ func TestBuildRecordShellScriptUsesExpectedCommands(t *testing.T) {
"visible_bootstrap_rc=\"$visible_home/.mire-shell-rc\"",
"for path in /tmp/mire-setup-scripts/*.sh; do",
"source \"$path\"",
`if [ -n "${MIRE_MOUNTS:-}" ]; then`,
`while IFS= read -r mount || [ -n "$mount" ]; do`,
`host_path=${mount%%:*}`,
`sandbox_path=${mount#*:}`,
`set -- "$@" --ro-bind "$host_path" "$sandbox_path"`,
"${MIRE_MOUNTS-}",
`if [ -n "${MIRE_SETUP_SCRIPTS:-}" ]; then`,
"i=1",
`while IFS= read -r host_path || [ -n "$host_path" ]; do`,
@@ -161,12 +167,13 @@ func TestRecordSessionEnvIncludesConfiguredSandboxEnv(t *testing.T) {
}, map[string]string{
"home": "/sandbox/home",
"key_word": "value",
}, []string{"/repo/e2e/setup.sh", "/repo/e2e/suite/setup.sh"})
}, []string{"/host/data:/sandbox/data", "/host/cache:/sandbox/cache"}, []string{"/repo/e2e/setup.sh", "/repo/e2e/suite/setup.sh"})
for _, want := range []string{
"MIRE_HOST_HOME=/tmp/host-home",
"MIRE_HOST_TMP=/tmp/host-tmp",
"MIRE_PATH_ENV=/tmp/bin",
"MIRE_MOUNTS=/host/data:/sandbox/data\n/host/cache:/sandbox/cache",
"MIRE_KEY_WORD=value",
"MIRE_HOME=/sandbox/home",
"MIRE_SETUP_SCRIPTS=/repo/e2e/setup.sh\n/repo/e2e/suite/setup.sh",
@@ -187,7 +194,7 @@ func TestRecordSessionEnvWithExtraIncludesAdditionalEntries(t *testing.T) {
pathEnv: "/tmp/bin",
}, map[string]string{
"home": "/sandbox/home",
}, []string{"/repo/e2e/setup.sh"}, map[string]string{
}, []string{"/host/data:/sandbox/data"}, []string{"/repo/e2e/setup.sh"}, map[string]string{
compareMarkerEnvName: compareMarkerEnabledValue,
})
@@ -195,6 +202,7 @@ func TestRecordSessionEnvWithExtraIncludesAdditionalEntries(t *testing.T) {
"MIRE_HOST_HOME=/tmp/host-home",
"MIRE_HOST_TMP=/tmp/host-tmp",
"MIRE_PATH_ENV=/tmp/bin",
"MIRE_MOUNTS=/host/data:/sandbox/data",
"MIRE_HOME=/sandbox/home",
"MIRE_SETUP_SCRIPTS=/repo/e2e/setup.sh",
"MIRE_COMPARE_MARKER=1",
@@ -224,7 +232,7 @@ func TestRunRecordSessionCapturesInputAndOutput(t *testing.T) {
rawIn := filepath.Join(t.TempDir(), "raw.in")
rawOut := filepath.Join(t.TempDir(), "raw.out")
err = withRecordStreams(t, "hello\n", func(rio recordIO) error {
return runRecordSession(t.TempDir(), rawIn, rawOut, shellPath, sandbox, rio, defaultSandboxConfig(), nil)
return runRecordSession(t.TempDir(), rawIn, rawOut, shellPath, sandbox, rio, defaultSandboxConfig(), nil, nil)
})
if err != nil {
t.Fatalf("runRecordSession() error = %v", err)
@@ -263,7 +271,7 @@ func TestRecordScenarioUsesDeterministicSandbox(t *testing.T) {
"y\n",
func(rio recordIO) error {
rio.out = ioDiscard{}
return recordScenario(target, recordShellPath(testDir), rio, sandboxConfig, nil)
return recordScenario(target, recordShellPath(testDir), rio, sandboxConfig, nil, nil)
},
)
})
@@ -301,7 +309,7 @@ func TestRecordScenarioUsesDeterministicSandbox(t *testing.T) {
func TestRecordFailsWhenRecorderShellMissing(t *testing.T) {
root := t.TempDir()
testDir := filepath.Join(root, "e2e")
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("e2e"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "e2e")
testutil.MustMkdirAll(t, testDir)
target := filepath.Join(testDir, "suite", "spec")
internal/mire/test.go
+3 -3
View File
@@ -102,7 +102,7 @@ func runTests(path string, tio testIO) error {
output.Fprintf(tio.out, "%s %s\n", output.Label("RUN", output.Info), scenario.relPath)
start := time.Now()
if err := replayScenario(scenario, shellPath, tio, cfg.Sandbox); err != nil {
if err := replayScenario(scenario, shellPath, tio, cfg.Sandbox, cfg.Mounts); err != nil {
elapsed := time.Since(start)
summary.failed++
output.Fprintf(tio.out, "%s %s (%s): %v\n", output.Label("FAIL", output.Fail), scenario.relPath, formatElapsed(elapsed), err)
@@ -231,7 +231,7 @@ func discoverTestScenarios(discoveryRoot, displayRoot string) ([]testScenario, e
return scenarios, nil
}
func replayScenario(scenario testScenario, shellPath string, _ testIO, sandboxConfig map[string]string) error {
func replayScenario(scenario testScenario, shellPath string, _ testIO, sandboxConfig map[string]string, mounts []string) error {
input, err := loadRecordedInput(scenario.inPath)
if err != nil {
return fmt.Errorf("failed to read recorded input: %v", err)
@@ -256,7 +256,7 @@ func replayScenario(scenario testScenario, shellPath string, _ testIO, sandboxCo
cmd := exec.Command(shellPath)
cmd.Dir = scenario.dir
cmd.Env = recordSessionEnvWithExtra(sandbox, sandboxConfig, scenario.setupScripts, map[string]string{
cmd.Env = recordSessionEnvWithExtra(sandbox, sandboxConfig, mounts, scenario.setupScripts, map[string]string{
compareMarkerEnvName: compareMarkerEnabledValue,
})
internal/mire/test_test.go
+4 -4
View File
@@ -110,7 +110,7 @@ func TestReplayScenarioUsesRecordedInputAndKeepsReplayOutputQuiet(t *testing.T)
}, shellPath, testIO{
out: &stdout,
err: &stderr,
}, defaultSandboxConfig())
}, defaultSandboxConfig(), nil)
if err != nil {
t.Fatalf("replayScenario() error = %v", err)
}
@@ -146,7 +146,7 @@ func TestReplayScenarioWaitsForPromptReadyMarkerBeforeSendingInput(t *testing.T)
}, shellPath, testIO{
out: &bytes.Buffer{},
err: &bytes.Buffer{},
}, defaultSandboxConfig())
}, defaultSandboxConfig(), nil)
if err != nil {
t.Fatalf("replayScenario() error = %v", err)
}
@@ -171,7 +171,7 @@ func TestReplayScenarioFailsWhenCompareMarkerMissing(t *testing.T) {
}, shellPath, testIO{
out: &bytes.Buffer{},
err: &bytes.Buffer{},
}, defaultSandboxConfig())
}, defaultSandboxConfig(), nil)
if err == nil {
t.Fatal("replayScenario() error = nil, want error")
}
@@ -235,7 +235,7 @@ func TestRunTestsScopedRunEmptyDirectoryFails(t *testing.T) {
root := t.TempDir()
testDir := filepath.Join(root, "e2e")
emptyDir := filepath.Join(testDir, "empty")
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("e2e"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "e2e")
mustWriteRecordShell(t, testDir)
testutil.MustMkdirAll(t, emptyDir)
internal/mire/testdir_test.go
+11 -12
View File
@@ -19,9 +19,8 @@ func TestInitCreatesConfigAtProjectRoot(t *testing.T) {
return struct{}{}
})
got := testutil.ReadFile(t, filepath.Join(root, "mire.toml"))
if got != testutil.DefaultWrittenConfig("e2e") {
t.Fatalf("config = %q, want %q", got, testutil.DefaultWrittenConfig("e2e"))
if _, err := os.Stat(filepath.Join(root, "mire.toml")); err != nil {
t.Fatalf("Stat(%q) error = %v", filepath.Join(root, "mire.toml"), err)
}
assertRecordShell(t, filepath.Join(root, "e2e", recordShellName))
}
@@ -47,7 +46,8 @@ func TestInitUsesGitRoot(t *testing.T) {
func TestInitLeavesExistingValidConfigUntouchedAndRefreshesShell(t *testing.T) {
root := t.TempDir()
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("custom/suite"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "custom/suite")
wantConfig := testutil.ReadFile(t, filepath.Join(root, "mire.toml"))
testutil.WriteFile(t, filepath.Join(root, "custom", "suite", recordShellName), "outdated\n")
testutil.WithWorkingDir(t, root, func() struct{} {
@@ -57,9 +57,8 @@ func TestInitLeavesExistingValidConfigUntouchedAndRefreshesShell(t *testing.T) {
return struct{}{}
})
got := testutil.ReadFile(t, filepath.Join(root, "mire.toml"))
if got != testutil.ValidConfigContent("custom/suite") {
t.Fatalf("config = %q, want %q", got, testutil.ValidConfigContent("custom/suite"))
if got := testutil.ReadFile(t, filepath.Join(root, "mire.toml")); got != wantConfig {
t.Fatalf("config = %q, want unchanged %q", got, wantConfig)
}
if got := testutil.ReadFile(t, filepath.Join(root, "custom", "suite", recordShellName)); got != buildRecordShellScript() {
t.Fatalf("shell = %q, want refreshed recorder shell", got)
@@ -68,7 +67,7 @@ func TestInitLeavesExistingValidConfigUntouchedAndRefreshesShell(t *testing.T) {
func TestInitCreatesMissingConfiguredTestDir(t *testing.T) {
root := t.TempDir()
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("custom/suite"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "custom/suite")
testutil.WithWorkingDir(t, root, func() struct{} {
if err := Init(); err != nil {
@@ -99,7 +98,7 @@ func TestResolveTestDirFromConfig(t *testing.T) {
root := t.TempDir()
configured := filepath.Join(root, "custom", "suite")
testutil.MustMkdirAll(t, configured)
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("custom/suite"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "custom/suite")
got := testutil.WithWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
@@ -184,7 +183,7 @@ func TestResolveTestDirMalformedConfigFails(t *testing.T) {
func TestResolveTestDirConfiguredMissingDirectoryReturnsConfiguredPath(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "missing")
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("missing"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "missing")
got := testutil.WithWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
@@ -202,7 +201,7 @@ func TestResolveTestDirConfiguredMissingDirectoryReturnsConfiguredPath(t *testin
func TestResolveTestDirConfiguredFileFails(t *testing.T) {
root := t.TempDir()
testutil.WriteFile(t, filepath.Join(root, "case.txt"), "hello\n")
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("case.txt"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "case.txt")
err := testutil.WithWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
@@ -221,7 +220,7 @@ func TestResolveTestDirUsesGitRoot(t *testing.T) {
root := t.TempDir()
testutil.MustGitInit(t, root)
want := filepath.Join(root, "e2e")
testutil.WriteFile(t, filepath.Join(root, "mire.toml"), testutil.ValidConfigContent("e2e"))
testutil.WriteValidConfig(t, filepath.Join(root, "mire.toml"), "e2e")
subdir := filepath.Join(root, "nested", "dir")
testutil.MustMkdirAll(t, subdir)
internal/testutil/testutil.go
+8 -6
View File
@@ -171,6 +171,12 @@ func WriteFile(t *testing.T, path, content string) {
}
}
func WriteValidConfig(t *testing.T, path, testDir string) {
t.Helper()
WriteFile(t, path, validConfigContent(testDir))
}
func WriteScenarioFixtures(t *testing.T, dir, in, out string) {
t.Helper()
@@ -437,10 +443,6 @@ func MustGitInit(t *testing.T, dir string) {
}
}
func DefaultWrittenConfig(testDir string) string {
return "[mire]\n test_dir = \"" + testDir + "\"\n\n[sandbox]\n home = \"/home/test\"\n"
}
func ValidConfigContent(testDir string) string {
return "[mire]\ntest_dir = \"" + testDir + "\"\n\n[sandbox]\nhome = \"/home/test\"\n"
func validConfigContent(testDir string) string {
return "[mire]\ntest_dir = \"" + testDir + "\"\n\n[sandbox]\nhome = \"/home/test\"\nmounts = []\n"
}