/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { describe, it, expect, beforeEach, afterEach, vi, type Mock, } from 'vitest'; import type { RipGrepToolParams } from './ripGrep.js'; import { RipGrepTool } from './ripGrep.js'; import path from 'node:path'; import fs from 'node:fs/promises'; import os, { EOL } from 'node:os'; import type { Config } from '../config/config.js'; import { createMockWorkspaceContext } from '../test-utils/mockWorkspaceContext.js'; import type { ChildProcess } from 'node:child_process'; import { spawn } from 'node:child_process'; import { getRipgrepCommand } from '../utils/ripgrepUtils.js'; import { DEFAULT_FILE_FILTERING_OPTIONS } from '../config/constants.js'; // Mock ripgrepUtils vi.mock('../utils/ripgrepUtils.js', () => ({ getRipgrepCommand: vi.fn(), })); // Mock child_process for ripgrep calls vi.mock('child_process', () => ({ spawn: vi.fn(), })); const mockSpawn = vi.mocked(spawn); // Helper function to create mock spawn implementations function createMockSpawn( options: { outputData?: string; exitCode?: number; signal?: string; onCall?: ( command: string, args: readonly string[], spawnOptions?: unknown, ) => void; } = {}, ) { const { outputData, exitCode = 0, signal, onCall } = options; return (command: string, args: readonly string[], spawnOptions?: unknown) => { onCall?.(command, args, spawnOptions); const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; // Set up event listeners immediately setTimeout(() => { const stdoutDataHandler = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const closeHandler = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (stdoutDataHandler && outputData) { stdoutDataHandler(Buffer.from(outputData)); } if (closeHandler) { closeHandler(exitCode, signal); } }, 0); return mockProcess as unknown as ChildProcess; }; } describe('RipGrepTool', () => { let tempRootDir: string; let grepTool: RipGrepTool; let fileExclusionsMock: { getGlobExcludes: () => string[] }; const abortSignal = new AbortController().signal; const mockConfig = { getTargetDir: () => tempRootDir, getWorkspaceContext: () => createMockWorkspaceContext(tempRootDir), getWorkingDir: () => tempRootDir, getDebugMode: () => false, getUseBuiltinRipgrep: () => true, getTruncateToolOutputThreshold: () => 25000, getTruncateToolOutputLines: () => 1000, } as unknown as Config; beforeEach(async () => { vi.clearAllMocks(); (getRipgrepCommand as Mock).mockResolvedValue('/mock/path/to/rg'); mockSpawn.mockReset(); tempRootDir = await fs.mkdtemp(path.join(os.tmpdir(), 'grep-tool-root-')); fileExclusionsMock = { getGlobExcludes: vi.fn().mockReturnValue([]), }; Object.assign(mockConfig, { getFileExclusions: () => fileExclusionsMock, getFileFilteringOptions: () => DEFAULT_FILE_FILTERING_OPTIONS, }); grepTool = new RipGrepTool(mockConfig); // Create some test files and directories await fs.writeFile( path.join(tempRootDir, 'fileA.txt'), 'hello world\nsecond line with world', ); await fs.writeFile( path.join(tempRootDir, 'fileB.js'), 'const foo = "bar";\nfunction baz() { return "hello"; }', ); await fs.mkdir(path.join(tempRootDir, 'sub')); await fs.writeFile( path.join(tempRootDir, 'sub', 'fileC.txt'), 'another world in sub dir', ); await fs.writeFile( path.join(tempRootDir, 'sub', 'fileD.md'), '# Markdown file\nThis is a test.', ); }); afterEach(async () => { await fs.rm(tempRootDir, { recursive: true, force: true }); }); describe('validateToolParams', () => { it('should return null for valid params (pattern only)', () => { const params: RipGrepToolParams = { pattern: 'hello' }; expect(grepTool.validateToolParams(params)).toBeNull(); }); it('should return null for valid params (pattern and path)', () => { const params: RipGrepToolParams = { pattern: 'hello', path: '.' }; expect(grepTool.validateToolParams(params)).toBeNull(); }); it('should return null for valid params (pattern, path, and glob)', () => { const params: RipGrepToolParams = { pattern: 'hello', path: '.', glob: '*.txt', }; expect(grepTool.validateToolParams(params)).toBeNull(); }); it('should return error if pattern is missing', () => { const params = { path: '.' } as unknown as RipGrepToolParams; expect(grepTool.validateToolParams(params)).toBe( `params must have required property 'pattern'`, ); }); it('should surface an error for invalid regex pattern', () => { const params: RipGrepToolParams = { pattern: '[[' }; expect(grepTool.validateToolParams(params)).toContain( 'Invalid regular expression pattern: [[', ); }); it('should return error if path does not exist', () => { const params: RipGrepToolParams = { pattern: 'hello', path: 'nonexistent', }; // Check for the core error message, as the full path might vary expect(grepTool.validateToolParams(params)).toContain( 'Path does not exist:', ); expect(grepTool.validateToolParams(params)).toContain('nonexistent'); }); it('should allow path to be a file', () => { const filePath = path.join(tempRootDir, 'fileA.txt'); const params: RipGrepToolParams = { pattern: 'hello', path: filePath }; expect(grepTool.validateToolParams(params)).toBeNull(); }); }); describe('execute', () => { it('should find matches for a simple pattern in all files', async () => { mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `fileA.txt:1:hello world${EOL}fileA.txt:2:second line with world${EOL}sub/fileC.txt:1:another world in sub dir${EOL}`, exitCode: 0, }), ); const params: RipGrepToolParams = { pattern: 'world' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 3 matches for pattern "world" in the workspace directory', ); expect(result.llmContent).toContain('fileA.txt:1:hello world'); expect(result.llmContent).toContain('fileA.txt:2:second line with world'); expect(result.llmContent).toContain( 'sub/fileC.txt:1:another world in sub dir', ); expect(result.returnDisplay).toBe('Found 3 matches'); }); it('should find matches in a specific path', async () => { // Setup specific mock for this test - searching in 'sub' should only return matches from that directory mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `fileC.txt:1:another world in sub dir${EOL}`, exitCode: 0, }), ); const params: RipGrepToolParams = { pattern: 'world', path: 'sub' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "world" in path "sub"', ); expect(result.llmContent).toContain( 'fileC.txt:1:another world in sub dir', ); expect(result.returnDisplay).toBe('Found 1 match'); }); it('should use target directory when path is not provided', async () => { mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `fileA.txt:1:hello world${EOL}`, exitCode: 0, onCall: (_, args) => { // Should search in the target directory (tempRootDir) expect(args[args.length - 1]).toBe(tempRootDir); }, }), ); const params: RipGrepToolParams = { pattern: 'world' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "world" in the workspace directory', ); }); it('should find matches with a glob filter', async () => { // Setup specific mock for this test mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `fileB.js:2:function baz() { return "hello"; }${EOL}`, exitCode: 0, }), ); const params: RipGrepToolParams = { pattern: 'hello', glob: '*.js' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "hello" in the workspace directory (filter: "*.js"):', ); expect(result.llmContent).toContain( 'fileB.js:2:function baz() { return "hello"; }', ); expect(result.returnDisplay).toBe('Found 1 match'); }); it('should find matches with a glob filter and path', async () => { await fs.writeFile( path.join(tempRootDir, 'sub', 'another.js'), 'const greeting = "hello";', ); // Setup specific mock for this test - searching for 'hello' in 'sub' with '*.js' filter mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { // Only return match from the .js file in sub directory onData(Buffer.from(`another.js:1:const greeting = "hello";${EOL}`)); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'hello', path: 'sub', glob: '*.js', }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "hello" in path "sub" (filter: "*.js")', ); expect(result.llmContent).toContain( 'another.js:1:const greeting = "hello";', ); expect(result.returnDisplay).toBe('Found 1 match'); }); it('should pass .qwenignore to ripgrep when respected', async () => { await fs.writeFile( path.join(tempRootDir, '.qwenignore'), 'ignored.txt\n', ); mockSpawn.mockImplementationOnce( createMockSpawn({ exitCode: 1, onCall: (_, args) => { expect(args).toContain('--ignore-file'); expect(args).toContain(path.join(tempRootDir, '.qwenignore')); }, }), ); const params: RipGrepToolParams = { pattern: 'secret' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'No matches found for pattern "secret" in the workspace directory.', ); expect(result.returnDisplay).toBe('No matches found'); }); it('should include .qwenignore matches when disabled in config', async () => { await fs.writeFile(path.join(tempRootDir, '.qwenignore'), 'kept.txt\n'); await fs.writeFile(path.join(tempRootDir, 'kept.txt'), 'keep me'); Object.assign(mockConfig, { getFileFilteringOptions: () => ({ respectGitIgnore: true, respectQwenIgnore: false, }), }); mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `kept.txt:1:keep me${EOL}`, exitCode: 0, onCall: (_, args) => { expect(args).not.toContain('--ignore-file'); expect(args).not.toContain(path.join(tempRootDir, '.qwenignore')); }, }), ); const params: RipGrepToolParams = { pattern: 'keep' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "keep" in the workspace directory:', ); expect(result.llmContent).toContain('kept.txt:1:keep me'); expect(result.returnDisplay).toBe('Found 1 match'); }); it('should disable gitignore when configured', async () => { Object.assign(mockConfig, { getFileFilteringOptions: () => ({ respectGitIgnore: false, respectQwenIgnore: true, }), }); mockSpawn.mockImplementationOnce( createMockSpawn({ exitCode: 1, onCall: (_, args) => { expect(args).toContain('--no-ignore-vcs'); }, }), ); const params: RipGrepToolParams = { pattern: 'ignored' }; const invocation = grepTool.build(params); await invocation.execute(abortSignal); }); it('should truncate llm content when exceeding maximum length', async () => { const longMatch = 'fileA.txt:1:' + 'a'.repeat(30_000); mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `${longMatch}${EOL}`, exitCode: 0, }), ); const params: RipGrepToolParams = { pattern: 'a+' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(String(result.llmContent).length).toBeLessThanOrEqual(26_000); expect(result.llmContent).toMatch(/\[\d+ lines? truncated\] \.\.\./); expect(result.returnDisplay).toContain('truncated'); }); it('should return "No matches found" when pattern does not exist', async () => { // Setup specific mock for no matches mockSpawn.mockImplementationOnce( createMockSpawn({ exitCode: 1, // No matches found }), ); const params: RipGrepToolParams = { pattern: 'nonexistentpattern' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'No matches found for pattern "nonexistentpattern" in the workspace directory.', ); expect(result.returnDisplay).toBe('No matches found'); }); it('should throw validation error for invalid regex pattern', async () => { const params: RipGrepToolParams = { pattern: '[[' }; expect(() => grepTool.build(params)).toThrow( 'Invalid regular expression pattern: [[', ); }); it('should handle regex special characters correctly', async () => { // Setup specific mock for this test - regex pattern 'foo.*bar' should match 'const foo = "bar";' mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { // Return match for the regex pattern onData(Buffer.from(`fileB.js:1:const foo = "bar";${EOL}`)); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'foo.*bar' }; // Matches 'const foo = "bar";' const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 1 match for pattern "foo.*bar" in the workspace directory:', ); expect(result.llmContent).toContain('fileB.js:1:const foo = "bar";'); }); it('should be case-insensitive by default (JS fallback)', async () => { // Setup specific mock for this test - case insensitive search for 'HELLO' mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { // Return case-insensitive matches for 'HELLO' onData( Buffer.from( `fileA.txt:1:hello world${EOL}fileB.js:2:function baz() { return "hello"; }${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'HELLO' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain( 'Found 2 matches for pattern "HELLO" in the workspace directory:', ); expect(result.llmContent).toContain('fileA.txt:1:hello world'); expect(result.llmContent).toContain( 'fileB.js:2:function baz() { return "hello"; }', ); }); it('should throw an error if params are invalid', async () => { const params = { path: '.' } as unknown as RipGrepToolParams; // Invalid: pattern missing expect(() => grepTool.build(params)).toThrow( /params must have required property 'pattern'/, ); }); it('should search within a single file when path is a file', async () => { mockSpawn.mockImplementationOnce( createMockSpawn({ outputData: `fileA.txt:1:hello world${EOL}fileA.txt:2:second line with world${EOL}`, exitCode: 0, }), ); const params: RipGrepToolParams = { pattern: 'world', path: path.join(tempRootDir, 'fileA.txt'), }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('Found 2 matches'); expect(result.llmContent).toContain('fileA.txt:1:hello world'); expect(result.llmContent).toContain('fileA.txt:2:second line with world'); expect(result.returnDisplay).toBe('Found 2 matches'); }); it('should throw an error if ripgrep is not available', async () => { (getRipgrepCommand as Mock).mockResolvedValue(null); const params: RipGrepToolParams = { pattern: 'world' }; const invocation = grepTool.build(params); expect(await invocation.execute(abortSignal)).toStrictEqual({ llmContent: 'Error during grep search operation: ripgrep binary not found.', returnDisplay: 'Error: ripgrep binary not found.', }); }); }); describe('abort signal handling', () => { it('should handle AbortSignal during search', async () => { const controller = new AbortController(); const params: RipGrepToolParams = { pattern: 'world' }; const invocation = grepTool.build(params); controller.abort(); const result = await invocation.execute(controller.signal); expect(result).toBeDefined(); }); it('should abort streaming search when signal is triggered', async () => { // Setup specific mock for this test - simulate process being killed due to abort mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; // Simulate process being aborted - use setTimeout to ensure handlers are registered first setTimeout(() => { const closeHandler = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (closeHandler) { // Simulate process killed by signal (code is null, signal is SIGTERM) closeHandler(null, 'SIGTERM'); } }, 0); return mockProcess as unknown as ChildProcess; }); const controller = new AbortController(); const params: RipGrepToolParams = { pattern: 'test' }; const invocation = grepTool.build(params); // Abort immediately before starting the search controller.abort(); const result = await invocation.execute(controller.signal); expect(result.llmContent).toContain( 'Error during grep search operation: ripgrep exited with code null', ); expect(result.returnDisplay).toContain( 'Error: ripgrep exited with code null', ); }); }); describe('error handling and edge cases', () => { it('should handle workspace boundary violations', () => { const params: RipGrepToolParams = { pattern: 'test', path: '../outside' }; expect(() => grepTool.build(params)).toThrow( /Path is not within workspace/, ); }); it('should handle empty directories gracefully', async () => { const emptyDir = path.join(tempRootDir, 'empty'); await fs.mkdir(emptyDir); // Setup specific mock for this test - searching in empty directory should return no matches mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onClose) { onClose(1); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'test', path: 'empty' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('No matches found'); expect(result.returnDisplay).toBe('No matches found'); }); it('should handle empty files correctly', async () => { await fs.writeFile(path.join(tempRootDir, 'empty.txt'), ''); // Setup specific mock for this test - searching for anything in empty files should return no matches mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onClose) { onClose(1); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'anything' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('No matches found'); }); it('should handle special characters in file names', async () => { const specialFileName = 'file with spaces & symbols!.txt'; await fs.writeFile( path.join(tempRootDir, specialFileName), 'hello world with special chars', ); // Setup specific mock for this test - searching for 'world' should find the file with special characters mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData( Buffer.from( `${specialFileName}:1:hello world with special chars${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'world' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain(specialFileName); expect(result.llmContent).toContain('hello world with special chars'); }); it('should handle deeply nested directories', async () => { const deepPath = path.join(tempRootDir, 'a', 'b', 'c', 'd', 'e'); await fs.mkdir(deepPath, { recursive: true }); await fs.writeFile( path.join(deepPath, 'deep.txt'), 'content in deep directory', ); // Setup specific mock for this test - searching for 'deep' should find the deeply nested file mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData( Buffer.from( `a/b/c/d/e/deep.txt:1:content in deep directory${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'deep' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('deep.txt'); expect(result.llmContent).toContain('content in deep directory'); }); }); describe('regex pattern validation', () => { it('should handle complex regex patterns', async () => { await fs.writeFile( path.join(tempRootDir, 'code.js'), 'function getName() { return "test"; }\nconst getValue = () => "value";', ); // Setup specific mock for this test - regex pattern should match function declarations mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData( Buffer.from( `code.js:1:function getName() { return "test"; }${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'function\\s+\\w+\\s*\\(' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('function getName()'); expect(result.llmContent).not.toContain('const getValue'); }); it('should handle case sensitivity correctly in JS fallback', async () => { await fs.writeFile( path.join(tempRootDir, 'case.txt'), 'Hello World\nhello world\nHELLO WORLD', ); // Setup specific mock for this test - case insensitive search should match all variants mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData( Buffer.from( `case.txt:1:Hello World${EOL}case.txt:2:hello world${EOL}case.txt:3:HELLO WORLD${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'hello' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('Hello World'); expect(result.llmContent).toContain('hello world'); expect(result.llmContent).toContain('HELLO WORLD'); }); it('should handle escaped regex special characters', async () => { await fs.writeFile( path.join(tempRootDir, 'special.txt'), 'Price: $19.99\nRegex: [a-z]+ pattern\nEmail: test@example.com', ); // Setup specific mock for this test - escaped regex pattern should match price format mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData(Buffer.from(`special.txt:1:Price: $19.99${EOL}`)); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: '\\$\\d+\\.\\d+' }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('Price: $19.99'); expect(result.llmContent).not.toContain('Email: test@example.com'); }); }); describe('glob pattern filtering', () => { it('should handle multiple file extensions in glob pattern', async () => { await fs.writeFile( path.join(tempRootDir, 'test.ts'), 'typescript content', ); await fs.writeFile(path.join(tempRootDir, 'test.tsx'), 'tsx content'); await fs.writeFile( path.join(tempRootDir, 'test.js'), 'javascript content', ); await fs.writeFile(path.join(tempRootDir, 'test.txt'), 'text content'); // Setup specific mock for this test - glob pattern should filter to only ts/tsx files mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData( Buffer.from( `test.ts:1:typescript content${EOL}test.tsx:1:tsx content${EOL}`, ), ); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'content', glob: '*.{ts,tsx}', }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('test.ts'); expect(result.llmContent).toContain('test.tsx'); expect(result.llmContent).not.toContain('test.js'); expect(result.llmContent).not.toContain('test.txt'); }); it('should handle directory patterns in glob', async () => { await fs.mkdir(path.join(tempRootDir, 'src'), { recursive: true }); await fs.writeFile( path.join(tempRootDir, 'src', 'main.ts'), 'source code', ); await fs.writeFile(path.join(tempRootDir, 'other.ts'), 'other code'); // Setup specific mock for this test - glob pattern should filter to only src/** files mockSpawn.mockImplementationOnce(() => { const mockProcess = { stdout: { on: vi.fn(), removeListener: vi.fn(), }, stderr: { on: vi.fn(), removeListener: vi.fn(), }, on: vi.fn(), removeListener: vi.fn(), kill: vi.fn(), }; setTimeout(() => { const onData = mockProcess.stdout.on.mock.calls.find( (call) => call[0] === 'data', )?.[1]; const onClose = mockProcess.on.mock.calls.find( (call) => call[0] === 'close', )?.[1]; if (onData) { onData(Buffer.from(`src/main.ts:1:source code${EOL}`)); } if (onClose) { onClose(0); } }, 0); return mockProcess as unknown as ChildProcess; }); const params: RipGrepToolParams = { pattern: 'code', glob: 'src/**', }; const invocation = grepTool.build(params); const result = await invocation.execute(abortSignal); expect(result.llmContent).toContain('main.ts'); expect(result.llmContent).not.toContain('other.ts'); }); }); describe('getDescription', () => { it('should generate correct description with pattern only', () => { const params: RipGrepToolParams = { pattern: 'testPattern' }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toBe("'testPattern'"); }); it('should generate correct description with pattern and glob', () => { const params: RipGrepToolParams = { pattern: 'testPattern', glob: '*.ts', }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toBe( "'testPattern' (filter: '*.ts')", ); }); it('should generate correct description with pattern and path', async () => { const dirPath = path.join(tempRootDir, 'src', 'app'); await fs.mkdir(dirPath, { recursive: true }); const params: RipGrepToolParams = { pattern: 'testPattern', path: path.join('src', 'app'), }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toContain( "'testPattern' in path 'src", ); expect(invocation.getDescription()).toContain("app'"); }); it('should generate correct description with default search path', () => { const params: RipGrepToolParams = { pattern: 'testPattern' }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toBe("'testPattern'"); }); it('should generate correct description with pattern, glob, and path', async () => { const dirPath = path.join(tempRootDir, 'src', 'app'); await fs.mkdir(dirPath, { recursive: true }); const params: RipGrepToolParams = { pattern: 'testPattern', glob: '*.ts', path: path.join('src', 'app'), }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toContain( "'testPattern' in path 'src", ); expect(invocation.getDescription()).toContain("(filter: '*.ts')"); }); it('should use path when specified in description', () => { const params: RipGrepToolParams = { pattern: 'testPattern', path: '.' }; const invocation = grepTool.build(params); expect(invocation.getDescription()).toBe("'testPattern' in path '.'"); }); }); });