GEMINI.md

1# Gemini CLI Test Utils (`@google/gemini-cli-test-utils`)
2 
3Shared test utilities used across the monorepo. This is a private package — not
4published to npm.
5 
6## Key Modules
7 
8- `src/test-rig.ts`: The primary test rig for spinning up end-to-end CLI
9  sessions with mock responses.
10- `src/file-system-test-helpers.ts`: Helpers for creating temporary file system
11  fixtures.
12- `src/mock-utils.ts`: Common mock utilities.
13- `src/test-mcp-server.ts`: Helper for building test MCP servers for tests.
14- `src/test-mcp-server-template.mjs`: Generic template script for running
15  isolated MCP processes.
16 
17## Test MCP Servers
18 
19The `TestRig` provides a fully isolated, compliant way to test tool triggers and
20workflows using local test MCP servers. This isolates your tests from live API
21endpoints and rate-limiting.
22 
23### Usage
24 
251. **Programmatic Builder:**
26 
27```typescript
28   import { TestMcpServerBuilder } from '@google/gemini-cli-test-utils';
29 
30   const builder = new TestMcpServerBuilder('weather-server').addTool(
31     'get_weather',
32     'Get weather',
33     'It is rainy',
34   );
35 
36   rig.addTestMcpServer('weather-server', builder.build());
37```
38 
392. **Predefined configurations via JSON:** Place a configuration file in
40   `packages/test-utils/assets/test-servers/google-workspace.json` and load it
41   by title:
42 
43```typescript
44   rig.addTestMcpServer('workspace-server', 'google-workspace');
45```
46 
47   **JSON Format Structure (`TestMcpConfig`):**
48 
49```json
50   {
51     "name": "string (Fallback server name)",
52     "tools": [
53       {
54         "name": "string (Tool execution name)",
55         "description": "string (Helpful summary for router)",
56         "inputSchema": {
57           "type": "object",
58           "properties": { ... }
59         },
60         "response": "string | object (The forced reply payload)"
61       }
62     ]
63   }
64```
65 
66## Usage
67 
68Import from `@google/gemini-cli-test-utils` in test files across the monorepo.
69