@testdriverai/mcp 7.10.0-canary.0 → 7.10.1-test

package/mcp-server/src/env-utils.test.ts

@@ -0,0 +1,82 @@
+/**
+ * Unit tests for env-utils.ts
+ *
+ * Verifies that the OS and E2B template ID resolution helpers apply the
+ * correct priority order:
+ *   explicit param  >  environment variable  >  built-in default
+ */
+
+import { describe, it, expect } from "vitest";
+import { resolveOs, resolveE2bTemplateId } from "./env-utils.js";
+
+// ---------------------------------------------------------------------------
+// resolveOs
+// ---------------------------------------------------------------------------
+
+describe("resolveOs", () => {
+  it("returns the explicit param when provided", () => {
+    const { os } = resolveOs("windows", { TD_OS: "linux" });
+    expect(os).toBe("windows");
+  });
+
+  it("falls back to TD_OS env var when no explicit param is given", () => {
+    const { os } = resolveOs(undefined, { TD_OS: "windows" });
+    expect(os).toBe("windows");
+  });
+
+  it("defaults to linux when neither param nor TD_OS is set", () => {
+    const { os } = resolveOs(undefined, {});
+    expect(os).toBe("linux");
+  });
+
+  it("returns linux and a warning when TD_OS has an unsupported value", () => {
+    const { os, warning } = resolveOs(undefined, { TD_OS: "mac" });
+    expect(os).toBe("linux");
+    expect(warning).toMatch(/unsupported/i);
+    expect(warning).toContain("mac");
+  });
+
+  it("returns linux and a warning when TD_OS is 'Linux' (wrong case)", () => {
+    const { os, warning } = resolveOs(undefined, { TD_OS: "Linux" });
+    expect(os).toBe("linux");
+    expect(warning).toBeDefined();
+  });
+
+  it("explicit param takes priority over TD_OS env var", () => {
+    const { os, warning } = resolveOs("linux", { TD_OS: "windows" });
+    expect(os).toBe("linux");
+    expect(warning).toBeUndefined();
+  });
+
+  it("returns no warning when TD_OS is valid", () => {
+    const { os, warning } = resolveOs(undefined, { TD_OS: "windows" });
+    expect(os).toBe("windows");
+    expect(warning).toBeUndefined();
+  });
+});
+
+// ---------------------------------------------------------------------------
+// resolveE2bTemplateId
+// ---------------------------------------------------------------------------
+
+describe("resolveE2bTemplateId", () => {
+  it("returns the explicit param when provided", () => {
+    const id = resolveE2bTemplateId("explicit-id", { TD_E2B_TEMPLATE_ID: "env-id" });
+    expect(id).toBe("explicit-id");
+  });
+
+  it("falls back to TD_E2B_TEMPLATE_ID env var when no explicit param is given", () => {
+    const id = resolveE2bTemplateId(undefined, { TD_E2B_TEMPLATE_ID: "env-id" });
+    expect(id).toBe("env-id");
+  });
+
+  it("returns undefined when neither param nor TD_E2B_TEMPLATE_ID is set", () => {
+    const id = resolveE2bTemplateId(undefined, {});
+    expect(id).toBeUndefined();
+  });
+
+  it("explicit param takes priority over TD_E2B_TEMPLATE_ID env var", () => {
+    const id = resolveE2bTemplateId("my-template", { TD_E2B_TEMPLATE_ID: "other-template" });
+    expect(id).toBe("my-template");
+  });
+});

package/mcp-server/src/env-utils.ts

@@ -0,0 +1,77 @@
+/**
+ * Utilities for resolving TestDriver environment variables.
+ *
+ * These helpers centralise the "param > env var > default" fallback logic
+ * so the server handler stays clean and the logic can be unit-tested
+ * independently.
+ */
+
+// ============================================================
+// OS resolution
+// ============================================================
+
+const VALID_OS_VALUES = ["linux", "windows"] as const;
+export type SandboxOs = (typeof VALID_OS_VALUES)[number];
+
+/**
+ * Resolve the sandbox OS with the following priority:
+ *   1. Explicit `os` parameter passed to session_start
+ *   2. `TD_OS` environment variable (validated against supported values)
+ *   3. `"linux"` default
+ *
+ * Mirrors the behaviour in `hooks.mjs` so the MCP server and the
+ * Vitest integration are consistent.
+ *
+ * @param explicitOs - The value passed explicitly by the caller (may be undefined)
+ * @param env        - The environment variables map (defaults to `process.env`)
+ * @returns          - The resolved OS and a warning message if TD_OS was invalid
+ */
+export function resolveOs(
+  explicitOs: SandboxOs | undefined,
+  env: NodeJS.ProcessEnv = process.env,
+): { os: SandboxOs; warning?: string } {
+  if (explicitOs) {
+    return { os: explicitOs };
+  }
+
+  const envOs = env.TD_OS;
+  if (envOs) {
+    if ((VALID_OS_VALUES as readonly string[]).includes(envOs)) {
+      return { os: envOs as SandboxOs };
+    }
+    return {
+      os: "linux",
+      warning: `TD_OS has unsupported value "${envOs}" (supported: ${VALID_OS_VALUES.join(", ")}), ignoring`,
+    };
+  }
+
+  return { os: "linux" };
+}
+
+// ============================================================
+// E2B template ID resolution
+// ============================================================
+
+/**
+ * Resolve the E2B template ID with the following priority:
+ *   1. Explicit `e2bTemplateId` parameter passed to session_start
+ *   2. `TD_E2B_TEMPLATE_ID` environment variable
+ *   3. `undefined` (let the SDK use its own default)
+ *
+ * Mirrors the behaviour in `hooks.mjs`:
+ *   ```js
+ *   if (!config.e2bTemplateId && process.env.TD_E2B_TEMPLATE_ID) {
+ *     config.e2bTemplateId = process.env.TD_E2B_TEMPLATE_ID;
+ *   }
+ *   ```
+ *
+ * @param explicitId - The value passed explicitly by the caller (may be undefined)
+ * @param env        - The environment variables map (defaults to `process.env`)
+ * @returns          - The resolved template ID, or undefined if none is set
+ */
+export function resolveE2bTemplateId(
+  explicitId: string | undefined,
+  env: NodeJS.ProcessEnv = process.env,
+): string | undefined {
+  return explicitId || env.TD_E2B_TEMPLATE_ID;
+}

package/mcp-server/src/provision-types.ts

@@ -143,7 +143,7 @@ export const SessionStartInputSchema = z.object({
   
   // Common session options
   /** Operating system for the sandbox */
-  os: z.enum(["linux", "windows"]).default("linux").describe("Sandbox OS"),
+  os: z.enum(["linux", "windows"]).optional().describe("Sandbox OS (default: 'linux', or TD_OS environment variable if set)"),
   /** Keep sandbox alive duration in ms (default: 5 minutes) */
   keepAlive: z.number().default(300000).describe("Keep sandbox alive for this many ms"),
   /** Path to test file - when provided, you MUST append generated code to this file after each action */
@@ -157,6 +157,9 @@ export const SessionStartInputSchema = z.object({
   /** Direct IP address of self-hosted instance (bypasses cloud provisioning) */
   ip: z.string().optional().describe("Direct IP address of self-hosted Windows instance (e.g., from AWS). When provided, connects directly to this IP instead of using cloud provisioning."),
   
+  /** E2B sandbox template ID (overrides TD_E2B_TEMPLATE_ID env var) */
+  e2bTemplateId: z.string().optional().describe("E2B sandbox template ID. Overrides the TD_E2B_TEMPLATE_ID environment variable when provided."),
+  
   // Debug mode - connect to existing sandbox
   /** Sandbox ID to connect to (for debug-on-failure mode). When provided, connects to an existing sandbox instead of creating a new one. Skip provisioning. */
   sandboxId: z.string().optional().describe("Existing sandbox ID to connect to (from debug-on-failure mode). Skips provisioning."),