mirror of
https://github.com/openclaw/openclaw.git
synced 2026-08-28 05:16:23 -06:00
test: link mcp gateway transport coverage (#97609)
This commit is contained in:
Dallin Romney
@@ -1,100 +0,0 @@
|
||||
// Mcp Channels Harness tests cover mcp channels harness script behavior.
|
||||
import { existsSync, mkdtempSync, readFileSync, rmSync, statSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import path from "node:path";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import {
|
||||
connectMcpClientWithPairingReconnect,
|
||||
createMcpClientTempState,
|
||||
type McpClientTempState,
|
||||
} from "../../scripts/e2e/mcp-client-temp-state.js";
|
||||
|
||||
describe("mcp-channels harness", () => {
|
||||
it("creates unique client temp state and removes token files on cleanup", () => {
|
||||
const tempRoot = mkdtempSync(path.join(tmpdir(), "openclaw-mcp-harness-test-"));
|
||||
try {
|
||||
const first = createMcpClientTempState({ gatewayToken: "first-token", tempRoot });
|
||||
const second = createMcpClientTempState({ gatewayToken: "second-token", tempRoot });
|
||||
|
||||
expect(first.root).not.toBe(second.root);
|
||||
expect(first.stateDir).toBe(path.join(first.root, "state"));
|
||||
expect(readFileSync(first.tokenFile, "utf8")).toBe("first-token\n");
|
||||
expect(statSync(first.tokenFile).mode & 0o777).toBe(0o600);
|
||||
expect(readFileSync(second.tokenFile, "utf8")).toBe("second-token\n");
|
||||
|
||||
first.cleanup();
|
||||
second.cleanup();
|
||||
|
||||
expect(existsSync(first.root)).toBe(false);
|
||||
expect(existsSync(second.root)).toBe(false);
|
||||
} finally {
|
||||
rmSync(tempRoot, { force: true, recursive: true });
|
||||
}
|
||||
});
|
||||
|
||||
it("reuses one MCP temp state across the pairing reconnect path", async () => {
|
||||
const tempState = createMcpClientTempState({ gatewayToken: "pairing-token" });
|
||||
const firstHandle = {
|
||||
cleanup: vi.fn(),
|
||||
client: { close: vi.fn(async () => undefined) },
|
||||
transport: { close: vi.fn(async () => undefined) },
|
||||
};
|
||||
const secondHandle = {
|
||||
cleanup: vi.fn(),
|
||||
client: { close: vi.fn(async () => undefined) },
|
||||
transport: { close: vi.fn(async () => undefined) },
|
||||
};
|
||||
const connectCalls: McpClientTempState[] = [];
|
||||
const connect = vi.fn(async (state: McpClientTempState) => {
|
||||
connectCalls.push(state);
|
||||
return connectCalls.length === 1 ? firstHandle : secondHandle;
|
||||
});
|
||||
|
||||
try {
|
||||
await expect(
|
||||
connectMcpClientWithPairingReconnect({
|
||||
connect,
|
||||
maybeApprovePairing: async () => true,
|
||||
tempState,
|
||||
}),
|
||||
).resolves.toBe(secondHandle);
|
||||
|
||||
expect(connect).toHaveBeenCalledTimes(2);
|
||||
expect(connectCalls).toEqual([tempState, tempState]);
|
||||
expect(firstHandle.client.close).toHaveBeenCalledOnce();
|
||||
expect(firstHandle.transport.close).toHaveBeenCalledOnce();
|
||||
expect(firstHandle.cleanup).toHaveBeenCalledOnce();
|
||||
expect(secondHandle.cleanup).not.toHaveBeenCalled();
|
||||
} finally {
|
||||
tempState.cleanup();
|
||||
}
|
||||
});
|
||||
|
||||
it("cleans up the first MCP client when pairing approval fails", async () => {
|
||||
const tempState = createMcpClientTempState({ gatewayToken: "pairing-token" });
|
||||
const handle = {
|
||||
cleanup: vi.fn(),
|
||||
client: { close: vi.fn(async () => undefined) },
|
||||
transport: { close: vi.fn(async () => undefined) },
|
||||
};
|
||||
const failure = new Error("pairing approval failed");
|
||||
|
||||
try {
|
||||
await expect(
|
||||
connectMcpClientWithPairingReconnect({
|
||||
connect: async () => handle,
|
||||
maybeApprovePairing: async () => {
|
||||
throw failure;
|
||||
},
|
||||
tempState,
|
||||
}),
|
||||
).rejects.toBe(failure);
|
||||
|
||||
expect(handle.client.close).toHaveBeenCalledOnce();
|
||||
expect(handle.transport.close).toHaveBeenCalledOnce();
|
||||
expect(handle.cleanup).toHaveBeenCalledOnce();
|
||||
} finally {
|
||||
tempState.cleanup();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -1,89 +0,0 @@
|
||||
// Mcp Connect Timeout tests cover mcp connect timeout script behavior.
|
||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||
import { connectMcpWithTimeout } from "../../scripts/e2e/mcp-connect-timeout.ts";
|
||||
|
||||
describe("MCP stdio connect timeout", () => {
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("resolves when the MCP client connects before the timeout", async () => {
|
||||
const client = {
|
||||
connect: vi.fn(async () => undefined),
|
||||
};
|
||||
const transport = {
|
||||
close: vi.fn(),
|
||||
};
|
||||
|
||||
await expect(connectMcpWithTimeout(client, transport, 1000)).resolves.toBeUndefined();
|
||||
|
||||
expect(client.connect).toHaveBeenCalledWith(transport);
|
||||
expect(transport.close).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("closes the transport when MCP initialize hangs", async () => {
|
||||
vi.useFakeTimers();
|
||||
const client = {
|
||||
connect: vi.fn(() => new Promise<void>(() => {})),
|
||||
};
|
||||
const transport = {
|
||||
close: vi.fn(),
|
||||
};
|
||||
|
||||
const result = connectMcpWithTimeout(client, transport, 100);
|
||||
const rejection = expect(result).rejects.toThrow("MCP stdio connect timed out after 100ms");
|
||||
|
||||
await vi.advanceTimersByTimeAsync(100);
|
||||
await rejection;
|
||||
expect(transport.close).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it("waits for timed-out transport cleanup before rejecting", async () => {
|
||||
vi.useFakeTimers();
|
||||
let closeSettled = false;
|
||||
const client = {
|
||||
connect: vi.fn(() => new Promise<void>(() => {})),
|
||||
};
|
||||
const transport = {
|
||||
close: vi.fn(
|
||||
() =>
|
||||
new Promise<void>((resolve) => {
|
||||
setTimeout(() => {
|
||||
closeSettled = true;
|
||||
resolve();
|
||||
}, 25);
|
||||
}),
|
||||
),
|
||||
};
|
||||
|
||||
const result = connectMcpWithTimeout(client, transport, 100);
|
||||
const rejection = expect(result).rejects.toThrow("MCP stdio connect timed out after 100ms");
|
||||
|
||||
await vi.advanceTimersByTimeAsync(100);
|
||||
expect(transport.close).toHaveBeenCalledOnce();
|
||||
expect(closeSettled).toBe(false);
|
||||
|
||||
await vi.advanceTimersByTimeAsync(25);
|
||||
await rejection;
|
||||
expect(closeSettled).toBe(true);
|
||||
});
|
||||
|
||||
it("keeps the original timeout error when cleanup rejects", async () => {
|
||||
vi.useFakeTimers();
|
||||
const client = {
|
||||
connect: vi.fn(() => new Promise<void>(() => {})),
|
||||
};
|
||||
const transport = {
|
||||
close: vi.fn(async () => {
|
||||
throw new Error("close failed");
|
||||
}),
|
||||
};
|
||||
|
||||
const result = connectMcpWithTimeout(client, transport, 100);
|
||||
const rejection = expect(result).rejects.toThrow("MCP stdio connect timed out after 100ms");
|
||||
|
||||
await vi.advanceTimersByTimeAsync(100);
|
||||
await rejection;
|
||||
expect(transport.close).toHaveBeenCalledOnce();
|
||||
});
|
||||
});
|
||||
@@ -1,72 +0,0 @@
|
||||
// Mcp Websocket Open tests cover mcp websocket open script behavior.
|
||||
import { EventEmitter } from "node:events";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { waitForWebSocketOpen } from "../../scripts/e2e/mcp-websocket-open.ts";
|
||||
|
||||
class FakeWebSocket extends EventEmitter {
|
||||
terminated = false;
|
||||
closed = false;
|
||||
|
||||
terminate(): void {
|
||||
this.terminated = true;
|
||||
queueMicrotask(() => {
|
||||
this.emit("error", new Error("socket abort after terminate"));
|
||||
this.emit("close");
|
||||
});
|
||||
}
|
||||
|
||||
close(): void {
|
||||
this.closed = true;
|
||||
}
|
||||
}
|
||||
|
||||
describe("mcp channel WebSocket open guard", () => {
|
||||
beforeEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("consumes abort errors after open timeouts", async () => {
|
||||
const ws = new FakeWebSocket();
|
||||
const keepAlive = setTimeout(() => {}, 100);
|
||||
|
||||
try {
|
||||
await expect(waitForWebSocketOpen(ws, 1)).rejects.toThrow("gateway ws open timeout");
|
||||
} finally {
|
||||
clearTimeout(keepAlive);
|
||||
}
|
||||
await new Promise((resolve) => {
|
||||
setImmediate(resolve);
|
||||
});
|
||||
|
||||
expect(ws.terminated).toBe(true);
|
||||
expect(ws.listenerCount("open")).toBe(0);
|
||||
expect(ws.listenerCount("error")).toBe(0);
|
||||
expect(ws.listenerCount("close")).toBe(0);
|
||||
});
|
||||
|
||||
it("cleans listeners after successful opens", async () => {
|
||||
const ws = new FakeWebSocket();
|
||||
const opened = waitForWebSocketOpen(ws, 100);
|
||||
|
||||
ws.emit("open");
|
||||
|
||||
await expect(opened).resolves.toBeUndefined();
|
||||
expect(ws.terminated).toBe(false);
|
||||
expect(ws.listenerCount("open")).toBe(0);
|
||||
expect(ws.listenerCount("error")).toBe(0);
|
||||
expect(ws.listenerCount("close")).toBe(0);
|
||||
});
|
||||
|
||||
it("rejects immediately when the socket closes before opening", async () => {
|
||||
const ws = new FakeWebSocket();
|
||||
const opened = waitForWebSocketOpen(ws, 1000);
|
||||
|
||||
ws.emit("close", 1006, Buffer.from("bye"));
|
||||
|
||||
await expect(opened).rejects.toThrow("closed before open: 1006 bye");
|
||||
expect(ws.terminated).toBe(false);
|
||||
expect(ws.listenerCount("open")).toBe(0);
|
||||
expect(ws.listenerCount("error")).toBe(0);
|
||||
expect(ws.listenerCount("close")).toBe(0);
|
||||
});
|
||||
});
|
||||
@@ -2009,22 +2009,10 @@ describe("scripts/test-projects changed-target routing", () => {
|
||||
"scripts/lib/plugin-npm-release.ts",
|
||||
["test/plugin-npm-release.test.ts", "test/plugin-clawhub-release.test.ts"],
|
||||
],
|
||||
[
|
||||
"scripts/plugin-clawhub-release-check.ts",
|
||||
["test/scripts/release-wrapper-scripts.test.ts"],
|
||||
],
|
||||
[
|
||||
"scripts/plugin-clawhub-release-plan.ts",
|
||||
["test/scripts/release-wrapper-scripts.test.ts"],
|
||||
],
|
||||
[
|
||||
"scripts/plugin-npm-release-check.ts",
|
||||
["test/scripts/release-wrapper-scripts.test.ts"],
|
||||
],
|
||||
[
|
||||
"scripts/plugin-npm-release-plan.ts",
|
||||
["test/scripts/release-wrapper-scripts.test.ts"],
|
||||
],
|
||||
["scripts/plugin-clawhub-release-check.ts", ["test/scripts/release-wrapper-scripts.test.ts"]],
|
||||
["scripts/plugin-clawhub-release-plan.ts", ["test/scripts/release-wrapper-scripts.test.ts"]],
|
||||
["scripts/plugin-npm-release-check.ts", ["test/scripts/release-wrapper-scripts.test.ts"]],
|
||||
["scripts/plugin-npm-release-plan.ts", ["test/scripts/release-wrapper-scripts.test.ts"]],
|
||||
[
|
||||
"scripts/plugin-release-pretag-pack-check.ts",
|
||||
["test/scripts/plugin-release-pretag-pack-check.test.ts"],
|
||||
@@ -2445,10 +2433,11 @@ describe("scripts/test-projects changed-target routing", () => {
|
||||
it("routes MCP and cron Docker E2E script targets instead of skipping changed tests", () => {
|
||||
const targets = [
|
||||
"scripts/e2e/mcp-channels-docker.sh",
|
||||
"scripts/e2e/mcp-channels-docker-client.ts",
|
||||
"test/e2e/qa-lab/runtime/mcp-channels-docker-client.ts",
|
||||
"test/e2e/qa-lab/runtime/mcp-channels.fixture.ts",
|
||||
"test/e2e/qa-lab/runtime/mcp-client-temp-state.fixture.ts",
|
||||
"scripts/e2e/mcp-channels-seed.ts",
|
||||
"scripts/e2e/docker-openai-seed.ts",
|
||||
"scripts/e2e/mcp-client-temp-state.ts",
|
||||
"scripts/e2e/mcp-code-mode-gateway-docker.sh",
|
||||
"scripts/e2e/mcp-code-mode-gateway-live-docker.sh",
|
||||
"scripts/e2e/mcp-code-mode-gateway-seed.ts",
|
||||
@@ -2469,13 +2458,13 @@ describe("scripts/test-projects changed-target routing", () => {
|
||||
"test/scripts/docker-e2e-observability.test.ts",
|
||||
"test/scripts/docker-e2e-plan.test.ts",
|
||||
"test/scripts/plugin-prerelease-test-plan.test.ts",
|
||||
"test/e2e/qa-lab/runtime/mcp-gateway-transport.e2e.test.ts",
|
||||
"test/scripts/cron-mcp-cleanup-docker-client.test.ts",
|
||||
"test/scripts/docker-e2e-seeds.test.ts",
|
||||
"test/scripts/mcp-channels-harness.test.ts",
|
||||
"test/scripts/mcp-code-mode-gateway-client.test.ts",
|
||||
"test/scripts/session-log-mentions.test.ts",
|
||||
"src/agents/agent-bundle-mcp-runtime.test.ts",
|
||||
"src/agents/agent-bundle-mcp-tools.materialize.test.ts",
|
||||
"test/scripts/cron-mcp-cleanup-docker-client.test.ts",
|
||||
"src/gateway/server.cron.test.ts",
|
||||
"src/gateway/server-methods/agent.test.ts",
|
||||
"src/cron/isolated-agent/run.fast-mode.test.ts",
|
||||
|
||||
Reference in New Issue
Block a user