@dalzoubi/dev-agents-sync 1.0.14 → 1.0.16

package/tests/check-constitution-version.test.mjs

@@ -0,0 +1,594 @@
+/**
+ * tests/check-constitution-version.test.mjs
+ *
+ * Tests for scripts/check-constitution-version.mjs — the PR-CI script that
+ * enforces the "Constitution version: vN" bump rule on prompts/constitution.md.
+ *
+ * The script does NOT exist yet (version-bump-check-script slice is pending).
+ * All tests here are expected to fail with "Cannot find" / non-zero exit until
+ * the implement agent creates the script.
+ *
+ * Approach: real temporary git repos — no mocking of git. Each test:
+ *   1. Creates a tmpdir and initialises a bare git repo in it.
+ *   2. Makes one or two commits representing "base" and "HEAD" states.
+ *   3. Spawns `node <scriptPath> --base <mergeBase>` as a subprocess.
+ *   4. Asserts exit code and (where applicable) stderr content.
+ *
+ * Node built-in test runner (node:test) — no jest/mocha/vitest.
+ */
+
+import { describe, it, before, after } from 'node:test';
+import assert from 'node:assert/strict';
+import { execSync, spawnSync } from 'node:child_process';
+import { mkdtempSync, mkdirSync, writeFileSync, rmSync } from 'node:fs';
+import { join, resolve } from 'node:path';
+import { tmpdir } from 'node:os';
+import { fileURLToPath } from 'node:url';
+
+// ---------------------------------------------------------------------------
+// Resolve script path — absolute, relative to this test file's location.
+// The script lives at <repo-root>/scripts/check-constitution-version.mjs.
+// This test file lives at packages/dev-agents-sync/tests/
+// so ../../.. reaches the repo root.
+// ---------------------------------------------------------------------------
+
+const TEST_FILE_DIR = fileURLToPath(new URL('.', import.meta.url));
+const SCRIPT_PATH = resolve(TEST_FILE_DIR, '..', '..', '..', 'scripts', 'check-constitution-version.mjs');
+
+// ---------------------------------------------------------------------------
+// Git helpers — all operate inside a provided repoDir.
+// ---------------------------------------------------------------------------
+
+/**
+ * Run a git command synchronously inside repoDir; throw on non-zero.
+ * @param {string} repoDir
+ * @param {string[]} args
+ * @returns {string} trimmed stdout
+ */
+function git(repoDir, args) {
+  const result = spawnSync('git', args, {
+    cwd: repoDir,
+    encoding: 'utf8',
+    env: {
+      ...process.env,
+      // Ensure a consistent git identity so tests work in CI.
+      GIT_AUTHOR_NAME: 'Test',
+      GIT_AUTHOR_EMAIL: 'test@test.invalid',
+      GIT_COMMITTER_NAME: 'Test',
+      GIT_COMMITTER_EMAIL: 'test@test.invalid',
+      GIT_CONFIG_NOSYSTEM: '1',
+    },
+  });
+  if (result.status !== 0) {
+    throw new Error(
+      `git ${args.join(' ')} failed (exit ${result.status}): ${result.stderr}`,
+    );
+  }
+  return (result.stdout || '').trimEnd();
+}
+
+/**
+ * Initialise a new git repo in a temp directory and make an initial (empty) commit
+ * so the repo has a valid HEAD.
+ * @returns {{ repoDir: string, cleanup: () => void }}
+ */
+function createTempRepo() {
+  const repoDir = mkdtempSync(join(tmpdir(), 'const-ver-test-'));
+  git(repoDir, ['init', '-b', 'main']);
+  git(repoDir, ['config', 'user.email', 'test@test.invalid']);
+  git(repoDir, ['config', 'user.name', 'Test']);
+
+  // Initial commit so the repo is not empty.
+  writeFileSync(join(repoDir, 'README.md'), 'placeholder\n');
+  git(repoDir, ['add', 'README.md']);
+  git(repoDir, ['commit', '-m', 'initial']);
+
+  return {
+    repoDir,
+    cleanup: () => rmSync(repoDir, { recursive: true, force: true }),
+  };
+}
+
+/**
+ * Write prompts/constitution.md into a repo, stage and commit it.
+ * @param {string} repoDir
+ * @param {string} content — full file content
+ * @param {string} message — commit message
+ * @returns {string} the SHA of the new commit
+ */
+function commitConstitution(repoDir, content, message) {
+  const promptsDir = join(repoDir, 'prompts');
+  mkdirSync(promptsDir, { recursive: true });
+  writeFileSync(join(promptsDir, 'constitution.md'), content);
+  git(repoDir, ['add', join('prompts', 'constitution.md')]);
+  git(repoDir, ['commit', '-m', message]);
+  return git(repoDir, ['rev-parse', 'HEAD']);
+}
+
+/**
+ * Resolve the merge-base SHA of HEAD against the given baseRef.
+ * @param {string} repoDir
+ * @param {string} baseRef — a commit SHA or ref
+ * @returns {string} merge-base SHA
+ */
+function mergeBase(repoDir, baseRef) {
+  return git(repoDir, ['merge-base', 'HEAD', baseRef]);
+}
+
+// ---------------------------------------------------------------------------
+// Canonical constitution content builders.
+// ---------------------------------------------------------------------------
+
+const BASE_CONTENT_V1 = `# Constitution
+
+Constitution version: v1
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+`;
+
+const BASE_CONTENT_V2_BUMPED = `# Constitution
+
+Constitution version: v2
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+§3 Be kind.
+`;
+
+const BASE_CONTENT_V2_UNBUMPED = `# Constitution
+
+Constitution version: v1
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+§3 Be kind.
+`;
+
+const BASE_CONTENT_V0_DECREASED = `# Constitution
+
+Constitution version: v0
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+§3 Be kind.
+`;
+
+const BASE_CONTENT_VERSION_LINE_ONLY_CHANGE = `# Constitution
+
+Constitution version: v2
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+`;
+
+const BASE_CONTENT_MISSING_VERSION_LINE = `# Constitution
+
+## Principles
+
+§1 Be good.
+§2 Be consistent.
+`;
+
+const BASE_CONTENT_MALFORMED_VERSION_LINE = `# Constitution
+
+Constitution version: banana
+
+## Principles
+
+§1 Be good.
+`;
+
+// ---------------------------------------------------------------------------
+// Invoke the script as a subprocess.
+// Returns { status, stdout, stderr }.
+// ---------------------------------------------------------------------------
+
+/**
+ * Run the check script synchronously.
+ * @param {string} repoDir — cwd for the invocation
+ * @param {string[]} extraArgs — passed after `node <scriptPath>`
+ * @param {Record<string,string>} [extraEnv] — merged into process.env
+ * @returns {{ status: number, stdout: string, stderr: string }}
+ */
+function runScript(repoDir, extraArgs = [], extraEnv = {}) {
+  const result = spawnSync('node', [SCRIPT_PATH, ...extraArgs], {
+    cwd: repoDir,
+    encoding: 'utf8',
+    env: {
+      ...process.env,
+      // Ensure GITHUB_BASE_REF is not accidentally inherited from CI.
+      GITHUB_BASE_REF: undefined,
+      GIT_AUTHOR_NAME: 'Test',
+      GIT_AUTHOR_EMAIL: 'test@test.invalid',
+      GIT_COMMITTER_NAME: 'Test',
+      GIT_COMMITTER_EMAIL: 'test@test.invalid',
+      GIT_CONFIG_NOSYSTEM: '1',
+      ...extraEnv,
+    },
+  });
+  return {
+    status: result.status ?? 1,
+    stdout: result.stdout || '',
+    stderr: result.stderr || '',
+  };
+}
+
+// ---------------------------------------------------------------------------
+// Test suite
+// ---------------------------------------------------------------------------
+
+describe('check-constitution-version.mjs', () => {
+  // -------------------------------------------------------------------------
+  // Case 1: Pass — no body change (file byte-identical at base and HEAD)
+  // -------------------------------------------------------------------------
+  it('Pass — no body change: file byte-identical → exit 0', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution',
+      );
+
+      // HEAD is the same commit (nothing changed).
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        0,
+        `expected exit 0, got ${result.status}. stderr: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 2: Pass — body change with proper bump (non-version line differs, integer increased)
+  // -------------------------------------------------------------------------
+  it('Pass — body change with proper bump: non-version line differs and integer increased → exit 0', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit (v2, with a new principle)
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_V2_BUMPED,
+        'bump constitution to v2',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        0,
+        `expected exit 0, got ${result.status}. stderr: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 3: Pass — version-line-only change (only version line differs)
+  // -------------------------------------------------------------------------
+  it('Pass — version-line-only change: only the version line differs → exit 0', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit: same body but version bumped to v2, no other change.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_VERSION_LINE_ONLY_CHANGE,
+        'pre-bump constitution version to v2',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        0,
+        `expected exit 0, got ${result.status}. stderr: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 4: Pass — new file (did not exist at merge base, HEAD has parseable vN ≥ 1)
+  // -------------------------------------------------------------------------
+  it('Pass — new file (no base copy): HEAD has parseable vN line → exit 0', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // Capture the initial commit SHA before any constitution exists.
+      const beforeConstitution = git(repoDir, ['rev-parse', 'HEAD']);
+
+      // Now add the constitution at HEAD.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'introduce constitution',
+      );
+
+      // Merge base is the commit before the constitution was added.
+      const base = mergeBase(repoDir, beforeConstitution);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        0,
+        `expected exit 0, got ${result.status}. stderr: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 5: Fail — body change without bump (non-version line differs, version same)
+  // -------------------------------------------------------------------------
+  it('Fail — body change without bump: version stayed same → exit 1 with "bump from vN to vN+1" message', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit: body changed but version NOT bumped.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_V2_UNBUMPED,
+        'add new principle (forgot to bump version)',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        1,
+        `expected exit 1, got ${result.status}. stderr: ${result.stderr}`,
+      );
+      assert.ok(
+        result.stderr.includes('bump from v1 to v2'),
+        `expected "bump from v1 to v2" in stderr, got: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 6: Fail — body change with version decrease (integer decreased)
+  // -------------------------------------------------------------------------
+  it('Fail — body change with version decrease: integer decreased → exit 1 with bump message', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit: body changed AND version decreased to v0.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_V0_DECREASED,
+        'accidentally decreased version',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        1,
+        `expected exit 1, got ${result.status}. stderr: ${result.stderr}`,
+      );
+      // The decrease case should produce a "bump from vN to vN+1" message because
+      // the version did not increase — the specific values reference the base
+      // side (v1) and the required next value (v2).
+      assert.ok(
+        result.stderr.includes('bump from'),
+        `expected "bump from" in stderr for version-decrease case, got: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 7a: Fail — missing version line at HEAD
+  // -------------------------------------------------------------------------
+  it('Fail — missing version line at HEAD: absent → exit 1 with "missing or malformed" message', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (valid v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit: version line removed.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_MISSING_VERSION_LINE,
+        'accidentally removed version line',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        1,
+        `expected exit 1, got ${result.status}. stderr: ${result.stderr}`,
+      );
+      assert.ok(
+        result.stderr.includes('missing or malformed'),
+        `expected "missing or malformed" in stderr, got: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 7b: Fail — malformed version line at HEAD
+  // -------------------------------------------------------------------------
+  it('Fail — malformed version line at HEAD: non-integer value → exit 1 with "missing or malformed" message', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // base commit (valid v1)
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+
+      // HEAD commit: version line present but malformed.
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_MALFORMED_VERSION_LINE,
+        'accidentally malformed version line',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+      const result = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        result.status,
+        1,
+        `expected exit 1, got ${result.status}. stderr: ${result.stderr}`,
+      );
+      assert.ok(
+        result.stderr.includes('missing or malformed'),
+        `expected "missing or malformed" in stderr, got: ${result.stderr}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 8: Fail — missing base ref (neither GITHUB_BASE_REF nor --base set)
+  // -------------------------------------------------------------------------
+  it('Fail — missing base ref: neither GITHUB_BASE_REF nor --base → exit 1 with actionable message', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      commitConstitution(repoDir, BASE_CONTENT_V1, 'add constitution');
+
+      // Run with no --base and GITHUB_BASE_REF explicitly unset.
+      const result = spawnSync('node', [SCRIPT_PATH], {
+        cwd: repoDir,
+        encoding: 'utf8',
+        env: {
+          ...process.env,
+          GITHUB_BASE_REF: undefined,
+          GIT_AUTHOR_NAME: 'Test',
+          GIT_AUTHOR_EMAIL: 'test@test.invalid',
+          GIT_COMMITTER_NAME: 'Test',
+          GIT_COMMITTER_EMAIL: 'test@test.invalid',
+          GIT_CONFIG_NOSYSTEM: '1',
+        },
+      });
+
+      assert.equal(
+        (result.status ?? 1),
+        1,
+        `expected exit 1, got ${result.status}. stderr: ${result.stderr}`,
+      );
+
+      const combined = (result.stderr || '') + (result.stdout || '');
+
+      // The error message must name both inputs so the user knows how to fix it.
+      assert.ok(
+        combined.includes('GITHUB_BASE_REF'),
+        `expected "GITHUB_BASE_REF" in output, got: ${combined}`,
+      );
+      assert.ok(
+        combined.includes('--base'),
+        `expected "--base" in output, got: ${combined}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+
+  // -------------------------------------------------------------------------
+  // Case 9: Determinism — same inputs → identical exit code and output both runs
+  // -------------------------------------------------------------------------
+  it('Determinism — same inputs produce identical exit code and output on two runs', () => {
+    const { repoDir, cleanup } = createTempRepo();
+    try {
+      // Set up a "fail" scenario (body changed, version not bumped) so both
+      // stderr output and exit code are non-trivial and comparable.
+      const baseCommit = commitConstitution(
+        repoDir,
+        BASE_CONTENT_V1,
+        'add constitution v1',
+      );
+      commitConstitution(
+        repoDir,
+        BASE_CONTENT_V2_UNBUMPED,
+        'add new principle (forgot to bump version)',
+      );
+
+      const base = mergeBase(repoDir, baseCommit);
+
+      const run1 = runScript(repoDir, ['--base', base]);
+      const run2 = runScript(repoDir, ['--base', base]);
+
+      assert.equal(
+        run1.status,
+        run2.status,
+        `exit codes differ: run1=${run1.status} run2=${run2.status}`,
+      );
+      assert.equal(
+        run1.stderr,
+        run2.stderr,
+        `stderr differs between runs:\nrun1: ${run1.stderr}\nrun2: ${run2.stderr}`,
+      );
+      assert.equal(
+        run1.stdout,
+        run2.stdout,
+        `stdout differs between runs:\nrun1: ${run1.stdout}\nrun2: ${run2.stdout}`,
+      );
+    } finally {
+      cleanup();
+    }
+  });
+});