MediaMetz/gemini-cli
1
0
Fork 0
mirror of https://github.com/google-gemini/gemini-cli.git synced 2026-04-21 10:34:35 -07:00
Code Issues Packages Projects Releases Wiki Activity

Use consistent param names (#12517)

Browse Source
This commit is contained in:
Tommaso Sciortino
2025-11-06 15:03:52 -08:00
committed by GitHub
parent 5f1208ad81
commit f05d937f39
27 changed files with 553 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/src/tools/ls.test.ts
+35 -39
View File
@@ -12,7 +12,7 @@ import { LSTool } from './ls.js';
import type { Config } from '../config/config.js';
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
import { ToolErrorType } from './tool-error.js';
import { createMockWorkspaceContext } from '../test-utils/mockWorkspaceContext.js';
import { WorkspaceContext } from '../utils/workspaceContext.js';
describe('LSTool', () => {
let lsTool: LSTool;
@@ -22,18 +22,16 @@ describe('LSTool', () => {
const abortSignal = new AbortController().signal;
beforeEach(async () => {
tempRootDir = await fs.mkdtemp(path.join(os.tmpdir(), 'ls-tool-root-'));
const realTmp = await fs.realpath(os.tmpdir());
tempRootDir = await fs.mkdtemp(path.join(realTmp, 'ls-tool-root-'));
tempSecondaryDir = await fs.mkdtemp(
path.join(os.tmpdir(), 'ls-tool-secondary-'),
path.join(realTmp, 'ls-tool-secondary-'),
);
const mockWorkspaceContext = createMockWorkspaceContext(tempRootDir, [
tempSecondaryDir,
]);
mockConfig = {
getTargetDir: () => tempRootDir,
getWorkspaceContext: () => mockWorkspaceContext,
getWorkspaceContext: () =>
new WorkspaceContext(tempRootDir, [tempSecondaryDir]),
getFileService: () => new FileDiscoveryService(tempRootDir),
getFileFilteringOptions: () => ({
respectGitIgnore: true,
@@ -54,19 +52,23 @@ describe('LSTool', () => {
const testPath = path.join(tempRootDir, 'src');
await fs.mkdir(testPath);
const invocation = lsTool.build({ path: testPath });
const invocation = lsTool.build({ dir_path: testPath });
expect(invocation).toBeDefined();
});
it('should reject relative paths', () => {
expect(() => lsTool.build({ path: './src' })).toThrow(
'Path must be absolute: ./src',
);
it('should accept relative paths', async () => {
const testPath = path.join(tempRootDir, 'src');
await fs.mkdir(testPath);
const relativePath = path.relative(tempRootDir, testPath);
const invocation = lsTool.build({ dir_path: relativePath });
expect(invocation).toBeDefined();
});
it('should reject paths outside workspace with clear error message', () => {
expect(() => lsTool.build({ path: '/etc/passwd' })).toThrow(
expect(() => lsTool.build({ dir_path: '/etc/passwd' })).toThrow(
`Path must be within one of the workspace directories: ${tempRootDir}, ${tempSecondaryDir}`,
);
});
@@ -75,7 +77,7 @@ describe('LSTool', () => {
const testPath = path.join(tempSecondaryDir, 'lib');
await fs.mkdir(testPath);
const invocation = lsTool.build({ path: testPath });
const invocation = lsTool.build({ dir_path: testPath });
expect(invocation).toBeDefined();
});
@@ -90,7 +92,7 @@ describe('LSTool', () => {
'secondary',
);
const invocation = lsTool.build({ path: tempRootDir });
const invocation = lsTool.build({ dir_path: tempRootDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('[DIR] subdir');
@@ -106,7 +108,7 @@ describe('LSTool', () => {
'secondary',
);
const invocation = lsTool.build({ path: tempSecondaryDir });
const invocation = lsTool.build({ dir_path: tempSecondaryDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('secondary-file.txt');
@@ -116,7 +118,7 @@ describe('LSTool', () => {
it('should handle empty directories', async () => {
const emptyDir = path.join(tempRootDir, 'empty');
await fs.mkdir(emptyDir);
const invocation = lsTool.build({ path: emptyDir });
const invocation = lsTool.build({ dir_path: emptyDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toBe(`Directory ${emptyDir} is empty.`);
@@ -128,7 +130,7 @@ describe('LSTool', () => {
await fs.writeFile(path.join(tempRootDir, 'file2.log'), 'content1');
const invocation = lsTool.build({
path: tempRootDir,
dir_path: tempRootDir,
ignore: ['*.log'],
});
const result = await invocation.execute(abortSignal);
@@ -143,7 +145,7 @@ describe('LSTool', () => {
await fs.writeFile(path.join(tempRootDir, 'file2.log'), 'content1');
await fs.writeFile(path.join(tempRootDir, '.git'), '');
await fs.writeFile(path.join(tempRootDir, '.gitignore'), '*.log');
const invocation = lsTool.build({ path: tempRootDir });
const invocation = lsTool.build({ dir_path: tempRootDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('file1.txt');
@@ -156,7 +158,7 @@ describe('LSTool', () => {
await fs.writeFile(path.join(tempRootDir, 'file1.txt'), 'content1');
await fs.writeFile(path.join(tempRootDir, 'file2.log'), 'content1');
await fs.writeFile(path.join(tempRootDir, '.geminiignore'), '*.log');
const invocation = lsTool.build({ path: tempRootDir });
const invocation = lsTool.build({ dir_path: tempRootDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('file1.txt');
@@ -168,7 +170,7 @@ describe('LSTool', () => {
const testPath = path.join(tempRootDir, 'file1.txt');
await fs.writeFile(testPath, 'content1');
const invocation = lsTool.build({ path: testPath });
const invocation = lsTool.build({ dir_path: testPath });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('Path is not a directory');
@@ -178,7 +180,7 @@ describe('LSTool', () => {
it('should handle non-existent paths', async () => {
const testPath = path.join(tempRootDir, 'does-not-exist');
const invocation = lsTool.build({ path: testPath });
const invocation = lsTool.build({ dir_path: testPath });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('Error listing directory');
@@ -192,7 +194,7 @@ describe('LSTool', () => {
await fs.mkdir(path.join(tempRootDir, 'x-dir'));
await fs.mkdir(path.join(tempRootDir, 'y-dir'));
const invocation = lsTool.build({ path: tempRootDir });
const invocation = lsTool.build({ dir_path: tempRootDir });
const result = await invocation.execute(abortSignal);
const lines = (
@@ -217,7 +219,7 @@ describe('LSTool', () => {
const error = new Error('EACCES: permission denied');
vi.spyOn(fs, 'readdir').mockRejectedValueOnce(error);
const invocation = lsTool.build({ path: restrictedDir });
const invocation = lsTool.build({ dir_path: restrictedDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('Error listing directory');
@@ -226,12 +228,6 @@ describe('LSTool', () => {
expect(result.error?.type).toBe(ToolErrorType.LS_EXECUTION_ERROR);
});
it('should throw for invalid params at build time', () => {
expect(() => lsTool.build({ path: '../outside' })).toThrow(
'Path must be absolute: ../outside',
);
});
it('should handle errors accessing individual files during listing', async () => {
await fs.writeFile(path.join(tempRootDir, 'file1.txt'), 'content1');
const problematicFile = path.join(tempRootDir, 'problematic.txt');
@@ -248,7 +244,7 @@ describe('LSTool', () => {
return originalStat(p);
});
const invocation = lsTool.build({ path: tempRootDir });
const invocation = lsTool.build({ dir_path: tempRootDir });
const result = await invocation.execute(abortSignal);
// Should still list the other files
@@ -264,7 +260,7 @@ describe('LSTool', () => {
it('should return shortened relative path', () => {
const deeplyNestedDir = path.join(tempRootDir, 'deeply', 'nested');
const params = {
path: path.join(deeplyNestedDir, 'directory'),
dir_path: path.join(deeplyNestedDir, 'directory'),
};
const invocation = lsTool.build(params);
const description = invocation.getDescription();
@@ -273,11 +269,11 @@ describe('LSTool', () => {
it('should handle paths in secondary workspace', () => {
const params = {
path: path.join(tempSecondaryDir, 'lib'),
dir_path: path.join(tempSecondaryDir, 'lib'),
};
const invocation = lsTool.build(params);
const description = invocation.getDescription();
const expected = path.relative(tempRootDir, params.path);
const expected = path.relative(tempRootDir, params.dir_path);
expect(description).toBe(expected);
});
});
@@ -286,19 +282,19 @@ describe('LSTool', () => {
it('should accept paths in primary workspace directory', async () => {
const testPath = path.join(tempRootDir, 'src');
await fs.mkdir(testPath);
const params = { path: testPath };
const params = { dir_path: testPath };
expect(lsTool.build(params)).toBeDefined();
});
it('should accept paths in secondary workspace directory', async () => {
const testPath = path.join(tempSecondaryDir, 'lib');
await fs.mkdir(testPath);
const params = { path: testPath };
const params = { dir_path: testPath };
expect(lsTool.build(params)).toBeDefined();
});
it('should reject paths outside all workspace directories', () => {
const params = { path: '/etc/passwd' };
const params = { dir_path: '/etc/passwd' };
expect(() => lsTool.build(params)).toThrow(
'Path must be within one of the workspace directories',
);
@@ -310,7 +306,7 @@ describe('LSTool', () => {
'secondary',
);
const invocation = lsTool.build({ path: tempSecondaryDir });
const invocation = lsTool.build({ dir_path: tempSecondaryDir });
const result = await invocation.execute(abortSignal);
expect(result.llmContent).toContain('secondary-file.txt');