462 lines
15 KiB
TypeScript
462 lines
15 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest';
|
|
import { render } from 'ink-testing-library';
|
|
import { AppWrapper as App } from './App.js';
|
|
import {
|
|
Config as ServerConfig,
|
|
MCPServerConfig,
|
|
ApprovalMode,
|
|
ToolRegistry,
|
|
AccessibilitySettings,
|
|
SandboxConfig,
|
|
} from '@google/gemini-cli-core';
|
|
import { LoadedSettings, SettingsFile, Settings } from '../config/settings.js';
|
|
import process from 'node:process';
|
|
import { Tips } from './components/Tips.js';
|
|
|
|
// Define a more complete mock server config based on actual Config
|
|
interface MockServerConfig {
|
|
apiKey: string;
|
|
model: string;
|
|
sandbox?: SandboxConfig;
|
|
targetDir: string;
|
|
debugMode: boolean;
|
|
question?: string;
|
|
fullContext: boolean;
|
|
coreTools?: string[];
|
|
toolDiscoveryCommand?: string;
|
|
toolCallCommand?: string;
|
|
mcpServerCommand?: string;
|
|
mcpServers?: Record<string, MCPServerConfig>; // Use imported MCPServerConfig
|
|
userAgent: string;
|
|
userMemory: string;
|
|
geminiMdFileCount: number;
|
|
approvalMode: ApprovalMode;
|
|
vertexai?: boolean;
|
|
showMemoryUsage?: boolean;
|
|
accessibility?: AccessibilitySettings;
|
|
embeddingModel: string;
|
|
|
|
getApiKey: Mock<() => string>;
|
|
getModel: Mock<() => string>;
|
|
getSandbox: Mock<() => SandboxConfig | undefined>;
|
|
getTargetDir: Mock<() => string>;
|
|
getToolRegistry: Mock<() => ToolRegistry>; // Use imported ToolRegistry type
|
|
getDebugMode: Mock<() => boolean>;
|
|
getQuestion: Mock<() => string | undefined>;
|
|
getFullContext: Mock<() => boolean>;
|
|
getCoreTools: Mock<() => string[] | undefined>;
|
|
getToolDiscoveryCommand: Mock<() => string | undefined>;
|
|
getToolCallCommand: Mock<() => string | undefined>;
|
|
getMcpServerCommand: Mock<() => string | undefined>;
|
|
getMcpServers: Mock<() => Record<string, MCPServerConfig> | undefined>;
|
|
getUserAgent: Mock<() => string>;
|
|
getUserMemory: Mock<() => string>;
|
|
setUserMemory: Mock<(newUserMemory: string) => void>;
|
|
getGeminiMdFileCount: Mock<() => number>;
|
|
setGeminiMdFileCount: Mock<(count: number) => void>;
|
|
getApprovalMode: Mock<() => ApprovalMode>;
|
|
setApprovalMode: Mock<(skip: ApprovalMode) => void>;
|
|
getVertexAI: Mock<() => boolean | undefined>;
|
|
getShowMemoryUsage: Mock<() => boolean>;
|
|
getAccessibility: Mock<() => AccessibilitySettings>;
|
|
getProjectRoot: Mock<() => string | undefined>;
|
|
getAllGeminiMdFilenames: Mock<() => string[]>;
|
|
}
|
|
|
|
// Mock @google/gemini-cli-core and its Config class
|
|
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
|
|
const actualCore =
|
|
await importOriginal<typeof import('@google/gemini-cli-core')>();
|
|
const ConfigClassMock = vi
|
|
.fn()
|
|
.mockImplementation((optionsPassedToConstructor) => {
|
|
const opts = { ...optionsPassedToConstructor }; // Clone
|
|
// Basic mock structure, will be extended by the instance in tests
|
|
return {
|
|
apiKey: opts.apiKey || 'test-key',
|
|
model: opts.model || 'test-model-in-mock-factory',
|
|
sandbox: opts.sandbox,
|
|
targetDir: opts.targetDir || '/test/dir',
|
|
debugMode: opts.debugMode || false,
|
|
question: opts.question,
|
|
fullContext: opts.fullContext ?? false,
|
|
coreTools: opts.coreTools,
|
|
toolDiscoveryCommand: opts.toolDiscoveryCommand,
|
|
toolCallCommand: opts.toolCallCommand,
|
|
mcpServerCommand: opts.mcpServerCommand,
|
|
mcpServers: opts.mcpServers,
|
|
userAgent: opts.userAgent || 'test-agent',
|
|
userMemory: opts.userMemory || '',
|
|
geminiMdFileCount: opts.geminiMdFileCount || 0,
|
|
approvalMode: opts.approvalMode ?? ApprovalMode.DEFAULT,
|
|
vertexai: opts.vertexai,
|
|
showMemoryUsage: opts.showMemoryUsage ?? false,
|
|
accessibility: opts.accessibility ?? {},
|
|
embeddingModel: opts.embeddingModel || 'test-embedding-model',
|
|
|
|
getApiKey: vi.fn(() => opts.apiKey || 'test-key'),
|
|
getModel: vi.fn(() => opts.model || 'test-model-in-mock-factory'),
|
|
getSandbox: vi.fn(() => opts.sandbox),
|
|
getTargetDir: vi.fn(() => opts.targetDir || '/test/dir'),
|
|
getToolRegistry: vi.fn(() => ({}) as ToolRegistry), // Simple mock
|
|
getDebugMode: vi.fn(() => opts.debugMode || false),
|
|
getQuestion: vi.fn(() => opts.question),
|
|
getFullContext: vi.fn(() => opts.fullContext ?? false),
|
|
getCoreTools: vi.fn(() => opts.coreTools),
|
|
getToolDiscoveryCommand: vi.fn(() => opts.toolDiscoveryCommand),
|
|
getToolCallCommand: vi.fn(() => opts.toolCallCommand),
|
|
getMcpServerCommand: vi.fn(() => opts.mcpServerCommand),
|
|
getMcpServers: vi.fn(() => opts.mcpServers),
|
|
getUserAgent: vi.fn(() => opts.userAgent || 'test-agent'),
|
|
getUserMemory: vi.fn(() => opts.userMemory || ''),
|
|
setUserMemory: vi.fn(),
|
|
getGeminiMdFileCount: vi.fn(() => opts.geminiMdFileCount || 0),
|
|
setGeminiMdFileCount: vi.fn(),
|
|
getApprovalMode: vi.fn(() => opts.approvalMode ?? ApprovalMode.DEFAULT),
|
|
setApprovalMode: vi.fn(),
|
|
getVertexAI: vi.fn(() => opts.vertexai),
|
|
getShowMemoryUsage: vi.fn(() => opts.showMemoryUsage ?? false),
|
|
getAccessibility: vi.fn(() => opts.accessibility ?? {}),
|
|
getProjectRoot: vi.fn(() => opts.projectRoot),
|
|
getGeminiClient: vi.fn(() => ({})),
|
|
getCheckpointingEnabled: vi.fn(() => opts.checkpointing ?? true),
|
|
getAllGeminiMdFilenames: vi.fn(() => ['GEMINI.md']),
|
|
setFlashFallbackHandler: vi.fn(),
|
|
};
|
|
});
|
|
return {
|
|
...actualCore,
|
|
Config: ConfigClassMock,
|
|
MCPServerConfig: actualCore.MCPServerConfig,
|
|
getAllGeminiMdFilenames: vi.fn(() => ['GEMINI.md']),
|
|
};
|
|
});
|
|
|
|
// Mock heavy dependencies or those with side effects
|
|
vi.mock('./hooks/useGeminiStream', () => ({
|
|
useGeminiStream: vi.fn(() => ({
|
|
streamingState: 'Idle',
|
|
submitQuery: vi.fn(),
|
|
initError: null,
|
|
pendingHistoryItems: [],
|
|
})),
|
|
}));
|
|
|
|
vi.mock('./hooks/useAuthCommand', () => ({
|
|
useAuthCommand: vi.fn(() => ({
|
|
isAuthDialogOpen: false,
|
|
openAuthDialog: vi.fn(),
|
|
handleAuthSelect: vi.fn(),
|
|
handleAuthHighlight: vi.fn(),
|
|
})),
|
|
}));
|
|
|
|
vi.mock('./hooks/useLogger', () => ({
|
|
useLogger: vi.fn(() => ({
|
|
getPreviousUserMessages: vi.fn().mockResolvedValue([]),
|
|
})),
|
|
}));
|
|
|
|
vi.mock('../config/config.js', async (importOriginal) => {
|
|
const actual = await importOriginal();
|
|
return {
|
|
// @ts-expect-error - this is fine
|
|
...actual,
|
|
loadHierarchicalGeminiMemory: vi
|
|
.fn()
|
|
.mockResolvedValue({ memoryContent: '', fileCount: 0 }),
|
|
};
|
|
});
|
|
|
|
vi.mock('./components/Tips.js', () => ({
|
|
Tips: vi.fn(() => null),
|
|
}));
|
|
|
|
describe('App UI', () => {
|
|
let mockConfig: MockServerConfig;
|
|
let mockSettings: LoadedSettings;
|
|
let currentUnmount: (() => void) | undefined;
|
|
|
|
const createMockSettings = (
|
|
settings: Partial<Settings> = {},
|
|
): LoadedSettings => {
|
|
const userSettingsFile: SettingsFile = {
|
|
path: '/user/settings.json',
|
|
settings: {},
|
|
};
|
|
const workspaceSettingsFile: SettingsFile = {
|
|
path: '/workspace/.gemini/settings.json',
|
|
settings: {
|
|
...settings,
|
|
},
|
|
};
|
|
return new LoadedSettings(userSettingsFile, workspaceSettingsFile, []);
|
|
};
|
|
|
|
beforeEach(() => {
|
|
const ServerConfigMocked = vi.mocked(ServerConfig, true);
|
|
mockConfig = new ServerConfigMocked({
|
|
embeddingModel: 'test-embedding-model',
|
|
sandbox: undefined,
|
|
targetDir: '/test/dir',
|
|
debugMode: false,
|
|
userMemory: '',
|
|
geminiMdFileCount: 0,
|
|
showMemoryUsage: false,
|
|
sessionId: 'test-session-id',
|
|
cwd: '/tmp',
|
|
model: 'model',
|
|
}) as unknown as MockServerConfig;
|
|
|
|
// Ensure the getShowMemoryUsage mock function is specifically set up if not covered by constructor mock
|
|
if (!mockConfig.getShowMemoryUsage) {
|
|
mockConfig.getShowMemoryUsage = vi.fn(() => false);
|
|
}
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false); // Default for most tests
|
|
|
|
// Ensure a theme is set so the theme dialog does not appear.
|
|
mockSettings = createMockSettings({ theme: 'Default' });
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (currentUnmount) {
|
|
currentUnmount();
|
|
currentUnmount = undefined;
|
|
}
|
|
vi.clearAllMocks(); // Clear mocks after each test
|
|
});
|
|
|
|
it('should display default "GEMINI.md" in footer when contextFileName is not set and count is 1', async () => {
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(1);
|
|
// For this test, ensure showMemoryUsage is false or debugMode is false if it relies on that
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve(); // Wait for any async updates
|
|
expect(lastFrame()).toContain('Using 1 GEMINI.md file');
|
|
});
|
|
|
|
it('should display default "GEMINI.md" with plural when contextFileName is not set and count is > 1', async () => {
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(2);
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('Using 2 GEMINI.md files');
|
|
});
|
|
|
|
it('should display custom contextFileName in footer when set and count is 1', async () => {
|
|
mockSettings = createMockSettings({
|
|
contextFileName: 'AGENTS.md',
|
|
theme: 'Default',
|
|
});
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(1);
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('Using 1 AGENTS.md file');
|
|
});
|
|
|
|
it('should display a generic message when multiple context files with different names are provided', async () => {
|
|
mockSettings = createMockSettings({
|
|
contextFileName: ['AGENTS.md', 'CONTEXT.md'],
|
|
theme: 'Default',
|
|
});
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(2);
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('Using 2 context files');
|
|
});
|
|
|
|
it('should display custom contextFileName with plural when set and count is > 1', async () => {
|
|
mockSettings = createMockSettings({
|
|
contextFileName: 'MY_NOTES.TXT',
|
|
theme: 'Default',
|
|
});
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(3);
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('Using 3 MY_NOTES.TXT files');
|
|
});
|
|
|
|
it('should not display context file message if count is 0, even if contextFileName is set', async () => {
|
|
mockSettings = createMockSettings({
|
|
contextFileName: 'ANY_FILE.MD',
|
|
theme: 'Default',
|
|
});
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(0);
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).not.toContain('ANY_FILE.MD');
|
|
});
|
|
|
|
it('should display GEMINI.md and MCP server count when both are present', async () => {
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(2);
|
|
mockConfig.getMcpServers.mockReturnValue({
|
|
server1: {} as MCPServerConfig,
|
|
});
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('server');
|
|
});
|
|
|
|
it('should display only MCP server count when GEMINI.md count is 0', async () => {
|
|
mockConfig.getGeminiMdFileCount.mockReturnValue(0);
|
|
mockConfig.getMcpServers.mockReturnValue({
|
|
server1: {} as MCPServerConfig,
|
|
server2: {} as MCPServerConfig,
|
|
});
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(lastFrame()).toContain('Using 2 MCP servers');
|
|
});
|
|
|
|
it('should display Tips component by default', async () => {
|
|
const { unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(vi.mocked(Tips)).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should not display Tips component when hideTips is true', async () => {
|
|
mockSettings = createMockSettings({
|
|
hideTips: true,
|
|
});
|
|
|
|
const { unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
await Promise.resolve();
|
|
expect(vi.mocked(Tips)).not.toHaveBeenCalled();
|
|
});
|
|
|
|
describe('when no theme is set', () => {
|
|
let originalNoColor: string | undefined;
|
|
|
|
beforeEach(() => {
|
|
originalNoColor = process.env.NO_COLOR;
|
|
// Ensure no theme is set for these tests
|
|
mockSettings = createMockSettings({});
|
|
mockConfig.getDebugMode.mockReturnValue(false);
|
|
mockConfig.getShowMemoryUsage.mockReturnValue(false);
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.env.NO_COLOR = originalNoColor;
|
|
});
|
|
|
|
it('should display theme dialog if NO_COLOR is not set', async () => {
|
|
delete process.env.NO_COLOR;
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
|
|
expect(lastFrame()).toContain('Select Theme');
|
|
});
|
|
|
|
it('should display a message if NO_COLOR is set', async () => {
|
|
process.env.NO_COLOR = 'true';
|
|
|
|
const { lastFrame, unmount } = render(
|
|
<App
|
|
config={mockConfig as unknown as ServerConfig}
|
|
settings={mockSettings}
|
|
/>,
|
|
);
|
|
currentUnmount = unmount;
|
|
|
|
expect(lastFrame()).toContain(
|
|
'Theme configuration unavailable due to NO_COLOR env variable.',
|
|
);
|
|
expect(lastFrame()).not.toContain('Select Theme');
|
|
});
|
|
});
|
|
});
|