vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-03-22 23:41:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(tests): centralize vitest mock typing

Browse Source
This commit is contained in:
Peter Steinberger
2026-02-14 19:06:29 +01:00
parent e03b0ce058
commit 11822f7b3f
4 changed files with 63 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/browser/server.control-server.test-harness.ts
View File

@@ -3,6 +3,7 @@ import { type AddressInfo, createServer } from "node:net";
import os from "node:os";
import path from "node:path";
import { afterAll, afterEach, beforeAll, beforeEach, vi } from "vitest";
import type { MockFn } from "../test-utils/vitest-mock-fn.js";
type HarnessState = {
testPort: number;
@@ -22,23 +23,23 @@ const state: HarnessState = {
prevGatewayPort: undefined,
};
export function getBrowserControlServerTestState() {
export function getBrowserControlServerTestState(): HarnessState {
return state;
}
export function getBrowserControlServerBaseUrl() {
export function getBrowserControlServerBaseUrl(): string {
return `http://127.0.0.1:${state.testPort}`;
}
export function setBrowserControlServerCreateTargetId(targetId: string | null) {
export function setBrowserControlServerCreateTargetId(targetId: string | null): void {
state.createTargetId = targetId;
}
export function setBrowserControlServerAttachOnly(attachOnly: boolean) {
export function setBrowserControlServerAttachOnly(attachOnly: boolean): void {
state.cfgAttachOnly = attachOnly;
}
export function setBrowserControlServerReachable(reachable: boolean) {
export function setBrowserControlServerReachable(reachable: boolean): void {
state.reachable = reachable;
}
@@ -51,8 +52,8 @@ const cdpMocks = vi.hoisted(() => ({
})),
}));
export function getCdpMocks() {
return cdpMocks;
export function getCdpMocks(): { createTargetViaCdp: MockFn; snapshotAria: MockFn } {
return cdpMocks as unknown as { createTargetViaCdp: MockFn; snapshotAria: MockFn };
}
const pwMocks = vi.hoisted(() => ({
@@ -97,8 +98,8 @@ const pwMocks = vi.hoisted(() => ({
waitForViaPlaywright: vi.fn(async () => {}),
}));
export function getPwMocks() {
return pwMocks;
export function getPwMocks(): Record<string, MockFn> {
return pwMocks as unknown as Record<string, MockFn>;
}
const chromeUserDataDir = vi.hoisted(() => ({ dir: "/tmp/openclaw" }));

71
src/commands/doctor.e2e-harness.ts
View File

@@ -2,6 +2,7 @@ import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, beforeEach, vi } from "vitest";
import type { MockFn } from "../test-utils/vitest-mock-fn.js";
let originalIsTTY: boolean | undefined;
let originalStateDir: string | undefined;
@@ -19,40 +20,40 @@ function setStdinTty(value: boolean | undefined) {
}
}
export const readConfigFileSnapshot: ReturnType<typeof vi.fn> = vi.fn();
export const confirm: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(true);
export const select: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue("node");
export const note: ReturnType<typeof vi.fn> = vi.fn();
export const writeConfigFile: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const resolveOpenClawPackageRoot: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(null);
export const runGatewayUpdate: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
export const readConfigFileSnapshot = vi.fn() as unknown as MockFn;
export const confirm = vi.fn().mockResolvedValue(true) as unknown as MockFn;
export const select = vi.fn().mockResolvedValue("node") as unknown as MockFn;
export const note = vi.fn() as unknown as MockFn;
export const writeConfigFile = vi.fn().mockResolvedValue(undefined) as unknown as MockFn;
export const resolveOpenClawPackageRoot = vi.fn().mockResolvedValue(null) as unknown as MockFn;
export const runGatewayUpdate = vi.fn().mockResolvedValue({
status: "skipped",
mode: "unknown",
steps: [],
durationMs: 0,
});
export const migrateLegacyConfig: ReturnType<typeof vi.fn> = vi.fn((raw: unknown) => ({
}) as unknown as MockFn;
export const migrateLegacyConfig = vi.fn((raw: unknown) => ({
config: raw as Record<string, unknown>,
changes: ["Moved routing.allowFrom → channels.whatsapp.allowFrom."],
}));
})) as unknown as MockFn;
export const runExec: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
export const runExec = vi.fn().mockResolvedValue({
stdout: "",
stderr: "",
});
export const runCommandWithTimeout: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
}) as unknown as MockFn;
export const runCommandWithTimeout = vi.fn().mockResolvedValue({
stdout: "",
stderr: "",
code: 0,
signal: null,
killed: false,
});
}) as unknown as MockFn;
export const ensureAuthProfileStore: ReturnType<typeof vi.fn> = vi
export const ensureAuthProfileStore = vi
.fn()
.mockReturnValue({ version: 1, profiles: {} });
.mockReturnValue({ version: 1, profiles: {} }) as unknown as MockFn;
export const legacyReadConfigFileSnapshot: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
export const legacyReadConfigFileSnapshot = vi.fn().mockResolvedValue({
path: "/tmp/openclaw.json",
exists: false,
raw: null,
@@ -61,30 +62,28 @@ export const legacyReadConfigFileSnapshot: ReturnType<typeof vi.fn> = vi.fn().mo
config: {},
issues: [],
legacyIssues: [],
});
export const createConfigIO: ReturnType<typeof vi.fn> = vi.fn(() => ({
}) as unknown as MockFn;
export const createConfigIO = vi.fn(() => ({
readConfigFileSnapshot: legacyReadConfigFileSnapshot,
}));
})) as unknown as MockFn;
export const findLegacyGatewayServices: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue([]);
export const uninstallLegacyGatewayServices: ReturnType<typeof vi.fn> = vi
export const findLegacyGatewayServices = vi.fn().mockResolvedValue([]) as unknown as MockFn;
export const uninstallLegacyGatewayServices = vi.fn().mockResolvedValue([]) as unknown as MockFn;
export const findExtraGatewayServices = vi.fn().mockResolvedValue([]) as unknown as MockFn;
export const renderGatewayServiceCleanupHints = vi
.fn()
.mockResolvedValue([]);
export const findExtraGatewayServices: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue([]);
export const renderGatewayServiceCleanupHints: ReturnType<typeof vi.fn> = vi
.fn()
.mockReturnValue(["cleanup"]);
export const resolveGatewayProgramArguments: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
.mockReturnValue(["cleanup"]) as unknown as MockFn;
export const resolveGatewayProgramArguments = vi.fn().mockResolvedValue({
programArguments: ["node", "cli", "gateway", "--port", "18789"],
});
export const serviceInstall: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceIsLoaded: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(false);
export const serviceStop: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceRestart: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceUninstall: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const callGateway: ReturnType<typeof vi.fn> = vi
}) as unknown as MockFn;
export const serviceInstall = vi.fn().mockResolvedValue(undefined) as unknown as MockFn;
export const serviceIsLoaded = vi.fn().mockResolvedValue(false) as unknown as MockFn;
export const serviceStop = vi.fn().mockResolvedValue(undefined) as unknown as MockFn;
export const serviceRestart = vi.fn().mockResolvedValue(undefined) as unknown as MockFn;
export const serviceUninstall = vi.fn().mockResolvedValue(undefined) as unknown as MockFn;
export const callGateway = vi
.fn()
.mockRejectedValue(new Error("gateway closed"));
.mockRejectedValue(new Error("gateway closed")) as unknown as MockFn;
vi.mock("@clack/prompts", () => ({
confirm,

22
src/telegram/bot.create-telegram-bot.test-harness.ts
View File

@@ -1,8 +1,10 @@
import { beforeEach, vi, type Mock } from "vitest";
import { beforeEach, vi } from "vitest";
import type { MockFn } from "../test-utils/vitest-mock-fn.js";
import { resetInboundDedupe } from "../auto-reply/reply/inbound-dedupe.js";
type AnyMock = Mock<(...args: unknown[]) => unknown>;
type AnyAsyncMock = Mock<(...args: unknown[]) => Promise<unknown>>;
type AnyMock = MockFn<(...args: unknown[]) => unknown>;
type AnyAsyncMock = MockFn<(...args: unknown[]) => Promise<unknown>>;
type ReplyOpts =
| {
onReplyStart?: () => void | Promise<void>;
@@ -74,12 +76,12 @@ vi.mock("../pairing/pairing-store.js", () => ({
upsertChannelPairingRequest,
}));
export const useSpy: Mock<(arg: unknown) => void> = vi.fn();
export const middlewareUseSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const onSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const stopSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const commandSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const botCtorSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const useSpy: MockFn<(arg: unknown) => void> = vi.fn();
export const middlewareUseSpy: AnyMock = vi.fn();
export const onSpy: AnyMock = vi.fn();
export const stopSpy: AnyMock = vi.fn();
export const commandSpy: AnyMock = vi.fn();
export const botCtorSpy: AnyMock = vi.fn();
export const answerCallbackQuerySpy: AnyAsyncMock = vi.fn(async () => undefined);
export const sendChatActionSpy: AnyMock = vi.fn();
export const setMessageReactionSpy: AnyAsyncMock = vi.fn(async () => undefined);
@@ -154,7 +156,7 @@ vi.mock("@grammyjs/transformer-throttler", () => ({
apiThrottler: () => throttlerSpy(),
}));
export const replySpy: Mock<(ctx: unknown, opts?: ReplyOpts) => Promise<void>> = vi.fn(
export const replySpy: MockFn<(ctx: unknown, opts?: ReplyOpts) => Promise<void>> = vi.fn(
async (_ctx, opts) => {
await opts?.onReplyStart?.();
return undefined;

6
src/test-utils/vitest-mock-fn.ts Normal file
View File

@@ -0,0 +1,6 @@
// Centralized Vitest mock type for harness modules under `src/`.
// Using an explicit named type avoids exporting inferred `vi.fn()` types that can trip TS2742.
//
// oxlint-disable-next-line typescript/no-explicit-any
export type MockFn<T extends (...args: any[]) => any = (...args: any[]) => any> =
import("vitest").Mock<T>;