/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { vi } from 'vitest'; import * as fs from 'node:fs'; import * as os from 'node:os'; import * as path from 'node:path'; import { EXTENSIONS_CONFIG_FILENAME, ExtensionStorage, INSTALL_METADATA_FILENAME, annotateActiveExtensions, disableExtension, enableExtension, installOrUpdateExtension, loadExtension, loadExtensionConfig, loadExtensions, performWorkspaceExtensionMigration, uninstallExtension, } from './extension.js'; import { GEMINI_DIR, type GeminiCLIExtension, ExtensionUninstallEvent, ExtensionDisableEvent, ExtensionEnableEvent, } from '@google/gemini-cli-core'; import { SettingScope } from './settings.js'; import { isWorkspaceTrusted } from './trustedFolders.js'; import { createExtension } from '../test-utils/createExtension.js'; import { ExtensionEnablementManager } from './extensions/extensionEnablement.js'; import { join } from 'node:path'; const mockGit = { clone: vi.fn(), getRemotes: vi.fn(), fetch: vi.fn(), checkout: vi.fn(), listRemote: vi.fn(), revparse: vi.fn(), // Not a part of the actual API, but we need to use this to do the correct // file system interactions. path: vi.fn(), }; const mockDownloadFromGithubRelease = vi.hoisted(() => vi.fn()); vi.mock('./extensions/github.js', async (importOriginal) => { const original = await importOriginal(); return { ...original, downloadFromGitHubRelease: mockDownloadFromGithubRelease, }; }); vi.mock('simple-git', () => ({ simpleGit: vi.fn((path: string) => { mockGit.path.mockReturnValue(path); return mockGit; }), })); vi.mock('os', async (importOriginal) => { const mockedOs = await importOriginal(); return { ...mockedOs, homedir: vi.fn(), }; }); vi.mock('./trustedFolders.js', async (importOriginal) => { const actual = await importOriginal(); return { ...actual, isWorkspaceTrusted: vi.fn(), }; }); const mockLogExtensionEnable = vi.hoisted(() => vi.fn()); const mockLogExtensionInstallEvent = vi.hoisted(() => vi.fn()); const mockLogExtensionUninstall = vi.hoisted(() => vi.fn()); const mockLogExtensionUpdateEvent = vi.hoisted(() => vi.fn()); const mockLogExtensionDisable = vi.hoisted(() => vi.fn()); vi.mock('@google/gemini-cli-core', async (importOriginal) => { const actual = await importOriginal(); return { ...actual, logExtensionEnable: mockLogExtensionEnable, logExtensionInstallEvent: mockLogExtensionInstallEvent, logExtensionUninstall: mockLogExtensionUninstall, logExtensionUpdateEvent: mockLogExtensionUpdateEvent, logExtensionDisable: mockLogExtensionDisable, ExtensionEnableEvent: vi.fn(), ExtensionInstallEvent: vi.fn(), ExtensionUninstallEvent: vi.fn(), ExtensionDisableEvent: vi.fn(), }; }); vi.mock('child_process', async (importOriginal) => { const actual = await importOriginal(); return { ...actual, execSync: vi.fn(), }; }); const EXTENSIONS_DIRECTORY_NAME = path.join(GEMINI_DIR, 'extensions'); describe('extension tests', () => { let tempHomeDir: string; let tempWorkspaceDir: string; let userExtensionsDir: string; beforeEach(() => { tempHomeDir = fs.mkdtempSync( path.join(os.tmpdir(), 'gemini-cli-test-home-'), ); tempWorkspaceDir = fs.mkdtempSync( path.join(tempHomeDir, 'gemini-cli-test-workspace-'), ); userExtensionsDir = path.join(tempHomeDir, EXTENSIONS_DIRECTORY_NAME); fs.mkdirSync(userExtensionsDir, { recursive: true }); vi.mocked(os.homedir).mockReturnValue(tempHomeDir); vi.mocked(isWorkspaceTrusted).mockReturnValue({ isTrusted: true, source: undefined, }); vi.spyOn(process, 'cwd').mockReturnValue(tempWorkspaceDir); }); afterEach(() => { fs.rmSync(tempHomeDir, { recursive: true, force: true }); fs.rmSync(tempWorkspaceDir, { recursive: true, force: true }); vi.restoreAllMocks(); }); describe('loadExtensions', () => { it('should include extension path in loaded extension', () => { const extensionDir = path.join(userExtensionsDir, 'test-extension'); fs.mkdirSync(extensionDir, { recursive: true }); createExtension({ extensionsDir: userExtensionsDir, name: 'test-extension', version: '1.0.0', }); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); expect(extensions[0].path).toBe(extensionDir); expect(extensions[0].name).toBe('test-extension'); }); it('should load context file path when GEMINI.md is present', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', addContextFile: true, }); createExtension({ extensionsDir: userExtensionsDir, name: 'ext2', version: '2.0.0', }); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(2); const ext1 = extensions.find((e) => e.name === 'ext1'); const ext2 = extensions.find((e) => e.name === 'ext2'); expect(ext1?.contextFiles).toEqual([ path.join(userExtensionsDir, 'ext1', 'GEMINI.md'), ]); expect(ext2?.contextFiles).toEqual([]); }); it('should load context file path from the extension config', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', addContextFile: false, contextFileName: 'my-context-file.md', }); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); const ext1 = extensions.find((e) => e.name === 'ext1'); expect(ext1?.contextFiles).toEqual([ path.join(userExtensionsDir, 'ext1', 'my-context-file.md'), ]); }); it('should filter out disabled extensions', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'disabled-extension', version: '1.0.0', }); createExtension({ extensionsDir: userExtensionsDir, name: 'enabled-extension', version: '2.0.0', }); disableExtension( 'disabled-extension', SettingScope.User, tempWorkspaceDir, ); const manager = new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ); const extensions = loadExtensions(manager); const activeExtensions = annotateActiveExtensions( extensions, tempWorkspaceDir, manager, ).filter((e) => e.isActive); expect(activeExtensions).toHaveLength(1); expect(activeExtensions[0].name).toBe('enabled-extension'); }); it('should hydrate variables', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'test-extension', version: '1.0.0', addContextFile: false, contextFileName: undefined, mcpServers: { 'test-server': { cwd: '${extensionPath}${/}server', }, }, }); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); const expectedCwd = path.join( userExtensionsDir, 'test-extension', 'server', ); expect(extensions[0].mcpServers?.['test-server'].cwd).toBe(expectedCwd); }); it('should load a linked extension correctly', async () => { const sourceExtDir = createExtension({ extensionsDir: tempWorkspaceDir, name: 'my-linked-extension', version: '1.0.0', contextFileName: 'context.md', }); fs.writeFileSync(path.join(sourceExtDir, 'context.md'), 'linked context'); const extensionName = await installOrUpdateExtension( { source: sourceExtDir, type: 'link', }, async (_) => true, ); expect(extensionName).toEqual('my-linked-extension'); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); const linkedExt = extensions[0]; expect(linkedExt.name).toBe('my-linked-extension'); expect(linkedExt.path).toBe(sourceExtDir); expect(linkedExt.installMetadata).toEqual({ source: sourceExtDir, type: 'link', }); expect(linkedExt.contextFiles).toEqual([ path.join(sourceExtDir, 'context.md'), ]); }); it('should resolve environment variables in extension configuration', () => { process.env['TEST_API_KEY'] = 'test-api-key-123'; process.env['TEST_DB_URL'] = 'postgresql://localhost:5432/testdb'; try { const userExtensionsDir = path.join( tempHomeDir, EXTENSIONS_DIRECTORY_NAME, ); fs.mkdirSync(userExtensionsDir, { recursive: true }); const extDir = path.join(userExtensionsDir, 'test-extension'); fs.mkdirSync(extDir); // Write config to a separate file for clarity and good practices const configPath = path.join(extDir, EXTENSIONS_CONFIG_FILENAME); const extensionConfig = { name: 'test-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], env: { API_KEY: '$TEST_API_KEY', DATABASE_URL: '${TEST_DB_URL}', STATIC_VALUE: 'no-substitution', }, }, }, }; fs.writeFileSync(configPath, JSON.stringify(extensionConfig)); const extensions = loadExtensions( new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ); expect(extensions).toHaveLength(1); const extension = extensions[0]; expect(extension.name).toBe('test-extension'); expect(extension.mcpServers).toBeDefined(); const serverConfig = extension.mcpServers?.['test-server']; expect(serverConfig).toBeDefined(); expect(serverConfig?.env).toBeDefined(); expect(serverConfig?.env?.['API_KEY']).toBe('test-api-key-123'); expect(serverConfig?.env?.['DATABASE_URL']).toBe( 'postgresql://localhost:5432/testdb', ); expect(serverConfig?.env?.['STATIC_VALUE']).toBe('no-substitution'); } finally { delete process.env['TEST_API_KEY']; delete process.env['TEST_DB_URL']; } }); it('should handle missing environment variables gracefully', () => { const userExtensionsDir = path.join( tempHomeDir, EXTENSIONS_DIRECTORY_NAME, ); fs.mkdirSync(userExtensionsDir, { recursive: true }); const extDir = path.join(userExtensionsDir, 'test-extension'); fs.mkdirSync(extDir); const extensionConfig = { name: 'test-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], env: { MISSING_VAR: '$UNDEFINED_ENV_VAR', MISSING_VAR_BRACES: '${ALSO_UNDEFINED}', }, }, }, }; fs.writeFileSync( path.join(extDir, EXTENSIONS_CONFIG_FILENAME), JSON.stringify(extensionConfig), ); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); const extension = extensions[0]; const serverConfig = extension.mcpServers!['test-server']; expect(serverConfig.env).toBeDefined(); expect(serverConfig.env!['MISSING_VAR']).toBe('$UNDEFINED_ENV_VAR'); expect(serverConfig.env!['MISSING_VAR_BRACES']).toBe('${ALSO_UNDEFINED}'); }); it('should skip extensions with invalid JSON and log a warning', () => { const consoleSpy = vi .spyOn(console, 'error') .mockImplementation(() => {}); // Good extension createExtension({ extensionsDir: userExtensionsDir, name: 'good-ext', version: '1.0.0', }); // Bad extension const badExtDir = path.join(userExtensionsDir, 'bad-ext'); fs.mkdirSync(badExtDir); const badConfigPath = path.join(badExtDir, EXTENSIONS_CONFIG_FILENAME); fs.writeFileSync(badConfigPath, '{ "name": "bad-ext"'); // Malformed const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); expect(extensions[0].name).toBe('good-ext'); expect(consoleSpy).toHaveBeenCalledOnce(); expect(consoleSpy).toHaveBeenCalledWith( expect.stringContaining( `Warning: Skipping extension in ${badExtDir}: Failed to load extension config from ${badConfigPath}`, ), ); consoleSpy.mockRestore(); }); it('should skip extensions with missing name and log a warning', () => { const consoleSpy = vi .spyOn(console, 'error') .mockImplementation(() => {}); // Good extension createExtension({ extensionsDir: userExtensionsDir, name: 'good-ext', version: '1.0.0', }); // Bad extension const badExtDir = path.join(userExtensionsDir, 'bad-ext-no-name'); fs.mkdirSync(badExtDir); const badConfigPath = path.join(badExtDir, EXTENSIONS_CONFIG_FILENAME); fs.writeFileSync(badConfigPath, JSON.stringify({ version: '1.0.0' })); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); expect(extensions[0].name).toBe('good-ext'); expect(consoleSpy).toHaveBeenCalledOnce(); expect(consoleSpy).toHaveBeenCalledWith( expect.stringContaining( `Warning: Skipping extension in ${badExtDir}: Failed to load extension config from ${badConfigPath}: Invalid configuration in ${badConfigPath}: missing "name"`, ), ); consoleSpy.mockRestore(); }); it('should filter trust out of mcp servers', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'test-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], trust: true, }, }, }); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(1); expect(extensions[0].mcpServers?.['test-server'].trust).toBeUndefined(); }); it('should throw an error for invalid extension names', () => { const consoleSpy = vi .spyOn(console, 'error') .mockImplementation(() => {}); const badExtDir = createExtension({ extensionsDir: userExtensionsDir, name: 'bad_name', version: '1.0.0', }); const extension = loadExtension({ extensionDir: badExtDir, workspaceDir: tempWorkspaceDir, }); expect(extension).toBeNull(); expect(consoleSpy).toHaveBeenCalledWith( expect.stringContaining('Invalid extension name: "bad_name"'), ); consoleSpy.mockRestore(); }); }); describe('annotateActiveExtensions', () => { const extensions: GeminiCLIExtension[] = [ { path: '/path/to/ext1', name: 'ext1', version: '1.0.0', contextFiles: [], isActive: true, }, { path: '/path/to/ext2', name: 'ext2', version: '1.0.0', contextFiles: [], isActive: true, }, { path: '/path/to/ext3', name: 'ext3', version: '1.0.0', contextFiles: [], isActive: true, }, ]; it('should mark all extensions as active if no enabled extensions are provided', () => { const activeExtensions = annotateActiveExtensions( extensions, '/path/to/workspace', new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.every((e) => e.isActive)).toBe(true); }); it('should mark only the enabled extensions as active', () => { const activeExtensions = annotateActiveExtensions( extensions, '/path/to/workspace', new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ['ext1', 'ext3'], ), ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.find((e) => e.name === 'ext1')?.isActive).toBe( true, ); expect(activeExtensions.find((e) => e.name === 'ext2')?.isActive).toBe( false, ); expect(activeExtensions.find((e) => e.name === 'ext3')?.isActive).toBe( true, ); }); it('should mark all extensions as inactive when "none" is provided', () => { const activeExtensions = annotateActiveExtensions( extensions, '/path/to/workspace', new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ['none'], ), ); expect(activeExtensions).toHaveLength(3); expect(activeExtensions.every((e) => !e.isActive)).toBe(true); }); it('should handle case-insensitivity', () => { const activeExtensions = annotateActiveExtensions( extensions, '/path/to/workspace', new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ['EXT1'], ), ); expect(activeExtensions.find((e) => e.name === 'ext1')?.isActive).toBe( true, ); }); it('should log an error for unknown extensions', () => { const consoleSpy = vi .spyOn(console, 'error') .mockImplementation(() => {}); annotateActiveExtensions( extensions, '/path/to/workspace', new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ['ext4'], ), ); expect(consoleSpy).toHaveBeenCalledWith('Extension not found: ext4'); consoleSpy.mockRestore(); }); describe('autoUpdate', () => { it('should be false if autoUpdate is not set in install metadata', () => { const activeExtensions = annotateActiveExtensions( extensions, tempHomeDir, new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ); expect( activeExtensions.every( (e) => e.installMetadata?.autoUpdate === false, ), ).toBe(false); }); it('should be true if autoUpdate is true in install metadata', () => { const extensionsWithAutoUpdate: GeminiCLIExtension[] = extensions.map( (e) => ({ ...e, installMetadata: { ...e.installMetadata!, autoUpdate: true, }, }), ); const activeExtensions = annotateActiveExtensions( extensionsWithAutoUpdate, tempHomeDir, new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ); expect( activeExtensions.every((e) => e.installMetadata?.autoUpdate === true), ).toBe(true); }); it('should respect the per-extension settings from install metadata', () => { const extensionsWithAutoUpdate: GeminiCLIExtension[] = [ { path: '/path/to/ext1', name: 'ext1', version: '1.0.0', contextFiles: [], installMetadata: { source: 'test', type: 'local', autoUpdate: true, }, isActive: true, }, { path: '/path/to/ext2', name: 'ext2', version: '1.0.0', contextFiles: [], installMetadata: { source: 'test', type: 'local', autoUpdate: false, }, isActive: true, }, { path: '/path/to/ext3', name: 'ext3', version: '1.0.0', contextFiles: [], isActive: true, }, ]; const activeExtensions = annotateActiveExtensions( extensionsWithAutoUpdate, tempHomeDir, new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ); expect( activeExtensions.find((e) => e.name === 'ext1')?.installMetadata ?.autoUpdate, ).toBe(true); expect( activeExtensions.find((e) => e.name === 'ext2')?.installMetadata ?.autoUpdate, ).toBe(false); expect( activeExtensions.find((e) => e.name === 'ext3')?.installMetadata ?.autoUpdate, ).toBe(undefined); }); }); }); describe('installExtension', () => { it('should install an extension from a local path', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', }); const targetExtDir = path.join(userExtensionsDir, 'my-local-extension'); const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ); expect(fs.existsSync(targetExtDir)).toBe(true); expect(fs.existsSync(metadataPath)).toBe(true); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: sourceExtDir, type: 'local', }); fs.rmSync(targetExtDir, { recursive: true, force: true }); }); it('should throw an error if the extension already exists', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', }); await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ), ).rejects.toThrow( 'Extension "my-local-extension" is already installed. Please uninstall it first.', ); }); it('should throw an error and cleanup if gemini-extension.json is missing', async () => { const sourceExtDir = path.join(tempHomeDir, 'bad-extension'); fs.mkdirSync(sourceExtDir, { recursive: true }); const configPath = path.join(sourceExtDir, EXTENSIONS_CONFIG_FILENAME); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ), ).rejects.toThrow(`Configuration file not found at ${configPath}`); const targetExtDir = path.join(userExtensionsDir, 'bad-extension'); expect(fs.existsSync(targetExtDir)).toBe(false); }); it('should throw an error for invalid JSON in gemini-extension.json', async () => { const sourceExtDir = path.join(tempHomeDir, 'bad-json-ext'); fs.mkdirSync(sourceExtDir, { recursive: true }); const configPath = path.join(sourceExtDir, EXTENSIONS_CONFIG_FILENAME); fs.writeFileSync(configPath, '{ "name": "bad-json", "version": "1.0.0"'); // Malformed JSON await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ), ).rejects.toThrow( new RegExp( `^Failed to load extension config from ${configPath.replace( /\\/g, '\\\\', )}`, ), ); }); it('should throw an error for missing name in gemini-extension.json', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'missing-name-ext', version: '1.0.0', }); const configPath = path.join(sourceExtDir, EXTENSIONS_CONFIG_FILENAME); // Overwrite with invalid config fs.writeFileSync(configPath, JSON.stringify({ version: '1.0.0' })); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ), ).rejects.toThrow( `Invalid configuration in ${configPath}: missing "name"`, ); }); it('should install an extension from a git URL', async () => { const gitUrl = 'https://somehost.com/somerepo.git'; const extensionName = 'some-extension'; const targetExtDir = path.join(userExtensionsDir, extensionName); const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); mockGit.clone.mockImplementation(async (_, destination) => { fs.mkdirSync(path.join(mockGit.path(), destination), { recursive: true, }); fs.writeFileSync( path.join(mockGit.path(), destination, EXTENSIONS_CONFIG_FILENAME), JSON.stringify({ name: extensionName, version: '1.0.0' }), ); }); mockGit.getRemotes.mockResolvedValue([{ name: 'origin' }]); mockDownloadFromGithubRelease.mockResolvedValue({ success: false, failureReason: 'no release data', type: 'github-release', }); await installOrUpdateExtension( { source: gitUrl, type: 'git' }, async (_) => true, ); expect(fs.existsSync(targetExtDir)).toBe(true); expect(fs.existsSync(metadataPath)).toBe(true); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: gitUrl, type: 'git', }); }); it('should install a linked extension', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-linked-extension', version: '1.0.0', }); const targetExtDir = path.join(userExtensionsDir, 'my-linked-extension'); const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); const configPath = path.join(targetExtDir, EXTENSIONS_CONFIG_FILENAME); await installOrUpdateExtension( { source: sourceExtDir, type: 'link' }, async (_) => true, ); expect(fs.existsSync(targetExtDir)).toBe(true); expect(fs.existsSync(metadataPath)).toBe(true); expect(fs.existsSync(configPath)).toBe(false); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: sourceExtDir, type: 'link', }); fs.rmSync(targetExtDir, { recursive: true, force: true }); }); describe.each([true, false])( 'with previous extension config: %s', (isUpdate: boolean) => { let sourceExtDir: string; beforeEach(async () => { sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.1.0', }); if (isUpdate) { await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ); } // Clears out any calls to mocks from the above function calls. vi.clearAllMocks(); }); it(`should log an ${isUpdate ? 'update' : 'install'} event to clearcut on success`, async () => { await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, undefined, isUpdate ? { name: 'my-local-extension', version: '1.0.0', } : undefined, ); if (isUpdate) { expect(mockLogExtensionUpdateEvent).toHaveBeenCalled(); expect(mockLogExtensionInstallEvent).not.toHaveBeenCalled(); } else { expect(mockLogExtensionInstallEvent).toHaveBeenCalled(); expect(mockLogExtensionUpdateEvent).not.toHaveBeenCalled(); } }); it(`should ${isUpdate ? 'not ' : ''} alter the extension enablement configuration`, async () => { const enablementManager = new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ); enablementManager.enable('my-local-extension', true, '/some/scope'); await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, undefined, isUpdate ? { name: 'my-local-extension', version: '1.0.0', } : undefined, ); const config = enablementManager.readConfig()['my-local-extension']; if (isUpdate) { expect(config).not.toBeUndefined(); expect(config.overrides).toContain('/some/scope/*'); } else { expect(config).not.toContain('/some/scope/*'); } }); }, ); it('should show users information on their ansi escaped mcp servers when installing', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node dobadthing \u001b[12D\u001b[K', args: ['server.js'], description: 'a local mcp server', }, 'test-server-2': { description: 'a remote mcp server', httpUrl: 'https://google.com', }, }, }); const mockRequestConsent = vi.fn(); mockRequestConsent.mockResolvedValue(true); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, mockRequestConsent, ), ).resolves.toBe('my-local-extension'); expect(mockRequestConsent).toHaveBeenCalledWith( `Installing extension "my-local-extension". **Extensions may introduce unexpected behavior. Ensure you have investigated the extension source and trust the author.** This extension will run the following MCP servers: * test-server (local): node dobadthing \\u001b[12D\\u001b[K server.js * test-server-2 (remote): https://google.com`, ); }); it('should continue installation if user accepts prompt for local extension with mcp servers', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], }, }, }); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async () => true, ), ).resolves.toBe('my-local-extension'); }); it('should cancel installation if user declines prompt for local extension with mcp servers', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], }, }, }); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async () => false, ), ).rejects.toThrow('Installation cancelled for "my-local-extension".'); }); it('should save the autoUpdate flag to the install metadata', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', }); const targetExtDir = path.join(userExtensionsDir, 'my-local-extension'); const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); await installOrUpdateExtension( { source: sourceExtDir, type: 'local', autoUpdate: true, }, async (_) => true, ); expect(fs.existsSync(targetExtDir)).toBe(true); expect(fs.existsSync(metadataPath)).toBe(true); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: sourceExtDir, type: 'local', autoUpdate: true, }); fs.rmSync(targetExtDir, { recursive: true, force: true }); }); it('should ignore consent flow if not required', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'my-local-extension', version: '1.0.0', mcpServers: { 'test-server': { command: 'node', args: ['server.js'], }, }, }); const mockRequestConsent = vi.fn(); // Install it and force consent first. await installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async () => true, ); // Now update it without changing anything. await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, mockRequestConsent, process.cwd(), // Provide its own existing config as the previous config. await loadExtensionConfig({ extensionDir: sourceExtDir, workspaceDir: process.cwd(), }), ), ).resolves.toBe('my-local-extension'); expect(mockRequestConsent).not.toHaveBeenCalled(); }); it('should throw an error for invalid extension names', async () => { const sourceExtDir = createExtension({ extensionsDir: tempHomeDir, name: 'bad_name', version: '1.0.0', }); await expect( installOrUpdateExtension( { source: sourceExtDir, type: 'local' }, async (_) => true, ), ).rejects.toThrow('Invalid extension name: "bad_name"'); }); describe('installing from github', () => { const gitUrl = 'https://github.com/google/gemini-test-extension.git'; const extensionName = 'gemini-test-extension'; beforeEach(() => { // Mock the git clone behavior for github installs that fallback to it. mockGit.clone.mockImplementation(async (_, destination) => { fs.mkdirSync(path.join(mockGit.path(), destination), { recursive: true, }); fs.writeFileSync( path.join(mockGit.path(), destination, EXTENSIONS_CONFIG_FILENAME), JSON.stringify({ name: extensionName, version: '1.0.0' }), ); }); mockGit.getRemotes.mockResolvedValue([{ name: 'origin' }]); }); afterEach(() => { vi.restoreAllMocks(); }); it('should install from a github release successfully', async () => { const targetExtDir = path.join(userExtensionsDir, extensionName); mockDownloadFromGithubRelease.mockResolvedValue({ success: true, tagName: 'v1.0.0', type: 'github-release', }); const tempDir = path.join(tempHomeDir, 'temp-ext'); fs.mkdirSync(tempDir, { recursive: true }); createExtension({ extensionsDir: tempDir, name: extensionName, version: '1.0.0', }); vi.spyOn(ExtensionStorage, 'createTmpDir').mockResolvedValue( join(tempDir, extensionName), ); await installOrUpdateExtension( { source: gitUrl, type: 'github-release' }, async () => true, ); expect(fs.existsSync(targetExtDir)).toBe(true); const metadataPath = path.join(targetExtDir, INSTALL_METADATA_FILENAME); expect(fs.existsSync(metadataPath)).toBe(true); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: gitUrl, type: 'github-release', releaseTag: 'v1.0.0', }); }); it('should fallback to git clone if github release download fails and user consents', async () => { mockDownloadFromGithubRelease.mockResolvedValue({ success: false, failureReason: 'failed to download asset', errorMessage: 'download failed', type: 'github-release', }); const requestConsent = vi.fn().mockResolvedValue(true); await installOrUpdateExtension( { source: gitUrl, type: 'github-release' }, // Use github-release to force consent requestConsent, ); // It gets called once to ask for a git clone, and once to consent to // the actual extension features. expect(requestConsent).toHaveBeenCalledTimes(2); expect(requestConsent).toHaveBeenCalledWith( expect.stringContaining( 'Would you like to attempt to install via "git clone" instead?', ), ); expect(mockGit.clone).toHaveBeenCalled(); const metadataPath = path.join( userExtensionsDir, extensionName, INSTALL_METADATA_FILENAME, ); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata.type).toBe('git'); }); it('should throw an error if github release download fails and user denies consent', async () => { mockDownloadFromGithubRelease.mockResolvedValue({ success: false, errorMessage: 'download failed', type: 'github-release', }); const requestConsent = vi.fn().mockResolvedValue(false); await expect( installOrUpdateExtension( { source: gitUrl, type: 'github-release' }, requestConsent, ), ).rejects.toThrow( `Failed to install extension ${gitUrl}: download failed`, ); expect(requestConsent).toHaveBeenCalledExactlyOnceWith( expect.stringContaining( 'Would you like to attempt to install via "git clone" instead?', ), ); expect(mockGit.clone).not.toHaveBeenCalled(); }); it('should fallback to git clone without consent if no release data is found on first install', async () => { mockDownloadFromGithubRelease.mockResolvedValue({ success: false, failureReason: 'no release data', type: 'github-release', }); const requestConsent = vi.fn().mockResolvedValue(true); await installOrUpdateExtension( { source: gitUrl, type: 'git' }, requestConsent, ); // We should not see the request to use git clone, this is a repo that // has no github releases so it is the only install method. expect(requestConsent).toHaveBeenCalledExactlyOnceWith( expect.stringContaining( 'Installing extension "gemini-test-extension"', ), ); expect(mockGit.clone).toHaveBeenCalled(); const metadataPath = path.join( userExtensionsDir, extensionName, INSTALL_METADATA_FILENAME, ); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata.type).toBe('git'); }); it('should ask for consent if no release data is found for an existing github-release extension', async () => { mockDownloadFromGithubRelease.mockResolvedValue({ success: false, failureReason: 'no release data', errorMessage: 'No release data found', type: 'github-release', }); const requestConsent = vi.fn().mockResolvedValue(true); await installOrUpdateExtension( { source: gitUrl, type: 'github-release' }, // Note the type requestConsent, ); expect(requestConsent).toHaveBeenCalledWith( expect.stringContaining( 'Would you like to attempt to install via "git clone" instead?', ), ); expect(mockGit.clone).toHaveBeenCalled(); }); }); }); describe('uninstallExtension', () => { it('should uninstall an extension by name', async () => { const sourceExtDir = createExtension({ extensionsDir: userExtensionsDir, name: 'my-local-extension', version: '1.0.0', }); await uninstallExtension('my-local-extension', false); expect(fs.existsSync(sourceExtDir)).toBe(false); }); it('should uninstall an extension by name and retain existing extensions', async () => { const sourceExtDir = createExtension({ extensionsDir: userExtensionsDir, name: 'my-local-extension', version: '1.0.0', }); const otherExtDir = createExtension({ extensionsDir: userExtensionsDir, name: 'other-extension', version: '1.0.0', }); await uninstallExtension('my-local-extension', false); expect(fs.existsSync(sourceExtDir)).toBe(false); expect( loadExtensions( new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ), ).toHaveLength(1); expect(fs.existsSync(otherExtDir)).toBe(true); }); it('should throw an error if the extension does not exist', async () => { await expect( uninstallExtension('nonexistent-extension', false), ).rejects.toThrow('Extension not found.'); }); describe.each([true, false])('with isUpdate: %s', (isUpdate: boolean) => { it(`should ${isUpdate ? 'not ' : ''}log uninstall event`, async () => { createExtension({ extensionsDir: userExtensionsDir, name: 'my-local-extension', version: '1.0.0', }); await uninstallExtension('my-local-extension', isUpdate); if (isUpdate) { expect(mockLogExtensionUninstall).not.toHaveBeenCalled(); expect(ExtensionUninstallEvent).not.toHaveBeenCalled(); } else { expect(mockLogExtensionUninstall).toHaveBeenCalled(); expect(ExtensionUninstallEvent).toHaveBeenCalledWith( 'my-local-extension', 'success', ); } }); it(`should ${isUpdate ? 'not ' : ''} alter the extension enablement configuration`, async () => { createExtension({ extensionsDir: userExtensionsDir, name: 'test-extension', version: '1.0.0', }); const enablementManager = new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ); enablementManager.enable('test-extension', true, '/some/scope'); await uninstallExtension('test-extension', isUpdate); const config = enablementManager.readConfig()['test-extension']; if (isUpdate) { expect(config).not.toBeUndefined(); expect(config.overrides).toEqual(['/some/scope/*']); } else { expect(config).toBeUndefined(); } }); }); it('should uninstall an extension by its source URL', async () => { const gitUrl = 'https://github.com/google/gemini-sql-extension.git'; const sourceExtDir = createExtension({ extensionsDir: userExtensionsDir, name: 'gemini-sql-extension', version: '1.0.0', installMetadata: { source: gitUrl, type: 'git', }, }); await uninstallExtension(gitUrl, false); expect(fs.existsSync(sourceExtDir)).toBe(false); expect(mockLogExtensionUninstall).toHaveBeenCalled(); expect(ExtensionUninstallEvent).toHaveBeenCalledWith( 'gemini-sql-extension', 'success', ); }); it('should fail to uninstall by URL if an extension has no install metadata', async () => { createExtension({ extensionsDir: userExtensionsDir, name: 'no-metadata-extension', version: '1.0.0', // No installMetadata provided }); await expect( uninstallExtension( 'https://github.com/google/no-metadata-extension', false, ), ).rejects.toThrow('Extension not found.'); }); }); describe('performWorkspaceExtensionMigration', () => { let workspaceExtensionsDir: string; beforeEach(() => { workspaceExtensionsDir = path.join( tempWorkspaceDir, EXTENSIONS_DIRECTORY_NAME, ); fs.mkdirSync(workspaceExtensionsDir, { recursive: true }); }); afterEach(() => { fs.rmSync(workspaceExtensionsDir, { recursive: true, force: true }); }); describe('folder trust', () => { it('refuses to install extensions from untrusted folders', async () => { vi.mocked(isWorkspaceTrusted).mockReturnValue({ isTrusted: false, source: undefined, }); const ext1Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext1', version: '1.0.0', }); const failed = await performWorkspaceExtensionMigration( [ loadExtension({ extensionDir: ext1Path, workspaceDir: tempWorkspaceDir, })!, ], async () => true, ); expect(failed).toEqual(['ext1']); }); it('does not copy extensions to the user dir', async () => { vi.mocked(isWorkspaceTrusted).mockReturnValue({ isTrusted: false, source: undefined, }); const ext1Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext1', version: '1.0.0', }); await performWorkspaceExtensionMigration( [ loadExtension({ extensionDir: ext1Path, workspaceDir: tempWorkspaceDir, })!, ], async (_) => true, ); const userExtensionsDir = path.join( tempHomeDir, GEMINI_DIR, 'extensions', ); expect(fs.readdirSync(userExtensionsDir).length).toBe(0); }); it('does not load any extensions in the workspace config', async () => { vi.mocked(isWorkspaceTrusted).mockReturnValue({ isTrusted: false, source: undefined, }); const ext1Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext1', version: '1.0.0', }); await performWorkspaceExtensionMigration( [ loadExtension({ extensionDir: ext1Path, workspaceDir: tempWorkspaceDir, })!, ], async (_) => true, ); const extensions = loadExtensions( new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ), ); expect(extensions).toEqual([]); }); }); it('should install the extensions in the user directory', async () => { const ext1Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext1', version: '1.0.0', }); const ext2Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext2', version: '1.0.0', }); const extensionsToMigrate: GeminiCLIExtension[] = [ loadExtension({ extensionDir: ext1Path, workspaceDir: tempWorkspaceDir, })!, loadExtension({ extensionDir: ext2Path, workspaceDir: tempWorkspaceDir, })!, ]; const failed = await performWorkspaceExtensionMigration( extensionsToMigrate, async (_) => true, ); expect(failed).toEqual([]); const userExtensionsDir = path.join( tempHomeDir, GEMINI_DIR, 'extensions', ); const userExt1Path = path.join(userExtensionsDir, 'ext1'); const extensions = loadExtensions( new ExtensionEnablementManager(ExtensionStorage.getUserExtensionsDir()), ); expect(extensions).toHaveLength(2); const metadataPath = path.join(userExt1Path, INSTALL_METADATA_FILENAME); expect(fs.existsSync(metadataPath)).toBe(true); const metadata = JSON.parse(fs.readFileSync(metadataPath, 'utf-8')); expect(metadata).toEqual({ source: ext1Path, type: 'local', }); }); it('should return the names of failed installations', async () => { const ext1Path = createExtension({ extensionsDir: workspaceExtensionsDir, name: 'ext1', version: '1.0.0', }); const extensions: GeminiCLIExtension[] = [ loadExtension({ extensionDir: ext1Path, workspaceDir: tempWorkspaceDir, })!, { path: '/ext/path/1', name: 'ext2', version: '1.0.0', contextFiles: [], isActive: true, }, ]; const failed = await performWorkspaceExtensionMigration( extensions, async (_) => true, ); expect(failed).toEqual(['ext2']); }); }); describe('disableExtension', () => { it('should disable an extension at the user scope', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'my-extension', version: '1.0.0', }); disableExtension('my-extension', SettingScope.User); expect( isEnabled({ name: 'my-extension', configDir: userExtensionsDir, enabledForPath: tempWorkspaceDir, }), ).toBe(false); }); it('should disable an extension at the workspace scope', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'my-extension', version: '1.0.0', }); disableExtension( 'my-extension', SettingScope.Workspace, tempWorkspaceDir, ); expect( isEnabled({ name: 'my-extension', configDir: userExtensionsDir, enabledForPath: tempHomeDir, }), ).toBe(true); expect( isEnabled({ name: 'my-extension', configDir: userExtensionsDir, enabledForPath: tempWorkspaceDir, }), ).toBe(false); }); it('should handle disabling the same extension twice', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'my-extension', version: '1.0.0', }); disableExtension('my-extension', SettingScope.User); disableExtension('my-extension', SettingScope.User); expect( isEnabled({ name: 'my-extension', configDir: userExtensionsDir, enabledForPath: tempWorkspaceDir, }), ).toBe(false); }); it('should throw an error if you request system scope', () => { expect(() => disableExtension('my-extension', SettingScope.System), ).toThrow('System and SystemDefaults scopes are not supported.'); }); it('should log a disable event', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', }); disableExtension('ext1', SettingScope.Workspace); expect(mockLogExtensionDisable).toHaveBeenCalled(); expect(ExtensionDisableEvent).toHaveBeenCalledWith( 'ext1', SettingScope.Workspace, ); }); }); describe('enableExtension', () => { afterAll(() => { vi.restoreAllMocks(); }); const getActiveExtensions = (): GeminiCLIExtension[] => { const manager = new ExtensionEnablementManager( ExtensionStorage.getUserExtensionsDir(), ); const extensions = loadExtensions(manager); const activeExtensions = annotateActiveExtensions( extensions, tempWorkspaceDir, manager, ); return activeExtensions.filter((e) => e.isActive); }; it('should enable an extension at the user scope', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', }); disableExtension('ext1', SettingScope.User); let activeExtensions = getActiveExtensions(); expect(activeExtensions).toHaveLength(0); enableExtension('ext1', SettingScope.User); activeExtensions = getActiveExtensions(); expect(activeExtensions).toHaveLength(1); expect(activeExtensions[0].name).toBe('ext1'); }); it('should enable an extension at the workspace scope', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', }); disableExtension('ext1', SettingScope.Workspace); let activeExtensions = getActiveExtensions(); expect(activeExtensions).toHaveLength(0); enableExtension('ext1', SettingScope.Workspace); activeExtensions = getActiveExtensions(); expect(activeExtensions).toHaveLength(1); expect(activeExtensions[0].name).toBe('ext1'); }); it('should log an enable event', () => { createExtension({ extensionsDir: userExtensionsDir, name: 'ext1', version: '1.0.0', }); disableExtension('ext1', SettingScope.Workspace); enableExtension('ext1', SettingScope.Workspace); expect(mockLogExtensionEnable).toHaveBeenCalled(); expect(ExtensionEnableEvent).toHaveBeenCalledWith( 'ext1', SettingScope.Workspace, ); }); }); }); function isEnabled(options: { name: string; configDir: string; enabledForPath: string; }) { const manager = new ExtensionEnablementManager(options.configDir); return manager.isEnabled(options.name, options.enabledForPath); }