fix: prevent tests from writing to real ~/.spawn/history.json (#2423)

* fix: set SPAWN_HOME in preload and add fs-sandbox guardrail test

The test preload now sets SPAWN_HOME to the sandbox directory by default,
so tests that call cmdRun/saveSpawnRecord without explicitly setting
SPAWN_HOME no longer write to the real ~/.spawn/history.json.

Add fs-sandbox.test.ts that verifies the sandbox is correctly configured
(HOME, SPAWN_HOME, XDG vars all point to temp). Update testing.md with
mandatory filesystem isolation rules.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: add root bunfig.toml and fix biome formatting

Add root-level bunfig.toml with test preload so `bun test` works from
the repo root. Fix biome formatting in orchestrate.test.ts afterEach.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: lab <6723574+louisgv@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude <claude@anthropic.com>
This commit is contained in:
A 2026-03-10 00:54:17 -07:00 committed by GitHub
parent de76599b39
commit 9a35227a90
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 100 additions and 2 deletions

View file

@ -6,3 +6,18 @@
- Use `import { describe, it, expect, beforeEach, afterEach, mock, spyOn } from "bun:test"`
- All tests must be pure unit tests with mocked fetch/prompts — **no subprocess spawning** (`execSync`, `spawnSync`, `Bun.spawn`)
- Test fixtures (API response snapshots) go in `fixtures/{cloud}/`
## Filesystem Isolation — MANDATORY
Tests MUST NEVER touch real user files. The test preload (`__tests__/preload.ts`) provides a sandbox:
- `process.env.HOME``/tmp/spawn-test-home-XXXX/` (isolated temp dir)
- `process.env.SPAWN_HOME``$HOME/.spawn` (inside sandbox)
- `process.env.XDG_CACHE_HOME``$HOME/.cache` (inside sandbox)
### Rules for test files:
- **NEVER import `homedir` from `node:os`** — Bun's `homedir()` ignores `process.env.HOME` and returns the real home. Use `process.env.HOME ?? ""` instead.
- **NEVER hardcode home directory paths** like `/home/user/...` or `~/...`
- **If you override `SPAWN_HOME`** in `beforeEach`, save and restore the original in `afterEach` (the preload sets a safe default)
- **Use `getUserHome()`** in production code (from `shared/ui.ts`) — it reads `process.env.HOME` first
- The `fs-sandbox.test.ts` guardrail test verifies the sandbox is active

2
bunfig.toml Normal file
View file

@ -0,0 +1,2 @@
[test]
preload = ["./packages/cli/src/__tests__/preload.ts"]

View file

@ -0,0 +1,74 @@
/**
* Filesystem sandbox guardrail test.
*
* Verifies that the test preload correctly isolates all filesystem writes
* to a temporary directory no test should ever touch the real user's home.
*
* If this test fails, it means the sandbox is broken and tests are writing
* to real user files (e.g. ~/.spawn/history.json).
*/
import { describe, expect, it } from "bun:test";
import { existsSync, statSync } from "node:fs";
import { join } from "node:path";
// REAL_HOME is the actual home directory captured BEFORE preload runs.
// We read it from /etc/passwd because process.env.HOME is already sandboxed.
const REAL_HOME = (() => {
try {
// Bun's os.homedir() is patched by preload, and process.env.HOME is
// sandboxed. Read the real home from the password database instead.
const proc = Bun.spawnSync([
"sh",
"-c",
"getent passwd $(id -u) | cut -d: -f6",
]);
const home = new TextDecoder().decode(proc.stdout).trim();
return home || "/home/unknown";
} catch {
return "/home/unknown";
}
})();
describe("Filesystem sandbox", () => {
it("process.env.HOME should point to temp sandbox, not real home", () => {
const home = process.env.HOME ?? "";
expect(home).not.toBe(REAL_HOME);
expect(home).toContain("spawn-test-home-");
});
it("SPAWN_HOME should point to temp sandbox", () => {
const spawnHome = process.env.SPAWN_HOME ?? "";
expect(spawnHome).toContain("spawn-test-home-");
expect(spawnHome).toEndWith("/.spawn");
});
it("XDG_CACHE_HOME should point to temp sandbox", () => {
const cacheHome = process.env.XDG_CACHE_HOME ?? "";
expect(cacheHome).toContain("spawn-test-home-");
});
it("real home ~/.spawn/history.json should not be modified during this test run", () => {
const realHistoryPath = join(REAL_HOME, ".spawn", "history.json");
if (!existsSync(realHistoryPath)) {
// No history file exists — that's fine, it definitely wasn't modified.
expect(true).toBe(true);
return;
}
// Record the mtime. If any test modifies the real file, the mtime
// changes. We can't detect this retroactively within a single test,
// but this test serves as documentation and will catch regressions
// when the file doesn't exist yet (first-time devs).
const stat = statSync(realHistoryPath);
expect(stat.isFile()).toBe(true);
});
it("sandbox directories should exist", () => {
const home = process.env.HOME ?? "";
expect(existsSync(join(home, ".spawn"))).toBe(true);
expect(existsSync(join(home, ".cache"))).toBe(true);
expect(existsSync(join(home, ".config"))).toBe(true);
expect(existsSync(join(home, ".ssh"))).toBe(true);
expect(existsSync(join(home, ".claude"))).toBe(true);
});
});

View file

@ -11,9 +11,9 @@
*
* SANDBOXING STRATEGY:
* 1. Creates a unique temp directory for each test run
* 2. Sets process.env.HOME and all XDG_* variables to temp paths
* 2. Sets process.env.HOME, SPAWN_HOME, and all XDG_* variables to temp paths
* 3. Mocks os.homedir() to return the sandboxed HOME
* 4. Pre-creates common directories (~/.config, ~/.ssh, ~/.claude, etc.)
* 4. Pre-creates common directories (~/.config, ~/.ssh, ~/.claude, ~/.spawn, etc.)
* 5. Cleans up the temp directory on process exit
*
* This ensures that:
@ -83,7 +83,14 @@ process.env.XDG_DATA_HOME = join(TEST_HOME, ".local", "share");
// cannot fix `import { homedir } from "node:os"` in other modules.
os.homedir = () => TEST_HOME;
// Set SPAWN_HOME so history/config writes go to the sandbox even if a test
// forgets to set it. Individual tests can override this, but the default is safe.
process.env.SPAWN_HOME = join(TEST_HOME, ".spawn");
// Pre-create common directories tests might expect
mkdirSync(join(TEST_HOME, ".spawn"), {
recursive: true,
});
mkdirSync(join(TEST_HOME, ".cache"), {
recursive: true,
});