import assert from "node:assert/strict"; import { execFile } from "node:child_process"; import { mkdir, mkdtemp, readFile, writeFile } from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { promisify } from "node:util"; import { test } from "node:test"; const execFileAsync = promisify(execFile); test("check command runs from a plugin root without fixture config", async () => { const rootDir = await mkdtemp(path.join(os.tmpdir(), "plugin-inspector-cli-root-")); await mkdir(path.join(rootDir, "src"), { recursive: true }); await writeFile( path.join(rootDir, "package.json"), `${JSON.stringify( { name: "@example/openclaw-weather", version: "1.0.0", type: "module", openclaw: { extensions: ["src/index.js"], compat: { pluginApi: "^1.0.0" }, }, }, null, 2, )}\n`, "utf8", ); await writeFile( path.join(rootDir, "openclaw.plugin.json"), `${JSON.stringify({ id: "weather", name: "Weather", version: "1.0.0", contracts: { tools: {} } }, null, 2)}\n`, "utf8", ); await writeFile( path.join(rootDir, "src", "index.js"), 'import { definePluginEntry } from "openclaw/plugin-sdk";\nexport default definePluginEntry((api) => api.registerTool({ name: "weather" }));\n', "utf8", ); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync(process.execPath, [cliPath, "check", "--out", "reports", "--no-openclaw"], { cwd: rootDir, }); const report = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector-report.json"), "utf8")); const issues = await readFile(path.join(rootDir, "reports", "plugin-inspector-issues.md"), "utf8"); assert.match(stdout, /Status: PASS/); assert.equal(report.summary.logCount, report.logs.length); assert.match(stdout, new RegExp(`Logs: ${report.logs.length}\\b`)); assert.doesNotMatch(stdout, /Logs: undefined/); assert.equal(report.targetOpenClaw.status, "disabled"); assert.equal(report.fixtures[0].id, "weather"); assert.ok(report.fixtures[0].package.openclaw.entrypoints.some((entrypoint) => entrypoint.exists)); assert.match(issues, /# OpenClaw Plugin Issue Findings/); await execFileAsync( process.execPath, [cliPath, "check", "--out", "capture-reports", "--no-openclaw", "--capture", "--allow-execute"], { cwd: rootDir }, ); const capture = JSON.parse( await readFile(path.join(rootDir, "capture-reports", "plugin-inspector-runtime-capture.json"), "utf8"), ); assert.equal(capture.summary.capturedCount, 1); assert.equal(capture.summary.registrationCount, 1); }); test("check command can target a plugin root and use runtime aliases", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-target-"); const cliPath = path.resolve("src/cli.js"); await execFileAsync( process.execPath, [cliPath, "--plugin-root", rootDir, "--out", "reports", "--no-openclaw", "--runtime", "--mock-sdk", "--allow-execute"], { cwd: os.tmpdir(), }, ); const report = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector-report.json"), "utf8")); const capture = JSON.parse( await readFile(path.join(rootDir, "reports", "plugin-inspector-runtime-capture.json"), "utf8"), ); assert.equal(report.fixtures[0].id, "weather"); assert.equal(capture.summary.capturedCount, 1); }); test("check command sanitizes absolute OpenClaw paths in JSON output and artifacts", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-sanitize-"); const openclawPath = await createTargetOpenClaw(rootDir); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync( process.execPath, [cliPath, "check", "--out", "reports", "--openclaw", openclawPath, "--json"], { cwd: rootDir }, ); const output = JSON.parse(stdout); const artifact = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector-report.json"), "utf8")); assert.equal(output.targetOpenClaw.configuredPath, ""); assert.equal(artifact.targetOpenClaw.configuredPath, ""); assert.deepEqual(artifact.targetOpenClaw.searchedPaths, [""]); assert.doesNotMatch(stdout, new RegExp(escapeRegExp(openclawPath))); }); test("inspect command runs from a plugin root and can write CI outputs", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-inspect-"); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync(process.execPath, [ cliPath, "inspect", "--out", "reports", "--no-openclaw", "--sarif", "--junit", ], { cwd: rootDir, }); const sarif = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector.sarif"), "utf8")); const junit = await readFile(path.join(rootDir, "reports", "plugin-inspector.junit.xml"), "utf8"); assert.match(stdout, /Status: PASS/); assert.equal(sarif.version, "2.1.0"); assert.match(junit, / { const rootDir = await createCliPluginRoot("plugin-inspector-cli-config-runtime-"); await writeFile( path.join(rootDir, "plugin-inspector.config.json"), `${JSON.stringify({ version: 1, capture: { runtime: true, mockSdk: true } }, null, 2)}\n`, "utf8", ); const cliPath = path.resolve("src/cli.js"); await execFileAsync(process.execPath, [cliPath, "check", "--out", "reports", "--no-openclaw", "--allow-execute"], { cwd: rootDir, }); const capture = JSON.parse( await readFile(path.join(rootDir, "reports", "plugin-inspector-runtime-capture.json"), "utf8"), ); assert.equal(capture.summary.registrationCount, 1); }); test("config command prints resolved plugin root config", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-config-print-"); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync(process.execPath, [cliPath, "config", "--plugin-root", rootDir]); const { stdout: jsonStdout } = await execFileAsync(process.execPath, [ cliPath, "config", "--plugin-root", rootDir, "--json", ]); const config = JSON.parse(jsonStdout); assert.match(stdout, /Plugin: weather/); assert.match(stdout, /Runtime capture: off/); assert.equal(config.fixtures[0].id, "weather"); assert.equal(config.fixtures[0].subdir, "src"); }); test("ci command writes CI summary artifacts", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-ci-"); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync( process.execPath, [cliPath, "ci", "--config", path.join(rootDir, "plugin-inspector.config.json"), "--out", "reports", "--no-openclaw"], { cwd: rootDir, }, ); const report = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector-report.json"), "utf8")); const summary = JSON.parse( await readFile(path.join(rootDir, "reports", "plugin-inspector-ci-summary.json"), "utf8"), ); const markdown = await readFile(path.join(rootDir, "reports", "plugin-inspector-ci-summary.md"), "utf8"); const sarif = JSON.parse(await readFile(path.join(rootDir, "reports", "plugin-inspector.sarif"), "utf8")); const junit = await readFile(path.join(rootDir, "reports", "plugin-inspector.junit.xml"), "utf8"); assert.match(stdout, /Status: PASS/); assert.match(stdout, /Artifacts: 1/); assert.equal(report.targetOpenClaw.status, "disabled"); assert.ok(Array.isArray(report.issues)); assert.equal(summary.status, "pass"); assert.equal(summary.summary.breakages, 0); assert.equal(summary.summary.issues, report.summary.issueCount); assert.equal(summary.artifacts.compatibility, "plugin-inspector-report.json"); assert.match(markdown, /# Plugin Inspector CI Summary/); assert.equal(sarif.runs[0].tool.driver.name, "plugin-inspector"); assert.match(junit, /failures="0"/); }); test("init command writes plugin config and CI workflow", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-init-"); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync( process.execPath, [cliPath, "init", "--plugin-root", rootDir, "--ci", "--package-manager", "pnpm", "--force"], ); const config = JSON.parse(await readFile(path.join(rootDir, "plugin-inspector.config.json"), "utf8")); const workflow = await readFile(path.join(rootDir, ".github", "workflows", "plugin-inspector.yml"), "utf8"); assert.match(stdout, /^wrote plugin-inspector\.config\.json$/m); assert.match(stdout, /^wrote \.github\/workflows\/plugin-inspector\.yml$/m); assert.match(stdout, /^package manager: pnpm$/m); assert.equal(stdout.includes(rootDir), false); assert.equal(config.plugin.id, "weather"); assert.equal(config.plugin.sourceRoot, "src"); assert.equal(config.capture.mockSdk, true); assert.match(workflow, /pnpm dlx @openclaw\/plugin-inspector ci --no-openclaw --runtime --mock-sdk --allow-execute/); }); test("init command detects plugin package managers", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-init-pm-"); const cliPath = path.resolve("src/cli.js"); await writeFile(path.join(rootDir, "pnpm-lock.yaml"), "lockfileVersion: '9.0'\n", "utf8"); await execFileAsync(process.execPath, [cliPath, "init", "--plugin-root", rootDir, "--ci", "--force"]); const workflow = await readFile(path.join(rootDir, ".github", "workflows", "plugin-inspector.yml"), "utf8"); assert.match(workflow, /cache: pnpm/); assert.match(workflow, /corepack enable/); assert.match(workflow, /pnpm install --frozen-lockfile/); assert.match(workflow, /pnpm dlx @openclaw\/plugin-inspector ci --no-openclaw --runtime --mock-sdk --allow-execute/); }); test("init command can add package scripts", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-init-scripts-"); const cliPath = path.resolve("src/cli.js"); await execFileAsync(process.execPath, [cliPath, "init", "--plugin-root", rootDir, "--scripts", "--force"]); const packageJson = JSON.parse(await readFile(path.join(rootDir, "package.json"), "utf8")); assert.equal(packageJson.scripts["plugin:check"], "plugin-inspector inspect --no-openclaw"); assert.equal(packageJson.scripts["plugin:ci"], "plugin-inspector ci --no-openclaw --runtime --mock-sdk --allow-execute"); }); test("init command can preview generated files", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-init-dry-run-"); const cliPath = path.resolve("src/cli.js"); const beforeConfig = await readFile(path.join(rootDir, "plugin-inspector.config.json"), "utf8"); const beforePackageJson = await readFile(path.join(rootDir, "package.json"), "utf8"); const { stdout } = await execFileAsync(process.execPath, [ cliPath, "init", "--plugin-root", rootDir, "--ci", "--scripts", "--dry-run", ]); assert.match(stdout, /^would write plugin-inspector\.config\.json$/m); assert.match(stdout, /^would write \.github\/workflows\/plugin-inspector\.yml$/m); assert.match(stdout, /^would write package\.json$/m); assert.equal(await readFile(path.join(rootDir, "plugin-inspector.config.json"), "utf8"), beforeConfig); assert.equal(await readFile(path.join(rootDir, "package.json"), "utf8"), beforePackageJson); await assert.rejects(readFile(path.join(rootDir, ".github", "workflows", "plugin-inspector.yml"), "utf8"), { code: "ENOENT", }); }); test("init command can print a JSON summary", async () => { const rootDir = await createCliPluginRoot("plugin-inspector-cli-init-json-"); const cliPath = path.resolve("src/cli.js"); const { stdout } = await execFileAsync(process.execPath, [ cliPath, "init", "--plugin-root", rootDir, "--ci", "--scripts", "--dry-run", "--json", ]); const summary = JSON.parse(stdout); assert.equal(summary.dryRun, true); assert.equal(summary.packageManager, "npm"); assert.equal(summary.pluginRoot, rootDir); assert.deepEqual(summary.files, [ "plugin-inspector.config.json", ".github/workflows/plugin-inspector.yml", "package.json", ]); }); async function createCliPluginRoot(prefix) { const rootDir = await mkdtemp(path.join(os.tmpdir(), prefix)); await mkdir(path.join(rootDir, "src"), { recursive: true }); await writeFile( path.join(rootDir, "package.json"), `${JSON.stringify( { name: "@example/openclaw-weather", version: "1.0.0", type: "module", openclaw: { extensions: ["src/index.js"], compat: { pluginApi: "^1.0.0" }, }, }, null, 2, )}\n`, "utf8", ); await writeFile( path.join(rootDir, "openclaw.plugin.json"), `${JSON.stringify({ id: "weather", name: "Weather", version: "1.0.0", contracts: { tools: {} } }, null, 2)}\n`, "utf8", ); await writeFile( path.join(rootDir, "src", "index.js"), 'import { definePluginEntry } from "openclaw/plugin-sdk";\nexport default definePluginEntry((api) => api.registerTool({ name: "weather" }));\n', "utf8", ); await writeFile( path.join(rootDir, "plugin-inspector.config.json"), `${JSON.stringify({ version: 1, plugin: { id: "weather", priority: "high", sourceRoot: "src" } }, null, 2)}\n`, "utf8", ); return rootDir; } async function createTargetOpenClaw(rootDir) { const openclawPath = path.join(rootDir, "target-openclaw"); await mkdir(path.join(openclawPath, "src/plugins/compat"), { recursive: true }); await writeFile( path.join(openclawPath, "src/plugins/compat/registry.ts"), 'export const records = [{ code: "legacy-root-sdk-import", status: "deprecated" }];\n', "utf8", ); return openclawPath; } function escapeRegExp(value) { return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); }