File size: 35,132 Bytes
84aa3bf | 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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import {
ExtensionManager,
resolveContextFilePaths,
validateContextFilePath,
} from './extension-manager.js';
import { createTestMergedSettings, type MergedSettings } from './settings.js';
import { createExtension } from '../test-utils/createExtension.js';
import { EXTENSIONS_DIRECTORY_NAME } from './extensions/variables.js';
import { themeManager } from '../ui/themes/theme-manager.js';
import {
TrustLevel,
loadTrustedFolders,
isWorkspaceTrusted,
} from './trustedFolders.js';
import {
getRealPath,
type CustomTheme,
IntegrityDataStatus,
} from '@google/gemini-cli-core';
const mockHomedir = vi.hoisted(() => vi.fn(() => '/tmp/mock-home'));
const mockIntegrityManager = vi.hoisted(() => ({
verify: vi.fn().mockResolvedValue('verified'),
store: vi.fn().mockResolvedValue(undefined),
}));
vi.mock('os', async (importOriginal) => {
const mockedOs = await importOriginal<typeof os>();
return {
...mockedOs,
homedir: mockHomedir,
};
});
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
homedir: mockHomedir,
ExtensionIntegrityManager: vi
.fn()
.mockImplementation(() => mockIntegrityManager),
};
});
const testTheme: CustomTheme = {
type: 'custom',
name: 'MyTheme',
background: {
primary: '#282828',
diff: { added: '#2b3312', removed: '#341212' },
},
text: {
primary: '#ebdbb2',
secondary: '#a89984',
link: '#83a598',
accent: '#d3869b',
},
status: {
success: '#b8bb26',
warning: '#fabd2f',
error: '#fb4934',
},
};
describe('ExtensionManager', () => {
let tempHomeDir: string;
let tempWorkspaceDir: string;
let userExtensionsDir: string;
let extensionManager: ExtensionManager;
beforeEach(() => {
vi.clearAllMocks();
tempHomeDir = fs.mkdtempSync(
path.join(os.tmpdir(), 'gemini-cli-test-home-'),
);
tempWorkspaceDir = fs.mkdtempSync(
path.join(tempHomeDir, 'gemini-cli-test-workspace-'),
);
mockHomedir.mockReturnValue(tempHomeDir);
userExtensionsDir = path.join(tempHomeDir, EXTENSIONS_DIRECTORY_NAME);
fs.mkdirSync(userExtensionsDir, { recursive: true });
extensionManager = new ExtensionManager({
settings: createTestMergedSettings(),
workspaceDir: tempWorkspaceDir,
requestConsent: vi.fn().mockResolvedValue(true),
requestSetting: null,
integrityManager: mockIntegrityManager,
});
});
afterEach(() => {
themeManager.clearExtensionThemes();
try {
fs.rmSync(tempHomeDir, { recursive: true, force: true });
} catch {
// Ignore
}
});
describe('loadExtensions parallel loading', () => {
it('should prevent concurrent loading and return the same promise', async () => {
createExtension({
extensionsDir: userExtensionsDir,
name: 'ext1',
version: '1.0.0',
});
createExtension({
extensionsDir: userExtensionsDir,
name: 'ext2',
version: '1.0.0',
});
// Call loadExtensions twice concurrently
const promise1 = extensionManager.loadExtensions();
const promise2 = extensionManager.loadExtensions();
// They should resolve to the exact same array
const [extensions1, extensions2] = await Promise.all([
promise1,
promise2,
]);
expect(extensions1).toBe(extensions2);
expect(extensions1).toHaveLength(2);
const names = extensions1.map((ext) => ext.name).sort();
expect(names).toEqual(['ext1', 'ext2']);
});
it('should throw an error if loadExtensions is called after it has already resolved', async () => {
createExtension({
extensionsDir: userExtensionsDir,
name: 'ext1',
version: '1.0.0',
});
await extensionManager.loadExtensions();
await expect(extensionManager.loadExtensions()).rejects.toThrow(
'Extensions already loaded, only load extensions once.',
);
});
it('should not throw if extension directory does not exist', async () => {
fs.rmSync(userExtensionsDir, { recursive: true, force: true });
const extensions = await extensionManager.loadExtensions();
expect(extensions).toEqual([]);
});
it('should throw if there are duplicate extension names', async () => {
// We manually create two extensions with different dirs but same name in config
const ext1Dir = path.join(userExtensionsDir, 'ext1-dir');
const ext2Dir = path.join(userExtensionsDir, 'ext2-dir');
fs.mkdirSync(ext1Dir, { recursive: true });
fs.mkdirSync(ext2Dir, { recursive: true });
const config = JSON.stringify({
name: 'duplicate-ext',
version: '1.0.0',
});
fs.writeFileSync(path.join(ext1Dir, 'gemini-extension.json'), config);
fs.writeFileSync(
path.join(ext1Dir, 'metadata.json'),
JSON.stringify({ type: 'local', source: ext1Dir }),
);
fs.writeFileSync(path.join(ext2Dir, 'gemini-extension.json'), config);
fs.writeFileSync(
path.join(ext2Dir, 'metadata.json'),
JSON.stringify({ type: 'local', source: ext2Dir }),
);
await expect(extensionManager.loadExtensions()).rejects.toThrow(
'Extension with name duplicate-ext already was loaded.',
);
});
it('should wait for loadExtensions to finish when loadExtension is called concurrently', async () => {
// Create an initial extension that loadExtensions will find
createExtension({
extensionsDir: userExtensionsDir,
name: 'ext1',
version: '1.0.0',
});
// Start the parallel load (it will read ext1)
const loadAllPromise = extensionManager.loadExtensions();
// Create a second extension dynamically in a DIFFERENT directory
// so that loadExtensions (which scans userExtensionsDir) doesn't find it.
const externalDir = fs.mkdtempSync(
path.join(os.tmpdir(), 'external-ext-'),
);
fs.writeFileSync(
path.join(externalDir, 'gemini-extension.json'),
JSON.stringify({ name: 'ext2', version: '1.0.0' }),
);
fs.writeFileSync(
path.join(externalDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: externalDir }),
);
// Concurrently call loadExtension (simulating an install or update)
const loadSinglePromise = extensionManager.loadExtension(externalDir);
// Wait for both to complete
await Promise.all([loadAllPromise, loadSinglePromise]);
// Both extensions should now be present in the loadedExtensions array
const extensions = extensionManager.getExtensions();
expect(extensions).toHaveLength(2);
const names = extensions.map((ext) => ext.name).sort();
expect(names).toEqual(['ext1', 'ext2']);
fs.rmSync(externalDir, { recursive: true, force: true });
});
});
describe('symlink handling', () => {
let extensionDir: string;
let symlinkDir: string;
beforeEach(() => {
extensionDir = path.join(tempHomeDir, 'extension');
symlinkDir = path.join(tempHomeDir, 'symlink-ext');
fs.mkdirSync(extensionDir, { recursive: true });
fs.writeFileSync(
path.join(extensionDir, 'gemini-extension.json'),
JSON.stringify({ name: 'test-ext', version: '1.0.0' }),
);
fs.symlinkSync(extensionDir, symlinkDir, 'dir');
});
it('preserves symlinks in installMetadata.source when linking', async () => {
const manager = new ExtensionManager({
workspaceDir: tempWorkspaceDir,
settings: {
security: {
folderTrust: { enabled: false }, // Disable trust for simplicity in this test
},
experimental: { extensionConfig: false },
admin: { extensions: { enabled: true }, mcp: { enabled: true } },
hooksConfig: { enabled: true },
} as unknown as MergedSettings,
requestConsent: () => Promise.resolve(true),
requestSetting: null,
integrityManager: mockIntegrityManager,
});
// Trust the workspace to allow installation
const trustedFolders = loadTrustedFolders();
await trustedFolders.setValue(tempWorkspaceDir, TrustLevel.TRUST_FOLDER);
const installMetadata = {
source: symlinkDir,
type: 'link' as const,
};
await manager.loadExtensions();
const extension = await manager.installOrUpdateExtension(installMetadata);
// Desired behavior: it preserves symlinks (if they were absolute or relative as provided)
expect(extension.installMetadata?.source).toBe(symlinkDir);
});
it('works with the new install command logic (preserves symlink but trusts real path)', async () => {
// This simulates the logic in packages/cli/src/commands/extensions/install.ts
const absolutePath = path.resolve(symlinkDir);
const realPath = getRealPath(absolutePath);
const settings = {
security: {
folderTrust: { enabled: true },
},
experimental: { extensionConfig: false },
admin: { extensions: { enabled: true }, mcp: { enabled: true } },
hooksConfig: { enabled: true },
} as unknown as MergedSettings;
// Trust the REAL path
const trustedFolders = loadTrustedFolders();
await trustedFolders.setValue(realPath, TrustLevel.TRUST_FOLDER);
// Check trust of the symlink path
const trustResult = isWorkspaceTrusted(settings, absolutePath);
expect(trustResult.isTrusted).toBe(true);
const manager = new ExtensionManager({
workspaceDir: tempWorkspaceDir,
settings,
requestConsent: () => Promise.resolve(true),
requestSetting: null,
integrityManager: mockIntegrityManager,
});
const installMetadata = {
source: absolutePath,
type: 'link' as const,
};
await manager.loadExtensions();
const extension = await manager.installOrUpdateExtension(installMetadata);
expect(extension.installMetadata?.source).toBe(absolutePath);
expect(extension.installMetadata?.source).not.toBe(realPath);
});
it('enforces allowedExtensions using the real path', async () => {
const absolutePath = path.resolve(symlinkDir);
const realPath = getRealPath(absolutePath);
const settings = {
security: {
folderTrust: { enabled: false },
// Only allow the real path, not the symlink path
allowedExtensions: [realPath.replace(/\\/g, '\\\\')],
},
experimental: { extensionConfig: false },
admin: { extensions: { enabled: true }, mcp: { enabled: true } },
hooksConfig: { enabled: true },
} as unknown as MergedSettings;
const manager = new ExtensionManager({
workspaceDir: tempWorkspaceDir,
settings,
requestConsent: () => Promise.resolve(true),
requestSetting: null,
integrityManager: mockIntegrityManager,
});
const installMetadata = {
source: absolutePath,
type: 'link' as const,
};
await manager.loadExtensions();
// This should pass because realPath is allowed
const extension = await manager.installOrUpdateExtension(installMetadata);
expect(extension.name).toBe('test-ext');
// Now try with a settings that only allows the symlink path string
const settingsOnlySymlink = {
security: {
folderTrust: { enabled: false },
// Only allow the symlink path string explicitly
allowedExtensions: [absolutePath.replace(/\\/g, '\\\\')],
},
experimental: { extensionConfig: false },
admin: { extensions: { enabled: true }, mcp: { enabled: true } },
hooksConfig: { enabled: true },
} as unknown as MergedSettings;
const manager2 = new ExtensionManager({
workspaceDir: tempWorkspaceDir,
settings: settingsOnlySymlink,
requestConsent: () => Promise.resolve(true),
requestSetting: null,
integrityManager: mockIntegrityManager,
});
// This should FAIL because it checks the real path against the pattern
// (Unless symlinkDir === extensionDir, which shouldn't happen in this test setup)
if (absolutePath !== realPath) {
await expect(
manager2.installOrUpdateExtension(installMetadata),
).rejects.toThrow(
/is not allowed by the "allowedExtensions" security setting/,
);
}
});
});
describe('Extension Renaming', () => {
it('should support renaming an extension during update', async () => {
// 1. Setup existing extension
const oldName = 'old-name';
const newName = 'new-name';
const extDir = path.join(userExtensionsDir, oldName);
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({ name: oldName, version: '1.0.0' }),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
await extensionManager.loadExtensions();
// 2. Create a temporary "new" version with a different name
const newSourceDir = fs.mkdtempSync(
path.join(tempHomeDir, 'new-source-'),
);
fs.writeFileSync(
path.join(newSourceDir, 'gemini-extension.json'),
JSON.stringify({ name: newName, version: '1.1.0' }),
);
fs.writeFileSync(
path.join(newSourceDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: newSourceDir }),
);
// 3. Update the extension
await extensionManager.installOrUpdateExtension(
{ type: 'local', source: newSourceDir },
{ name: oldName, version: '1.0.0' },
);
// 4. Verify old directory is gone and new one exists
expect(fs.existsSync(path.join(userExtensionsDir, oldName))).toBe(false);
expect(fs.existsSync(path.join(userExtensionsDir, newName))).toBe(true);
// Verify the loaded state is updated
const extensions = extensionManager.getExtensions();
expect(extensions.some((e) => e.name === newName)).toBe(true);
expect(extensions.some((e) => e.name === oldName)).toBe(false);
});
it('should carry over enablement status when renaming', async () => {
const oldName = 'old-name';
const newName = 'new-name';
const extDir = path.join(userExtensionsDir, oldName);
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({ name: oldName, version: '1.0.0' }),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
// Enable it
const enablementManager = extensionManager.getEnablementManager();
enablementManager.enable(oldName, true, tempHomeDir);
await extensionManager.loadExtensions();
const extension = extensionManager.getExtensions()[0];
expect(extension.isActive).toBe(true);
const newSourceDir = fs.mkdtempSync(
path.join(tempHomeDir, 'new-source-'),
);
fs.writeFileSync(
path.join(newSourceDir, 'gemini-extension.json'),
JSON.stringify({ name: newName, version: '1.1.0' }),
);
fs.writeFileSync(
path.join(newSourceDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: newSourceDir }),
);
await extensionManager.installOrUpdateExtension(
{ type: 'local', source: newSourceDir },
{ name: oldName, version: '1.0.0' },
);
// Verify new name is enabled
expect(enablementManager.isEnabled(newName, tempHomeDir)).toBe(true);
// Verify old name is removed from enablement
expect(enablementManager.readConfig()[oldName]).toBeUndefined();
});
it('should prevent renaming if the new name conflicts with an existing extension', async () => {
// Setup two extensions
const ext1Dir = path.join(userExtensionsDir, 'ext1');
fs.mkdirSync(ext1Dir, { recursive: true });
fs.writeFileSync(
path.join(ext1Dir, 'gemini-extension.json'),
JSON.stringify({ name: 'ext1', version: '1.0.0' }),
);
fs.writeFileSync(
path.join(ext1Dir, 'metadata.json'),
JSON.stringify({ type: 'local', source: ext1Dir }),
);
const ext2Dir = path.join(userExtensionsDir, 'ext2');
fs.mkdirSync(ext2Dir, { recursive: true });
fs.writeFileSync(
path.join(ext2Dir, 'gemini-extension.json'),
JSON.stringify({ name: 'ext2', version: '1.0.0' }),
);
fs.writeFileSync(
path.join(ext2Dir, 'metadata.json'),
JSON.stringify({ type: 'local', source: ext2Dir }),
);
await extensionManager.loadExtensions();
// Try to update ext1 to name 'ext2'
const newSourceDir = fs.mkdtempSync(
path.join(tempHomeDir, 'new-source-'),
);
fs.writeFileSync(
path.join(newSourceDir, 'gemini-extension.json'),
JSON.stringify({ name: 'ext2', version: '1.1.0' }),
);
fs.writeFileSync(
path.join(newSourceDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: newSourceDir }),
);
await expect(
extensionManager.installOrUpdateExtension(
{ type: 'local', source: newSourceDir },
{ name: 'ext1', version: '1.0.0' },
),
).rejects.toThrow(/already installed/);
});
});
describe('extension integrity', () => {
it('should store integrity data during installation', async () => {
const storeSpy = vi.spyOn(extensionManager, 'storeExtensionIntegrity');
const extDir = path.join(tempHomeDir, 'new-integrity-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({ name: 'integrity-ext', version: '1.0.0' }),
);
const installMetadata = {
source: extDir,
type: 'local' as const,
};
await extensionManager.loadExtensions();
await extensionManager.installOrUpdateExtension(installMetadata);
expect(storeSpy).toHaveBeenCalledWith('integrity-ext', installMetadata);
});
it('should store integrity data during first update', async () => {
const storeSpy = vi.spyOn(extensionManager, 'storeExtensionIntegrity');
const verifySpy = vi.spyOn(extensionManager, 'verifyExtensionIntegrity');
// Setup existing extension
const extName = 'update-integrity-ext';
const extDir = path.join(userExtensionsDir, extName);
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({ name: extName, version: '1.0.0' }),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
await extensionManager.loadExtensions();
// Ensure no integrity data exists for this extension
verifySpy.mockResolvedValueOnce(IntegrityDataStatus.MISSING);
const initialStatus = await extensionManager.verifyExtensionIntegrity(
extName,
{ type: 'local', source: extDir },
);
expect(initialStatus).toBe('missing');
// Create new version of the extension
const newSourceDir = fs.mkdtempSync(
path.join(tempHomeDir, 'new-source-'),
);
fs.writeFileSync(
path.join(newSourceDir, 'gemini-extension.json'),
JSON.stringify({ name: extName, version: '1.1.0' }),
);
const installMetadata = {
source: newSourceDir,
type: 'local' as const,
};
// Perform update and verify integrity was stored
await extensionManager.installOrUpdateExtension(installMetadata, {
name: extName,
version: '1.0.0',
});
expect(storeSpy).toHaveBeenCalledWith(extName, installMetadata);
});
});
describe('early theme registration', () => {
it('should register themes with ThemeManager during loadExtensions for active extensions', async () => {
createExtension({
extensionsDir: userExtensionsDir,
name: 'themed-ext',
version: '1.0.0',
themes: [testTheme],
});
await extensionManager.loadExtensions();
expect(themeManager.getCustomThemeNames()).toContain(
'MyTheme (themed-ext)',
);
});
it('should not register themes for inactive extensions', async () => {
createExtension({
extensionsDir: userExtensionsDir,
name: 'disabled-ext',
version: '1.0.0',
themes: [testTheme],
});
// Disable the extension by creating an enablement override
const manager = new ExtensionManager({
enabledExtensionOverrides: ['none'],
settings: createTestMergedSettings(),
workspaceDir: tempWorkspaceDir,
requestConsent: vi.fn().mockResolvedValue(true),
requestSetting: null,
});
await manager.loadExtensions();
expect(themeManager.getCustomThemeNames()).not.toContain(
'MyTheme (disabled-ext)',
);
});
});
describe('contextFileName directory boundary validation and path resolution', () => {
it('loads legitimate relative paths within the extension directory (e.g. context/GEMINI.md, ./GEMINI.md)', async () => {
const extDir = path.join(userExtensionsDir, 'legit-ext');
const contextDir = path.join(extDir, 'context');
fs.mkdirSync(contextDir, { recursive: true });
fs.writeFileSync(path.join(contextDir, 'GEMINI.md'), 'context content');
fs.writeFileSync(path.join(extDir, 'GEMINI.md'), 'root context content');
fs.writeFileSync(path.join(extDir, 'DOCS.md'), 'docs content');
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'legit-ext',
version: '1.0.0',
contextFileName: ['context/GEMINI.md', './GEMINI.md', 'DOCS.md'],
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
const ext = extensions[0];
expect(ext.contextFiles).toEqual([
path.join(extDir, 'context', 'GEMINI.md'),
path.join(extDir, 'GEMINI.md'),
path.join(extDir, 'DOCS.md'),
]);
});
it('rejects relative parent directory navigation using .. (e.g. ../../../../etc/passwd, ../secret.txt) and skips loading the invalid context file', async () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const extDir = path.join(userExtensionsDir, 'relative-parent-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(path.join(extDir, 'valid.md'), 'valid content');
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'relative-parent-ext',
version: '1.0.0',
contextFileName: [
'valid.md',
'../../../../etc/passwd',
'../secret.txt',
'subdir/../../escaped.txt',
'..\\secret.txt',
'%2e%2e%2fsecret.txt',
],
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
const ext = extensions[0];
// Only valid.md should be loaded; all invalid path attempts should be skipped
expect(ext.contextFiles).toEqual([path.join(extDir, 'valid.md')]);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('../../../../etc/passwd'),
);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('../secret.txt'),
);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('subdir/../../escaped.txt'),
);
warnSpy.mockRestore();
});
it('rejects absolute paths (e.g. /etc/hosts or C:\\Windows\\System32) and skips loading the invalid context file', async () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const extDir = path.join(userExtensionsDir, 'absolute-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(path.join(extDir, 'valid.md'), 'valid content');
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'absolute-ext',
version: '1.0.0',
contextFileName: [
'valid.md',
'/etc/hosts',
'/etc/passwd',
'C:\\Windows\\System32',
'C:/Windows/System32',
'\\\\server\\share\\secret.txt',
],
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
const ext = extensions[0];
expect(ext.contextFiles).toEqual([path.join(extDir, 'valid.md')]);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('/etc/hosts'),
);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('C:\\Windows\\System32'),
);
warnSpy.mockRestore();
});
it('skips non-string, empty, or whitespace-only contextFileName entries', async () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const extDir = path.join(userExtensionsDir, 'empty-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(path.join(extDir, 'valid.md'), 'valid content');
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'empty-ext',
version: '1.0.0',
contextFileName: ['valid.md', '', ' ', null, 123],
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
expect(extensions[0].contextFiles).toEqual([
path.join(extDir, 'valid.md'),
]);
warnSpy.mockRestore();
});
it('rejects context file path with null byte injection', async () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const extDir = path.join(userExtensionsDir, 'nullbyte-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'nullbyte-ext',
version: '1.0.0',
contextFileName: 'context.md\0/etc/hosts',
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
expect(extensions[0].contextFiles).toHaveLength(0);
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining('null bytes are not allowed'),
);
warnSpy.mockRestore();
});
it('sanitizes plan.directory against relative parent directory navigation', async () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const extDir = path.join(userExtensionsDir, 'plan-ext');
fs.mkdirSync(extDir, { recursive: true });
fs.writeFileSync(
path.join(extDir, 'gemini-extension.json'),
JSON.stringify({
name: 'plan-ext',
version: '1.0.0',
plan: {
directory: '../../../../etc',
},
}),
);
fs.writeFileSync(
path.join(extDir, 'metadata.json'),
JSON.stringify({ type: 'local', source: extDir }),
);
const extensions = await extensionManager.loadExtensions();
expect(extensions).toHaveLength(1);
expect(extensions[0].plan).toBeUndefined();
expect(warnSpy).toHaveBeenCalledWith(
expect.stringContaining(
'Invalid plan.directory in extension "plan-ext"',
),
);
warnSpy.mockRestore();
});
describe('resolveContextFilePaths unit tests', () => {
it('returns empty array when context files do not exist', () => {
const config = {
name: 'test',
version: '1.0.0',
contextFileName: 'non-existent.md',
};
const result = resolveContextFilePaths(config, tempWorkspaceDir);
expect(result).toEqual([]);
});
it('returns resolved paths for existing valid context files', () => {
const testFile = path.join(tempWorkspaceDir, 'valid.md');
fs.writeFileSync(testFile, 'test');
const config = {
name: 'test',
version: '1.0.0',
contextFileName: 'valid.md',
};
const result = resolveContextFilePaths(config, tempWorkspaceDir);
expect(result).toEqual([testFile]);
});
it('filters out relative parent directory paths even if target file exists on disk', () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
const outsideFile = path.join(tempHomeDir, 'outside-secret.txt');
fs.writeFileSync(outsideFile, 'secret');
const extDir = path.join(tempHomeDir, 'ext-sub');
fs.mkdirSync(extDir, { recursive: true });
const config = {
name: 'test',
version: '1.0.0',
contextFileName: '../outside-secret.txt',
};
const result = resolveContextFilePaths(config, extDir);
expect(result).toEqual([]);
expect(warnSpy).toHaveBeenCalled();
warnSpy.mockRestore();
});
it('loads context file with percent characters without skipping it', () => {
const testFile = path.join(tempWorkspaceDir, '100%_complete.md');
fs.writeFileSync(testFile, '100% completed content');
const config = {
name: 'test',
version: '1.0.0',
contextFileName: '100%_complete.md',
};
const result = resolveContextFilePaths(config, tempWorkspaceDir);
expect(result).toEqual([testFile]);
});
});
describe('validateContextFilePath unit tests', () => {
it('validates standard relative context file path', () => {
const result = validateContextFilePath('GEMINI.md', tempWorkspaceDir);
expect(result.isValid).toBe(true);
expect(result.resolvedPath).toBe(
path.resolve(tempWorkspaceDir, 'GEMINI.md'),
);
});
it('validates context file path in nested subdirectory', () => {
const result = validateContextFilePath(
'docs/context.md',
tempWorkspaceDir,
);
expect(result.isValid).toBe(true);
expect(result.resolvedPath).toBe(
path.resolve(tempWorkspaceDir, 'docs/context.md'),
);
});
it('validates context file path containing percent characters', () => {
const result = validateContextFilePath(
'progress_100%_report.md',
tempWorkspaceDir,
);
expect(result.isValid).toBe(true);
expect(result.resolvedPath).toBe(
path.resolve(tempWorkspaceDir, 'progress_100%_report.md'),
);
});
it('rejects relative parent directory navigation', () => {
const result = validateContextFilePath(
'../secret.txt',
tempWorkspaceDir,
);
expect(result.isValid).toBe(false);
expect(result.errorMessage).toContain(
'Relative parent directory references ("..") are not allowed.',
);
});
it('rejects URL-encoded relative parent directory navigation', () => {
const resultLower = validateContextFilePath(
'%2e%2e/secret.txt',
tempWorkspaceDir,
);
expect(resultLower.isValid).toBe(false);
expect(resultLower.errorMessage).toContain(
'Relative parent directory references ("..") are not allowed.',
);
const resultUpper = validateContextFilePath(
'%2E%2E/secret.txt',
tempWorkspaceDir,
);
expect(resultUpper.isValid).toBe(false);
expect(resultUpper.errorMessage).toContain(
'Relative parent directory references ("..") are not allowed.',
);
});
it('rejects POSIX and Windows absolute paths', () => {
const resultPosix = validateContextFilePath(
'/etc/hosts',
tempWorkspaceDir,
);
expect(resultPosix.isValid).toBe(false);
expect(resultPosix.errorMessage).toContain(
'Absolute paths are not allowed.',
);
const resultWin = validateContextFilePath(
'C:\\Windows\\System32',
tempWorkspaceDir,
);
expect(resultWin.isValid).toBe(false);
expect(resultWin.errorMessage).toContain(
'Absolute paths are not allowed.',
);
});
it('rejects null bytes', () => {
const result = validateContextFilePath(
'context.md\0outside.txt',
tempWorkspaceDir,
);
expect(result.isValid).toBe(false);
expect(result.errorMessage).toContain('null bytes are not allowed.');
});
it('rejects empty or non-string inputs', () => {
expect(validateContextFilePath('', tempWorkspaceDir).isValid).toBe(
false,
);
expect(validateContextFilePath(' ', tempWorkspaceDir).isValid).toBe(
false,
);
expect(validateContextFilePath(null, tempWorkspaceDir).isValid).toBe(
false,
);
expect(validateContextFilePath(123, tempWorkspaceDir).isValid).toBe(
false,
);
});
it('validates context files when root path casing varies on case-insensitive platforms', () => {
const lowerRoot = tempWorkspaceDir.toLowerCase();
const result = validateContextFilePath('GEMINI.md', lowerRoot);
if (process.platform === 'darwin' || process.platform === 'win32') {
expect(result.isValid).toBe(true);
}
});
});
});
});
|