vrr/spawn
2
0
Fork 0
mirror of https://github.com/OpenRouterTeam/spawn.git synced 2026-04-28 11:59:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spawn/.claude/rules/testing.md
A d4328f38c2
fix: correct DigitalOcean default droplet size in README and stale getUserHome path (#2513) 
DO_DROPLET_SIZE default documented as s-2vcpu-4gb ($24/mo) but code and manifest
both use s-2vcpu-2gb ($18/mo). Also fixes stale getUserHome() source reference in
testing rules (shared/paths.ts, not shared/ui.ts).

Agent: code-health

Co-authored-by: B <6723574+louisgv@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-03-11 21:25:30 -07:00

1.3 KiB
Raw Blame History

Testing

  • NEVER use vitest — use Bun's built-in test runner (bun:test) exclusively
  • Test files go in packages/cli/src/__tests__/
  • Run tests with bun test
  • 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/paths.ts) — it reads process.env.HOME first
  • The fs-sandbox.test.ts guardrail test verifies the sandbox is active