File size: 5,147 Bytes
fc93158 | 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 | import { Command } from "commander";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { ProgramContext } from "./context.js";
const hasEmittedCliBannerMock = vi.fn(() => false);
const formatCliBannerLineMock = vi.fn(() => "BANNER-LINE");
const formatDocsLinkMock = vi.fn((_path: string, full: string) => `https://${full}`);
const resolveCommitHashMock = vi.fn<() => string | null>(() => "abc1234");
const resolveCliNameMock = vi.fn(() => "openclaw");
const resolveCliDisplayNameMock = vi.fn(() => "OpenClaw");
vi.mock("../../terminal/links.js", () => ({
formatDocsLink: formatDocsLinkMock,
}));
vi.mock("../../terminal/theme.js", () => ({
isRich: () => false,
theme: {
heading: (s: string) => s,
muted: (s: string) => s,
option: (s: string) => s,
command: (s: string) => s,
error: (s: string) => s,
},
}));
vi.mock("../banner.js", () => ({
formatCliBannerLine: formatCliBannerLineMock,
hasEmittedCliBanner: hasEmittedCliBannerMock,
}));
vi.mock("../../infra/git-commit.js", () => ({
resolveCommitHash: resolveCommitHashMock,
}));
vi.mock("../cli-name.js", () => ({
resolveCliName: resolveCliNameMock,
resolveCliDisplayName: resolveCliDisplayNameMock,
replaceCliName: (cmd: string) => cmd,
}));
vi.mock("./command-registry.js", () => ({
getCoreCliCommandsWithSubcommands: () => ["models", "message"],
}));
vi.mock("./register.subclis.js", () => ({
getSubCliCommandsWithSubcommands: () => ["gateway"],
}));
const { configureProgramHelp } = await import("./help.js");
const testProgramContext: ProgramContext = {
programVersion: "9.9.9-test",
channelOptions: ["telegram"],
messageChannelOptions: "telegram",
agentChannelOptions: "last|telegram",
};
describe("configureProgramHelp", () => {
let originalArgv: string[];
beforeEach(() => {
vi.clearAllMocks();
originalArgv = [...process.argv];
hasEmittedCliBannerMock.mockReturnValue(false);
resolveCommitHashMock.mockReturnValue("abc1234");
resolveCliNameMock.mockReturnValue("openclaw");
resolveCliDisplayNameMock.mockReturnValue("OpenClaw");
});
afterEach(() => {
process.argv = originalArgv;
});
function makeProgramWithCommands() {
const program = new Command();
program.command("models").description("models");
program.command("status").description("status");
return program;
}
function captureHelpOutput(program: Command): string {
let output = "";
const writeSpy = vi.spyOn(process.stdout, "write").mockImplementation(((
chunk: string | Uint8Array,
) => {
output += String(chunk);
return true;
}) as typeof process.stdout.write);
try {
program.outputHelp();
return output;
} finally {
writeSpy.mockRestore();
}
}
function expectVersionExit(params: { expectedVersion: string }) {
const logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
const exitSpy = vi.spyOn(process, "exit").mockImplementation(((code?: number) => {
throw new Error(`exit:${code ?? ""}`);
}) as typeof process.exit);
try {
const program = makeProgramWithCommands();
expect(() => configureProgramHelp(program, testProgramContext)).toThrow("exit:0");
expect(logSpy).toHaveBeenCalledWith(params.expectedVersion);
expect(exitSpy).toHaveBeenCalledWith(0);
} finally {
logSpy.mockRestore();
exitSpy.mockRestore();
}
}
it("adds root help hint and marks commands with subcommands", () => {
process.argv = ["node", "openclaw", "--help"];
const program = makeProgramWithCommands();
configureProgramHelp(program, testProgramContext);
const help = captureHelpOutput(program);
expect(help).toContain("Hint: commands suffixed with * have subcommands");
expect(help).toContain("models *");
expect(help).toContain("status");
expect(help).not.toContain("status *");
});
it("includes banner and docs/examples in root help output", () => {
process.argv = ["node", "openclaw", "--help"];
const program = makeProgramWithCommands();
configureProgramHelp(program, testProgramContext);
const help = captureHelpOutput(program);
expect(help).toContain("BANNER-LINE");
expect(help).toContain("Examples:");
expect(help).toContain("https://docs.openclaw.ai/cli");
});
it("prints version and exits immediately when version flags are present", () => {
process.argv = ["node", "openclaw", "--version"];
expectVersionExit({ expectedVersion: "OpenClaw 9.9.9-test (abc1234)" });
});
it("prints version and exits immediately without commit metadata", () => {
process.argv = ["node", "openclaw", "--version"];
resolveCommitHashMock.mockReturnValue(null);
expectVersionExit({ expectedVersion: "OpenClaw 9.9.9-test" });
});
it("prints OpenSkynet when launched via openskynet", () => {
process.argv = ["node", "openskynet", "--version"];
resolveCliNameMock.mockReturnValue("openskynet");
resolveCliDisplayNameMock.mockReturnValue("OpenSkynet");
expectVersionExit({ expectedVersion: "OpenSkynet 9.9.9-test (abc1234)" });
});
});
|