Download packages/cli/src/ui/components/messages/ShellToolMessage.test.tsx from SaylorTwift/gemini-cli: direct link, hf CLI and curl.
- Browser
- Download file 13 kB
-
https://huggingface.co/SaylorTwift/gemini-cli/resolve/main/packages/cli/src/ui/components/messages/ShellToolMessage.test.tsx
- Command line
-
hf download hf://SaylorTwift/gemini-cli/packages/cli/src/ui/components/messages/ShellToolMessage.test.tsx
-
curl -L -o ShellToolMessage.test.tsx https://huggingface.co/SaylorTwift/gemini-cli/resolve/main/packages/cli/src/ui/components/messages/ShellToolMessage.test.tsx
13 kB
| /** | |
| * @license | |
| * Copyright 2025 Google LLC | |
| * SPDX-License-Identifier: Apache-2.0 | |
| */ | |
| import React, { act } from 'react'; | |
| import { | |
| ShellToolMessage, | |
| type ShellToolMessageProps, | |
| } from './ShellToolMessage.js'; | |
| import { StreamingState } from '../../types.js'; | |
| import { | |
| type Config, | |
| SHELL_TOOL_NAME, | |
| CoreToolCallStatus, | |
| } from '@google/gemini-cli-core'; | |
| import { renderWithProviders } from '../../../test-utils/render.js'; | |
| import { createMockSettings } from '../../../test-utils/settings.js'; | |
| import { makeFakeConfig } from '@google/gemini-cli-core'; | |
| import { waitFor } from '../../../test-utils/async.js'; | |
| import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; | |
| import { SHELL_COMMAND_NAME, ACTIVE_SHELL_MAX_LINES } from '../../constants.js'; | |
| import { | |
| SHELL_CONTENT_OVERHEAD, | |
| TOOL_RESULT_STANDARD_RESERVED_LINE_COUNT, | |
| } from '../../utils/toolLayoutUtils.js'; | |
| describe('<ShellToolMessage />', () => { | |
| const baseProps: ShellToolMessageProps = { | |
| callId: 'tool-123', | |
| name: SHELL_COMMAND_NAME, | |
| description: 'A shell command', | |
| resultDisplay: 'Test result', | |
| status: CoreToolCallStatus.Executing, | |
| terminalWidth: 80, | |
| confirmationDetails: undefined, | |
| emphasis: 'medium', | |
| isFirst: true, | |
| borderColor: 'green', | |
| borderDimColor: false, | |
| isExpandable: false, | |
| config: { | |
| getEnableInteractiveShell: () => true, | |
| } as unknown as Config, | |
| }; | |
| const LONG_OUTPUT = Array.from( | |
| { length: 100 }, | |
| (_, i) => `Line ${i + 1}`, | |
| ).join('\n'); | |
| const mockSetEmbeddedShellFocused = vi.fn(); | |
| const uiActions = { | |
| setEmbeddedShellFocused: mockSetEmbeddedShellFocused, | |
| }; | |
| beforeEach(() => { | |
| vi.clearAllMocks(); | |
| vi.useFakeTimers(); | |
| }); | |
| afterEach(() => { | |
| vi.useRealTimers(); | |
| }); | |
| describe('interactive shell focus', () => { | |
| it.each([ | |
| ['SHELL_COMMAND_NAME', SHELL_COMMAND_NAME], | |
| ['SHELL_TOOL_NAME', SHELL_TOOL_NAME], | |
| ])('clicks inside the shell area sets focus for %s', async (_, name) => { | |
| const { lastFrame, simulateClick, unmount, waitUntilReady } = | |
| await renderWithProviders( | |
| <ShellToolMessage {...baseProps} name={name} />, | |
| { uiActions, mouseEventsEnabled: true }, | |
| ); | |
| await waitUntilReady(); | |
| expect(lastFrame()).toContain('A shell command'); | |
| await simulateClick(2, 2); | |
| await waitFor(() => { | |
| expect(mockSetEmbeddedShellFocused).toHaveBeenCalledWith(true); | |
| }); | |
| unmount(); | |
| }); | |
| it('resets focus when shell finishes', async () => { | |
| let updateStatus: (s: CoreToolCallStatus) => void = () => {}; | |
| const Wrapper = () => { | |
| const [status, setStatus] = React.useState( | |
| CoreToolCallStatus.Executing, | |
| ); | |
| updateStatus = setStatus; | |
| return <ShellToolMessage {...baseProps} status={status} ptyId={1} />; | |
| }; | |
| const { lastFrame, unmount, waitUntilReady } = await renderWithProviders( | |
| <Wrapper />, | |
| { | |
| uiActions, | |
| uiState: { | |
| streamingState: StreamingState.Idle, | |
| embeddedShellFocused: true, | |
| activePtyId: 1, | |
| }, | |
| }, | |
| ); | |
| // Verify it is initially focused | |
| await waitUntilReady(); | |
| expect(lastFrame()).toContain('(Shift+Tab to unfocus)'); | |
| // Now update status to Success | |
| await act(async () => { | |
| updateStatus(CoreToolCallStatus.Success); | |
| }); | |
| // Should call setEmbeddedShellFocused(false) because isThisShellFocused became false | |
| await waitFor(() => { | |
| expect(mockSetEmbeddedShellFocused).toHaveBeenCalledWith(false); | |
| expect(lastFrame()).not.toContain('(Shift+Tab to unfocus)'); | |
| }); | |
| unmount(); | |
| }); | |
| }); | |
| describe('Snapshots', () => { | |
| it.each([ | |
| [ | |
| 'renders in Executing state', | |
| { status: CoreToolCallStatus.Executing }, | |
| undefined, | |
| ], | |
| [ | |
| 'renders in Success state (history mode)', | |
| { status: CoreToolCallStatus.Success }, | |
| undefined, | |
| ], | |
| [ | |
| 'renders in Error state', | |
| { status: CoreToolCallStatus.Error, resultDisplay: 'Error output' }, | |
| undefined, | |
| ], | |
| [ | |
| 'renders in Cancelled state with partial output', | |
| { | |
| status: CoreToolCallStatus.Cancelled, | |
| resultDisplay: 'Partial output before cancellation', | |
| }, | |
| undefined, | |
| ], | |
| [ | |
| 'renders in Alternate Buffer mode while focused', | |
| { | |
| status: CoreToolCallStatus.Executing, | |
| ptyId: 1, | |
| }, | |
| { | |
| config: makeFakeConfig({ useAlternateBuffer: true }), | |
| settings: createMockSettings({ ui: { useAlternateBuffer: true } }), | |
| uiState: { | |
| embeddedShellFocused: true, | |
| activePtyId: 1, | |
| }, | |
| }, | |
| ], | |
| [ | |
| 'renders in Alternate Buffer mode while unfocused', | |
| { | |
| status: CoreToolCallStatus.Executing, | |
| ptyId: 1, | |
| }, | |
| { | |
| config: makeFakeConfig({ useAlternateBuffer: true }), | |
| settings: createMockSettings({ ui: { useAlternateBuffer: true } }), | |
| uiState: { | |
| embeddedShellFocused: false, | |
| activePtyId: 1, | |
| }, | |
| }, | |
| ], | |
| ])('%s', async (_, props, options) => { | |
| const { lastFrame, unmount } = await renderWithProviders( | |
| <ShellToolMessage {...baseProps} {...props} />, | |
| { uiActions, ...options }, | |
| ); | |
| expect(lastFrame()).toMatchSnapshot(); | |
| unmount(); | |
| }); | |
| }); | |
| describe('Height Constraints', () => { | |
| it.each([ | |
| [ | |
| 'respects availableTerminalHeight when it is smaller than ACTIVE_SHELL_MAX_LINES', | |
| 10, | |
| 10 - TOOL_RESULT_STANDARD_RESERVED_LINE_COUNT, // 7 (Header height is 3, but calculation uses reserved=3) | |
| false, | |
| true, | |
| false, | |
| ], | |
| [ | |
| 'uses ACTIVE_SHELL_MAX_LINES when availableTerminalHeight is large', | |
| 100, | |
| ACTIVE_SHELL_MAX_LINES - SHELL_CONTENT_OVERHEAD, // 11 | |
| false, | |
| true, | |
| false, | |
| ], | |
| [ | |
| 'uses full availableTerminalHeight when focused in alternate buffer mode', | |
| 100, | |
| 100 - TOOL_RESULT_STANDARD_RESERVED_LINE_COUNT, // 97 | |
| true, | |
| false, | |
| false, | |
| ], | |
| [ | |
| 'defaults to ACTIVE_SHELL_MAX_LINES in alternate buffer when availableTerminalHeight is undefined', | |
| undefined, | |
| ACTIVE_SHELL_MAX_LINES - SHELL_CONTENT_OVERHEAD, // 11 | |
| false, | |
| true, | |
| false, | |
| ], | |
| ])( | |
| '%s', | |
| async ( | |
| _, | |
| availableTerminalHeight, | |
| expectedMaxLines, | |
| focused, | |
| constrainHeight, | |
| isExpandable, | |
| ) => { | |
| const { lastFrame, waitUntilReady, unmount } = | |
| await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| resultDisplay={LONG_OUTPUT} | |
| renderOutputAsMarkdown={false} | |
| availableTerminalHeight={availableTerminalHeight} | |
| ptyId={1} | |
| status={CoreToolCallStatus.Executing} | |
| isExpandable={isExpandable} | |
| />, | |
| { | |
| uiActions, | |
| config: makeFakeConfig({ useAlternateBuffer: true }), | |
| settings: createMockSettings({ | |
| ui: { useAlternateBuffer: true }, | |
| }), | |
| uiState: { | |
| activePtyId: focused ? 1 : 2, | |
| embeddedShellFocused: focused, | |
| constrainHeight, | |
| }, | |
| }, | |
| ); | |
| await waitUntilReady(); | |
| const frame = lastFrame(); | |
| expect(frame.match(/Line \d+/g)?.length).toBe(expectedMaxLines); | |
| expect(frame).toMatchSnapshot(); | |
| unmount(); | |
| }, | |
| ); | |
| it('fully expands in standard mode when availableTerminalHeight is undefined', async () => { | |
| const { lastFrame, unmount, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| resultDisplay={LONG_OUTPUT} | |
| renderOutputAsMarkdown={false} | |
| availableTerminalHeight={undefined} | |
| status={CoreToolCallStatus.Executing} | |
| />, | |
| { | |
| uiActions, | |
| config: makeFakeConfig({ useAlternateBuffer: false }), | |
| settings: createMockSettings({ ui: { useAlternateBuffer: false } }), | |
| uiState: { | |
| constrainHeight: false, | |
| terminalHeight: 200, | |
| }, | |
| }, | |
| ); | |
| await waitUntilReady(); | |
| const frame = lastFrame(); | |
| // Since it's Executing, it might still constrain to ACTIVE_SHELL_MAX_LINES (10) | |
| // Actually let's just assert on the behaviour that happens right now (which is 100 lines because we removed the terminalBuffer check) | |
| expect(frame.match(/Line \d+/g)?.length).toBe(100); | |
| unmount(); | |
| }); | |
| it('fully expands in alternate buffer mode when constrainHeight is false and isExpandable is true', async () => { | |
| const { lastFrame, unmount, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| resultDisplay={LONG_OUTPUT} | |
| renderOutputAsMarkdown={false} | |
| availableTerminalHeight={undefined} | |
| status={CoreToolCallStatus.Success} | |
| isExpandable={true} | |
| />, | |
| { | |
| uiActions, | |
| config: makeFakeConfig({ useAlternateBuffer: true }), | |
| settings: createMockSettings({ ui: { useAlternateBuffer: true } }), | |
| uiState: { | |
| constrainHeight: false, | |
| }, | |
| }, | |
| ); | |
| await waitUntilReady(); | |
| const frame = lastFrame(); | |
| // Should show all 100 lines because constrainHeight is false and isExpandable is true | |
| expect(frame.match(/Line \d+/g)?.length).toBe(100); | |
| expect(lastFrame()).toMatchSnapshot(); | |
| unmount(); | |
| }); | |
| it('stays constrained in alternate buffer mode when isExpandable is false even if constrainHeight is false', async () => { | |
| const { lastFrame, unmount, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| resultDisplay={LONG_OUTPUT} | |
| renderOutputAsMarkdown={false} | |
| availableTerminalHeight={undefined} | |
| status={CoreToolCallStatus.Success} | |
| isExpandable={false} | |
| />, | |
| { | |
| uiActions, | |
| config: makeFakeConfig({ useAlternateBuffer: true }), | |
| settings: createMockSettings({ ui: { useAlternateBuffer: true } }), | |
| uiState: { | |
| constrainHeight: false, | |
| }, | |
| }, | |
| ); | |
| await waitUntilReady(); | |
| const frame = lastFrame(); | |
| // Should still be constrained to 11 (15 - 4) because isExpandable is false | |
| expect(frame.match(/Line \d+/g)?.length).toBe( | |
| ACTIVE_SHELL_MAX_LINES - SHELL_CONTENT_OVERHEAD, | |
| ); | |
| expect(lastFrame()).toMatchSnapshot(); | |
| unmount(); | |
| }); | |
| }); | |
| describe('Header Expansion', () => { | |
| const LONG_DESCRIPTION = 'very long '.repeat(20); | |
| it('truncates header by default', async () => { | |
| const { lastFrame, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| description={LONG_DESCRIPTION} | |
| availableTerminalHeight={10} | |
| />, | |
| { uiActions }, | |
| ); | |
| await waitUntilReady(); | |
| const output = lastFrame(); | |
| // Should be a single line header | |
| expect(output.split('\n')[1]).toContain(SHELL_COMMAND_NAME); // name | |
| // We check if it's truncated. In our ToolInfo, it's height 1. | |
| // The StickyHeader adds some structure, but the ToolInfo Box is inside. | |
| }); | |
| it('expands header when availableTerminalHeight is undefined', async () => { | |
| const { lastFrame, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| description={LONG_DESCRIPTION} | |
| availableTerminalHeight={undefined} | |
| />, | |
| { uiActions }, | |
| ); | |
| await waitUntilReady(); | |
| const output = lastFrame(); | |
| // When expanded, the header (ToolInfo) should wrap and take multiple lines. | |
| // Since it's at the top, we check if the first few lines contain parts of the description. | |
| const lines = output.split('\n'); | |
| expect(lines.length).toBeGreaterThan(5); | |
| }); | |
| it('expands header when isExpanded is true in context', async () => { | |
| const { lastFrame, waitUntilReady } = await renderWithProviders( | |
| <ShellToolMessage | |
| {...baseProps} | |
| description={LONG_DESCRIPTION} | |
| availableTerminalHeight={10} | |
| />, | |
| { | |
| uiActions, | |
| toolActions: { | |
| isExpanded: (id: string) => id === baseProps.callId, | |
| }, | |
| }, | |
| ); | |
| await waitUntilReady(); | |
| const output = lastFrame(); | |
| // Should be expanded due to context | |
| expect(output.split('\n').length).toBeGreaterThan(5); | |
| }); | |
| }); | |
| }); | |