1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
import open from 'open';
import { docsCommand } from './docsCommand.js';
import { type CommandContext } from './types.js';
import { createMockCommandContext } from '../../test-utils/mockCommandContext.js';
import { MessageType } from '../types.js';
// Mock the 'open' library
vi.mock('open', () => ({
default: vi.fn(),
}));
describe('docsCommand', () => {
let mockContext: CommandContext;
beforeEach(() => {
// Create a fresh mock context before each test
mockContext = createMockCommandContext();
// Reset the `open` mock
vi.mocked(open).mockClear();
});
afterEach(() => {
// Restore any stubbed environment variables
vi.unstubAllEnvs();
});
it("should add an info message and call 'open' in a non-sandbox environment", async () => {
if (!docsCommand.action) {
throw new Error('docsCommand must have an action.');
}
const docsUrl = 'https://goo.gle/gemini-cli-docs';
await docsCommand.action(mockContext, '');
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
{
type: MessageType.INFO,
text: `Opening documentation in your browser: ${docsUrl}`,
},
expect.any(Number),
);
expect(open).toHaveBeenCalledWith(docsUrl);
});
it('should only add an info message in a sandbox environment', async () => {
if (!docsCommand.action) {
throw new Error('docsCommand must have an action.');
}
// Simulate a sandbox environment
vi.stubEnv('SANDBOX', 'gemini-sandbox');
const docsUrl = 'https://goo.gle/gemini-cli-docs';
await docsCommand.action(mockContext, '');
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
{
type: MessageType.INFO,
text: `Please open the following URL in your browser to view the documentation:\n${docsUrl}`,
},
expect.any(Number),
);
// Ensure 'open' was not called in the sandbox
expect(open).not.toHaveBeenCalled();
});
it("should not open browser for 'sandbox-exec'", async () => {
if (!docsCommand.action) {
throw new Error('docsCommand must have an action.');
}
// Simulate the specific 'sandbox-exec' environment
vi.stubEnv('SANDBOX', 'sandbox-exec');
const docsUrl = 'https://goo.gle/gemini-cli-docs';
await docsCommand.action(mockContext, '');
// The logic should fall through to the 'else' block
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
{
type: MessageType.INFO,
text: `Opening documentation in your browser: ${docsUrl}`,
},
expect.any(Number),
);
// 'open' should be called in this specific sandbox case
expect(open).toHaveBeenCalledWith(docsUrl);
});
});
|
