Files
openclaw/test/scripts/plain-gh.test.ts
2026-06-22 18:44:21 +08:00

109 lines
3.4 KiB
TypeScript

// Plain GitHub CLI helper tests cover wrapper-safe gh execution for maintainer scripts.
import { spawnSync } from "node:child_process";
import { chmodSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it } from "vitest";
import { plainGhEnv, resolvePlainGhBin } from "../../scripts/lib/plain-gh.mjs";
const tempDirs: string[] = [];
afterEach(() => {
for (const dir of tempDirs.splice(0)) {
rmSync(dir, { recursive: true, force: true });
}
});
function makeFakeGh(): string {
const dir = mkdtempSync(path.join(tmpdir(), "plain-gh-"));
tempDirs.push(dir);
const binDir = path.join(dir, "bin");
mkdirSync(binDir);
const ghPath = path.join(binDir, "gh");
writeFileSync(
ghPath,
`#!/usr/bin/env bash
printf 'argv=%s\\n' "$*"
printf 'NO_COLOR=%s\\n' "\${NO_COLOR-}"
printf 'GH_FORCE_TTY=%s\\n' "\${GH_FORCE_TTY-}"
printf 'FORCE_COLOR=%s\\n' "\${FORCE_COLOR-}"
printf 'CLICOLOR=%s\\n' "\${CLICOLOR-}"
printf 'CLICOLOR_FORCE=%s\\n' "\${CLICOLOR_FORCE-}"
printf 'COLORTERM_SET=%s\\n' "\${COLORTERM+x}"
`,
);
chmodSync(ghPath, 0o755);
return ghPath;
}
describe("plain gh helpers", () => {
it("prefers OPENCLAW_GH_BIN over PATH shims", () => {
const ghPath = makeFakeGh();
expect(
resolvePlainGhBin({
HOME: path.dirname(path.dirname(ghPath)),
OPENCLAW_GH_BIN: ghPath,
PATH: "",
}),
).toBe(ghPath);
});
it("normalizes color environment for JSON-safe gh output", () => {
expect(
plainGhEnv({
CLICOLOR: "1",
CLICOLOR_FORCE: "1",
COLORTERM: "truecolor",
FORCE_COLOR: "3",
}),
).toMatchObject({
NO_COLOR: "1",
FORCE_COLOR: "0",
CLICOLOR: "0",
CLICOLOR_FORCE: "0",
});
expect(plainGhEnv({ COLORTERM: "truecolor" })).not.toHaveProperty("COLORTERM");
expect(plainGhEnv({ GH_FORCE_TTY: "120" })).not.toHaveProperty("GH_FORCE_TTY");
});
it("runs the shell helper with color disabled", () => {
const ghPath = makeFakeGh();
const outputPath = path.join(path.dirname(path.dirname(ghPath)), "output.txt");
const script = [
"set -euo pipefail",
"source scripts/lib/plain-gh.sh",
`OPENCLAW_GH_BIN=${JSON.stringify(ghPath)}`,
"export OPENCLAW_GH_BIN",
`gh_plain api rate_limit > ${JSON.stringify(outputPath)}`,
].join("\n");
const result = spawnSync("bash", ["-lc", script], {
encoding: "utf8",
env: {
...process.env,
CLICOLOR: "1",
CLICOLOR_FORCE: "1",
COLORTERM: "truecolor",
FORCE_COLOR: "3",
},
});
expect(result.status).toBe(0);
expect(readFileSync(outputPath, "utf8")).toContain("argv=api rate_limit");
expect(readFileSync(outputPath, "utf8")).toContain("NO_COLOR=1");
expect(readFileSync(outputPath, "utf8")).toContain("GH_FORCE_TTY=");
expect(readFileSync(outputPath, "utf8")).toContain("FORCE_COLOR=0");
expect(readFileSync(outputPath, "utf8")).toContain("CLICOLOR=0");
expect(readFileSync(outputPath, "utf8")).toContain("CLICOLOR_FORCE=0");
expect(readFileSync(outputPath, "utf8")).toContain("COLORTERM_SET=");
});
it("keeps the shell resolver on external gh binaries", () => {
const helper = readFileSync("scripts/lib/plain-gh.sh", "utf8");
expect(helper).toContain("type -P gh");
expect(helper).not.toContain("command -v gh");
});
});