test: dedupe fixtures and test harness setup

2026-05-09 10:27:38 +00:00 · 2026-02-23 05:43:30 +00:00
parent 8af19ddc5b
commit 1c753ea786
75 changed files with 1886 additions and 2136 deletions
--- a/extensions/lobster/src/lobster-tool.test.ts
+++ b/extensions/lobster/src/lobster-tool.test.ts
@@ -5,6 +5,12 @@ import path from "node:path";
 import { PassThrough } from "node:stream";
 import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
 import type { OpenClawPluginApi, OpenClawPluginToolContext } from "../../../src/plugins/types.js";
+import {
+  createWindowsCmdShimFixture,
+  restorePlatformPathEnv,
+  setProcessPlatform,
+  snapshotPlatformPathEnv,
+} from "./test-helpers.js";

 const spawnState = vi.hoisted(() => ({
  queue: [] as Array<{ stdout: string; stderr?: string; exitCode?: number }>,
@@ -57,20 +63,9 @@ function fakeCtx(overrides: Partial<OpenClawPluginToolContext> = {}): OpenClawPl
  };
 }

-function setProcessPlatform(platform: NodeJS.Platform) {
-  Object.defineProperty(process, "platform", {
-    value: platform,
-    configurable: true,
-  });
-}
-
 describe("lobster plugin tool", () => {
  let tempDir = "";
-  const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
-  const originalPath = process.env.PATH;
-  const originalPathAlt = process.env.Path;
-  const originalPathExt = process.env.PATHEXT;
-  const originalPathExtAlt = process.env.Pathext;
+  const originalProcessState = snapshotPlatformPathEnv();

  beforeAll(async () => {
    ({ createLobsterTool } = await import("./lobster-tool.js"));
@@ -79,29 +74,7 @@ describe("lobster plugin tool", () => {
  });

  afterEach(() => {
-    if (originalPlatform) {
-      Object.defineProperty(process, "platform", originalPlatform);
-    }
-    if (originalPath === undefined) {
-      delete process.env.PATH;
-    } else {
-      process.env.PATH = originalPath;
-    }
-    if (originalPathAlt === undefined) {
-      delete process.env.Path;
-    } else {
-      process.env.Path = originalPathAlt;
-    }
-    if (originalPathExt === undefined) {
-      delete process.env.PATHEXT;
-    } else {
-      process.env.PATHEXT = originalPathExt;
-    }
-    if (originalPathExtAlt === undefined) {
-      delete process.env.Pathext;
-    } else {
-      process.env.Pathext = originalPathExtAlt;
-    }
+    restorePlatformPathEnv(originalProcessState);
  });

  afterAll(async () => {
@@ -156,17 +129,6 @@ describe("lobster plugin tool", () => {
    });
  };

-  const createWindowsShimFixture = async (params: {
-    shimPath: string;
-    scriptPath: string;
-    scriptToken: string;
-  }) => {
-    await fs.mkdir(path.dirname(params.scriptPath), { recursive: true });
-    await fs.mkdir(path.dirname(params.shimPath), { recursive: true });
-    await fs.writeFile(params.scriptPath, "module.exports = {};\n", "utf8");
-    await fs.writeFile(params.shimPath, `@echo off\r\n"${params.scriptToken}" %*\r\n`, "utf8");
-  };
-
  it("runs lobster and returns parsed envelope in details", async () => {
    spawnState.queue.push({
      stdout: JSON.stringify({
@@ -281,10 +243,10 @@ describe("lobster plugin tool", () => {
    setProcessPlatform("win32");
    const shimScriptPath = path.join(tempDir, "shim-dist", "lobster-cli.cjs");
    const shimPath = path.join(tempDir, "shim-bin", "lobster.cmd");
-    await createWindowsShimFixture({
+    await createWindowsCmdShimFixture({
      shimPath,
      scriptPath: shimScriptPath,
-      scriptToken: "%dp0%\\..\\shim-dist\\lobster-cli.cjs",
+      shimLine: `"%dp0%\\..\\shim-dist\\lobster-cli.cjs" %*`,
    });
    process.env.PATHEXT = ".CMD;.EXE";
    process.env.PATH = `${path.dirname(shimPath)};${process.env.PATH ?? ""}`;
--- a/extensions/lobster/src/test-helpers.ts
+++ b/extensions/lobster/src/test-helpers.ts
@@ -0,0 +1,56 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+
+type PathEnvKey = "PATH" | "Path" | "PATHEXT" | "Pathext";
+
+const PATH_ENV_KEYS = ["PATH", "Path", "PATHEXT", "Pathext"] as const;
+
+export type PlatformPathEnvSnapshot = {
+  platformDescriptor: PropertyDescriptor | undefined;
+  env: Record<PathEnvKey, string | undefined>;
+};
+
+export function setProcessPlatform(platform: NodeJS.Platform): void {
+  Object.defineProperty(process, "platform", {
+    value: platform,
+    configurable: true,
+  });
+}
+
+export function snapshotPlatformPathEnv(): PlatformPathEnvSnapshot {
+  return {
+    platformDescriptor: Object.getOwnPropertyDescriptor(process, "platform"),
+    env: {
+      PATH: process.env.PATH,
+      Path: process.env.Path,
+      PATHEXT: process.env.PATHEXT,
+      Pathext: process.env.Pathext,
+    },
+  };
+}
+
+export function restorePlatformPathEnv(snapshot: PlatformPathEnvSnapshot): void {
+  if (snapshot.platformDescriptor) {
+    Object.defineProperty(process, "platform", snapshot.platformDescriptor);
+  }
+
+  for (const key of PATH_ENV_KEYS) {
+    const value = snapshot.env[key];
+    if (value === undefined) {
+      delete process.env[key];
+      continue;
+    }
+    process.env[key] = value;
+  }
+}
+
+export async function createWindowsCmdShimFixture(params: {
+  shimPath: string;
+  scriptPath: string;
+  shimLine: string;
+}): Promise<void> {
+  await fs.mkdir(path.dirname(params.scriptPath), { recursive: true });
+  await fs.mkdir(path.dirname(params.shimPath), { recursive: true });
+  await fs.writeFile(params.scriptPath, "module.exports = {};\n", "utf8");
+  await fs.writeFile(params.shimPath, `@echo off\r\n${params.shimLine}\r\n`, "utf8");
+}
--- a/extensions/lobster/src/windows-spawn.test.ts
+++ b/extensions/lobster/src/windows-spawn.test.ts
@@ -2,22 +2,17 @@ import fs from "node:fs/promises";
 import os from "node:os";
 import path from "node:path";
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import {
+  createWindowsCmdShimFixture,
+  restorePlatformPathEnv,
+  setProcessPlatform,
+  snapshotPlatformPathEnv,
+} from "./test-helpers.js";
 import { resolveWindowsLobsterSpawn } from "./windows-spawn.js";

-function setProcessPlatform(platform: NodeJS.Platform) {
-  Object.defineProperty(process, "platform", {
-    value: platform,
-    configurable: true,
-  });
-}
-
 describe("resolveWindowsLobsterSpawn", () => {
  let tempDir = "";
-  const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
-  const originalPath = process.env.PATH;
-  const originalPathAlt = process.env.Path;
-  const originalPathExt = process.env.PATHEXT;
-  const originalPathExtAlt = process.env.Pathext;
+  const originalProcessState = snapshotPlatformPathEnv();

  beforeEach(async () => {
    tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-lobster-win-spawn-"));
@@ -25,29 +20,7 @@ describe("resolveWindowsLobsterSpawn", () => {
  });

  afterEach(async () => {
-    if (originalPlatform) {
-      Object.defineProperty(process, "platform", originalPlatform);
-    }
-    if (originalPath === undefined) {
-      delete process.env.PATH;
-    } else {
-      process.env.PATH = originalPath;
-    }
-    if (originalPathAlt === undefined) {
-      delete process.env.Path;
-    } else {
-      process.env.Path = originalPathAlt;
-    }
-    if (originalPathExt === undefined) {
-      delete process.env.PATHEXT;
-    } else {
-      process.env.PATHEXT = originalPathExt;
-    }
-    if (originalPathExtAlt === undefined) {
-      delete process.env.Pathext;
-    } else {
-      process.env.Pathext = originalPathExtAlt;
-    }
+    restorePlatformPathEnv(originalProcessState);
    if (tempDir) {
      await fs.rm(tempDir, { recursive: true, force: true });
      tempDir = "";
@@ -57,14 +30,11 @@ describe("resolveWindowsLobsterSpawn", () => {
  it("unwraps cmd shim with %dp0% token", async () => {
    const scriptPath = path.join(tempDir, "shim-dist", "lobster-cli.cjs");
    const shimPath = path.join(tempDir, "shim", "lobster.cmd");
-    await fs.mkdir(path.dirname(scriptPath), { recursive: true });
-    await fs.mkdir(path.dirname(shimPath), { recursive: true });
-    await fs.writeFile(scriptPath, "module.exports = {};\n", "utf8");
-    await fs.writeFile(
+    await createWindowsCmdShimFixture({
      shimPath,
-      `@echo off\r\n"%dp0%\\..\\shim-dist\\lobster-cli.cjs" %*\r\n`,
-      "utf8",
-    );
+      scriptPath,
+      shimLine: `"%dp0%\\..\\shim-dist\\lobster-cli.cjs" %*`,
+    });

    const target = resolveWindowsLobsterSpawn(shimPath, ["run", "noop"], process.env);
    expect(target.command).toBe(process.execPath);
@@ -75,14 +45,11 @@ describe("resolveWindowsLobsterSpawn", () => {
  it("unwraps cmd shim with %~dp0% token", async () => {
    const scriptPath = path.join(tempDir, "shim-dist", "lobster-cli.cjs");
    const shimPath = path.join(tempDir, "shim", "lobster.cmd");
-    await fs.mkdir(path.dirname(scriptPath), { recursive: true });
-    await fs.mkdir(path.dirname(shimPath), { recursive: true });
-    await fs.writeFile(scriptPath, "module.exports = {};\n", "utf8");
-    await fs.writeFile(
+    await createWindowsCmdShimFixture({
      shimPath,
-      `@echo off\r\n"%~dp0%\\..\\shim-dist\\lobster-cli.cjs" %*\r\n`,
-      "utf8",
-    );
+      scriptPath,
+      shimLine: `"%~dp0%\\..\\shim-dist\\lobster-cli.cjs" %*`,
+    });

    const target = resolveWindowsLobsterSpawn(shimPath, ["run", "noop"], process.env);
    expect(target.command).toBe(process.execPath);