mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-15 08:31:14 -07:00
418 lines
12 KiB
TypeScript
418 lines
12 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2026 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
|
import { Box } from 'ink';
|
|
import { ToolConfirmationQueue } from './ToolConfirmationQueue.js';
|
|
import { StreamingState } from '../types.js';
|
|
import { renderWithProviders } from '../../test-utils/render.js';
|
|
import { waitFor } from '../../test-utils/async.js';
|
|
import { type Config, CoreToolCallStatus } from '@google/gemini-cli-core';
|
|
import type { ConfirmingToolState } from '../hooks/useConfirmingTool.js';
|
|
import { theme } from '../semantic-colors.js';
|
|
|
|
vi.mock('./StickyHeader.js', async (importOriginal) => {
|
|
const actual = await importOriginal<typeof import('./StickyHeader.js')>();
|
|
return {
|
|
...actual,
|
|
StickyHeader: vi.fn((props) => actual.StickyHeader(props)),
|
|
};
|
|
});
|
|
|
|
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
|
|
const actual =
|
|
await importOriginal<typeof import('@google/gemini-cli-core')>();
|
|
return {
|
|
...actual,
|
|
validatePlanPath: vi.fn().mockResolvedValue(undefined),
|
|
validatePlanContent: vi.fn().mockResolvedValue(undefined),
|
|
processSingleFileContent: vi.fn().mockResolvedValue({
|
|
llmContent: 'Plan content goes here',
|
|
error: undefined,
|
|
}),
|
|
};
|
|
});
|
|
|
|
const { StickyHeader } = await import('./StickyHeader.js');
|
|
|
|
describe('ToolConfirmationQueue', () => {
|
|
const mockConfig = {
|
|
isTrustedFolder: () => true,
|
|
getIdeMode: () => false,
|
|
getModel: () => 'gemini-pro',
|
|
getDebugMode: () => false,
|
|
getTargetDir: () => '/mock/target/dir',
|
|
getFileSystemService: () => ({
|
|
readFile: vi.fn().mockResolvedValue('Plan content'),
|
|
}),
|
|
storage: {
|
|
getPlansDir: () => '/mock/temp/plans',
|
|
},
|
|
getUseAlternateBuffer: () => false,
|
|
} as unknown as Config;
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it('renders the confirming tool with progress indicator', async () => {
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'ls',
|
|
description: 'list files',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'exec' as const,
|
|
title: 'Confirm execution',
|
|
command: 'ls',
|
|
rootCommand: 'ls',
|
|
rootCommands: ['ls'],
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 3,
|
|
};
|
|
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
const output = lastFrame();
|
|
expect(output).toContain('Action Required');
|
|
expect(output).toContain('1 of 3');
|
|
expect(output).toContain('ls'); // Tool name
|
|
expect(output).toContain('list files'); // Tool description
|
|
expect(output).toContain("Allow execution of: 'ls'?");
|
|
expect(output).toMatchSnapshot();
|
|
|
|
const stickyHeaderProps = vi.mocked(StickyHeader).mock.calls[0][0];
|
|
expect(stickyHeaderProps.borderColor).toBe(theme.status.warning);
|
|
unmount();
|
|
});
|
|
|
|
it('returns null if tool has no confirmation details', async () => {
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'ls',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: undefined,
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
expect(lastFrame({ allowEmpty: true })).toBe('');
|
|
unmount();
|
|
});
|
|
|
|
it('renders expansion hint when content is long and constrained', async () => {
|
|
const longDiff = '@@ -1,1 +1,50 @@\n' + '+line\n'.repeat(50);
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'replace',
|
|
description: 'edit file',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'edit' as const,
|
|
title: 'Confirm edit',
|
|
fileName: 'test.ts',
|
|
filePath: '/test.ts',
|
|
fileDiff: longDiff,
|
|
originalContent: 'old',
|
|
newContent: 'new',
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<Box flexDirection="column" height={30}>
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>
|
|
</Box>,
|
|
{
|
|
config: mockConfig,
|
|
useAlternateBuffer: true,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
terminalHeight: 20,
|
|
constrainHeight: true,
|
|
streamingState: StreamingState.WaitingForConfirmation,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
await waitFor(() =>
|
|
expect(lastFrame()?.toLowerCase()).toContain(
|
|
'press ctrl+o to show more lines',
|
|
),
|
|
);
|
|
expect(lastFrame()).toMatchSnapshot();
|
|
unmount();
|
|
});
|
|
|
|
it('calculates availableContentHeight based on availableTerminalHeight from UI state', async () => {
|
|
const longDiff = '@@ -1,1 +1,50 @@\n' + '+line\n'.repeat(50);
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'replace',
|
|
description: 'edit file',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'edit' as const,
|
|
title: 'Confirm edit',
|
|
fileName: 'test.ts',
|
|
filePath: '/test.ts',
|
|
fileDiff: longDiff,
|
|
originalContent: 'old',
|
|
newContent: 'new',
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
// Use a small availableTerminalHeight to force truncation
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
useAlternateBuffer: false,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
terminalHeight: 40,
|
|
availableTerminalHeight: 10,
|
|
constrainHeight: true,
|
|
streamingState: StreamingState.WaitingForConfirmation,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
// With availableTerminalHeight = 10:
|
|
// maxHeight = Math.max(10 - 1, 4) = 9
|
|
// availableContentHeight = Math.max(9 - 6, 4) = 4
|
|
// MaxSizedBox in ToolConfirmationMessage will use 4
|
|
// It should show truncation message
|
|
await waitFor(() => expect(lastFrame()).toContain('49 hidden (Ctrl+O)'));
|
|
expect(lastFrame()).toMatchSnapshot();
|
|
unmount();
|
|
});
|
|
|
|
it('provides more height for ask_user by subtracting less overhead', async () => {
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'ask_user',
|
|
description: 'ask user',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'ask_user' as const,
|
|
questions: [
|
|
{
|
|
type: 'choice',
|
|
header: 'Height Test',
|
|
question: 'Line 1\nLine 2\nLine 3\nLine 4\nLine 5\nLine 6',
|
|
options: [{ label: 'Option 1', description: 'Desc' }],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const {
|
|
lastFrame,
|
|
waitUntilReady,
|
|
unmount = vi.fn(),
|
|
} = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
terminalHeight: 40,
|
|
availableTerminalHeight: 20,
|
|
constrainHeight: true,
|
|
streamingState: StreamingState.WaitingForConfirmation,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
// Calculation:
|
|
// availableTerminalHeight: 20 -> maxHeight: 19 (20-1)
|
|
// hideToolIdentity is true for ask_user -> subtracts 4 instead of 6
|
|
// availableContentHeight = 19 - 4 = 15
|
|
// ToolConfirmationMessage handlesOwnUI=true -> returns full 15
|
|
// AskUserDialog allocates maxQuestionHeight = floor(15 * 0.7) = 10.
|
|
// 10 lines is enough for the 6-line question + padding.
|
|
await waitFor(() => {
|
|
expect(lastFrame()).toContain('Line 6');
|
|
expect(lastFrame()).not.toContain('lines hidden');
|
|
});
|
|
expect(lastFrame()).toMatchSnapshot();
|
|
unmount();
|
|
});
|
|
|
|
it('does not render expansion hint when constrainHeight is false', async () => {
|
|
const longDiff = 'line\n'.repeat(50);
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'replace',
|
|
description: 'edit file',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'edit' as const,
|
|
title: 'Confirm edit',
|
|
fileName: 'test.ts',
|
|
filePath: '/test.ts',
|
|
fileDiff: longDiff,
|
|
originalContent: 'old',
|
|
newContent: 'new',
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
terminalHeight: 40,
|
|
constrainHeight: false,
|
|
streamingState: StreamingState.WaitingForConfirmation,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
const output = lastFrame();
|
|
expect(output).not.toContain('Press CTRL-O to show more lines');
|
|
expect(output).toMatchSnapshot();
|
|
unmount();
|
|
});
|
|
|
|
it('renders AskUser tool confirmation with Success color', async () => {
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'ask_user',
|
|
description: 'ask user',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'ask_user' as const,
|
|
questions: [],
|
|
onConfirm: vi.fn(),
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const { lastFrame, waitUntilReady, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
},
|
|
},
|
|
);
|
|
await waitUntilReady();
|
|
|
|
const output = lastFrame();
|
|
expect(output).toMatchSnapshot();
|
|
|
|
const stickyHeaderProps = vi.mocked(StickyHeader).mock.calls[0][0];
|
|
expect(stickyHeaderProps.borderColor).toBe(theme.status.success);
|
|
unmount();
|
|
});
|
|
|
|
it('renders ExitPlanMode tool confirmation with Success color', async () => {
|
|
const confirmingTool = {
|
|
tool: {
|
|
callId: 'call-1',
|
|
name: 'exit_plan_mode',
|
|
description: 'exit plan mode',
|
|
status: CoreToolCallStatus.AwaitingApproval,
|
|
confirmationDetails: {
|
|
type: 'exit_plan_mode' as const,
|
|
planPath: '/path/to/plan',
|
|
onConfirm: vi.fn(),
|
|
},
|
|
},
|
|
index: 1,
|
|
total: 1,
|
|
};
|
|
|
|
const { lastFrame, unmount } = renderWithProviders(
|
|
<ToolConfirmationQueue
|
|
confirmingTool={confirmingTool as unknown as ConfirmingToolState}
|
|
/>,
|
|
{
|
|
config: mockConfig,
|
|
uiState: {
|
|
terminalWidth: 80,
|
|
},
|
|
},
|
|
);
|
|
|
|
await waitFor(() => {
|
|
expect(lastFrame()).toContain('Plan content goes here');
|
|
});
|
|
|
|
const output = lastFrame();
|
|
expect(output).toMatchSnapshot();
|
|
|
|
const stickyHeaderProps = vi.mocked(StickyHeader).mock.calls[0][0];
|
|
expect(stickyHeaderProps.borderColor).toBe(theme.status.success);
|
|
unmount();
|
|
});
|
|
});
|