seriesoftubes/.claude/skills/write-tests/SKILL.md
Frederic Jung 05ff4ea7ad
Docs and guard rails: GitHub Pages only, where code goes, updated skills
- docs/adr/0001: GitHub Pages is the only host, not open for renegotiation
- docs/adr/0002: source in many files, shipped as one page assembled at build
- tests/pages.test.js: builds stay static files Pages can serve, all local
  references resolve, only release.yml deploys and only via the Pages actions
- tests/build.test.js: partial naming and layout rules
- new skills: github-pages, edit-the-game; add-strings, performance, release
  and write-tests updated for src/, sorted dictionaries and --base-ref
- CLAUDE.md, ARCHITECTURE.md, CONTRIBUTING.md (incl. porting older branches),
  README.md and the PR template describe the new layout
2026-10-27 10:15:12 +01:00

2.4 KiB

name description
write-tests Write deterministic jsdom tests for Series of Tubes features and fixes in tests/*.test.js.

Writing tests

Tests use node:test and tests/harness.js, which assembles the game page from src/ (once per test file) and loads it in jsdom with the animation loop off, a seeded Math.random and a recording fake canvas. Code runs inside the page through ev().

Pattern

const test = require('node:test');
const assert = require('node:assert/strict');
const { load } = require('./harness');

test('what the player should see happen', () => {
  const { ev, errors } = load();
  ev("ACT.start({});S.cash=1e8;for(const g of GOALS)S.done[g.id]=0;ACT.launchBB({city:'fra'})");
  ev("ACT.buyTransit({city:'fra',net:'cog',tier:1});compute()");
  assert.ok(ev("R.served") > 0);
  assert.deepEqual(errors, []);   // always: no page errors
});

Where to put it

Pick the suite by topic: game (core loop), build, persist (save/import/migrate), services (customers), peering, issues (GitHub issue regressions, name them #NN …), regions, modes (scenarios, sandbox, weekly), i18n, pages (hosting). For a new feature, prefer a new file named after it (tests/route-servers.test.js): every tests/*.test.js runs on its own (scripts/test.js), and a file of your own never conflicts with someone else's tests. Appending to the big suites (issues, regions) is where pull requests collide. Run one file with npm test -- tests/route-servers.test.js.

Rules

  • Deterministic. Never rely on luck. Use the default seed, window.__reseed(n), or set state directly (S.day=…, S.ev.x=…).
  • Force a specific random failure or event by patching the picker:
    ev("eval('('+fireFailure.toString().replace('const e=pick(opts);',\"const e='crash';\")+')')()");
    
    Check the current source for the exact pick line first (grep -rn "function fireFailure" src/game); it may differ.
  • Drive the game through ACT like a player would, then compute() or dayTick().
  • Saves: for persistence changes, round-trip JSON.stringify(S) through parseSave()/migrate(), and test that an old save without the new field still loads.
  • UI: render with renderAll() and query dom.window.document; check phone layouts by setting window.innerWidth = 390 before rendering.
  • Run npm test; the whole suite must pass, not just the new test.