File size: 10,774 Bytes
7421850 | 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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | /**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { GeminiCliSession } from './session.js';
import type { GeminiCliAgent } from './agent.js';
import type { GeminiCliAgentOptions } from './types.js';
// Mutable mock client so individual tests can override sendMessageStream
const mockClient = {
resumeChat: vi.fn().mockResolvedValue(undefined),
getHistory: vi.fn().mockReturnValue([]),
sendMessageStream: vi.fn().mockReturnValue((async function* () {})()),
updateSystemInstruction: vi.fn(),
};
// Mutable mock config so individual tests can spy on setUserMemory etc.
const mockConfig = {
initialize: vi.fn().mockResolvedValue(undefined),
refreshAuth: vi.fn().mockResolvedValue(undefined),
getSkillManager: vi.fn().mockReturnValue({
getSkills: vi.fn().mockReturnValue([]),
addSkills: vi.fn(),
}),
getToolRegistry: vi.fn().mockReturnValue({
getTool: vi.fn().mockReturnValue(null),
registerTool: vi.fn(),
unregisterTool: vi.fn(),
}),
getMessageBus: vi.fn().mockReturnValue({}),
getGeminiClient: vi.fn().mockReturnValue(mockClient),
getSessionId: vi.fn().mockReturnValue('mock-session-id'),
getWorkingDir: vi.fn().mockReturnValue('/tmp'),
setUserMemory: vi.fn(),
};
// Mock scheduleAgentTools at module level so tests can override it
const mockScheduleAgentTools = vi.fn().mockResolvedValue([]);
// Mock @google/gemini-cli-core to avoid heavy filesystem/auth/telemetry setup
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
Config: vi.fn().mockImplementation(() => mockConfig),
getAuthTypeFromEnv: vi.fn().mockReturnValue(null),
scheduleAgentTools: (...args: unknown[]) => mockScheduleAgentTools(...args),
loadSkillsFromDir: vi.fn().mockResolvedValue([]),
ActivateSkillTool: class {
static Name = 'activate_skill';
},
PolicyDecision: actual.PolicyDecision,
};
});
const mockAgent = {} as unknown as GeminiCliAgent;
const baseOptions: GeminiCliAgentOptions = {
instructions: 'You are a helpful assistant.',
};
beforeEach(() => {
vi.clearAllMocks();
// Reset sendMessageStream to empty stream by default
mockClient.sendMessageStream.mockReturnValue((async function* () {})());
mockScheduleAgentTools.mockResolvedValue([]);
});
describe('GeminiCliSession constructor', () => {
it('accepts string instructions', () => {
expect(
() => new GeminiCliSession(baseOptions, 'session-1', mockAgent),
).not.toThrow();
});
it('accepts function instructions', () => {
const options: GeminiCliAgentOptions = {
instructions: async () => 'dynamic instructions',
};
expect(
() => new GeminiCliSession(options, 'session-2', mockAgent),
).not.toThrow();
});
it('throws when instructions is an object (not string or function)', () => {
const options = {
instructions: { invalid: true },
} as unknown as GeminiCliAgentOptions;
expect(() => new GeminiCliSession(options, 'session-3', mockAgent)).toThrow(
'Instructions must be a string or a function.',
);
});
it('throws when instructions is a number', () => {
const options = {
instructions: 42,
} as unknown as GeminiCliAgentOptions;
expect(() => new GeminiCliSession(options, 'session-4', mockAgent)).toThrow(
'Instructions must be a string or a function.',
);
});
it('throws when instructions is an array', () => {
const options = {
instructions: ['step1', 'step2'],
} as unknown as GeminiCliAgentOptions;
expect(() => new GeminiCliSession(options, 'session-5', mockAgent)).toThrow(
'Instructions must be a string or a function.',
);
});
});
describe('GeminiCliSession id getter', () => {
it('returns the sessionId passed to the constructor', () => {
const session = new GeminiCliSession(
baseOptions,
'my-session-id',
mockAgent,
);
expect(session.id).toBe('my-session-id');
});
it('returns different ids for different sessions', () => {
const s1 = new GeminiCliSession(baseOptions, 'session-a', mockAgent);
const s2 = new GeminiCliSession(baseOptions, 'session-b', mockAgent);
expect(s1.id).not.toBe(s2.id);
});
});
describe('GeminiCliSession initialize()', () => {
it('initializes successfully with string instructions', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-init-1',
mockAgent,
);
await expect(session.initialize()).resolves.toBeUndefined();
});
it('is idempotent — calling initialize() twice does not throw', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-init-2',
mockAgent,
);
await session.initialize();
await expect(session.initialize()).resolves.toBeUndefined();
});
it('initializes with empty tools array', async () => {
const options: GeminiCliAgentOptions = { ...baseOptions, tools: [] };
const session = new GeminiCliSession(options, 'session-init-3', mockAgent);
await expect(session.initialize()).resolves.toBeUndefined();
});
it('initializes with empty skills array', async () => {
const options: GeminiCliAgentOptions = { ...baseOptions, skills: [] };
const session = new GeminiCliSession(options, 'session-init-4', mockAgent);
await expect(session.initialize()).resolves.toBeUndefined();
});
it('initializes with custom model', async () => {
const options: GeminiCliAgentOptions = {
...baseOptions,
model: 'gemini-2.0-flash',
};
const session = new GeminiCliSession(options, 'session-init-5', mockAgent);
await expect(session.initialize()).resolves.toBeUndefined();
});
it('initializes with custom cwd', async () => {
const options: GeminiCliAgentOptions = {
...baseOptions,
cwd: '/custom/working/dir',
};
const session = new GeminiCliSession(options, 'session-init-6', mockAgent);
await expect(session.initialize()).resolves.toBeUndefined();
});
});
// TODO(#24999): Mock uses getGeminiClient() method but session.ts expects geminiClient property.
describe.skip('GeminiCliSession sendStream()', () => {
it('auto-initializes if not yet initialized', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-stream-1',
mockAgent,
);
const events = [];
for await (const event of session.sendStream('Hello')) {
events.push(event);
}
expect(events).toHaveLength(0);
});
it('completes cleanly when model returns no tool calls', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-stream-2',
mockAgent,
);
await session.initialize();
const events = [];
for await (const event of session.sendStream('Hello')) {
events.push(event);
}
expect(events).toHaveLength(0);
});
it('accepts an AbortSignal without throwing', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-stream-3',
mockAgent,
);
const controller = new AbortController();
const events = [];
for await (const event of session.sendStream('Hello', controller.signal)) {
events.push(event);
}
expect(events).toHaveLength(0);
});
it('executes tool call loop and sends function response back to model', async () => {
const { GeminiEventType } = await import('@google/gemini-cli-core');
// First call: yield a ToolCallRequest, then end
// Second call: empty stream (model is done after tool result)
let callCount = 0;
mockClient.sendMessageStream.mockImplementation(() => {
callCount++;
if (callCount === 1) {
return (async function* () {
yield {
type: GeminiEventType.ToolCallRequest,
value: {
callId: 'call-1',
name: 'testTool',
args: { input: 'value' },
},
};
})();
}
return (async function* () {})();
});
mockScheduleAgentTools.mockResolvedValue([
{
response: {
responseParts: [
{
functionResponse: {
name: 'testTool',
response: { result: 'done' },
},
},
],
},
},
]);
const session = new GeminiCliSession(
baseOptions,
'session-stream-4',
mockAgent,
);
const events = [];
for await (const event of session.sendStream('Use the tool')) {
events.push(event);
}
// The ToolCallRequest event should have been yielded to the caller
expect(events).toHaveLength(1);
expect(events[0].type).toBe(GeminiEventType.ToolCallRequest);
// scheduleAgentTools should have been called with the tool call
expect(mockScheduleAgentTools).toHaveBeenCalledOnce();
// sendMessageStream called twice: once for prompt, once with tool result
expect(mockClient.sendMessageStream).toHaveBeenCalledTimes(2);
});
it('calls setUserMemory and updateSystemInstruction when instructions is a function', async () => {
const dynamicInstructions = vi
.fn()
.mockResolvedValue('updated instructions');
const options: GeminiCliAgentOptions = {
instructions: dynamicInstructions,
};
const session = new GeminiCliSession(
options,
'session-stream-5',
mockAgent,
);
for await (const _event of session.sendStream('Hello')) {
// consume stream
}
// The instructions function should have been called with a SessionContext
expect(dynamicInstructions).toHaveBeenCalledOnce();
const context = dynamicInstructions.mock.calls[0][0];
expect(context).toHaveProperty('sessionId');
expect(context).toHaveProperty('transcript');
expect(context).toHaveProperty('cwd');
expect(context).toHaveProperty('timestamp');
// Config should have been updated with the new instructions
expect(mockConfig.setUserMemory).toHaveBeenCalledWith(
'updated instructions',
);
// Client system instruction should have been refreshed
expect(mockClient.updateSystemInstruction).toHaveBeenCalledOnce();
});
it('does not call setUserMemory when instructions is a string', async () => {
const session = new GeminiCliSession(
baseOptions,
'session-stream-6',
mockAgent,
);
for await (const _event of session.sendStream('Hello')) {
// consume stream
}
expect(mockConfig.setUserMemory).not.toHaveBeenCalled();
expect(mockClient.updateSystemInstruction).not.toHaveBeenCalled();
});
});
|