File size: 5,451 Bytes
eb3f11e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | // Build program tests cover root CLI program construction and command wiring.
import process from "node:process";
import { Command, CommanderError } from "commander";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { buildProgram } from "./build-program.js";
import type { ProgramContext } from "./context.js";
const registerProgramCommandsMock = vi.hoisted(() => vi.fn());
const createProgramContextMock = vi.hoisted(() => vi.fn());
const configureProgramHelpMock = vi.hoisted(() => vi.fn());
const registerPreActionHooksMock = vi.hoisted(() => vi.fn());
const setProgramContextMock = vi.hoisted(() => vi.fn());
vi.mock("./command-registry.js", () => ({
registerProgramCommands: registerProgramCommandsMock,
}));
vi.mock("./context.js", () => ({
createProgramContext: createProgramContextMock,
}));
vi.mock("./help.js", () => ({
configureProgramHelp: configureProgramHelpMock,
}));
vi.mock("./preaction.js", () => ({
registerPreActionHooks: registerPreActionHooksMock,
}));
vi.mock("./program-context.js", () => ({
setProgramContext: setProgramContextMock,
}));
describe("buildProgram", () => {
function mockProcessOutput() {
vi.spyOn(process.stdout, "write").mockImplementation(
(() => true) as unknown as typeof process.stdout.write,
);
vi.spyOn(process.stderr, "write").mockImplementation(
(() => true) as unknown as typeof process.stderr.write,
);
}
async function expectCommanderExit(promise: Promise<unknown>, exitCode: number) {
const error = await promise.catch((err: unknown) => err);
expect(error).toBeInstanceOf(CommanderError);
expect((error as CommanderError).exitCode).toBe(exitCode);
return error as CommanderError;
}
beforeEach(() => {
vi.clearAllMocks();
mockProcessOutput();
createProgramContextMock.mockReturnValue({
programVersion: "9.9.9-test",
messageChannelOptions: "quietchat",
agentChannelOptions: "last|quietchat",
} satisfies ProgramContext);
});
afterEach(() => {
process.exitCode = undefined;
vi.restoreAllMocks();
});
it("wires context/help/preaction/command registration with shared context", () => {
const argv = ["node", "openclaw", "status"];
const originalArgv = process.argv;
process.argv = argv;
try {
const program = buildProgram();
const ctx = createProgramContextMock.mock.results[0]?.value as ProgramContext;
expect(program).toBeInstanceOf(Command);
expect(setProgramContextMock).toHaveBeenCalledWith(program, ctx);
expect(configureProgramHelpMock).toHaveBeenCalledWith(program, ctx);
expect(registerPreActionHooksMock).toHaveBeenCalledWith(program, ctx.programVersion);
expect(registerProgramCommandsMock).toHaveBeenCalledWith(program, ctx, argv);
} finally {
process.argv = originalArgv;
}
});
it("sets exitCode to 1 on argument errors (fixes #60905)", async () => {
const program = buildProgram();
program.command("test").description("Test command");
const error = await expectCommanderExit(
program.parseAsync(["test", "unexpected-arg"], { from: "user" }),
1,
);
expect(error.code).toBe("commander.excessArguments");
expect(process.exitCode).toBe(1);
});
it("does not run the command action after an argument error", async () => {
const program = buildProgram();
const actionSpy = vi.fn();
program.command("test").action(actionSpy);
await expectCommanderExit(program.parseAsync(["test", "unexpected-arg"], { from: "user" }), 1);
expect(actionSpy).not.toHaveBeenCalled();
});
it("preserves exitCode 0 for help display", async () => {
const program = buildProgram();
program.command("test").description("Test command");
const error = await expectCommanderExit(program.parseAsync(["--help"], { from: "user" }), 0);
expect(error.code).toBe("commander.helpDisplayed");
expect(process.exitCode).toBe(0);
});
it("preserves exitCode 0 for version display", async () => {
const program = buildProgram();
program.version("1.0.0");
const error = await expectCommanderExit(program.parseAsync(["--version"], { from: "user" }), 0);
expect(error.code).toBe("commander.version");
expect(process.exitCode).toBe(0);
});
it("preserves non-zero exitCode for help error flows", async () => {
const program = buildProgram();
program.helpCommand("help [command]");
const error = await expectCommanderExit(
program.parseAsync(["help", "missing"], { from: "user" }),
1,
);
expect(error.code).toBe("commander.help");
expect(process.exitCode).toBe(1);
});
it("preserves caller-configured Commander error output", async () => {
let stderr = "";
const outputError = vi.fn((value: string, write: (value: string) => void) => {
write(`custom: ${value}`);
});
const originalArgv = process.argv;
const program = buildProgram().configureOutput({
writeErr: (value) => {
stderr += value;
},
outputError,
});
program.command("probe").action(() => {});
process.argv = ["node", "openclaw", "probe", "--wat"];
try {
await expectCommanderExit(program.parseAsync(process.argv), 1);
} finally {
process.argv = originalArgv;
}
expect(outputError).toHaveBeenCalledOnce();
expect(stderr).toContain("custom: error: unknown option '--wat'");
});
});
|