summaryrefslogtreecommitdiff
path: root/packages/core/src/utils/bfsFileSearch.test.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/core/src/utils/bfsFileSearch.test.ts')
-rw-r--r--packages/core/src/utils/bfsFileSearch.test.ts145
1 files changed, 145 insertions, 0 deletions
diff --git a/packages/core/src/utils/bfsFileSearch.test.ts b/packages/core/src/utils/bfsFileSearch.test.ts
new file mode 100644
index 00000000..679700ca
--- /dev/null
+++ b/packages/core/src/utils/bfsFileSearch.test.ts
@@ -0,0 +1,145 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Dirent, PathLike } from 'fs';
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import * as fs from 'fs/promises';
+import * as gitUtils from './gitUtils.js';
+import { bfsFileSearch } from './bfsFileSearch.js';
+
+vi.mock('fs/promises');
+vi.mock('./gitUtils.js');
+
+const createMockDirent = (name: string, isFile: boolean): Dirent => {
+ const dirent = new Dirent();
+ dirent.name = name;
+ dirent.isFile = () => isFile;
+ dirent.isDirectory = () => !isFile;
+ return dirent;
+};
+
+// Type for the specific overload we're using
+type ReaddirWithFileTypes = (
+ path: PathLike,
+ options: { withFileTypes: true },
+) => Promise<Dirent[]>;
+
+describe('bfsFileSearch', () => {
+ beforeEach(() => {
+ vi.resetAllMocks();
+ });
+
+ it('should find a file in the root directory', async () => {
+ const mockFs = vi.mocked(fs);
+ const mockReaddir = mockFs.readdir as unknown as ReaddirWithFileTypes;
+ vi.mocked(mockReaddir).mockResolvedValue([
+ createMockDirent('file1.txt', true),
+ createMockDirent('file2.txt', true),
+ ]);
+
+ const result = await bfsFileSearch('/test', { fileName: 'file1.txt' });
+ expect(result).toEqual(['/test/file1.txt']);
+ });
+
+ it('should find a file in a subdirectory', async () => {
+ const mockFs = vi.mocked(fs);
+ const mockReaddir = mockFs.readdir as unknown as ReaddirWithFileTypes;
+ vi.mocked(mockReaddir).mockImplementation(async (dir) => {
+ if (dir === '/test') {
+ return [createMockDirent('subdir', false)];
+ }
+ if (dir === '/test/subdir') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ return [];
+ });
+
+ const result = await bfsFileSearch('/test', { fileName: 'file1.txt' });
+ expect(result).toEqual(['/test/subdir/file1.txt']);
+ });
+
+ it('should ignore specified directories', async () => {
+ const mockFs = vi.mocked(fs);
+ const mockReaddir = mockFs.readdir as unknown as ReaddirWithFileTypes;
+ vi.mocked(mockReaddir).mockImplementation(async (dir) => {
+ if (dir === '/test') {
+ return [
+ createMockDirent('subdir1', false),
+ createMockDirent('subdir2', false),
+ ];
+ }
+ if (dir === '/test/subdir1') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ if (dir === '/test/subdir2') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ return [];
+ });
+
+ const result = await bfsFileSearch('/test', {
+ fileName: 'file1.txt',
+ ignoreDirs: ['subdir2'],
+ });
+ expect(result).toEqual(['/test/subdir1/file1.txt']);
+ });
+
+ it('should respect maxDirs limit', async () => {
+ const mockFs = vi.mocked(fs);
+ const mockReaddir = mockFs.readdir as unknown as ReaddirWithFileTypes;
+ vi.mocked(mockReaddir).mockImplementation(async (dir) => {
+ if (dir === '/test') {
+ return [
+ createMockDirent('subdir1', false),
+ createMockDirent('subdir2', false),
+ ];
+ }
+ if (dir === '/test/subdir1') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ if (dir === '/test/subdir2') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ return [];
+ });
+
+ const result = await bfsFileSearch('/test', {
+ fileName: 'file1.txt',
+ maxDirs: 2,
+ });
+ expect(result).toEqual(['/test/subdir1/file1.txt']);
+ });
+
+ it('should respect .gitignore files', async () => {
+ const mockFs = vi.mocked(fs);
+ const mockGitUtils = vi.mocked(gitUtils);
+ mockGitUtils.isGitRepository.mockReturnValue(true);
+ const mockReaddir = mockFs.readdir as unknown as ReaddirWithFileTypes;
+ vi.mocked(mockReaddir).mockImplementation(async (dir) => {
+ if (dir === '/test') {
+ return [
+ createMockDirent('.gitignore', true),
+ createMockDirent('subdir1', false),
+ createMockDirent('subdir2', false),
+ ];
+ }
+ if (dir === '/test/subdir1') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ if (dir === '/test/subdir2') {
+ return [createMockDirent('file1.txt', true)];
+ }
+ return [];
+ });
+ mockFs.readFile.mockResolvedValue('subdir2');
+
+ const result = await bfsFileSearch('/test', {
+ fileName: 'file1.txt',
+ respectGitIgnore: true,
+ });
+ expect(result).toEqual(['/test/subdir1/file1.txt']);
+ });
+});