Initial open-source release

scripts/relationship-orbit-verification.test.mjs

@@ -0,0 +1,244 @@
+import assert from 'node:assert/strict';
+import { readFile } from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { describe, it } from 'node:test';
+import {
+  buildOrbitReportArgv,
+  buildOrbitScanArgv,
+  defaultOrbitVerificationProjectDir,
+  extractRunId,
+  formatOrbitVerificationMarkdown,
+  runOrbitVerification,
+} from './relationship-orbit-verification.mjs';
+
+function successReportJson() {
+  return JSON.stringify({
+    runId: 'scan-orbit-1',
+    connectionId: 'orbit',
+    mode: 'enriched',
+    syncId: '2026-05-07-100000-scan-enriched-1',
+    relationships: {
+      accepted: 14,
+      review: 8,
+      rejected: 91,
+      skipped: 0,
+    },
+    enrichment: {
+      deterministicRelationships: 'completed',
+      statisticalValidation: 'completed',
+      llmRelationshipValidation: 'skipped',
+    },
+    warnings: [
+      {
+        code: 'scan_enrichment_backend_not_configured',
+        message:
+          'Skipping description and embedding enrichment because scan.enrichment.mode is not configured; relationship discovery still ran.',
+        recoverable: true,
+      },
+    ],
+    artifactPaths: {
+      reportPath: 'raw-sources/orbit/live-database/2026-05-07-100000-scan-enriched-1/reports/scan-report.json',
+      rawSourcesDir: 'raw-sources/orbit/live-database/2026-05-07-100000-scan-enriched-1',
+      manifestShards: ['semantic-layer/orbit/_schema/orbit_analytics.yaml'],
+      enrichmentArtifacts: [
+        'raw-sources/orbit/live-database/2026-05-07-100000-scan-enriched-1/enrichment/relationships.json',
+        'raw-sources/orbit/live-database/2026-05-07-100000-scan-enriched-1/enrichment/relationship-profile.json',
+        'raw-sources/orbit/live-database/2026-05-07-100000-scan-enriched-1/enrichment/relationship-diagnostics.json',
+      ],
+    },
+  });
+}
+
+describe('relationship Orbit verification helper', () => {
+  it('exposes the Orbit verification command from the KLO workspace package', async () => {
+    const packageJson = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8'));
+
+    assert.equal(
+      packageJson.scripts['relationships:verify-orbit'],
+      'node scripts/relationship-orbit-verification.mjs',
+    );
+  });
+
+  it('builds the current KLO launcher arguments for scan and JSON report commands', () => {
+    assert.deepEqual(buildOrbitScanArgv({ connectionId: 'orbit', projectDir: '/tmp/orbit-project' }), [
+      'dev',
+      'scan',
+      'orbit',
+      '--enrich',
+      '--project-dir',
+      '/tmp/orbit-project',
+    ]);
+    assert.deepEqual(buildOrbitReportArgv({ projectDir: '/tmp/orbit-project', runId: 'scan-orbit-1' }), [
+      'dev',
+      'scan',
+      'report',
+      '--json',
+      '--project-dir',
+      '/tmp/orbit-project',
+      'scan-orbit-1',
+    ]);
+  });
+
+  it('uses the checked-in Orbit verification project by default', async () => {
+    const calls = [];
+    const envs = [];
+    const writes = [];
+    const defaultProjectDir = defaultOrbitVerificationProjectDir();
+
+    const result = await runOrbitVerification({
+      reportPath: '/tmp/orbit-report.md',
+      now: () => new Date('2026-05-07T10:00:00.000Z'),
+      mkdir: async () => {},
+      writeFile: async (path, content) => {
+        writes.push({ path, content });
+      },
+      runWorkspaceKlo: async (argv, options) => {
+        calls.push(argv);
+        envs.push(options.env);
+        if (argv[2] === 'report') {
+          options.stdout.write(successReportJson());
+          return 0;
+        }
+        options.stdout.write('KLO scan completed\nRun: scan-orbit-1\nConnection: orbit\n');
+        return 0;
+      },
+    });
+
+    assert.equal(result.status, 'success');
+    assert.deepEqual(calls, [
+      ['dev', 'scan', 'orbit', '--enrich', '--project-dir', defaultProjectDir],
+      ['dev', 'scan', 'report', '--json', '--project-dir', defaultProjectDir, 'scan-orbit-1'],
+    ]);
+    assert.equal(envs[0].GIT_CEILING_DIRECTORIES, dirname(defaultProjectDir));
+    assert.equal(envs[1].GIT_CEILING_DIRECTORIES, dirname(defaultProjectDir));
+    assert.equal(writes.length, 1);
+    assert.match(writes[0].content, new RegExp(defaultProjectDir.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')));
+  });
+
+  it('extracts the run id from human scan output', () => {
+    assert.equal(extractRunId(`KLO scan completed\nStatus: done\nRun: scan-orbit-1\nConnection: orbit\n`), 'scan-orbit-1');
+    assert.equal(extractRunId('KLO scan completed without a run line\n'), null);
+  });
+
+  it('formats successful Orbit verification evidence from the JSON report', () => {
+    const markdown = formatOrbitVerificationMarkdown({
+      status: 'success',
+      date: '2026-05-07',
+      connectionId: 'orbit',
+      projectDir: '/tmp/orbit-project',
+      scanCommand: 'pnpm run klo -- dev scan orbit --enrich --project-dir /tmp/orbit-project',
+      reportCommand: 'pnpm run klo -- dev scan report --json --project-dir /tmp/orbit-project scan-orbit-1',
+      scanExitCode: 0,
+      reportExitCode: 0,
+      scanStdout: 'KLO scan completed\nRun: scan-orbit-1\n',
+      scanStderr: '',
+      report: JSON.parse(successReportJson()),
+    });
+
+    assert.match(markdown, /# KLO Relationship Discovery Orbit Verification/);
+    assert.match(markdown, /Outcome/);
+    assert.match(markdown, /Exit code: 0/);
+    assert.match(markdown, /Accepted: 14/);
+    assert.match(markdown, /Review: 8/);
+    assert.match(markdown, /Rejected: 91/);
+    assert.match(markdown, /semantic-layer\/orbit\/_schema\/orbit_analytics\.yaml/);
+    assert.match(markdown, /relationship-diagnostics\.json/);
+    assert.match(markdown, /scan_enrichment_backend_not_configured/);
+  });
+
+  it('formats blocked Orbit verification evidence from the current failing command', () => {
+    const markdown = formatOrbitVerificationMarkdown({
+      status: 'blocked',
+      date: '2026-05-07',
+      connectionId: 'orbit',
+      projectDir: '/tmp/orbit-project',
+      scanCommand: 'pnpm run klo -- dev scan orbit --enrich --project-dir /tmp/orbit-project',
+      scanExitCode: 1,
+      blocker: 'Connection "orbit" was not found',
+      scanStdout: '',
+      scanStderr: 'Connection "orbit" was not found\n',
+    });
+
+    assert.match(markdown, /Exit code: 1/);
+    assert.match(markdown, /Connection "orbit" was not found/);
+    assert.match(markdown, /Orbit verification was not executed because the current local Orbit scan command failed/);
+    assert.doesNotMatch(markdown, /scan\.enrichment\.mode is required/);
+  });
+
+  it('runs scan then JSON report and writes success Markdown', async () => {
+    const calls = [];
+    const writes = [];
+    const result = await runOrbitVerification({
+      connectionId: 'orbit',
+      projectDir: '/tmp/orbit-project',
+      reportPath: '/tmp/orbit-report.md',
+      now: () => new Date('2026-05-07T10:00:00.000Z'),
+      mkdir: async () => {},
+      writeFile: async (path, content) => {
+        writes.push({ path, content });
+      },
+      runWorkspaceKlo: async (argv, options) => {
+        calls.push(argv);
+        if (argv[2] === 'report') {
+          options.stdout.write(successReportJson());
+          return 0;
+        }
+        options.stdout.write('KLO scan completed\nRun: scan-orbit-1\nConnection: orbit\n');
+        return 0;
+      },
+    });
+
+    assert.equal(result.status, 'success');
+    assert.deepEqual(calls, [
+      ['dev', 'scan', 'orbit', '--enrich', '--project-dir', '/tmp/orbit-project'],
+      ['dev', 'scan', 'report', '--json', '--project-dir', '/tmp/orbit-project', 'scan-orbit-1'],
+    ]);
+    assert.equal(writes.length, 1);
+    assert.equal(writes[0].path, '/tmp/orbit-report.md');
+    assert.match(writes[0].content, /Accepted: 14/);
+  });
+
+  it('writes blocked Markdown when the scan command fails before a run id exists', async () => {
+    const writes = [];
+    const result = await runOrbitVerification({
+      connectionId: 'orbit',
+      projectDir: '/tmp/orbit-project',
+      reportPath: '/tmp/orbit-report.md',
+      now: () => new Date('2026-05-07T10:00:00.000Z'),
+      mkdir: async () => {},
+      writeFile: async (path, content) => {
+        writes.push({ path, content });
+      },
+      runWorkspaceKlo: async (_argv, options) => {
+        options.stderr.write('Connection "orbit" was not found\n');
+        return 1;
+      },
+    });
+
+    assert.equal(result.status, 'blocked');
+    assert.equal(result.scanExitCode, 1);
+    assert.equal(writes.length, 1);
+    assert.match(writes[0].content, /Connection "orbit" was not found/);
+  });
+
+  it('runs the workspace launcher in buffered mode so real scan errors are captured', async () => {
+    let sawExecFile = false;
+    const result = await runOrbitVerification({
+      connectionId: 'orbit',
+      projectDir: '/tmp/orbit-project',
+      reportPath: '/tmp/orbit-report.md',
+      now: () => new Date('2026-05-07T10:00:00.000Z'),
+      mkdir: async () => {},
+      writeFile: async () => {},
+      execFile: async () => ({ stdout: '', stderr: '' }),
+      runWorkspaceKlo: async (_argv, options) => {
+        sawExecFile = typeof options.execFile === 'function';
+        options.stderr.write('ENOENT: no such file or directory, open \'/tmp/orbit-project/klo.yaml\'\n');
+        return 1;
+      },
+    });
+
+    assert.equal(sawExecFile, true);
+    assert.equal(result.blocker, "ENOENT: no such file or directory, open '/tmp/orbit-project/klo.yaml'");
+  });
+});