Skip to content

Commit 2ceafba

Browse files
steipetesteipete
committed
test(gateway): cover minimal connect startup
1 parent e811d04 commit 2ceafba

3 files changed

Lines changed: 115 additions & 0 deletions

File tree

‎src/gateway/gateway-cli-backend.connect.test.ts‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
import fs from "node:fs/promises";
2+
import os from "node:os";
3+
import path from "node:path";
4+
import { afterEach, describe, expect, it } from "vitest";
5+
import { clearConfigCache, clearRuntimeConfigSnapshot } from "../config/config.js";
6+
import { clearSessionStoreCacheForTest } from "../config/sessions/store.js";
7+
import { captureEnv } from "../test-utils/env.js";
8+
import {
9+
connectTestGatewayClient,
10+
ensurePairedTestGatewayClientIdentity,
11+
getFreeGatewayPort,
12+
} from "./gateway-cli-backend.live-helpers.js";
13+
import { startGatewayServer } from "./server.js";
14+
15+
const GATEWAY_CONNECT_TIMEOUT_MS = 90_000;
16+
17+
describe("gateway cli backend connect", () => {
18+
afterEach(() => {
19+
clearRuntimeConfigSnapshot();
20+
clearConfigCache();
21+
clearSessionStoreCacheForTest();
22+
});
23+
24+
it(
25+
"connects a same-process test gateway client in minimal mode",
26+
async () => {
27+
const envSnapshot = captureEnv([
28+
"HOME",
29+
"OPENCLAW_STATE_DIR",
30+
"OPENCLAW_CONFIG_PATH",
31+
"OPENCLAW_GATEWAY_TOKEN",
32+
"OPENCLAW_SKIP_CHANNELS",
33+
"OPENCLAW_SKIP_PROVIDERS",
34+
"OPENCLAW_SKIP_GMAIL_WATCHER",
35+
"OPENCLAW_SKIP_CRON",
36+
"OPENCLAW_SKIP_CANVAS_HOST",
37+
"OPENCLAW_SKIP_BROWSER_CONTROL_SERVER",
38+
"OPENCLAW_BUNDLED_PLUGINS_DIR",
39+
"OPENCLAW_TEST_MINIMAL_GATEWAY",
40+
]);
41+
42+
const tempHome = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-gateway-connect-home-"));
43+
const configPath = path.join(tempHome, ".openclaw", "openclaw.json");
44+
const bundledPluginsDir = path.join(tempHome, "openclaw-test-no-bundled-extensions");
45+
const token = `test-${Date.now()}`;
46+
process.env.HOME = tempHome;
47+
process.env.OPENCLAW_STATE_DIR = path.join(tempHome, ".openclaw");
48+
process.env.OPENCLAW_CONFIG_PATH = configPath;
49+
process.env.OPENCLAW_GATEWAY_TOKEN = token;
50+
process.env.OPENCLAW_SKIP_CHANNELS = "1";
51+
process.env.OPENCLAW_SKIP_PROVIDERS = "1";
52+
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = "1";
53+
process.env.OPENCLAW_SKIP_CRON = "1";
54+
process.env.OPENCLAW_SKIP_CANVAS_HOST = "1";
55+
process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER = "1";
56+
process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = bundledPluginsDir;
57+
process.env.OPENCLAW_TEST_MINIMAL_GATEWAY = "1";
58+
await fs.mkdir(path.dirname(configPath), { recursive: true });
59+
await fs.mkdir(bundledPluginsDir, { recursive: true });
60+
await fs.writeFile(
61+
configPath,
62+
`${JSON.stringify({ gateway: { auth: { mode: "token", token } } }, null, 2)}\n`,
63+
);
64+
clearRuntimeConfigSnapshot();
65+
clearConfigCache();
66+
clearSessionStoreCacheForTest();
67+
68+
const deviceIdentity = await ensurePairedTestGatewayClientIdentity();
69+
const port = await getFreeGatewayPort();
70+
const server = await startGatewayServer(port, {
71+
bind: "loopback",
72+
auth: { mode: "token", token },
73+
controlUiEnabled: false,
74+
});
75+
let client: Awaited<ReturnType<typeof connectTestGatewayClient>> | undefined;
76+
77+
try {
78+
client = await connectTestGatewayClient({
79+
url: `ws://127.0.0.1:${port}`,
80+
token,
81+
deviceIdentity,
82+
});
83+
const health = await client.request<{ ok?: boolean }>("health", undefined, {
84+
timeoutMs: 5_000,
85+
});
86+
expect(health).toMatchObject({
87+
ok: true,
88+
});
89+
} finally {
90+
await client?.stopAndWait({ timeoutMs: 1_000 }).catch(() => {});
91+
await server.close({ reason: "gateway connect regression complete" });
92+
await fs.rm(tempHome, { recursive: true, force: true });
93+
envSnapshot.restore();
94+
}
95+
},
96+
GATEWAY_CONNECT_TIMEOUT_MS,
97+
);
98+
});

‎src/gateway/gateway-cli-backend.live-helpers.test.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ describe("gateway cli backend live helpers", () => {
2626
afterEach(() => {
2727
gatewayClientState.lastOptions = undefined;
2828
delete process.env.OPENCLAW_SKIP_CHANNELS;
29+
delete process.env.OPENCLAW_SKIP_PROVIDERS;
2930
delete process.env.OPENCLAW_SKIP_GMAIL_WATCHER;
3031
delete process.env.OPENCLAW_SKIP_CRON;
3132
delete process.env.OPENCLAW_SKIP_CANVAS_HOST;
3233
delete process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER;
34+
delete process.env.OPENCLAW_BUNDLED_PLUGINS_DIR;
3335
delete process.env.OPENCLAW_TEST_MINIMAL_GATEWAY;
3436
delete process.env.ANTHROPIC_API_KEY;
3537
delete process.env.ANTHROPIC_API_KEY_OLD;
@@ -40,10 +42,12 @@ describe("gateway cli backend live helpers", () => {
4042
await import("./gateway-cli-backend.live-helpers.js");
4143

4244
process.env.OPENCLAW_SKIP_CHANNELS = "old-channels";
45+
process.env.OPENCLAW_SKIP_PROVIDERS = "old-providers";
4346
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = "old-gmail";
4447
process.env.OPENCLAW_SKIP_CRON = "old-cron";
4548
process.env.OPENCLAW_SKIP_CANVAS_HOST = "old-canvas";
4649
process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER = "old-browser";
50+
process.env.OPENCLAW_BUNDLED_PLUGINS_DIR = "old-bundled";
4751
process.env.OPENCLAW_TEST_MINIMAL_GATEWAY = "old-minimal";
4852
process.env.ANTHROPIC_API_KEY = "old-anthropic";
4953
process.env.ANTHROPIC_API_KEY_OLD = "old-anthropic-old";
@@ -52,21 +56,25 @@ describe("gateway cli backend live helpers", () => {
5256
applyCliBackendLiveEnv(new Set<string>());
5357

5458
expect(process.env.OPENCLAW_SKIP_CHANNELS).toBe("1");
59+
expect(process.env.OPENCLAW_SKIP_PROVIDERS).toBe("1");
5560
expect(process.env.OPENCLAW_SKIP_GMAIL_WATCHER).toBe("1");
5661
expect(process.env.OPENCLAW_SKIP_CRON).toBe("1");
5762
expect(process.env.OPENCLAW_SKIP_CANVAS_HOST).toBe("1");
5863
expect(process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER).toBe("1");
64+
expect(process.env.OPENCLAW_BUNDLED_PLUGINS_DIR).toBe("old-bundled");
5965
expect(process.env.OPENCLAW_TEST_MINIMAL_GATEWAY).toBe("1");
6066
expect(process.env.ANTHROPIC_API_KEY).toBeUndefined();
6167
expect(process.env.ANTHROPIC_API_KEY_OLD).toBeUndefined();
6268

6369
restoreCliBackendLiveEnv(snapshot);
6470

6571
expect(process.env.OPENCLAW_SKIP_CHANNELS).toBe("old-channels");
72+
expect(process.env.OPENCLAW_SKIP_PROVIDERS).toBe("old-providers");
6673
expect(process.env.OPENCLAW_SKIP_GMAIL_WATCHER).toBe("old-gmail");
6774
expect(process.env.OPENCLAW_SKIP_CRON).toBe("old-cron");
6875
expect(process.env.OPENCLAW_SKIP_CANVAS_HOST).toBe("old-canvas");
6976
expect(process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER).toBe("old-browser");
77+
expect(process.env.OPENCLAW_BUNDLED_PLUGINS_DIR).toBe("old-bundled");
7078
expect(process.env.OPENCLAW_TEST_MINIMAL_GATEWAY).toBe("old-minimal");
7179
expect(process.env.ANTHROPIC_API_KEY).toBe("old-anthropic");
7280
expect(process.env.ANTHROPIC_API_KEY_OLD).toBe("old-anthropic-old");

‎src/gateway/gateway-cli-backend.live-helpers.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,12 @@ export type CliBackendLiveEnvSnapshot = {
9696
stateDir?: string;
9797
token?: string;
9898
skipChannels?: string;
99+
skipProviders?: string;
99100
skipGmail?: string;
100101
skipCron?: string;
101102
skipCanvas?: string;
102103
skipBrowserControl?: string;
104+
bundledPluginsDir?: string;
103105
minimalGateway?: string;
104106
anthropicApiKey?: string;
105107
anthropicApiKeyOld?: string;
@@ -338,10 +340,12 @@ export function snapshotCliBackendLiveEnv(): CliBackendLiveEnvSnapshot {
338340
stateDir: process.env.OPENCLAW_STATE_DIR,
339341
token: process.env.OPENCLAW_GATEWAY_TOKEN,
340342
skipChannels: process.env.OPENCLAW_SKIP_CHANNELS,
343+
skipProviders: process.env.OPENCLAW_SKIP_PROVIDERS,
341344
skipGmail: process.env.OPENCLAW_SKIP_GMAIL_WATCHER,
342345
skipCron: process.env.OPENCLAW_SKIP_CRON,
343346
skipCanvas: process.env.OPENCLAW_SKIP_CANVAS_HOST,
344347
skipBrowserControl: process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER,
348+
bundledPluginsDir: process.env.OPENCLAW_BUNDLED_PLUGINS_DIR,
345349
minimalGateway: process.env.OPENCLAW_TEST_MINIMAL_GATEWAY,
346350
anthropicApiKey: process.env.ANTHROPIC_API_KEY,
347351
anthropicApiKeyOld: process.env.ANTHROPIC_API_KEY_OLD,
@@ -350,10 +354,13 @@ export function snapshotCliBackendLiveEnv(): CliBackendLiveEnvSnapshot {
350354

351355
export function applyCliBackendLiveEnv(preservedEnv: ReadonlySet<string>): void {
352356
process.env.OPENCLAW_SKIP_CHANNELS = "1";
357+
process.env.OPENCLAW_SKIP_PROVIDERS = "1";
353358
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = "1";
354359
process.env.OPENCLAW_SKIP_CRON = "1";
355360
process.env.OPENCLAW_SKIP_CANVAS_HOST = "1";
356361
process.env.OPENCLAW_SKIP_BROWSER_CONTROL_SERVER = "1";
362+
process.env.OPENCLAW_BUNDLED_PLUGINS_DIR =
363+
process.env.OPENCLAW_BUNDLED_PLUGINS_DIR ?? "openclaw-live-test-no-bundled-extensions";
357364
process.env.OPENCLAW_TEST_MINIMAL_GATEWAY = "1";
358365
if (!preservedEnv.has("ANTHROPIC_API_KEY")) {
359366
delete process.env.ANTHROPIC_API_KEY;
@@ -368,10 +375,12 @@ export function restoreCliBackendLiveEnv(snapshot: CliBackendLiveEnvSnapshot): v
368375
restoreEnvVar("OPENCLAW_STATE_DIR", snapshot.stateDir);
369376
restoreEnvVar("OPENCLAW_GATEWAY_TOKEN", snapshot.token);
370377
restoreEnvVar("OPENCLAW_SKIP_CHANNELS", snapshot.skipChannels);
378+
restoreEnvVar("OPENCLAW_SKIP_PROVIDERS", snapshot.skipProviders);
371379
restoreEnvVar("OPENCLAW_SKIP_GMAIL_WATCHER", snapshot.skipGmail);
372380
restoreEnvVar("OPENCLAW_SKIP_CRON", snapshot.skipCron);
373381
restoreEnvVar("OPENCLAW_SKIP_CANVAS_HOST", snapshot.skipCanvas);
374382
restoreEnvVar("OPENCLAW_SKIP_BROWSER_CONTROL_SERVER", snapshot.skipBrowserControl);
383+
restoreEnvVar("OPENCLAW_BUNDLED_PLUGINS_DIR", snapshot.bundledPluginsDir);
375384
restoreEnvVar("OPENCLAW_TEST_MINIMAL_GATEWAY", snapshot.minimalGateway);
376385
restoreEnvVar("ANTHROPIC_API_KEY", snapshot.anthropicApiKey);
377386
restoreEnvVar("ANTHROPIC_API_KEY_OLD", snapshot.anthropicApiKeyOld);

0 commit comments

Comments
 (0)