pi-usereq 0.49.0 → 0.51.0

package/tests/release-workflow.test.ts

@@ -1,195 +0,0 @@
-import assert from "node:assert/strict";
-import { spawnSync } from "node:child_process";
-import fs from "node:fs";
-import path from "node:path";
-import test from "node:test";
-
-/**
- * @brief Loads the npm release workflow YAML for structural assertions.
- * @details Resolves the repository-local workflow path from the current process working directory and returns the UTF-8 document unchanged so tests can assert release-gating and publication directives deterministically. Runtime is O(n) in file size. Side effects are limited to filesystem reads.
- * @return {string} Raw workflow YAML text.
- * @satisfies TST-039
- */
-function readReleaseWorkflow(): string {
-  return fs.readFileSync(
-    path.join(process.cwd(), ".github", "workflows", "release-npm.yml"),
-    "utf8",
-  );
-}
-
-/**
- * @brief Verifies the release workflow YAML parses successfully via Python.
- * @details Resolves a project-local `.venv/bin/python` first, then falls back to `python` and `python3`, executes an inline `yaml.safe_load(...)` check against `.github/workflows/release-npm.yml`, accepts the `PyYAML not available` skip path, and fails on non-zero exit status or `YAML ERROR` output. Runtime is dominated by subprocess probing and one Python execution. Side effects are limited to subprocess creation and filesystem reads performed by the Python snippet.
- * @return {void} No return value.
- * @throws {AssertionError} Throws when no usable Python interpreter exists or the workflow YAML fails to parse.
- * @satisfies TST-039
- */
-function assertReleaseWorkflowYamlSyntax(): void {
-  const workflowPath = path.join(
-    process.cwd(),
-    ".github",
-    "workflows",
-    "release-npm.yml",
-  );
-  const pythonCandidates = [
-    path.join(process.cwd(), ".venv", "bin", "python"),
-    "python",
-    "python3",
-  ];
-  const pythonCommand = pythonCandidates.find((candidate) => {
-    if (candidate.includes(path.sep) && !fs.existsSync(candidate)) {
-      return false;
-    }
-    const probe = spawnSync(candidate, ["--version"], { encoding: "utf8" });
-    return !probe.error && probe.status === 0;
-  });
-  assert.ok(pythonCommand, "python executable not found for release workflow validation");
-
-  const pythonCode = [
-    "from pathlib import Path",
-    "import sys",
-    `p = Path(${JSON.stringify(workflowPath)})`,
-    "text = p.read_text()",
-    "try:",
-    "    import yaml",
-    "except Exception as error:",
-    "    print(f'PyYAML not available: {error}')",
-    "    sys.exit(0)",
-    "try:",
-    "    yaml.safe_load(text)",
-    "    print('YAML OK')",
-    "except Exception as error:",
-    "    print(f'YAML ERROR: {error}')",
-    "    sys.exit(1)",
-  ].join("\n");
-  const result = spawnSync(pythonCommand, ["-c", pythonCode], {
-    cwd: process.cwd(),
-    encoding: "utf8",
-  });
-  const output = `${result.stdout}${result.stderr}`;
-
-  assert.equal(result.status, 0, output || result.error?.message || "unknown python execution failure");
-  assert.doesNotMatch(output, /YAML ERROR:/u);
-}
-
-/**
- * @brief Describes the package manifest fields asserted by npm release tests.
- * @details Constrains the parsed `package.json` shape to the publication identity and provenance metadata required by the release workflow tests. The interface is compile-time only and introduces no runtime side effects.
- */
-interface PackageManifest {
-  name?: unknown;
-  repository?: {
-    type?: unknown;
-    url?: unknown;
-  };
-  bugs?: {
-    url?: unknown;
-  };
-  homepage?: unknown;
-}
-
-/**
- * @brief Loads the repository package manifest for npm publication assertions.
- * @details Resolves `package.json` from the current process working directory, parses the UTF-8 JSON document, and returns the manifest object so tests can assert publication identity and provenance metadata deterministically. Runtime is O(n) in file size. Side effects are limited to filesystem reads.
- * @return {PackageManifest} Parsed package manifest.
- * @satisfies TST-042, TST-044
- */
-function readPackageManifest(): PackageManifest {
-  return JSON.parse(
-    fs.readFileSync(path.join(process.cwd(), "package.json"), "utf8"),
-  ) as PackageManifest;
-}
-
-/**
- * @brief Asserts the fixed npm package name used for publication.
- * @details Loads `package.json` and verifies that the published package name remains `pi-usereq`, preserving the canonical npm package identity. Runtime is O(n) in file size. Side effects are limited to filesystem reads through `readPackageManifest`.
- * @return {void} No return value.
- * @satisfies TST-042
- */
-function assertFixedPackageName(): void {
-  const manifest = readPackageManifest();
-
-  assert.equal(manifest.name, "pi-usereq");
-}
-
-/**
- * @brief Asserts canonical GitHub provenance metadata in `package.json`.
- * @details Loads `package.json` and verifies that repository, issues, and homepage URLs remain aligned to the canonical GitHub repository required by npm provenance validation. Runtime is O(n) in file size. Side effects are limited to filesystem reads through `readPackageManifest`.
- * @return {void} No return value.
- * @satisfies TST-044
- */
-function assertCanonicalPackageProvenanceMetadata(): void {
-  const manifest = readPackageManifest();
-
-  assert.deepEqual(manifest.repository, {
-    type: "git",
-    url: "git+https://github.com/Ogekuri/PI-useReq.git",
-  });
-  assert.deepEqual(manifest.bugs, {
-    url: "https://github.com/Ogekuri/PI-useReq/issues",
-  });
-  assert.equal(manifest.homepage, "https://github.com/Ogekuri/PI-useReq#readme");
-}
-
-test(
-  "release workflow remains valid YAML when parsed by Python",
-  assertReleaseWorkflowYamlSyntax,
-);
-
-test(
-  "release workflow keeps the current tag trigger and gates release work on origin/master ancestry",
-  () => {
-    const workflow = readReleaseWorkflow();
-
-    assert.match(workflow, /name:\s+Release \(npm\)/);
-    assert.match(workflow, /tags:\s*\n\s*-\s*'v\[0-9\]\+\.\[0-9\]\+\.\[0-9\]\+'/);
-    assert.ok(workflow.includes("check-branch:"));
-    assert.ok(workflow.includes("is_master: ${{ steps.check.outputs.is_master }}"));
-    assert.ok(workflow.includes("git fetch origin master"));
-    assert.ok(workflow.includes('grep -q "origin/master"'));
-    assert.ok(
-      workflow.includes("if: needs.check-branch.outputs.is_master == 'true'"),
-    );
-    assert.ok(workflow.includes("build-release:"));
-  },
-);
-
-test(
-  "release workflow pins Node.js 24.15.0, publishes to npm, and creates the GitHub release",
-  () => {
-    const workflow = readReleaseWorkflow();
-
-    assert.match(workflow, /NODE_VERSION:\s+'24\.15\.0'/);
-    assert.ok(workflow.includes("uses: actions/setup-node@v5"));
-    assert.ok(workflow.includes("registry-url: 'https://registry.npmjs.org'"));
-    assert.ok(workflow.includes("run: npm ci"));
-    assert.ok(workflow.includes("run: npm pkg delete private"));
-    assert.ok(
-      workflow.includes("run: npm publish --provenance --access public"),
-    );
-    assert.ok(workflow.includes("NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}"));
-    assert.ok(
-      workflow.includes(
-        "uses: mikepenz/release-changelog-builder-action@v6",
-      ),
-    );
-    assert.ok(workflow.includes("uses: softprops/action-gh-release@v2"));
-    assert.ok(workflow.includes("draft: false"));
-    assert.ok(workflow.includes("prerelease: false"));
-    assert.ok(
-      workflow.includes(
-        "body: ${{ steps.build_changelog.outputs.changelog }}",
-      ),
-    );
-  },
-);
-
-test(
-  "package manifest keeps the npm publication name fixed to pi-usereq",
-  assertFixedPackageName,
-);
-
-test(
-  "package manifest keeps canonical repository, bugs, and homepage metadata for npm provenance",
-  assertCanonicalPackageProvenanceMetadata,
-);

package/tests/static-check-bundled.test.ts

@@ -1,332 +0,0 @@
-/**
- * @file
- * @brief Verifies bundled static-checker resolution, postinstall exit-code invariants, and session_start missing-checker notification.
- * @details Exercises `resolveCheckerExecutable` bundled-bin precedence, the `scripts/install-static-checkers.ts` exit-code-0 invariant, and the `checkDefaultCheckersAvailability` helper used during `session_start`. Runtime is dominated by filesystem metadata checks and optional child-process execution. Side effects are limited to temporary filesystem reads and bounded writes under the installation-owned `node_modules/.bin` with cleanup.
- */
-
-import test from "node:test";
-import assert from "node:assert/strict";
-import fs from "node:fs";
-import os from "node:os";
-import path from "node:path";
-import { spawnSync } from "node:child_process";
-import { createRequire } from "node:module";
-import {
-  resolveCheckerExecutable,
-  checkDefaultCheckersAvailability,
-} from "../src/core/static-check.js";
-import { getInstallationPath } from "../src/core/path-context.js";
-import { getDefaultConfig } from "../src/core/config.js";
-import {
-  main as installStaticCheckersMain,
-  approvePendingInstallScripts,
-  getConsumerInstallRoot,
-  selectInstallScriptPackageNames,
-  mergeAllowScriptsEntries,
-} from "../scripts/install-static-checkers.ts";
-import type {
-  NodeModulesPackage,
-  InstallScriptApprovalDeps,
-} from "../scripts/install-static-checkers.ts";
-
-const require = createRequire(import.meta.url);
-const ROOT = path.resolve(path.dirname(new URL(import.meta.url).pathname), "..");
-const TSX_LOADER = require.resolve("tsx", { paths: [ROOT] });
-
-/**
- * @brief Resolves the bundled `node_modules/.bin` directory probed by `resolveCheckerExecutable`.
- * @details Computes the first bundled-bin candidate directory derived from the runtime installation path so tests can create and clean up temporary fake executables at the exact probed location. Runtime is O(1). No side effects occur.
- * @return {string} Absolute bundled `node_modules/.bin` directory path.
- */
-function getBundledBinDir(): string {
-  return path.join(getInstallationPath(), "..", "node_modules", ".bin");
-}
-
-test("resolveCheckerExecutable probes bundled node_modules/.bin before PATH scan", () => {
-  const binDir = getBundledBinDir();
-  const fakeName = "pi-usereq-fake-checker";
-  const fakeBin = path.join(binDir, fakeName);
-  const dirExisted = fs.existsSync(binDir);
-  try {
-    fs.mkdirSync(binDir, { recursive: true });
-    fs.writeFileSync(fakeBin, "#!/bin/sh\nexit 0\n", { mode: 0o755 });
-    const resolved = resolveCheckerExecutable(fakeName);
-    assert.ok(resolved, "expected bundled-bin candidate to resolve");
-    assert.equal(resolved, fakeBin);
-  } finally {
-    if (fs.existsSync(fakeBin)) {
-      fs.rmSync(fakeBin, { force: true });
-    }
-    if (!dirExisted && fs.existsSync(binDir)) {
-      fs.rmSync(binDir, { recursive: true, force: true });
-    }
-  }
-});
-
-test("resolveCheckerExecutable falls back to PATH scan for system executables", () => {
-  const resolved = resolveCheckerExecutable("node");
-  assert.ok(resolved, "expected 'node' to resolve via PATH scan");
-});
-
-test("resolveCheckerExecutable returns undefined for non-existent commands", () => {
-  const resolved = resolveCheckerExecutable("pi-usereq-definitely-not-a-real-binary-xyz");
-  assert.equal(resolved, undefined);
-});
-
-test("scripts/install-static-checkers.ts always returns exit code 0", () => {
-  const exitCode = installStaticCheckersMain([]);
-  assert.equal(exitCode, 0);
-  const exitCodeWithArgs = installStaticCheckersMain(["--ignored"]);
-  assert.equal(exitCodeWithArgs, 0);
-});
-
-test("scripts/install-static-checkers.ts exits 0 when invoked as a subprocess", () => {
-  const result = spawnSync(
-    "node",
-    ["--import", TSX_LOADER, path.join(ROOT, "scripts", "install-static-checkers.ts")],
-    { encoding: "utf8" },
-  );
-  assert.equal(result.status, 0);
-});
-
-test("checkDefaultCheckersAvailability returns missing enabled checkers for default config", () => {
-  const config = getDefaultConfig(process.cwd());
-  const missing = checkDefaultCheckersAvailability(config);
-  assert.ok(Array.isArray(missing), "expected an array of missing checker names");
-  for (const checker of ["cppcheck", "clang-format"]) {
-    if (!resolveCheckerExecutable(checker)) {
-      assert.ok(missing.includes(checker), `expected missing checker '${checker}' to be reported`);
-    }
-  }
-});
-
-test("checkDefaultCheckersAvailability returns empty array when all checkers disabled", () => {
-  const config = getDefaultConfig(process.cwd());
-  for (const languageConfig of Object.values(config["static-check"])) {
-    languageConfig.enabled = "disable";
-  }
-  const missing = checkDefaultCheckersAvailability(config);
-  assert.equal(missing.length, 0);
-});
-
-test("getConsumerInstallRoot resolves INIT_CWD as the consumer install root", () => {
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    process.env.INIT_CWD = "/tmp/pi-usereq-consumer-root";
-    delete process.env.npm_config_local_prefix;
-    assert.equal(getConsumerInstallRoot(), "/tmp/pi-usereq-consumer-root");
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-});
-
-test("getConsumerInstallRoot falls back to npm_config_local_prefix and then undefined", () => {
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    delete process.env.INIT_CWD;
-    process.env.npm_config_local_prefix = "/tmp/pi-usereq-prefix-root";
-    assert.equal(getConsumerInstallRoot(), "/tmp/pi-usereq-prefix-root");
-    delete process.env.npm_config_local_prefix;
-    assert.equal(getConsumerInstallRoot(), undefined);
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-});
-
-test("getConsumerInstallRoot prefers npm_config_local_prefix over INIT_CWD for --prefix installs", () => {
-  // Reproducer for `pi update --extensions` `npm warn allow-scripts`: the pi host runs
-  // `npm install <pkg> --prefix <installRoot>` from its own caller cwd, so INIT_CWD is the
-  // caller cwd while npm_config_local_prefix is the real install root. Resolving INIT_CWD
-  // first writes the allowScripts approval to the wrong project (or nowhere) and the warning
-  // persists on every extension update.
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    process.env.INIT_CWD = "/tmp/pi-usereq-caller-cwd";
-    process.env.npm_config_local_prefix = "/tmp/pi-usereq-install-root";
-    assert.equal(getConsumerInstallRoot(), "/tmp/pi-usereq-install-root");
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-});
-
-test("selectInstallScriptPackageNames returns only packages with lifecycle scripts", () => {
-  const packages: NodeModulesPackage[] = [
-    { name: "has-postinstall", scripts: { postinstall: "node install.js" } },
-    { name: "has-install", scripts: { install: "node build.js" } },
-    { name: "no-scripts", scripts: {} },
-    { name: "only-test-script", scripts: { test: "node --test" } },
-    { name: "empty-postinstall", scripts: { postinstall: "" } },
-    { name: "only-prepare-ignored", scripts: { prepare: "node prep.js" } },
-    { name: "@scope/has-preinstall", scripts: { preinstall: "node prep.js" } },
-  ];
-  assert.deepEqual(selectInstallScriptPackageNames(packages), [
-    "has-postinstall",
-    "has-install",
-    "@scope/has-preinstall",
-  ]);
-});
-
-test("mergeAllowScriptsEntries adds name-only approvals and preserves existing denials", () => {
-  const existing = { esbuild: true, koffi: false };
-  const merged = mergeAllowScriptsEntries(existing, ["esbuild", "pi-usereq", "koffi", "protobufjs"]);
-  assert.deepEqual(merged, {
-    esbuild: true,
-    koffi: false,
-    "pi-usereq": true,
-    protobufjs: true,
-  });
-});
-
-test("mergeAllowScriptsEntries starts from undefined and skips empty names", () => {
-  const merged = mergeAllowScriptsEntries(undefined, ["esbuild", "", "  "]);
-  assert.deepEqual(merged, { esbuild: true });
-});
-
-test("approvePendingInstallScripts writes name-only allowScripts into the consumer root", () => {
-  const consumerRoot = "/tmp/pi-usereq-approval-root";
-  const nodeModules = `${consumerRoot}/node_modules`;
-  const rootPackageJson = `${consumerRoot}/package.json`;
-  const files = new Map<string, string>([
-    [`${nodeModules}/esbuild/package.json`, JSON.stringify({ name: "esbuild", scripts: { postinstall: "node install.js" } })],
-    [`${nodeModules}/safe-dep/package.json`, JSON.stringify({ name: "safe-dep", scripts: { test: "node --test" } })],
-    [`${nodeModules}/@scope/has-install/package.json`, JSON.stringify({ name: "@scope/has-install", scripts: { install: "node build.js" } })],
-    [rootPackageJson, JSON.stringify({ name: "pi-extensions", private: true, dependencies: { "pi-usereq": "^0.45.0" } })],
-  ]);
-  const dirs = new Map<string, string[]>([
-    [nodeModules, ["esbuild", "safe-dep", "@scope", ".bin"]],
-    [`${nodeModules}/@scope`, ["has-install"]],
-  ]);
-  let writtenPath = "";
-  let writtenData = "";
-  const deps: InstallScriptApprovalDeps = {
-    existsSync: (p) => files.has(p) || dirs.has(p),
-    readdirSync: (p) => dirs.get(p) ?? [],
-    readFileSync: (p) => files.get(p) ?? "",
-    writeFileSync: (p, data) => {
-      writtenPath = p;
-      writtenData = data;
-    },
-  };
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    process.env.INIT_CWD = consumerRoot;
-    delete process.env.npm_config_local_prefix;
-    approvePendingInstallScripts(deps);
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-  assert.equal(writtenPath, rootPackageJson);
-  const written = JSON.parse(writtenData) as { allowScripts?: Record<string, boolean>; dependencies?: unknown };
-  assert.deepEqual(written.allowScripts, { esbuild: true, "@scope/has-install": true });
-  assert.ok(written.dependencies, "existing package.json fields MUST be preserved");
-});
-
-test("approvePendingInstallScripts preserves existing allowScripts and skips when nothing changes", () => {
-  const consumerRoot = "/tmp/pi-usereq-noop-root";
-  const nodeModules = `${consumerRoot}/node_modules`;
-  const rootPackageJson = `${consumerRoot}/package.json`;
-  const files = new Map<string, string>([
-    [`${nodeModules}/esbuild/package.json`, JSON.stringify({ name: "esbuild", scripts: { postinstall: "node install.js" } })],
-    [rootPackageJson, JSON.stringify({ name: "pi-extensions", allowScripts: { esbuild: true, koffi: false } })],
-  ]);
-  const dirs = new Map<string, string[]>([[nodeModules, ["esbuild"]]]);
-  let wrote = false;
-  const deps: InstallScriptApprovalDeps = {
-    existsSync: (p) => files.has(p) || dirs.has(p),
-    readdirSync: (p) => dirs.get(p) ?? [],
-    readFileSync: (p) => files.get(p) ?? "",
-    writeFileSync: () => {
-      wrote = true;
-    },
-  };
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    process.env.INIT_CWD = consumerRoot;
-    delete process.env.npm_config_local_prefix;
-    approvePendingInstallScripts(deps);
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-  assert.equal(wrote, false);
-});
-
-test("approvePendingInstallScripts skips approval outside an npm install lifecycle", () => {
-  let wrote = false;
-  const deps: InstallScriptApprovalDeps = {
-    existsSync: () => true,
-    readdirSync: () => [],
-    readFileSync: () => "{}",
-    writeFileSync: () => {
-      wrote = true;
-    },
-  };
-  const previousInitCwd = process.env.INIT_CWD;
-  const previousPrefix = process.env.npm_config_local_prefix;
-  try {
-    delete process.env.INIT_CWD;
-    delete process.env.npm_config_local_prefix;
-    approvePendingInstallScripts(deps);
-  } finally {
-    if (previousInitCwd === undefined) {
-      delete process.env.INIT_CWD;
-    } else {
-      process.env.INIT_CWD = previousInitCwd;
-    }
-    if (previousPrefix === undefined) {
-      delete process.env.npm_config_local_prefix;
-    } else {
-      process.env.npm_config_local_prefix = previousPrefix;
-    }
-  }
-  assert.equal(wrote, false);
-});