mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-23 04:21:31 -07:00
239 lines
7.6 KiB
TypeScript
239 lines
7.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import {
|
|
vi,
|
|
describe,
|
|
it,
|
|
expect,
|
|
beforeEach,
|
|
afterEach,
|
|
type Mock,
|
|
} from 'vitest';
|
|
import { renderHook } from '../../test-utils/render.js';
|
|
import { waitFor } from '../../test-utils/async.js';
|
|
import { useIncludeDirsTrust } from './useIncludeDirsTrust.js';
|
|
import * as trustedFolders from '../../config/trustedFolders.js';
|
|
import type { Config, WorkspaceContext } from '@google/gemini-cli-core';
|
|
import type { UseHistoryManagerReturn } from './useHistoryManager.js';
|
|
import type { LoadedTrustedFolders } from '../../config/trustedFolders.js';
|
|
|
|
import type { MultiFolderTrustDialogProps } from '../components/MultiFolderTrustDialog.js';
|
|
|
|
vi.mock('../utils/directoryUtils.js', async (importOriginal) => {
|
|
const actual =
|
|
await importOriginal<typeof import('../utils/directoryUtils.js')>();
|
|
return {
|
|
...actual,
|
|
expandHomeDir: (p: string) => p, // Simple pass-through for testing
|
|
batchAddDirectories: (
|
|
workspaceContext: WorkspaceContext,
|
|
paths: string[],
|
|
) => {
|
|
const result = workspaceContext.addDirectories(paths);
|
|
const errors: string[] = [];
|
|
for (const failure of result.failed) {
|
|
errors.push(`Error adding '${failure.path}': ${failure.error.message}`);
|
|
}
|
|
return { added: result.added, errors };
|
|
},
|
|
loadMemoryFromDirectories: vi.fn().mockResolvedValue({ fileCount: 1 }),
|
|
};
|
|
});
|
|
|
|
vi.mock('../components/MultiFolderTrustDialog.js', () => ({
|
|
MultiFolderTrustDialog: (props: MultiFolderTrustDialogProps) => (
|
|
<div data-testid="mock-dialog">{JSON.stringify(props.folders)}</div>
|
|
),
|
|
}));
|
|
|
|
describe('useIncludeDirsTrust', () => {
|
|
let mockConfig: Config;
|
|
let mockHistoryManager: UseHistoryManagerReturn;
|
|
let mockSetCustomDialog: Mock;
|
|
let mockWorkspaceContext: WorkspaceContext;
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
|
|
mockWorkspaceContext = {
|
|
addDirectory: vi.fn(),
|
|
addDirectories: vi.fn().mockReturnValue({ added: [], failed: [] }),
|
|
getDirectories: vi.fn().mockReturnValue([]),
|
|
onDirectoriesChangedListeners: new Set(),
|
|
onDirectoriesChanged: vi.fn(),
|
|
notifyDirectoriesChanged: vi.fn(),
|
|
resolveAndValidateDir: vi.fn(),
|
|
getInitialDirectories: vi.fn(),
|
|
setDirectories: vi.fn(),
|
|
isPathWithinWorkspace: vi.fn(),
|
|
fullyResolvedPath: vi.fn(),
|
|
isPathWithinRoot: vi.fn(),
|
|
isFileSymlink: vi.fn(),
|
|
} as unknown as ReturnType<typeof mockConfig.getWorkspaceContext>;
|
|
|
|
mockConfig = {
|
|
getPendingIncludeDirectories: vi.fn().mockReturnValue([]),
|
|
clearPendingIncludeDirectories: vi.fn(),
|
|
getFolderTrust: vi.fn().mockReturnValue(true),
|
|
getWorkspaceContext: () => mockWorkspaceContext,
|
|
getGeminiClient: vi
|
|
.fn()
|
|
.mockReturnValue({ addDirectoryContext: vi.fn() }),
|
|
} as unknown as Config;
|
|
|
|
mockHistoryManager = {
|
|
addItem: vi.fn(),
|
|
history: [],
|
|
updateItem: vi.fn(),
|
|
clearItems: vi.fn(),
|
|
loadHistory: vi.fn(),
|
|
};
|
|
mockSetCustomDialog = vi.fn();
|
|
});
|
|
|
|
const renderTestHook = (isTrustedFolder: boolean | undefined) => {
|
|
renderHook(() =>
|
|
useIncludeDirsTrust(
|
|
mockConfig,
|
|
isTrustedFolder,
|
|
mockHistoryManager,
|
|
mockSetCustomDialog,
|
|
),
|
|
);
|
|
};
|
|
|
|
it('should do nothing if isTrustedFolder is undefined', () => {
|
|
vi.mocked(mockConfig.getPendingIncludeDirectories).mockReturnValue([
|
|
'/foo',
|
|
]);
|
|
renderTestHook(undefined);
|
|
expect(mockConfig.clearPendingIncludeDirectories).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('should do nothing if there are no pending directories', () => {
|
|
renderTestHook(true);
|
|
expect(mockConfig.clearPendingIncludeDirectories).not.toHaveBeenCalled();
|
|
});
|
|
|
|
describe('when folder trust is disabled or workspace is untrusted', () => {
|
|
it.each([
|
|
{ trustEnabled: false, isTrusted: true, scenario: 'trust is disabled' },
|
|
{
|
|
trustEnabled: true,
|
|
isTrusted: false,
|
|
scenario: 'workspace is untrusted',
|
|
},
|
|
])(
|
|
'should add directories directly when $scenario',
|
|
async ({ trustEnabled, isTrusted }) => {
|
|
vi.mocked(mockConfig.getFolderTrust).mockReturnValue(trustEnabled);
|
|
vi.mocked(mockConfig.getPendingIncludeDirectories).mockReturnValue([
|
|
'/dir1',
|
|
'/dir2',
|
|
]);
|
|
vi.mocked(mockWorkspaceContext.addDirectories).mockReturnValue({
|
|
added: ['/dir1'],
|
|
failed: [{ path: '/dir2', error: new Error('Test error') }],
|
|
});
|
|
|
|
renderTestHook(isTrusted);
|
|
|
|
await waitFor(() => {
|
|
expect(mockWorkspaceContext.addDirectories).toHaveBeenCalledWith([
|
|
'/dir1',
|
|
'/dir2',
|
|
]);
|
|
expect(mockHistoryManager.addItem).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
text: expect.stringContaining("Error adding '/dir2': Test error"),
|
|
}),
|
|
);
|
|
expect(
|
|
mockConfig.clearPendingIncludeDirectories,
|
|
).toHaveBeenCalledTimes(1);
|
|
});
|
|
},
|
|
);
|
|
});
|
|
|
|
describe('when folder trust is enabled and workspace is trusted', () => {
|
|
let mockIsPathTrusted: Mock;
|
|
|
|
beforeEach(() => {
|
|
vi.spyOn(mockConfig, 'getFolderTrust').mockReturnValue(true);
|
|
mockIsPathTrusted = vi.fn();
|
|
const mockLoadedFolders = {
|
|
isPathTrusted: mockIsPathTrusted,
|
|
} as unknown as LoadedTrustedFolders;
|
|
vi.spyOn(trustedFolders, 'loadTrustedFolders').mockReturnValue(
|
|
mockLoadedFolders,
|
|
);
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it('should add trusted dirs, collect untrusted errors, and open dialog for undefined', async () => {
|
|
const pendingDirs = ['/trusted', '/untrusted', '/undefined'];
|
|
vi.mocked(mockConfig.getPendingIncludeDirectories).mockReturnValue(
|
|
pendingDirs,
|
|
);
|
|
|
|
mockIsPathTrusted.mockImplementation((path: string) => {
|
|
if (path === '/trusted') return true;
|
|
if (path === '/untrusted') return false;
|
|
return undefined;
|
|
});
|
|
|
|
vi.mocked(mockWorkspaceContext.addDirectories).mockReturnValue({
|
|
added: ['/trusted'],
|
|
failed: [],
|
|
});
|
|
|
|
renderTestHook(true);
|
|
|
|
// Opens dialog for undefined trust dir
|
|
expect(mockSetCustomDialog).toHaveBeenCalledTimes(1);
|
|
const customDialogAction = mockSetCustomDialog.mock.calls[0][0];
|
|
expect(customDialogAction).toBeDefined();
|
|
const dialogProps = (
|
|
customDialogAction as React.ReactElement<MultiFolderTrustDialogProps>
|
|
).props;
|
|
expect(dialogProps.folders).toEqual(['/undefined']);
|
|
expect(dialogProps.trustedDirs).toEqual(['/trusted']);
|
|
expect(dialogProps.errors).toEqual([
|
|
`The following directories are explicitly untrusted and cannot be added to a trusted workspace:\n- /untrusted\nPlease use the permissions command to modify their trust level.`,
|
|
]);
|
|
});
|
|
|
|
it('should only add directories and clear pending if no dialog is needed', async () => {
|
|
const pendingDirs = ['/trusted1', '/trusted2'];
|
|
vi.mocked(mockConfig.getPendingIncludeDirectories).mockReturnValue(
|
|
pendingDirs,
|
|
);
|
|
mockIsPathTrusted.mockReturnValue(true);
|
|
vi.mocked(mockWorkspaceContext.addDirectories).mockReturnValue({
|
|
added: pendingDirs,
|
|
failed: [],
|
|
});
|
|
|
|
renderTestHook(true);
|
|
|
|
await waitFor(() => {
|
|
expect(mockWorkspaceContext.addDirectories).toHaveBeenCalledWith(
|
|
pendingDirs,
|
|
);
|
|
expect(mockSetCustomDialog).not.toHaveBeenCalled();
|
|
expect(mockConfig.clearPendingIncludeDirectories).toHaveBeenCalledTimes(
|
|
1,
|
|
);
|
|
});
|
|
});
|
|
});
|
|
});
|