* test(#2874): add failing-first gate for the executed-plan return Four rows from the matrix's red-first order. E3 pins the one early return, for the opencode family, where a void-shaped hole would otherwise survive unnoticed. E13 sweeps every runtime in the registry - enumerated from the registry rather than hardcoded, so a runtime added later cannot slip past. F2 proves absence of real filesystem contact rather than merely that the happy path ran, which is the difference between a complete seam and a partial one. G1 and G3 are the additive guard and must be green before and after. G3 deliberately leaves the two existing adapter test doubles untouched: if this change required editing them it would not be additive, and the acceptance criterion would be unmet. No production code. All 19 runtimes install without throwing today, so E3 and E13 fail on the undefined comparison alone. Refs #2874 * feat(#2874): return the executed plan and route install IO through a seam installRuntimeArtifacts returned void, so its correctness was observable only by re-reading disk. It now returns what it executed - per kind, per scope - including on the combinedFamilyInstall path, which was the one early return where a void-shaped hole would have survived unnoticed. Failure still throws rather than becoming an ok:false return, so control flow is unchanged for both existing callers. A best-effort cleanup that fails is still swallowed, but is now visible in the returned value rather than silently absent. The fs seam is ambient rather than threaded. Explicit deps through install-profiles and the 3000-line conversion module was impractical; the tradeoff, the synchronous-only re-entrancy assumption, the restore guarantee and the partial-adapter fallback trap are all documented at the seam. findInstallSourceRoot and its sibling stay unrouted by design - they locate the package's own source, not the install destination. readCmdNames keeps a second implementation because the standalone CLI that owns the original cannot require the compiled adapter without a build-order dependency on its own output. A parity test fails if the two ever disagree. Refs #2874 * chore(#2874): gitignore the new build artifact install-fs-adapter.cjs is tsc output from src/install-fs-adapter.cts, not a tracked source file. It was added to eslint's ignore list but not to .gitignore, so it landed as a tracked file - the third time this step of the new-.cts ripple has been missed on this epic. Refs #2874 * fix(#2874): close two seam leaks and correct a false comment A correctness review found the seam still leaked in two places, both subtler than the three already closed. readGsdCommandNames was routed when it should not have been: it reads the package's own commands directory, which a destination-fake is never seeded with, so under a fake adapter it returned an empty or wrong roster instead of failing loudly. It now reads real fs, matching the precedent already documented for findInstallSourceRoot. cleanupStagedSkills ran raw rmSync from a process exit handler, which is real filesystem work deferred past the point where withInstallFs has restored - the one thing the synchronous-only contract exists to exclude. Staging now captures the adapter that created each directory and cleanup replays it, so a real install cleans up exactly as before and a fake-staged path never reaches the real filesystem. Also corrected a comment claiming the migration reads were an unrouted, untested residual gap. They are routed and exercised; a comment understating the seam is as corrosive as one overstating it in a module whose trust rests on being honestly documented. Refs #2874 * test(#2874): migrate the exemplar group and cover the matrix AC3's exemplar migration lands in place: the qwen install group now asserts skills and agents destinations from the returned plan in one deepStrictEqual instead of probing the filesystem for each. Nine facts the old probes established were enumerated first. Two moved to the value assertion; seven were retained deliberately - per-file SKILL.md existence, the VERSION file written outside this function, the manifest content, and the post-uninstall absence checks all sit outside the plan's per-kind contract. A migration that quietly asserts less looks like a win and is a regression, so the enumeration is the guard rather than the line count. Also implements the rest of the matrix: the executed-plan shape, adapter failure modes, the security-boundary rows including a fake that cannot certify an install the real filesystem would refuse, cleanup visibility, and two seeded property tests. Only the two external CI gates are left unticked, because self-certifying them would be a claim rather than a check. Refs #2874 * fix(#2874): restore streaming hashes and derive F2 from the boundary rule The checkpoint found three things reasoning had missed. sha256File had been converted from raw-fd streaming to a single readFileSync on the assumption that GSD artifacts are never large. A test named for exactly that contract already existed and went red. Streaming is restored, now routed through the adapter, which gains openSync, readSync and closeSync. The contract was the specification; the assumption was not. Three existing tests inject faults by monkeypatching real fs. They broke because mkInstallTempDir stopped calling real mkdtempSync, not because of any binding subtlety - the real adapter was already late-bound. It now calls the real function when no fake is injected, so a monkeypatch applied after import is still seen and the additive contract holds. F2 poisoned real fs by method, so a deliberately unrouted package-source read failed a correct design. It now poisons by path: destination IO is forbidden, package-source IO is allowed and positively asserted. The claim was always zero real destination IO, and the test now derives from that rule instead of coincidentally matching it. Refs #2874 * docs(#2874): add the contributor how-to for plan-based test migration The phase gate caught a real gap. The docs plan was Reference plus Explanation only, and every CI check would have passed, because the docs-required lint only verifies that some file under docs/ moved. But this phase exists to demonstrate a pattern for follow-on work, and that work is other contributors migrating probing test groups. The sequence has two live traps - a partial fake silently falls back to real fs, and the seam is ambient and synchronous-only - plus one discipline nobody infers: enumerate the facts before converting, or you assert less and call it a win. The page carries the qwen migration's arithmetic, nine facts enumerated and only two converted, because a reader seeing only the diff would reasonably conclude the pattern is to replace probes wholesale. No locale mirrors: none of the four carries any contributor-only how-to, so a single translated file would manufacture parity rather than provide it. Refs #2874 * chore(#2874): backfill changeset pr number * test(#2874): normalize both sides of the G1 tree comparison G1 failed on Windows only, deterministically on both shards. The defect was in the test helper, not production. _computePathPrefix posix-normalizes the resolved config dir unconditionally, so on Windows the path embedded in every emitted SKILL.md body is forward-slash form. hashDirTree stripped against the raw backslash path from mkdtempSync, so the substring never matched and each install's unique temp suffix stayed baked into every file - all fifteen skill bodies hashed differently for two runs that had written identical bytes. Both sides are now normalized unconditionally rather than gated on path.sep, matching the rule this repo already records: backslash paths arrive on Linux too. Production code is untouched and was verified correct. Normalizing this away on the production side would have hidden a real portability bug if one had existed. Refs #2874 --------- Co-authored-by: sim <sim@local>
This commit is contained in:
@@ -7014,3 +7014,119 @@ describe('#2873 C1-C6 — install-time shadow report (spawned installer wiring)'
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// ─── #2874 (epic #2866 Phase 5) — G1/G3: the additive-contract guard ────────
|
||||
// Governed by ADR-58 (docs/adr/58-runtime-install-policy-module.md).
|
||||
// Design: .gsd/phase/feat-2874-executed-plan-return/40-design.md
|
||||
// Test matrix: .gsd/phase/feat-2874-executed-plan-return/50-test-matrix.md
|
||||
//
|
||||
// G1 and G3 must be GREEN both BEFORE and AFTER the executed-plan return
|
||||
// lands — they are the guard proving the return value is additive (AC4),
|
||||
// never a behavior change. No production code is touched by this file.
|
||||
|
||||
/**
|
||||
* Recursively hash a directory tree into a stable, order-independent digest.
|
||||
* `stripDir`, if given, is textually removed from each UTF-8-decodable
|
||||
* file's content before hashing, so two installs into DIFFERENT temp
|
||||
* directories (whose absolute paths get baked into rewritten skill bodies)
|
||||
* can still be compared for content-identity.
|
||||
*
|
||||
* Both `stripDir` and the file content are normalized to forward slashes
|
||||
* before the strip, unconditionally (never gated on `path.sep`) — production
|
||||
* (`posixNormalize` in shell-command-projection.cts) rewrites `\` -> `/` in
|
||||
* the resolved configDir before baking it into skill bodies, so on Windows
|
||||
* `stripDir` (a raw fs.mkdtempSync path, backslash-separated) would never
|
||||
* match the posix-normalized text actually written, leaving each install's
|
||||
* unique temp-dir suffix embedded and making every file's hash diverge.
|
||||
*/
|
||||
function hashDirTree(rootDir, stripDir) {
|
||||
const entries = [];
|
||||
const stripDirPosix = stripDir ? stripDir.replace(/\\/g, '/') : stripDir;
|
||||
const walk = (relPath, absPath) => {
|
||||
for (const entry of fs.readdirSync(absPath, { withFileTypes: true })
|
||||
.sort((a, b) => a.name.localeCompare(b.name))) {
|
||||
const childRel = relPath ? `${relPath}/${entry.name}` : entry.name;
|
||||
const childAbs = path.join(absPath, entry.name);
|
||||
if (entry.isDirectory()) {
|
||||
walk(childRel, childAbs);
|
||||
} else if (entry.isFile()) {
|
||||
const buf = fs.readFileSync(childAbs);
|
||||
const normalized = stripDirPosix
|
||||
? buf.toString('utf8').replace(/\\/g, '/').split(stripDirPosix).join('<CONFIGDIR>')
|
||||
: buf;
|
||||
entries.push(`${childRel}:${crypto.createHash('sha256').update(normalized).digest('hex')}`);
|
||||
}
|
||||
}
|
||||
};
|
||||
if (fs.existsSync(rootDir)) walk('', rootDir);
|
||||
return entries.sort().join('\n');
|
||||
}
|
||||
|
||||
describe('installRuntimeArtifacts — G1: void-ignoring caller is unaffected (AC4)', () => {
|
||||
test('writes are byte-identical whether or not the caller uses the return value', (t) => {
|
||||
const configDirIgnored = createTempDir('gsd-g1-ignored-');
|
||||
const configDirCaptured = createTempDir('gsd-g1-captured-');
|
||||
t.after(() => cleanup(configDirIgnored));
|
||||
t.after(() => cleanup(configDirCaptured));
|
||||
|
||||
// Caller A: discards the return value entirely — today's every call site
|
||||
// (bin/install.js, both existing adapter test doubles).
|
||||
installRuntimeArtifacts('claude', configDirIgnored, 'global', RESOLVED_CORE);
|
||||
|
||||
// Caller B: captures the return value. Its shape is not asserted here —
|
||||
// section E owns that — only that capturing it changes nothing about
|
||||
// what gets written, and that capturing never itself throws.
|
||||
const captured = installRuntimeArtifacts('claude', configDirCaptured, 'global', RESOLVED_CORE);
|
||||
assert.ok(
|
||||
captured === undefined || (captured !== null && typeof captured === 'object'),
|
||||
'G1: the return value, whatever its shape, must be undefined (today) or a plain object ' +
|
||||
'(after) — never something a capturing caller could not safely ignore',
|
||||
);
|
||||
|
||||
assert.strictEqual(
|
||||
hashDirTree(configDirCaptured, configDirCaptured),
|
||||
hashDirTree(configDirIgnored, configDirIgnored),
|
||||
'G1: writes must be byte-identical regardless of whether the caller captures the return value',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('installRuntimeArtifacts — G3: adapter calling-convention regression guard', () => {
|
||||
// tests/adapter-declarative-equivalence.test.cjs:52 and
|
||||
// tests/adapter-imperative.test.cjs:80 pin their OWN behavior via a
|
||||
// module-ref monkeypatch of installRuntimeArtifacts — neither file ever
|
||||
// invokes the real function, and neither is read or modified here. This
|
||||
// row proves those two files' SUBJECT — the real installRuntimeArtifacts,
|
||||
// called with the exact positional shape each adapter uses — still
|
||||
// behaves: a real, successful, byte-on-disk install.
|
||||
|
||||
test('declarative-adapter call shape (5 positional args, no capabilityRegistry) still installs', (t) => {
|
||||
const configDir = createTempDir('gsd-g3-declarative-');
|
||||
t.after(() => cleanup(configDir));
|
||||
|
||||
// Matches tests/adapter-declarative-equivalence.test.cjs:62-66's
|
||||
// captured shape: [runtime, configDir, scope, resolvedProfile, resolveAttribution].
|
||||
const resolveAttribution = () => 'attr-claude';
|
||||
installRuntimeArtifacts('claude', configDir, 'global', RESOLVED_CORE, resolveAttribution);
|
||||
|
||||
assert.ok(
|
||||
fs.existsSync(path.join(configDir, 'skills', 'gsd-help', 'SKILL.md')),
|
||||
'G3: the declarative adapter\'s calling convention must still produce a real install',
|
||||
);
|
||||
});
|
||||
|
||||
test('imperative-adapter call shape (6 positional args incl. composed capability registry) still installs', (t) => {
|
||||
const configDir = createTempDir('gsd-g3-imperative-');
|
||||
t.after(() => cleanup(configDir));
|
||||
|
||||
// Matches tests/adapter-imperative.test.cjs:88's captured shape:
|
||||
// [runtime, configDir, scope, resolvedProfile, resolveAttribution, capabilityRegistry].
|
||||
const capabilityRegistry = { capabilityClusters: {} };
|
||||
installRuntimeArtifacts('claude', configDir, 'global', RESOLVED_CORE, undefined, capabilityRegistry);
|
||||
|
||||
assert.ok(
|
||||
fs.existsSync(path.join(configDir, 'skills', 'gsd-help', 'SKILL.md')),
|
||||
'G3: the imperative adapter\'s calling convention must still produce a real install',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user