mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-09 17:14:33 +00:00
test: reclassify doctor command suites out of e2e
This commit is contained in:
Peter Steinberger
471
src/commands/doctor-config-flow.test.ts
Normal file
471
src/commands/doctor-config-flow.test.ts
Normal file
@@ -0,0 +1,471 @@
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import { withTempHome } from "../../test/helpers/temp-home.js";
|
||||
import { loadAndMaybeMigrateDoctorConfig } from "./doctor-config-flow.js";
|
||||
|
||||
async function runDoctorConfigWithInput(params: {
|
||||
config: Record<string, unknown>;
|
||||
repair?: boolean;
|
||||
}) {
|
||||
return withTempHome(async (home) => {
|
||||
const configDir = path.join(home, ".openclaw");
|
||||
await fs.mkdir(configDir, { recursive: true });
|
||||
await fs.writeFile(
|
||||
path.join(configDir, "openclaw.json"),
|
||||
JSON.stringify(params.config, null, 2),
|
||||
"utf-8",
|
||||
);
|
||||
return loadAndMaybeMigrateDoctorConfig({
|
||||
options: { nonInteractive: true, repair: params.repair },
|
||||
confirm: async () => false,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function expectGoogleChatDmAllowFromRepaired(cfg: unknown) {
|
||||
const typed = cfg as {
|
||||
channels: {
|
||||
googlechat: {
|
||||
dm: { allowFrom: string[] };
|
||||
allowFrom?: string[];
|
||||
};
|
||||
};
|
||||
};
|
||||
expect(typed.channels.googlechat.dm.allowFrom).toEqual(["*"]);
|
||||
expect(typed.channels.googlechat.allowFrom).toBeUndefined();
|
||||
}
|
||||
|
||||
describe("doctor config flow", () => {
|
||||
it("preserves invalid config for doctor repairs", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
config: {
|
||||
gateway: { auth: { mode: "token", token: 123 } },
|
||||
agents: { list: [{ id: "pi" }] },
|
||||
},
|
||||
});
|
||||
|
||||
expect((result.cfg as Record<string, unknown>).gateway).toEqual({
|
||||
auth: { mode: "token", token: 123 },
|
||||
});
|
||||
});
|
||||
|
||||
it("drops unknown keys on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
bridge: { bind: "auto" },
|
||||
gateway: { auth: { mode: "token", token: "ok", extra: true } },
|
||||
agents: { list: [{ id: "pi" }] },
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as Record<string, unknown>;
|
||||
expect(cfg.bridge).toBeUndefined();
|
||||
expect((cfg.gateway as Record<string, unknown>)?.auth).toEqual({
|
||||
mode: "token",
|
||||
token: "ok",
|
||||
});
|
||||
});
|
||||
|
||||
it("preserves discord streaming intent while stripping unsupported keys on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
discord: {
|
||||
streaming: true,
|
||||
lifecycle: {
|
||||
enabled: true,
|
||||
reactions: {
|
||||
queued: "⏳",
|
||||
thinking: "🧠",
|
||||
tool: "🔧",
|
||||
done: "✅",
|
||||
error: "❌",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as {
|
||||
channels: {
|
||||
discord: {
|
||||
streamMode?: string;
|
||||
streaming?: string;
|
||||
lifecycle?: unknown;
|
||||
};
|
||||
};
|
||||
};
|
||||
expect(cfg.channels.discord.streaming).toBe("partial");
|
||||
expect(cfg.channels.discord.streamMode).toBeUndefined();
|
||||
expect(cfg.channels.discord.lifecycle).toBeUndefined();
|
||||
});
|
||||
|
||||
it("resolves Telegram @username allowFrom entries to numeric IDs on repair", async () => {
|
||||
const fetchSpy = vi.fn(async (url: string) => {
|
||||
const u = String(url);
|
||||
const chatId = new URL(u).searchParams.get("chat_id") ?? "";
|
||||
const id =
|
||||
chatId.toLowerCase() === "@testuser"
|
||||
? 111
|
||||
: chatId.toLowerCase() === "@groupuser"
|
||||
? 222
|
||||
: chatId.toLowerCase() === "@topicuser"
|
||||
? 333
|
||||
: chatId.toLowerCase() === "@accountuser"
|
||||
? 444
|
||||
: null;
|
||||
return {
|
||||
ok: id != null,
|
||||
json: async () => (id != null ? { ok: true, result: { id } } : { ok: false }),
|
||||
} as unknown as Response;
|
||||
});
|
||||
vi.stubGlobal("fetch", fetchSpy);
|
||||
try {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
telegram: {
|
||||
botToken: "123:abc",
|
||||
allowFrom: ["@testuser"],
|
||||
groupAllowFrom: ["groupUser"],
|
||||
groups: {
|
||||
"-100123": {
|
||||
allowFrom: ["tg:@topicUser"],
|
||||
topics: { "99": { allowFrom: ["@accountUser"] } },
|
||||
},
|
||||
},
|
||||
accounts: {
|
||||
alerts: { botToken: "456:def", allowFrom: ["@accountUser"] },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: {
|
||||
telegram: {
|
||||
allowFrom: string[];
|
||||
groupAllowFrom: string[];
|
||||
groups: Record<
|
||||
string,
|
||||
{ allowFrom: string[]; topics: Record<string, { allowFrom: string[] }> }
|
||||
>;
|
||||
accounts: Record<string, { allowFrom: string[] }>;
|
||||
};
|
||||
};
|
||||
};
|
||||
expect(cfg.channels.telegram.allowFrom).toEqual(["111"]);
|
||||
expect(cfg.channels.telegram.groupAllowFrom).toEqual(["222"]);
|
||||
expect(cfg.channels.telegram.groups["-100123"].allowFrom).toEqual(["333"]);
|
||||
expect(cfg.channels.telegram.groups["-100123"].topics["99"].allowFrom).toEqual(["444"]);
|
||||
expect(cfg.channels.telegram.accounts.alerts.allowFrom).toEqual(["444"]);
|
||||
} finally {
|
||||
vi.unstubAllGlobals();
|
||||
}
|
||||
});
|
||||
|
||||
it("converts numeric discord ids to strings on repair", async () => {
|
||||
await withTempHome(async (home) => {
|
||||
const configDir = path.join(home, ".openclaw");
|
||||
await fs.mkdir(configDir, { recursive: true });
|
||||
await fs.writeFile(
|
||||
path.join(configDir, "openclaw.json"),
|
||||
JSON.stringify(
|
||||
{
|
||||
channels: {
|
||||
discord: {
|
||||
allowFrom: [123],
|
||||
dm: { allowFrom: [456], groupChannels: [789] },
|
||||
execApprovals: { approvers: [321] },
|
||||
guilds: {
|
||||
"100": {
|
||||
users: [111],
|
||||
roles: [222],
|
||||
channels: {
|
||||
general: { users: [333], roles: [444] },
|
||||
},
|
||||
},
|
||||
},
|
||||
accounts: {
|
||||
work: {
|
||||
allowFrom: [555],
|
||||
dm: { allowFrom: [666], groupChannels: [777] },
|
||||
execApprovals: { approvers: [888] },
|
||||
guilds: {
|
||||
"200": {
|
||||
users: [999],
|
||||
roles: [1010],
|
||||
channels: {
|
||||
help: { users: [1111], roles: [1212] },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
null,
|
||||
2,
|
||||
),
|
||||
"utf-8",
|
||||
);
|
||||
|
||||
const result = await loadAndMaybeMigrateDoctorConfig({
|
||||
options: { nonInteractive: true, repair: true },
|
||||
confirm: async () => false,
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: {
|
||||
discord: {
|
||||
allowFrom: string[];
|
||||
dm: { allowFrom: string[]; groupChannels: string[] };
|
||||
execApprovals: { approvers: string[] };
|
||||
guilds: Record<
|
||||
string,
|
||||
{
|
||||
users: string[];
|
||||
roles: string[];
|
||||
channels: Record<string, { users: string[]; roles: string[] }>;
|
||||
}
|
||||
>;
|
||||
accounts: Record<
|
||||
string,
|
||||
{
|
||||
allowFrom: string[];
|
||||
dm: { allowFrom: string[]; groupChannels: string[] };
|
||||
execApprovals: { approvers: string[] };
|
||||
guilds: Record<
|
||||
string,
|
||||
{
|
||||
users: string[];
|
||||
roles: string[];
|
||||
channels: Record<string, { users: string[]; roles: string[] }>;
|
||||
}
|
||||
>;
|
||||
}
|
||||
>;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
expect(cfg.channels.discord.allowFrom).toEqual(["123"]);
|
||||
expect(cfg.channels.discord.dm.allowFrom).toEqual(["456"]);
|
||||
expect(cfg.channels.discord.dm.groupChannels).toEqual(["789"]);
|
||||
expect(cfg.channels.discord.execApprovals.approvers).toEqual(["321"]);
|
||||
expect(cfg.channels.discord.guilds["100"].users).toEqual(["111"]);
|
||||
expect(cfg.channels.discord.guilds["100"].roles).toEqual(["222"]);
|
||||
expect(cfg.channels.discord.guilds["100"].channels.general.users).toEqual(["333"]);
|
||||
expect(cfg.channels.discord.guilds["100"].channels.general.roles).toEqual(["444"]);
|
||||
expect(cfg.channels.discord.accounts.work.allowFrom).toEqual(["555"]);
|
||||
expect(cfg.channels.discord.accounts.work.dm.allowFrom).toEqual(["666"]);
|
||||
expect(cfg.channels.discord.accounts.work.dm.groupChannels).toEqual(["777"]);
|
||||
expect(cfg.channels.discord.accounts.work.execApprovals.approvers).toEqual(["888"]);
|
||||
expect(cfg.channels.discord.accounts.work.guilds["200"].users).toEqual(["999"]);
|
||||
expect(cfg.channels.discord.accounts.work.guilds["200"].roles).toEqual(["1010"]);
|
||||
expect(cfg.channels.discord.accounts.work.guilds["200"].channels.help.users).toEqual([
|
||||
"1111",
|
||||
]);
|
||||
expect(cfg.channels.discord.accounts.work.guilds["200"].channels.help.roles).toEqual([
|
||||
"1212",
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
it('adds allowFrom ["*"] when dmPolicy="open" and allowFrom is missing on repair', async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
discord: {
|
||||
token: "test-token",
|
||||
dmPolicy: "open",
|
||||
groupPolicy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: { discord: { allowFrom: string[]; dmPolicy: string } };
|
||||
};
|
||||
expect(cfg.channels.discord.allowFrom).toEqual(["*"]);
|
||||
expect(cfg.channels.discord.dmPolicy).toBe("open");
|
||||
});
|
||||
|
||||
it("adds * to existing allowFrom array when dmPolicy is open on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
slack: {
|
||||
botToken: "xoxb-test",
|
||||
appToken: "xapp-test",
|
||||
dmPolicy: "open",
|
||||
allowFrom: ["U123"],
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: { slack: { allowFrom: string[] } };
|
||||
};
|
||||
expect(cfg.channels.slack.allowFrom).toContain("*");
|
||||
expect(cfg.channels.slack.allowFrom).toContain("U123");
|
||||
});
|
||||
|
||||
it("repairs nested dm.allowFrom when top-level allowFrom is absent on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
discord: {
|
||||
token: "test-token",
|
||||
dmPolicy: "open",
|
||||
dm: { allowFrom: ["123"] },
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: { discord: { dm: { allowFrom: string[] }; allowFrom?: string[] } };
|
||||
};
|
||||
// When dmPolicy is set at top level but allowFrom only exists nested in dm,
|
||||
// the repair adds "*" to dm.allowFrom
|
||||
if (cfg.channels.discord.dm) {
|
||||
expect(cfg.channels.discord.dm.allowFrom).toContain("*");
|
||||
expect(cfg.channels.discord.dm.allowFrom).toContain("123");
|
||||
} else {
|
||||
// If doctor flattened the config, allowFrom should be at top level
|
||||
expect(cfg.channels.discord.allowFrom).toContain("*");
|
||||
}
|
||||
});
|
||||
|
||||
it("skips repair when allowFrom already includes *", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
discord: {
|
||||
token: "test-token",
|
||||
dmPolicy: "open",
|
||||
allowFrom: ["*"],
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: { discord: { allowFrom: string[] } };
|
||||
};
|
||||
expect(cfg.channels.discord.allowFrom).toEqual(["*"]);
|
||||
});
|
||||
|
||||
it("repairs per-account dmPolicy open without allowFrom on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
discord: {
|
||||
token: "test-token",
|
||||
accounts: {
|
||||
work: {
|
||||
token: "test-token-2",
|
||||
dmPolicy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: {
|
||||
discord: { accounts: { work: { allowFrom: string[]; dmPolicy: string } } };
|
||||
};
|
||||
};
|
||||
expect(cfg.channels.discord.accounts.work.allowFrom).toEqual(["*"]);
|
||||
});
|
||||
|
||||
it("repairs googlechat dm.policy open by setting dm.allowFrom on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
googlechat: {
|
||||
dm: {
|
||||
policy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expectGoogleChatDmAllowFromRepaired(result.cfg);
|
||||
});
|
||||
|
||||
it("repairs googlechat account dm.policy open by setting dm.allowFrom on repair", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
googlechat: {
|
||||
accounts: {
|
||||
work: {
|
||||
dm: {
|
||||
policy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const cfg = result.cfg as unknown as {
|
||||
channels: {
|
||||
googlechat: {
|
||||
accounts: {
|
||||
work: {
|
||||
dm: {
|
||||
policy: string;
|
||||
allowFrom: string[];
|
||||
};
|
||||
allowFrom?: string[];
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
expect(cfg.channels.googlechat.accounts.work.dm.allowFrom).toEqual(["*"]);
|
||||
expect(cfg.channels.googlechat.accounts.work.allowFrom).toBeUndefined();
|
||||
});
|
||||
|
||||
it("recovers from stale googlechat top-level allowFrom by repairing dm.allowFrom", async () => {
|
||||
const result = await runDoctorConfigWithInput({
|
||||
repair: true,
|
||||
config: {
|
||||
channels: {
|
||||
googlechat: {
|
||||
allowFrom: ["*"],
|
||||
dm: {
|
||||
policy: "open",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expectGoogleChatDmAllowFromRepaired(result.cfg);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user