450 lines
13 KiB
Go
450 lines
13 KiB
Go
package miro
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
func TestRecordCreatesRelativePath(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
mustMkdirAll(t, testDir)
|
|
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"e2e\"\n")
|
|
mustWriteRecordShell(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
|
|
got := withWorkingDir(t, root, func() string {
|
|
withStdin(t, "y\n", func() {})
|
|
path, err := Record(filepath.Join("a", "b", "c") + string(os.PathSeparator))
|
|
if err != nil {
|
|
t.Fatalf("Record() error = %v", err)
|
|
}
|
|
return path
|
|
})
|
|
|
|
want := filepath.Join(testDir, "a", "b", "c")
|
|
if got != want {
|
|
t.Fatalf("Record() = %q, want %q", got, want)
|
|
}
|
|
|
|
for _, name := range []string{"in", "out"} {
|
|
if _, err := os.Stat(filepath.Join(want, name)); err != nil {
|
|
t.Fatalf("Stat(%q) error = %v", filepath.Join(want, name), err)
|
|
}
|
|
}
|
|
|
|
if got := readFile(t, filepath.Join(want, "in")); got != "fake recorded input\n" {
|
|
t.Fatalf("saved in = %q, want %q", got, "fake recorded input\n")
|
|
}
|
|
if got := readFile(t, filepath.Join(want, "out")); got != "fake recorded output\n" {
|
|
t.Fatalf("saved out = %q, want %q", got, "fake recorded output\n")
|
|
}
|
|
}
|
|
|
|
func TestRecordAcceptsExplicitTestDirPrefix(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
mustMkdirAll(t, testDir)
|
|
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"e2e\"\n")
|
|
mustWriteRecordShell(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
|
|
got := withWorkingDir(t, root, func() string {
|
|
withStdin(t, "y\n", func() {})
|
|
path, err := Record(filepath.Join("e2e", "a", "b", "c"))
|
|
if err != nil {
|
|
t.Fatalf("Record() error = %v", err)
|
|
}
|
|
return path
|
|
})
|
|
|
|
want := filepath.Join(testDir, "a", "b", "c")
|
|
if got != want {
|
|
t.Fatalf("Record() = %q, want %q", got, want)
|
|
}
|
|
|
|
for _, name := range []string{"in", "out"} {
|
|
if _, err := os.Stat(filepath.Join(want, name)); err != nil {
|
|
t.Fatalf("Stat(%q) error = %v", filepath.Join(want, name), err)
|
|
}
|
|
}
|
|
|
|
if got := readFile(t, filepath.Join(want, "out")); got != "fake recorded output\n" {
|
|
t.Fatalf("saved out = %q, want %q", got, "fake recorded output\n")
|
|
}
|
|
}
|
|
|
|
func TestRecordRejectsAbsolutePathOutsideTestDir(t *testing.T) {
|
|
root := t.TempDir()
|
|
mustMkdirAll(t, filepath.Join(root, "e2e"))
|
|
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"e2e\"\n")
|
|
outside := filepath.Join(root, "outside", "a", "b", "c")
|
|
|
|
err := withWorkingDir(t, root, func() error {
|
|
_, err := Record(outside)
|
|
return err
|
|
})
|
|
|
|
if err == nil {
|
|
t.Fatal("Record() error = nil, want error")
|
|
}
|
|
if _, statErr := os.Stat(outside); !os.IsNotExist(statErr) {
|
|
t.Fatalf("Stat(%q) error = %v, want not exists", outside, statErr)
|
|
}
|
|
}
|
|
|
|
func TestRecordReturnsDiscardedErrorWhenSaveDeclined(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
mustMkdirAll(t, testDir)
|
|
mustWriteRecordShell(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
|
|
err := withWorkingDir(t, root, func() error {
|
|
target := filepath.Join(testDir, "a", "b", "c")
|
|
mustMkdirAll(t, target)
|
|
return withRecordStreams(t, "n\n", func(rio recordIO) error {
|
|
return recordScenario(target, recordShellPath(testDir), rio)
|
|
})
|
|
})
|
|
|
|
if !errors.Is(err, ErrRecordingDiscarded) {
|
|
t.Fatalf("Record() error = %v, want ErrRecordingDiscarded", err)
|
|
}
|
|
|
|
target := filepath.Join(testDir, "a", "b", "c")
|
|
for _, name := range []string{"in", "out"} {
|
|
if _, err := os.Stat(filepath.Join(target, name)); !os.IsNotExist(err) {
|
|
t.Fatalf("Stat(%q) error = %v, want not exists", filepath.Join(target, name), err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRecordReturnsDiscardedErrorWhenOverwriteDeclined(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
target := filepath.Join(testDir, "a", "b", "c")
|
|
mustMkdirAll(t, target)
|
|
mustWriteRecordShell(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
writeFile(t, filepath.Join(target, "in"), "existing in\n")
|
|
writeFile(t, filepath.Join(target, "out"), "existing out\n")
|
|
|
|
err := withWorkingDir(t, root, func() error {
|
|
return withRecordStreams(t, "n\n", func(rio recordIO) error {
|
|
return recordScenario(target, recordShellPath(testDir), rio)
|
|
})
|
|
})
|
|
|
|
if !errors.Is(err, ErrRecordingDiscarded) {
|
|
t.Fatalf("recordScenario() error = %v, want ErrRecordingDiscarded", err)
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
name string
|
|
want string
|
|
}{
|
|
{name: "in", want: "existing in\n"},
|
|
{name: "out", want: "existing out\n"},
|
|
} {
|
|
got, readErr := os.ReadFile(filepath.Join(target, tc.name))
|
|
if readErr != nil {
|
|
t.Fatalf("ReadFile(%q) error = %v", filepath.Join(target, tc.name), readErr)
|
|
}
|
|
if string(got) != tc.want {
|
|
t.Fatalf("%s = %q, want %q", tc.name, string(got), tc.want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestBuildRecordShellScriptUsesExpectedCommands(t *testing.T) {
|
|
body := buildRecordShellScript()
|
|
|
|
for _, want := range []string{
|
|
"host_home=${MIRO_RECORD_HOST_HOME:?}",
|
|
"host_tmp=${MIRO_RECORD_HOST_TMP:?}",
|
|
"project_root=${MIRO_RECORD_PROJECT_ROOT:?}",
|
|
"path_env=${MIRO_RECORD_PATH_ENV:?}",
|
|
"HOME=\"$host_home\" GIT_CONFIG_NOSYSTEM=1 git config --global user.name 'Miro Test'",
|
|
"--bind \"$host_home\" " + shQuote(recordVisibleHome),
|
|
"--ro-bind \"$project_root\" " + shQuote(recordVisibleRepo),
|
|
"--bind \"$host_tmp\" " + shQuote(recordVisibleTmp),
|
|
"--setenv HOME " + shQuote(recordVisibleHome),
|
|
"--setenv PATH \"$path_env\"",
|
|
"--setenv PS1 '$ '",
|
|
"--setenv TERM 'xterm-256color'",
|
|
"--setenv TZ 'UTC'",
|
|
"--chdir " + shQuote(recordVisibleHome),
|
|
"bash --noprofile --norc -i",
|
|
} {
|
|
if !strings.Contains(body, want) {
|
|
t.Fatalf("wrapper = %q, want substring %q", body, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRunRecordSessionUsesSandboxedScriptCommand(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
mustWriteRecordShell(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
|
|
argsPath := filepath.Join(t.TempDir(), "script.args")
|
|
commandBodyPath := filepath.Join(t.TempDir(), "script.command")
|
|
t.Setenv("FAKE_SCRIPT_ARGS_FILE", argsPath)
|
|
t.Setenv("FAKE_SCRIPT_COMMAND_BODY_FILE", commandBodyPath)
|
|
|
|
sandbox, cleanup, err := newRecordSandboxForProjectRoot(root, os.Getenv("PATH"))
|
|
if err != nil {
|
|
t.Fatalf("newRecordSandboxForProjectRoot() error = %v", err)
|
|
}
|
|
defer cleanup()
|
|
|
|
shellPath := recordShellPath(testDir)
|
|
err = withRecordStreams(t, "", func(rio recordIO) error {
|
|
return runRecordSession(root, filepath.Join(t.TempDir(), "raw.in"), filepath.Join(t.TempDir(), "raw.out"), shellPath, sandbox, rio)
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("runRecordSession() error = %v", err)
|
|
}
|
|
|
|
args := strings.Split(strings.TrimSpace(readFile(t, argsPath)), "\n")
|
|
if len(args) != 9 {
|
|
t.Fatalf("script args = %q, want 9 args", args)
|
|
}
|
|
if got := args[:4]; strings.Join(got, "\n") != strings.Join([]string{"-q", "-E", "always", "-I"}, "\n") {
|
|
t.Fatalf("script args prefix = %q, want %q", got, []string{"-q", "-E", "always", "-I"})
|
|
}
|
|
if args[5] != "-O" {
|
|
t.Fatalf("script args[5] = %q, want %q", args[5], "-O")
|
|
}
|
|
if args[7] != "-c" {
|
|
t.Fatalf("script args[7] = %q, want %q", args[7], "-c")
|
|
}
|
|
if args[8] != shellPath {
|
|
t.Fatalf("script args[8] = %q, want %q", args[8], shellPath)
|
|
}
|
|
|
|
body := readFile(t, commandBodyPath)
|
|
for _, want := range []string{
|
|
"host_home=${MIRO_RECORD_HOST_HOME:?}",
|
|
"--ro-bind / /",
|
|
"--tmpfs /home",
|
|
"--ro-bind \"$project_root\" " + shQuote(recordVisibleRepo),
|
|
"--setenv HOME " + shQuote(recordVisibleHome),
|
|
"--setenv TMPDIR " + shQuote(recordVisibleTmp),
|
|
"bash --noprofile --norc -i",
|
|
} {
|
|
if !strings.Contains(body, want) {
|
|
t.Fatalf("wrapper = %q, want substring %q", body, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRecordScenarioUsesDeterministicSandbox(t *testing.T) {
|
|
requireCommands(t, "script", "bwrap", "bash")
|
|
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
target := filepath.Join(testDir, "suite", "spec")
|
|
mustMkdirAll(t, target)
|
|
mustWriteRecordShell(t, testDir)
|
|
|
|
reader, writer, err := os.Pipe()
|
|
if err != nil {
|
|
t.Fatalf("os.Pipe() error = %v", err)
|
|
}
|
|
t.Cleanup(func() {
|
|
if err := reader.Close(); err != nil {
|
|
t.Fatalf("close pipe reader: %v", err)
|
|
}
|
|
})
|
|
|
|
writeDone := make(chan error, 1)
|
|
go func() {
|
|
defer close(writeDone)
|
|
defer writer.Close()
|
|
|
|
if _, err := writer.Write([]byte("pwd\necho \"$HOME\"\ncd repo\npwd\nexit\n")); err != nil {
|
|
writeDone <- err
|
|
return
|
|
}
|
|
|
|
time.Sleep(300 * time.Millisecond)
|
|
|
|
if _, err := writer.Write([]byte("y\n")); err != nil {
|
|
writeDone <- err
|
|
return
|
|
}
|
|
|
|
writeDone <- nil
|
|
}()
|
|
|
|
err = withWorkingDir(t, root, func() error {
|
|
return recordScenario(target, recordShellPath(testDir), recordIO{
|
|
in: reader,
|
|
out: ioDiscard{},
|
|
err: &bytes.Buffer{},
|
|
})
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("recordScenario() error = %v", err)
|
|
}
|
|
if err := <-writeDone; err != nil {
|
|
t.Fatalf("write session input: %v", err)
|
|
}
|
|
|
|
recordedIn := readFile(t, filepath.Join(target, "in"))
|
|
if strings.Contains(recordedIn, "Script started on ") {
|
|
t.Fatalf("saved in = %q, want stripped script wrapper", recordedIn)
|
|
}
|
|
for _, want := range []string{"pwd\n", "echo \"$HOME\"\n", "cd repo\n", "exit\n"} {
|
|
if !strings.Contains(recordedIn, want) {
|
|
t.Fatalf("saved in = %q, want substring %q", recordedIn, want)
|
|
}
|
|
}
|
|
|
|
recordedOut := readFile(t, filepath.Join(target, "out"))
|
|
if strings.Contains(recordedOut, "Script started on ") {
|
|
t.Fatalf("saved out = %q, want stripped script wrapper", recordedOut)
|
|
}
|
|
for _, want := range []string{recordVisibleHome, recordVisibleRepo} {
|
|
if !strings.Contains(recordedOut, want) {
|
|
t.Fatalf("saved out = %q, want substring %q", recordedOut, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRecordFailsWhenRecorderShellMissing(t *testing.T) {
|
|
root := t.TempDir()
|
|
testDir := filepath.Join(root, "e2e")
|
|
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"e2e\"\n")
|
|
mustMkdirAll(t, testDir)
|
|
addFakeRecordDependencies(t, "script")
|
|
|
|
target := filepath.Join(testDir, "suite", "spec")
|
|
err := withWorkingDir(t, root, func() error {
|
|
_, err := Record(filepath.Join("suite", "spec"))
|
|
return err
|
|
})
|
|
if err == nil {
|
|
t.Fatal("Record() error = nil, want error")
|
|
}
|
|
if !strings.Contains(err.Error(), "rerun `miro init`") {
|
|
t.Fatalf("Record() error = %q, want rerun init hint", err.Error())
|
|
}
|
|
if _, statErr := os.Stat(target); !os.IsNotExist(statErr) {
|
|
t.Fatalf("Stat(%q) error = %v, want not exists", target, statErr)
|
|
}
|
|
}
|
|
|
|
func withRecordStreams[T any](t *testing.T, input string, fn func(recordIO) T) T {
|
|
t.Helper()
|
|
|
|
path := filepath.Join(t.TempDir(), "stdin.txt")
|
|
if err := os.WriteFile(path, []byte(input), 0o644); err != nil {
|
|
t.Fatalf("WriteFile(%q) error = %v", path, err)
|
|
}
|
|
|
|
file, err := os.Open(path)
|
|
if err != nil {
|
|
t.Fatalf("Open(%q) error = %v", path, err)
|
|
}
|
|
|
|
t.Cleanup(func() {
|
|
if err := file.Close(); err != nil {
|
|
t.Fatalf("close record input: %v", err)
|
|
}
|
|
})
|
|
|
|
return fn(recordIO{
|
|
in: file,
|
|
out: ioDiscard{},
|
|
err: &bytes.Buffer{},
|
|
})
|
|
}
|
|
|
|
func withStdin(t *testing.T, input string, fn func()) {
|
|
t.Helper()
|
|
|
|
path := filepath.Join(t.TempDir(), "stdin.txt")
|
|
if err := os.WriteFile(path, []byte(input), 0o644); err != nil {
|
|
t.Fatalf("WriteFile(%q) error = %v", path, err)
|
|
}
|
|
|
|
file, err := os.Open(path)
|
|
if err != nil {
|
|
t.Fatalf("Open(%q) error = %v", path, err)
|
|
}
|
|
|
|
oldStdin := os.Stdin
|
|
os.Stdin = file
|
|
t.Cleanup(func() {
|
|
os.Stdin = oldStdin
|
|
if err := file.Close(); err != nil {
|
|
t.Fatalf("close stdin file: %v", err)
|
|
}
|
|
})
|
|
|
|
fn()
|
|
}
|
|
|
|
func readFile(t *testing.T, path string) string {
|
|
t.Helper()
|
|
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
t.Fatalf("ReadFile(%q) error = %v", path, err)
|
|
}
|
|
|
|
return string(data)
|
|
}
|
|
|
|
type ioDiscard struct{}
|
|
|
|
func (ioDiscard) Write(p []byte) (int, error) {
|
|
return len(p), nil
|
|
}
|
|
|
|
func addFakeRecordDependencies(t *testing.T, names ...string) {
|
|
t.Helper()
|
|
|
|
binDir := t.TempDir()
|
|
for _, name := range names {
|
|
path := filepath.Join(binDir, name)
|
|
body := "#!/bin/sh\nexit 0\n"
|
|
if name == "script" {
|
|
body = "#!/bin/sh\nif [ -n \"${FAKE_SCRIPT_ARGS_FILE:-}\" ]; then\n : > \"$FAKE_SCRIPT_ARGS_FILE\"\n for arg in \"$@\"; do\n printf '%s\\n' \"$arg\" >> \"$FAKE_SCRIPT_ARGS_FILE\"\n done\nfi\nin=''\nout=''\ncmd=''\nwhile [ \"$#\" -gt 0 ]; do\n case \"$1\" in\n -I)\n in=\"$2\"\n shift 2\n ;;\n -O)\n out=\"$2\"\n shift 2\n ;;\n -c)\n cmd=\"$2\"\n shift 2\n ;;\n *)\n shift\n ;;\n esac\ndone\nif [ -n \"${FAKE_SCRIPT_COMMAND_BODY_FILE:-}\" ] && [ -n \"$cmd\" ]; then\n : > \"$FAKE_SCRIPT_COMMAND_BODY_FILE\"\n while IFS= read -r line || [ -n \"$line\" ]; do\n printf '%s\\n' \"$line\" >> \"$FAKE_SCRIPT_COMMAND_BODY_FILE\"\n done < \"$cmd\"\nfi\nif [ -n \"${FAKE_SCRIPT_LOG_IN+x}\" ]; then\n printf '%s' \"$FAKE_SCRIPT_LOG_IN\" > \"$in\"\nelse\n printf '%s' 'fake recorded input\n' > \"$in\"\nfi\nif [ -n \"${FAKE_SCRIPT_LOG_OUT+x}\" ]; then\n printf '%s' \"$FAKE_SCRIPT_LOG_OUT\" > \"$out\"\nelse\n printf '%s' 'Script started on 2026-03-18 11:13:38+00:00 [TERM=\"xterm-256color\"]\nfake recorded output\nScript done on 2026-03-18 11:13:44+00:00 [COMMAND_EXIT_CODE=\"0\"]\n' > \"$out\"\nfi\nexit 0\n"
|
|
}
|
|
if err := os.WriteFile(path, []byte(body), 0o755); err != nil {
|
|
t.Fatalf("WriteFile(%q) error = %v", path, err)
|
|
}
|
|
}
|
|
|
|
t.Setenv("PATH", binDir)
|
|
}
|
|
|
|
func requireCommands(t *testing.T, names ...string) {
|
|
t.Helper()
|
|
|
|
for _, name := range names {
|
|
if _, err := exec.LookPath(name); err != nil {
|
|
t.Skipf("missing command %q: %v", name, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func mustWriteRecordShell(t *testing.T, testDir string) {
|
|
t.Helper()
|
|
|
|
if err := writeRecordShell(testDir); err != nil {
|
|
t.Fatalf("writeRecordShell(%q) error = %v", testDir, err)
|
|
}
|
|
}
|