| index b8711d2d9..ae9398bb1 100644 |
| --- a/main_test.go |
| +++ b/main_test.go |
| @@ -1,16 +1,164 @@ |
| package main |
| |
| import ( |
| + "errors" |
| + "fmt" |
| "os" |
| + "path/filepath" |
| + "runtime" |
| + "strings" |
| "testing" |
| ) |
| |
| -// TestMain keeps an exported deploy token out of the root package's tests. |
| -// resolveMode reads CARLOS_SERVICE_TOKEN, and a CI shell running `go test` |
| -// may well export one. In-process tests that call run() or a verb directly |
| -// would then inherit it. Tests that want a token set it with t.Setenv, which |
| -// still works after this Unsetenv. |
| +// TestMain keeps the operator's own state out of the root package's tests. |
| +// |
| +// An exported deploy token: resolveMode reads CARLOS_SERVICE_TOKEN, and a CI |
| +// shell running `go test` may well export one. In-process tests that call |
| +// run() or a verb directly would then inherit it. Tests that want a token set |
| +// it with t.Setenv, which still works after this Unsetenv. |
| +// |
| +// The operator's .carlos/config: see isolateTempRoot. The binary refuses to |
| +// run rather than work under one. |
| func TestMain(m *testing.M) { |
| os.Unsetenv("CARLOS_SERVICE_TOKEN") |
| - os.Exit(m.Run()) |
| + moved, cleanup, err := isolateTempRoot([]string{"/var/tmp", "/tmp"}) |
| + if err != nil { |
| + fmt.Fprintln(os.Stderr, err) |
| + os.Exit(1) |
| + } |
| + if moved != "" { |
| + fmt.Fprintln(os.Stderr, moved) |
| + } |
| + code := m.Run() |
| + cleanup() |
| + os.Exit(code) |
| +} |
| + |
| +// isolateTempRoot makes sure no .carlos/config sits above the directory |
| +// t.TempDir() hands out, before any test asks for one. |
| +// |
| +// The tests pin HOME, but the CLI's config discovery (config.go |
| +// walkConfigFiles) walks up from the working directory, and that directory |
| +// is a t.TempDir() for every test that uses useTempCredentials or runs the |
| +// binary from a scratch cmd.Dir. Where the temp root is inside a logged-in |
| +// operator's home (TMPDIR=~/.cache/tmp/..., the default in a sandboxed agent |
| +// session) the walk reached the real ~/.carlos/config: two dozen tests |
| +// failed with "not logged in" to the operator's console, and one offered a |
| +// re-login to it and waited ten minutes (#226, #258). Pinning CARLOS_CONFIG |
| +// in the shared helpers is not the fix, because it switches discovery off |
| +// for the tests that write a .carlos/config of their own. |
| +// |
| +// A temp root with nothing above it is left alone, which is every CI run. |
| +// Otherwise the tests get a fresh directory under the first of bases that is |
| +// clear, through TMPDIR so that child processes follow: moved says where, |
| +// and the returned cleanup removes it. When none can be made the error says |
| +// so and TestMain stops. |
| +func isolateTempRoot(bases []string) (moved string, cleanup func(), err error) { |
| + root := os.TempDir() |
| + found := configAbove(root) |
| + if found == "" { |
| + return "", func() {}, nil |
| + } |
| + for _, base := range bases { |
| + dir, err := os.MkdirTemp(base, "carlos-test-") |
| + if err != nil { |
| + continue |
| + } |
| + os.Setenv("TMPDIR", dir) |
| + // Asked of os.TempDir() again rather than assumed: the base may sit |
| + // under a config too, and not every platform reads TMPDIR. |
| + if configAbove(os.TempDir()) == "" { |
| + moved = fmt.Sprintf("carlos tests: %s is above the temp directory %s, so the tests work in %s instead", found, root, dir) |
| + return moved, func() { os.RemoveAll(dir) }, nil |
| + } |
| + os.Remove(dir) |
| + } |
| + return "", nil, fmt.Errorf("carlos tests: %s is above the temp directory %s and the CLI's config walk would read it; set TMPDIR to a directory with no .carlos/config above it", found, root) |
| +} |
| + |
| +// configAbove is the first .carlos/config the CLI's discovery would read |
| +// walking up from dir, "" when there is none. The walk is over the path as |
| +// written, which is what discovery follows after a t.Chdir, and over the |
| +// path with its symlinks resolved, which is what it follows when PWD is |
| +// unset. Anything but "does not exist" counts as there: discovery fails on |
| +// a config it cannot read. |
| +func configAbove(dir string) string { |
| + if abs, err := filepath.Abs(dir); err == nil { |
| + dir = abs |
| + } |
| + starts := []string{dir} |
| + if resolved, err := filepath.EvalSymlinks(dir); err == nil && resolved != dir { |
| + starts = append(starts, resolved) |
| + } |
| + for _, d := range starts { |
| + for { |
| + path := filepath.Join(d, ".carlos", "config") |
| + if _, err := os.Stat(path); !errors.Is(err, os.ErrNotExist) { |
| + return path |
| + } |
| + parent := filepath.Dir(d) |
| + if parent == d { |
| + break |
| + } |
| + d = parent |
| + } |
| + } |
| + return "" |
| +} |
| + |
| +// The guard, against a tree of its own: a temp root under a config moves to |
| +// the first base that is clear, the move is undone by the cleanup alone, |
| +// and with no clear base the binary is told to stop. |
| +func TestIsolateTempRoot(t *testing.T) { |
| + if p := configAbove(os.TempDir()); p != "" { |
| + t.Fatalf("TestMain let the tests run with %s above the temp directory", p) |
| + } |
| + if runtime.GOOS == "windows" { |
| + t.Skip("os.TempDir does not read TMPDIR on windows, so there is no moving it") |
| + } |
| + |
| + home := t.TempDir() |
| + planted := writeConfig(t, home, `{"console": "https://operator.example"}`) |
| + under := filepath.Join(home, "cache", "tmp") |
| + alsoUnder := filepath.Join(home, "var") |
| + clear := t.TempDir() |
| + for _, d := range []string{under, alsoUnder} { |
| + if err := os.MkdirAll(d, 0o755); err != nil { |
| + t.Fatal(err) |
| + } |
| + } |
| + if got := configAbove(under); got != planted { |
| + t.Fatalf("configAbove(%s) = %q, want %s", under, got, planted) |
| + } |
| + |
| + t.Setenv("TMPDIR", under) |
| + said, cleanup, err := isolateTempRoot([]string{filepath.Join(home, "missing"), alsoUnder, clear}) |
| + if err != nil { |
| + t.Fatal(err) |
| + } |
| + moved := os.TempDir() |
| + if filepath.Dir(moved) != clear || !strings.Contains(said, planted) || !strings.Contains(said, moved) { |
| + t.Fatalf("the temp root moved to %s (%q), want a directory under %s and both paths named", moved, said, clear) |
| + } |
| + if left, _ := os.ReadDir(alsoUnder); len(left) != 0 { |
| + t.Fatalf("the refused base kept %v", left) |
| + } |
| + cleanup() |
| + if _, err := os.Stat(moved); !errors.Is(err, os.ErrNotExist) { |
| + t.Fatalf("the cleanup left %s (%v)", moved, err) |
| + } |
| + if _, err := os.Stat(clear); err != nil { |
| + t.Fatalf("the cleanup took the base with it: %v", err) |
| + } |
| + |
| + t.Setenv("TMPDIR", under) |
| + if _, _, err := isolateTempRoot([]string{alsoUnder}); err == nil || !strings.Contains(err.Error(), planted) { |
| + t.Fatalf("no clear base = %v, want an error naming %s", err, planted) |
| + } |
| + |
| + // A clear temp root is not moved at all. |
| + t.Setenv("TMPDIR", clear) |
| + if said, _, err := isolateTempRoot([]string{filepath.Join(home, "missing")}); err != nil || said != "" || os.TempDir() != clear { |
| + t.Fatalf("a clear temp root = %s, %q, %v; want it left alone", os.TempDir(), said, err) |
| + } |
| } |
amadan