File size: 7,498 Bytes
7a1ad33 | 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 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { EditTool } from './edit.js';
import { WriteFileTool } from './write-file.js';
import { WebFetchTool } from './web-fetch.js';
import { ToolConfirmationOutcome } from './tools.js';
import { ApprovalMode } from '../policy/types.js';
import { MessageBusType } from '../confirmation-bus/types.js';
import type { MessageBus } from '../confirmation-bus/message-bus.js';
import type { Config } from '../config/config.js';
import path from 'node:path';
import { isSubpath } from '../utils/paths.js';
import fs from 'node:fs';
import os from 'node:os';
// Mock telemetry loggers to avoid failures
vi.mock('../telemetry/loggers.js', () => ({
logEditStrategy: vi.fn(),
logEditCorrectionEvent: vi.fn(),
logFileOperation: vi.fn(),
}));
describe('Tool Confirmation Policy Updates', () => {
let mockConfig: any;
let mockMessageBus: MessageBus;
const rootDir = path.join(
os.tmpdir(),
`gemini-cli-policy-test-${Date.now()}`,
);
beforeEach(() => {
if (!fs.existsSync(rootDir)) {
fs.mkdirSync(rootDir, { recursive: true });
}
mockMessageBus = {
publish: vi.fn(),
subscribe: vi.fn(),
unsubscribe: vi.fn(),
} as unknown as MessageBus;
mockConfig = {
get config() {
return this;
},
getTargetDir: () => rootDir,
getApprovalMode: vi.fn().mockReturnValue(ApprovalMode.DEFAULT),
setApprovalMode: vi.fn(),
getFileSystemService: () => ({
readTextFile: vi.fn().mockImplementation((p) => {
if (fs.existsSync(p)) {
return fs.readFileSync(p, 'utf8');
}
return 'existing content';
}),
writeTextFile: vi.fn().mockImplementation((p, c) => {
fs.writeFileSync(p, c);
}),
}),
getFileService: () => ({}),
getFileFilteringOptions: () => ({}),
getGeminiClient: () => ({}),
getBaseLlmClient: () => ({}),
getDisableLLMCorrection: () => true,
getIdeMode: () => false,
getActiveModel: () => 'test-model',
isPlanMode: () => false,
getWorkspaceContext: () => ({
isPathWithinWorkspace: () => true,
getDirectories: () => [rootDir],
}),
getDirectWebFetch: () => false,
storage: {
getProjectTempDir: () => path.join(os.tmpdir(), 'gemini-cli-temp'),
},
isPathAllowed(this: Config, absolutePath: string): boolean {
const workspaceContext = this.getWorkspaceContext();
if (workspaceContext.isPathWithinWorkspace(absolutePath)) {
return true;
}
const projectTempDir = this.storage.getProjectTempDir();
return isSubpath(path.resolve(projectTempDir), absolutePath);
},
validatePathAccess(this: Config, absolutePath: string): string | null {
if (this.isPathAllowed(absolutePath)) {
return null;
}
const workspaceDirs = this.getWorkspaceContext().getDirectories();
const projectTempDir = this.storage.getProjectTempDir();
return `Path not in workspace: Attempted path "${absolutePath}" resolves outside the allowed workspace directories: ${workspaceDirs.join(', ')} or the project temp directory: ${projectTempDir}`;
},
};
});
afterEach(() => {
if (fs.existsSync(rootDir)) {
fs.rmSync(rootDir, { recursive: true, force: true });
}
vi.restoreAllMocks();
});
const tools = [
{
name: 'EditTool',
create: (config: Config, bus: MessageBus) => new EditTool(config, bus),
params: {
file_path: 'test.txt',
instruction: 'change content',
old_string: 'existing',
new_string: 'new',
},
},
{
name: 'WriteFileTool',
create: (config: Config, bus: MessageBus) =>
new WriteFileTool(config, bus),
params: {
file_path: path.join(rootDir, 'test.txt'),
content: 'new content',
},
},
{
name: 'WebFetchTool',
create: (config: Config, bus: MessageBus) =>
new WebFetchTool(config, bus),
params: {
prompt: 'fetch https://example.com',
},
},
];
describe.each(tools)('$name policy updates', ({ create, params }) => {
it.each([
{
outcome: ToolConfirmationOutcome.ProceedAlways,
_shouldPublish: false,
expectedApprovalMode: ApprovalMode.AUTO_EDIT,
},
{
outcome: ToolConfirmationOutcome.ProceedAlwaysAndSave,
_shouldPublish: true,
_persist: true,
},
])(
'should handle $outcome correctly',
async ({ outcome, expectedApprovalMode }) => {
const tool = create(mockConfig, mockMessageBus);
// For file-based tools, ensure the file exists if needed
if (params.file_path) {
const fullPath = path.isAbsolute(params.file_path)
? params.file_path
: path.join(rootDir, params.file_path);
fs.writeFileSync(fullPath, 'existing content');
}
const invocation = tool.build(params as any);
// Mock getMessageBusDecision to trigger ASK_USER flow
vi.spyOn(invocation as any, 'getMessageBusDecision').mockResolvedValue(
'ask_user',
);
const confirmation = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
expect(confirmation).not.toBe(false);
if (confirmation) {
await confirmation.onConfirm(outcome);
// Policy updates are no longer published by onConfirm; they are
// handled centrally by the schedulers.
const publishCalls = (mockMessageBus.publish as any).mock.calls;
const hasUpdatePolicy = publishCalls.some(
(call: any) => call[0].type === MessageBusType.UPDATE_POLICY,
);
expect(hasUpdatePolicy).toBe(false);
if (expectedApprovalMode !== undefined) {
// expectedApprovalMode in this test (AUTO_EDIT) is now handled
// by updatePolicy in the scheduler, so it should not be called
// here either.
expect(mockConfig.setApprovalMode).not.toHaveBeenCalled();
}
}
},
);
it('should skip confirmation in AUTO_EDIT mode', async () => {
vi.spyOn(mockConfig, 'getApprovalMode').mockReturnValue(
ApprovalMode.AUTO_EDIT,
);
const tool = create(mockConfig, mockMessageBus);
const invocation = tool.build(params as any);
const confirmation = await invocation.shouldConfirmExecute(
new AbortController().signal,
);
expect(confirmation).toBe(false);
});
it('should NOT skip confirmation in AUTO_EDIT mode if forcedDecision is ask_user', async () => {
vi.spyOn(mockConfig, 'getApprovalMode').mockReturnValue(
ApprovalMode.AUTO_EDIT,
);
const tool = create(mockConfig, mockMessageBus);
const invocation = tool.build(params as any);
// Mock getMessageBusDecision to return ask_user
vi.spyOn(invocation as any, 'getMessageBusDecision').mockResolvedValue(
'ask_user',
);
const confirmation = await invocation.shouldConfirmExecute(
new AbortController().signal,
'ask_user',
);
expect(confirmation).not.toBe(false);
});
});
});
|