openrig/scripts/portability-report.test.mjs

import test from "node:test";
import assert from "node:assert/strict";
import { addedLines, findPortabilityIssues, renderReport } from "./portability-report.mjs";

const diff = [
  "diff --git a/docs/a.md b/docs/a.md",
  "--- a/docs/a.md",
  "+++ b/docs/a.md",
  "@@ -1,0 +10,2 @@",
  "+Clone into /Users/alice/code/app first.",
  "+Nothing machine-specific here.",
  "diff --git a/old.md b/old.md",
  "+++ /dev/null",
  "+ignored because the file is deleted",
].join("\n");

test("reads only added lines with their new line numbers", () => {
  assert.deepEqual(addedLines(diff), [
    { file: "docs/a.md", line: 10, text: "Clone into /Users/alice/code/app first." },
    { file: "docs/a.md", line: 11, text: "Nothing machine-specific here." },
  ]);
});

function categories(text) {
  return findPortabilityIssues([{ file: "f", line: 1, text }]).map((finding) => finding.category);
}

test("reports each principle's typical cases", () => {
  assert.deepEqual(categories("key = 'ghp_" + "a".repeat(36) + "'"), ["Credential"]);
  assert.deepEqual(categories("-----BEGIN OPENSSH PRIVATE KEY-----"), ["Credential"]);
  assert.deepEqual(categories("see /home/bob/project"), ["Home path"]);
  assert.deepEqual(categories("cache in /private/tmp/claude-501/x"), ["Machine path"]);
  assert.deepEqual(categories("ssh 100.95.1.2"), ["Network address"]);
  assert.deepEqual(categories("reach build-box.local"), ["Network address"]);
  assert.deepEqual(categories("mail [email protected]"), ["Email address"]);
});

test("placeholders, loopback, documentation ranges and product names are not reported", () => {
  for (const text of [
    "cd /Users/example/repo",
    "cd /home/user/repo",
    "listen on 127.0.0.1:7433",
    "docs address 192.0.2.10",
    "[email protected]",
    "[email protected]",
    "send to operator-agent@kernel and orch-lead@v-openrig-build",
    "token = process.env.GITHUB_TOKEN",
    'const token = "00000000-0000-7000-8000-000000000001";',
    'resume_token : "other-thread"',
    "edit .claude/settings.local.json",
    "id: OPR.99.0.1.1",
    "release v2.0.0.1",
    "maintainers at [email protected]",
  ]) {
    assert.deepEqual(categories(text), [], text);
  }
});

test("the report never repeats a suspected credential", () => {
  const secret = "ghp_" + "Zz9".repeat(12);
  const report = renderReport(
    findPortabilityIssues([{ file: "f", line: 1, text: `const key = "${secret}"` }]),
    "x..y",
  );
  assert.match(report, /## Credential \(1\)/);
  assert.ok(!report.includes(secret.slice(6)), report);
});

test("a credential on the same line as another finding is withheld from every category", () => {
  const secret = "ghp_" + "Qx7".repeat(12);
  const lines = [
    { file: "f", line: 1, text: `token = "${secret}" in /Users/alice/.config and 100.95.1.2` },
  ];
  const findings = findPortabilityIssues(lines);
  assert.deepEqual(
    findings.map((finding) => finding.category),
    ["Credential", "Home path", "Network address"],
  );
  const report = renderReport(findings, "x..y");
  assert.ok(!report.includes(secret.slice(6)), report);
  assert.match(report, /\/Users\/alice\//);
  assert.match(report, /100\.95\.1\.2/);
});

test("locations-only output names file and line without quoting the matched text", () => {
  const findings = findPortabilityIssues(addedLines(diff));
  const report = renderReport(findings, "x..y", { locationsOnly: true });
  assert.match(report, /## Home path \(1\)/);
  assert.match(report, /- `docs\/a\.md:10`/);
  assert.ok(!report.includes("/Users/alice/"), report);
});

test("the report says so when nothing is found and groups findings when something is", () => {
  assert.match(renderReport([], "x..y"), /No matching machine-specific values detected/);
  const report = renderReport(findPortabilityIssues(addedLines(diff)), "x..y");
  assert.match(report, /## Home path \(1\)/);
  assert.match(report, /docs\/a\.md:10/);
});

test("the CLI executes through a script path containing spaces and a hash", async () => {
  const { mkdtempSync, symlinkSync, rmSync } = await import("node:fs");
  const { tmpdir } = await import("node:os");
  const { join } = await import("node:path");
  const { fileURLToPath } = await import("node:url");
  const { spawnSync } = await import("node:child_process");
  const temp = mkdtempSync(join(tmpdir(), "openrig script # "));
  try {
    const script = join(temp, "portability report.mjs");
    symlinkSync(fileURLToPath(new URL("./portability-report.mjs", import.meta.url)), script);
    const result = spawnSync(process.execPath, [script, "--unknown-option"], { encoding: "utf8" });
    assert.equal(result.status, 2);
    assert.match(result.stderr, /Unknown argument: --unknown-option/);
  } finally { rmSync(temp, { recursive: true, force: true }); }
});


test("the CLI executes with preserve-symlinks-main and imports without argv remain inert", async () => {
  const { mkdtempSync, symlinkSync, rmSync } = await import("node:fs");
  const { tmpdir } = await import("node:os");
  const { join } = await import("node:path");
  const { fileURLToPath } = await import("node:url");
  const { spawnSync } = await import("node:child_process");
  const temp = mkdtempSync(join(tmpdir(), "openrig preserved # "));
  const source = new URL("./portability-report.mjs", import.meta.url);
  try {
    const script = join(temp, "report.mjs");
    symlinkSync(fileURLToPath(source), script);
    const run = spawnSync(process.execPath, ["--preserve-symlinks-main", script, "--unknown-option"], { encoding: "utf8" });
    assert.equal(run.status, 2, run.stderr);
    assert.match(run.stderr, /Unknown argument/);
    const imported = spawnSync(process.execPath, ["--input-type=module", "-e", `await import(${JSON.stringify(source.href)})`], { encoding: "utf8" });
    assert.equal(imported.status, 0, imported.stderr);
    assert.equal(imported.stdout, "");
    assert.equal(imported.stderr, "");
  } finally { rmSync(temp, { recursive: true, force: true }); }
});

test("keeps added header-shaped text as source content inside a hunk", () => {
  const text = ["+++ b/file.md", "@@ -0,0 +1,2 @@", "+++ b/literal.md", "+see /Users/alice/work"].join("\n");
  assert.deepEqual(addedLines(text), [
    { file: "file.md", line: 1, text: "++ b/literal.md" },
    { file: "file.md", line: 2, text: "see /Users/alice/work" },
  ]);
});


test("native Git reports UTF-8 and spaced names independently of quotePath and diff-prefix configuration", async () => {
  const { mkdtempSync, writeFileSync, rmSync } = await import("node:fs");
  const { tmpdir } = await import("node:os");
  const { join } = await import("node:path");
  const { fileURLToPath } = await import("node:url");
  const { execFileSync } = await import("node:child_process");
  const repo = mkdtempSync(join(tmpdir(), "openrig-portability-paths-"));
  const names = ["café.md", "ordinary name.md"];
  try {
    execFileSync("git", ["init", "--quiet", repo]);
    for (const name of names) writeFileSync(join(repo, name), "see /Users/alice/project\n");
    execFileSync("git", ["-C", repo, "add", "--", ...names]);
    for (const [quotePath, mnemonicPrefix] of [["true", "true"], ["false", "true"], ["true", "false"], ["false", "false"]]) {
      execFileSync("git", ["-C", repo, "config", "diff.mnemonicPrefix", mnemonicPrefix]);
      execFileSync("git", ["-C", repo, "config", "core.quotePath", quotePath]);
      const report = execFileSync(process.execPath, [fileURLToPath(new URL("./portability-report.mjs", import.meta.url)), "--repo", repo, "--staged", "--locations-only"], { encoding: "utf8" });
      for (const name of names) assert.ok(report.includes(`\`${name}:1\``), report);
      assert.ok(!report.includes("\t"), report);
    }
  } finally { rmSync(repo, { recursive: true, force: true }); }
});

test("strips Git's separator tab and leaves C-quoted filenames quoted", () => {
  for (const header of ['"b/quote\\\"name.md"', '"b/back\\\\slash.md"', '"b/tab\\tname.md"']) {
    const diff = `+++ ${header}\n@@ -0,0 +1 @@\n+see /Users/alice/project\n`;
    assert.deepEqual(addedLines(diff), [{ file: header, line: 1, text: "see /Users/alice/project" }]);
  }
  assert.deepEqual(addedLines("+++ b/ordinary name.md\t\n@@ -0,0 +1 @@\n+see /Users/alice/project\n"), [{ file: "ordinary name.md", line: 1, text: "see /Users/alice/project" }]);
});