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
235
236
237
|
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import {
vi,
describe,
it,
expect,
beforeEach,
afterEach,
Mocked,
Mock,
} from 'vitest';
import * as fs from 'fs/promises';
import { restoreCommand } from './restoreCommand.js';
import { type CommandContext } from './types.js';
import { createMockCommandContext } from '../../test-utils/mockCommandContext.js';
import { Config, GitService } from '@google/gemini-cli-core';
vi.mock('fs/promises', () => ({
readdir: vi.fn(),
readFile: vi.fn(),
mkdir: vi.fn(),
}));
describe('restoreCommand', () => {
let mockContext: CommandContext;
let mockConfig: Config;
let mockGitService: GitService;
const mockFsPromises = fs as Mocked<typeof fs>;
let mockSetHistory: ReturnType<typeof vi.fn>;
beforeEach(() => {
mockSetHistory = vi.fn().mockResolvedValue(undefined);
mockGitService = {
restoreProjectFromSnapshot: vi.fn().mockResolvedValue(undefined),
} as unknown as GitService;
mockConfig = {
getCheckpointingEnabled: vi.fn().mockReturnValue(true),
getProjectTempDir: vi.fn().mockReturnValue('/tmp/gemini'),
getGeminiClient: vi.fn().mockReturnValue({
setHistory: mockSetHistory,
}),
} as unknown as Config;
mockContext = createMockCommandContext({
services: {
config: mockConfig,
git: mockGitService,
},
});
});
afterEach(() => {
vi.restoreAllMocks();
});
it('should return null if checkpointing is not enabled', () => {
(mockConfig.getCheckpointingEnabled as Mock).mockReturnValue(false);
const command = restoreCommand(mockConfig);
expect(command).toBeNull();
});
it('should return the command if checkpointing is enabled', () => {
const command = restoreCommand(mockConfig);
expect(command).not.toBeNull();
expect(command?.name).toBe('restore');
expect(command?.description).toBeDefined();
expect(command?.action).toBeDefined();
expect(command?.completion).toBeDefined();
});
describe('action', () => {
it('should return an error if temp dir is not found', async () => {
(mockConfig.getProjectTempDir as Mock).mockReturnValue(undefined);
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, '');
expect(result).toEqual({
type: 'message',
messageType: 'error',
content: 'Could not determine the .gemini directory path.',
});
});
it('should inform when no checkpoints are found if no args are passed', async () => {
mockFsPromises.readdir.mockResolvedValue([]);
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, '');
expect(result).toEqual({
type: 'message',
messageType: 'info',
content: 'No restorable tool calls found.',
});
expect(mockFsPromises.mkdir).toHaveBeenCalledWith(
'/tmp/gemini/checkpoints',
{
recursive: true,
},
);
});
it('should list available checkpoints if no args are passed', async () => {
mockFsPromises.readdir.mockResolvedValue([
'test1.json',
'test2.json',
// eslint-disable-next-line @typescript-eslint/no-explicit-any
] as any);
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, '');
expect(result).toEqual({
type: 'message',
messageType: 'info',
content: 'Available tool calls to restore:\n\ntest1\ntest2',
});
});
it('should return an error if the specified file is not found', async () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
mockFsPromises.readdir.mockResolvedValue(['test1.json'] as any);
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, 'test2');
expect(result).toEqual({
type: 'message',
messageType: 'error',
content: 'File not found: test2.json',
});
});
it('should handle file read errors gracefully', async () => {
const readError = new Error('Read failed');
// eslint-disable-next-line @typescript-eslint/no-explicit-any
mockFsPromises.readdir.mockResolvedValue(['test1.json'] as any);
mockFsPromises.readFile.mockRejectedValue(readError);
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, 'test1');
expect(result).toEqual({
type: 'message',
messageType: 'error',
content: `Could not read restorable tool calls. This is the error: ${readError}`,
});
});
it('should restore a tool call and project state', async () => {
const toolCallData = {
history: [{ type: 'user', text: 'do a thing' }],
clientHistory: [{ role: 'user', parts: [{ text: 'do a thing' }] }],
commitHash: 'abcdef123',
toolCall: { name: 'run_shell_command', args: 'ls' },
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
mockFsPromises.readdir.mockResolvedValue(['my-checkpoint.json'] as any);
mockFsPromises.readFile.mockResolvedValue(JSON.stringify(toolCallData));
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, 'my-checkpoint');
// Check history restoration
expect(mockContext.ui.loadHistory).toHaveBeenCalledWith(
toolCallData.history,
);
expect(mockSetHistory).toHaveBeenCalledWith(toolCallData.clientHistory);
// Check git restoration
expect(mockGitService.restoreProjectFromSnapshot).toHaveBeenCalledWith(
toolCallData.commitHash,
);
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
{
type: 'info',
text: 'Restored project to the state before the tool call.',
},
expect.any(Number),
);
// Check returned action
expect(result).toEqual({
type: 'tool',
toolName: 'run_shell_command',
toolArgs: 'ls',
});
});
it('should restore even if only toolCall is present', async () => {
const toolCallData = {
toolCall: { name: 'run_shell_command', args: 'ls' },
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
mockFsPromises.readdir.mockResolvedValue(['my-checkpoint.json'] as any);
mockFsPromises.readFile.mockResolvedValue(JSON.stringify(toolCallData));
const command = restoreCommand(mockConfig);
const result = await command?.action?.(mockContext, 'my-checkpoint');
expect(mockContext.ui.loadHistory).not.toHaveBeenCalled();
expect(mockSetHistory).not.toHaveBeenCalled();
expect(mockGitService.restoreProjectFromSnapshot).not.toHaveBeenCalled();
expect(result).toEqual({
type: 'tool',
toolName: 'run_shell_command',
toolArgs: 'ls',
});
});
});
describe('completion', () => {
it('should return an empty array if temp dir is not found', async () => {
(mockConfig.getProjectTempDir as Mock).mockReturnValue(undefined);
const command = restoreCommand(mockConfig);
const result = await command?.completion?.(mockContext, '');
expect(result).toEqual([]);
});
it('should return an empty array on readdir error', async () => {
mockFsPromises.readdir.mockRejectedValue(new Error('ENOENT'));
const command = restoreCommand(mockConfig);
const result = await command?.completion?.(mockContext, '');
expect(result).toEqual([]);
});
it('should return a list of checkpoint names', async () => {
mockFsPromises.readdir.mockResolvedValue([
'test1.json',
'test2.json',
'not-a-checkpoint.txt',
// eslint-disable-next-line @typescript-eslint/no-explicit-any
] as any);
const command = restoreCommand(mockConfig);
const result = await command?.completion?.(mockContext, '');
expect(result).toEqual(['test1', 'test2']);
});
});
});
|
