'use strict'; /** * Regression tests for issue #844: manifest version sync. * * Verifies that `scripts/sync-manifest-versions.cjs` correctly stamps the * package.json version into every registered runtime-integration manifest, * and that all currently-tracked manifests are in sync. * * Key deliverable: the regression guard (test d) asserts that any committed * JSON file with a top-level `version` field matching package.json is * registered in VERSIONED_MANIFESTS — forcing explicit opt-in for future * manifests. */ const { test, describe, before, after } = require('node:test'); const assert = require('node:assert/strict'); const fs = require('fs'); const os = require('os'); const path = require('path'); const { execFileSync } = require('child_process'); const ROOT = path.resolve(__dirname, '..'); const helpers = require(path.join(__dirname, 'helpers.cjs')); const { VERSIONED_MANIFESTS, VERSIONED_MANIFEST_PATHS, getByPath, setByPath, syncManifestVersions, getPackageVersion, stageManifests, listCapabilityManifests, syncCapabilityVersions, } = require(path.join(ROOT, 'scripts', 'sync-manifest-versions.cjs')); // ─── A: RED→GREEN repro via temp fixture ───────────────────────────────────── // // Each test in this describe operates on a single per-describe tmpRoot that is // created in before() and torn down in after(). There are no setup/cleanup // test() nodes — order-independence is guaranteed by the lifecycle hooks. describe('A: syncManifestVersions — temp fixture', () => { let tmpRoot; before(() => { tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-')); // Write tmp package.json fs.writeFileSync( path.join(tmpRoot, 'package.json'), JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n' ); // Copy real manifests into tmp, stamped at OLD version so tests can // verify the pre-sync (stale) state and post-sync (updated) state. for (const entry of VERSIONED_MANIFESTS) { const realAbs = path.join(ROOT, entry.path); const manifest = JSON.parse(fs.readFileSync(realAbs, 'utf8')); setByPath(manifest, entry.versionKey, '0.0.0'); const destAbs = path.join(tmpRoot, entry.path); const destDir = path.dirname(destAbs); if (!fs.existsSync(destDir)) fs.mkdirSync(destDir, { recursive: true }); fs.writeFileSync(destAbs, JSON.stringify(manifest, null, 2) + '\n'); } // Run the sync once so post-sync assertions are valid. syncManifestVersions({ root: tmpRoot }); }); after(() => { helpers.cleanup(tmpRoot); tmpRoot = null; }); test('pre-sync fixture had at least one stale manifest (version 0.0.0 != 9.9.9-test.0)', () => { // The before() hook wrote 0.0.0 into every manifest before syncing. // We verify the sync actually had work to do by checking that any manifest // that now reads 9.9.9-test.0 was not already at that version (0.0.0 ≠ 9.9.9-test.0). // The simplest red-check: the fixture started with 0.0.0, which != 9.9.9-test.0. assert.ok( VERSIONED_MANIFESTS.length > 0, 'VERSIONED_MANIFESTS must be non-empty for the fixture to be meaningful' ); // Independently confirm the target version != the stale seed assert.notEqual('0.0.0', '9.9.9-test.0', 'Stale seed 0.0.0 must differ from fixture package.json version 9.9.9-test.0'); }); test('syncManifestVersions stamps all manifests to package.json version', () => { const pkgVersion = getPackageVersion(tmpRoot); assert.equal(pkgVersion, '9.9.9-test.0'); for (const entry of VERSIONED_MANIFESTS) { const abs = path.join(tmpRoot, entry.path); const m = JSON.parse(fs.readFileSync(abs, 'utf8')); assert.equal( getByPath(m, entry.versionKey), '9.9.9-test.0', `${entry.path} version (${entry.versionKey}) should be 9.9.9-test.0 after sync` ); } }); test('syncManifestVersions reports at least one changed file on first run', () => { // Run a fresh sync against a freshly-stale fixture to observe the changed list. // Create a separate sub-fixture so this test does not rely on before()'s sync order. const sub = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-chk-')); try { fs.writeFileSync( path.join(sub, 'package.json'), JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n' ); for (const entry of VERSIONED_MANIFESTS) { const manifest = JSON.parse(fs.readFileSync(path.join(ROOT, entry.path), 'utf8')); setByPath(manifest, entry.versionKey, '0.0.0'); const destAbs = path.join(sub, entry.path); const destDir = path.dirname(destAbs); if (!fs.existsSync(destDir)) fs.mkdirSync(destDir, { recursive: true }); fs.writeFileSync(destAbs, JSON.stringify(manifest, null, 2) + '\n'); } const changed = syncManifestVersions({ root: sub }); assert.ok(changed.length > 0, 'syncManifestVersions should report at least one changed file'); } finally { helpers.cleanup(sub); } }); test('non-version fields are preserved after sync', () => { for (const entry of VERSIONED_MANIFESTS) { const rel = entry.path; const real = JSON.parse(fs.readFileSync(path.join(ROOT, rel), 'utf8')); const tmp = JSON.parse(fs.readFileSync(path.join(tmpRoot, rel), 'utf8')); // Check that every non-version key from the real manifest exists in tmp. // For nested versionKey manifests (e.g. marketplace plugins[0].version), // the comparison is structural at the top level only — the version slot // itself is the one field sync is allowed to change. for (const key of Object.keys(real)) { assert.ok( Object.prototype.hasOwnProperty.call(tmp, key), `${rel}: field "${key}" should be preserved after sync` ); } } }); test('each synced file ends with a single trailing newline', () => { for (const entry of VERSIONED_MANIFESTS) { const rel = entry.path; const raw = fs.readFileSync(path.join(tmpRoot, rel), 'utf8'); assert.ok(raw.endsWith('\n'), `${rel} must end with a trailing newline`); assert.ok(!raw.endsWith('\n\n'), `${rel} must not end with a double newline`); } }); test('second syncManifestVersions call is idempotent (returns [])', () => { // The before() already ran one sync. A second call must return []. const changed = syncManifestVersions({ root: tmpRoot }); assert.deepEqual(changed, [], 'Second sync call should return [] (already in sync)'); }); }); // ─── B: Registry-in-sync: real manifests match package.json ────────────────── describe('B: real manifests match package.json version', () => { const pkgVersion = getPackageVersion(ROOT); for (const entry of VERSIONED_MANIFESTS) { const rel = entry.path; test(`${rel} version (${entry.versionKey}) === ${pkgVersion}`, () => { const abs = path.join(ROOT, rel); assert.ok(fs.existsSync(abs), `${rel} must exist at ${abs}`); const m = JSON.parse(fs.readFileSync(abs, 'utf8')); assert.equal( getByPath(m, entry.versionKey), pkgVersion, `${rel} version (${entry.versionKey} = ${getByPath(m, entry.versionKey)}) must match package.json version (${pkgVersion}). ` + 'Run `node scripts/sync-manifest-versions.cjs` to fix.' ); }); } }); // ─── B2: native capability manifests track package.json version (ADR-1244 D6) ─ describe('B2: native capability manifests match package.json version', () => { const pkgVersion = getPackageVersion(ROOT); const capManifests = listCapabilityManifests({ root: ROOT }); test('there is at least one native capability manifest', () => { assert.ok(capManifests.length >= 30, `expected the native capability set, found ${capManifests.length}`); }); for (const rel of capManifests) { test(`${rel} version === ${pkgVersion}`, () => { const m = JSON.parse(fs.readFileSync(path.join(ROOT, rel), 'utf8')); assert.equal( m.version, pkgVersion, `${rel} version (${m.version}) must match package.json version (${pkgVersion}). ` + 'Run `node scripts/sync-manifest-versions.cjs` to fix.' ); }); } }); // ─── B3: syncCapabilityVersions stamps + is idempotent (temp fixture) ───────── describe('B3: syncCapabilityVersions — temp fixture', () => { test('stamps stale capability manifests to package version, then is idempotent', () => { const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-cap-')); try { fs.writeFileSync( path.join(tmpRoot, 'package.json'), JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n' ); // Two stale capability manifests. for (const id of ['alpha', 'beta']) { const dir = path.join(tmpRoot, 'capabilities', id); fs.mkdirSync(dir, { recursive: true }); fs.writeFileSync( path.join(dir, 'capability.json'), JSON.stringify({ id, role: 'feature', version: '0.0.0', title: id }, null, 2) + '\n' ); } const found = listCapabilityManifests({ root: tmpRoot }); assert.equal(found.length, 2, 'should discover both capability manifests'); const changed = syncCapabilityVersions({ root: tmpRoot }); assert.equal(changed.length, 2, 'both manifests should be stamped on first run'); for (const rel of found) { const m = JSON.parse(fs.readFileSync(path.join(tmpRoot, rel), 'utf8')); assert.equal(m.version, '9.9.9-test.0', `${rel} should be stamped`); assert.equal(m.title, m.id, `${rel} non-version fields preserved`); } // Idempotent second run. assert.deepEqual(syncCapabilityVersions({ root: tmpRoot }), [], 'second run is a no-op'); } finally { helpers.cleanup(tmpRoot); } }); test('listCapabilityManifests returns [] when there is no capabilities/ dir', () => { const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-nocaps-')); try { assert.deepEqual(listCapabilityManifests({ root: tmpRoot }), []); } finally { helpers.cleanup(tmpRoot); } }); }); // ─── C: Regression guard — all version-bearing JSON files are registered ────── describe('C: regression guard — version-bearing JSON files must be registered', () => { // package.json is the version source; package-lock.json is npm-managed. // Both inherently track the version without the sync script. // Native capability manifests (capabilities//capability.json) are // version-swept by syncCapabilityVersions (ADR-1244 D6) — discovered by glob, // so every one is "registered" without an explicit entry here. const ALLOWED = new Set([ ...VERSIONED_MANIFEST_PATHS, ...listCapabilityManifests({ root: ROOT }), 'package.json', 'package-lock.json', ]); // Semver-ish: matches X.Y.Z with optional pre-release/build metadata. const SEMVER = /^\d+\.\d+\.\d+(?:[-+].+)?$/; // Paths to exclude from the guard const EXCLUDED_PREFIXES = ['tests/', 'node_modules/', '.changeset/', 'docs/']; test('every committed JSON with a semver top-level version is registered or explicitly allowed', (t) => { // Enumerate committed JSON files via git (no pathspec to avoid recursion quirks; // filter to .json in JS instead). let lines; try { const out = execFileSync('git', ['ls-files'], { cwd: ROOT }); lines = out.toString().split('\n').filter((f) => f.endsWith('.json')); } catch (err) { t.skip('git unavailable: ' + err.message); return; } for (const rel of lines) { if (ALLOWED.has(rel)) continue; if (EXCLUDED_PREFIXES.some(prefix => rel.startsWith(prefix))) continue; const abs = path.join(ROOT, rel); let parsed; try { parsed = JSON.parse(fs.readFileSync(abs, 'utf8')); } catch (_) { continue; // skip invalid JSON (shouldn't exist, but be safe) } if ( parsed && typeof parsed === 'object' && !Array.isArray(parsed) && typeof parsed.version === 'string' && SEMVER.test(parsed.version) ) { assert.ok( ALLOWED.has(rel), `${rel} has a semver top-level "version" but is not registered in ` + 'scripts/sync-manifest-versions.cjs VERSIONED_MANIFESTS (nor an npm-managed file). ' + "Register it so 'npm version' keeps it in sync (issue #844)." ); } } }); }); // ─── E: stageManifests in a non-git dir must not throw ─────────────────────── describe('E: stageManifests — non-git dir is a no-op, not a throw', () => { test('stageManifests({root}) with a non-git tempdir warns and returns without throwing', () => { const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-nogit-')); try { // Write a minimal package.json so getPackageVersion doesn't error if called fs.writeFileSync( path.join(tmpRoot, 'package.json'), JSON.stringify({ name: 'x', version: '0.0.0' }, null, 2) + '\n' ); // Must not throw even though tmpRoot is not a git repo assert.doesNotThrow(() => { stageManifests({ root: tmpRoot }); }, 'stageManifests must not throw outside a git work tree'); } finally { helpers.cleanup(tmpRoot); } }); }); // ─── D: CLI --check exits 0 when in sync ───────────────────────────────────── // Moved to `npm run lint:generated-sync` (sync-manifest-versions.cjs --check), // which runs against the committed manifests in both local and CI lint lanes // instead of being masked by gsd-test's `npm run build` leg. // ─── F: version script includes capability-registry regen (#1498) ───────────── // // Regression guard for #1498: the `npm version` lifecycle script must regenerate // capability-registry.cjs after stamping capability manifests. Without this, // `npm version X.Y.Z` leaves the committed registry stale (capability JSONs get // new version strings but the registry still has the old ones), causing the // `gen-capability-registry.cjs --check` test to fail in the RC workflow. describe('F: npm version script includes gen-capability-registry --write (#1498)', () => { test('package.json "version" script regenerates capability-registry.cjs after syncing manifests', () => { const pkg = JSON.parse(fs.readFileSync(path.join(ROOT, 'package.json'), 'utf8')); const versionScript = pkg.scripts && pkg.scripts.version; assert.ok( typeof versionScript === 'string', 'package.json must have a "version" script', ); assert.ok( versionScript.includes('gen-capability-registry.cjs --write'), 'package.json "version" script must include "gen-capability-registry.cjs --write" to keep the registry in sync after npm version bumps capability manifests. ' + 'Got: ' + JSON.stringify(versionScript), ); assert.ok( versionScript.includes('git add') && versionScript.includes('capability-registry.cjs'), 'package.json "version" script must stage capability-registry.cjs with "git add" so it is included in the version-bump commit. ' + 'Got: ' + JSON.stringify(versionScript), ); }); });