mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-19 18:40:57 -07:00
[Extension Reloading]: Update custom commands, add enable/disable command (#12547)
This commit is contained in:
@@ -7,10 +7,16 @@
|
||||
import type { GeminiCLIExtension } from '@google/gemini-cli-core';
|
||||
import { createMockCommandContext } from '../../test-utils/mockCommandContext.js';
|
||||
import { MessageType } from '../types.js';
|
||||
import { extensionsCommand } from './extensionsCommand.js';
|
||||
import { type CommandContext } from './types.js';
|
||||
import {
|
||||
completeExtensions,
|
||||
completeExtensionsAndScopes,
|
||||
extensionsCommand,
|
||||
} from './extensionsCommand.js';
|
||||
import { type CommandContext, type SlashCommand } from './types.js';
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import { type ExtensionUpdateAction } from '../state/extensions.js';
|
||||
import { ExtensionManager } from '../../config/extension-manager.js';
|
||||
import { SettingScope } from '../../config/settings.js';
|
||||
|
||||
import open from 'open';
|
||||
vi.mock('open', () => ({
|
||||
@@ -22,20 +28,72 @@ vi.mock('../../config/extensions/update.js', () => ({
|
||||
checkForAllExtensionUpdates: vi.fn(),
|
||||
}));
|
||||
|
||||
const mockDisableExtension = vi.fn();
|
||||
const mockEnableExtension = vi.fn();
|
||||
const mockGetExtensions = vi.fn();
|
||||
|
||||
const inactiveExt: GeminiCLIExtension = {
|
||||
name: 'ext-one',
|
||||
id: 'ext-one-id',
|
||||
version: '1.0.0',
|
||||
isActive: false, // should suggest disabled extensions
|
||||
path: '/test/dir/ext-one',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
const activeExt: GeminiCLIExtension = {
|
||||
name: 'ext-two',
|
||||
id: 'ext-two-id',
|
||||
version: '1.0.0',
|
||||
isActive: true, // should not suggest enabled extensions
|
||||
path: '/test/dir/ext-two',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
const allExt: GeminiCLIExtension = {
|
||||
name: 'all-ext',
|
||||
id: 'all-ext-id',
|
||||
version: '1.0.0',
|
||||
isActive: true,
|
||||
path: '/test/dir/all-ext',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
|
||||
describe('extensionsCommand', () => {
|
||||
let mockContext: CommandContext;
|
||||
const mockDispatchExtensionState = vi.fn();
|
||||
|
||||
beforeEach(() => {
|
||||
vi.resetAllMocks();
|
||||
mockGetExtensions.mockReturnValue([]);
|
||||
|
||||
mockGetExtensions.mockReturnValue([inactiveExt, activeExt, allExt]);
|
||||
vi.mocked(open).mockClear();
|
||||
mockContext = createMockCommandContext({
|
||||
services: {
|
||||
config: {
|
||||
getExtensions: mockGetExtensions,
|
||||
getExtensionLoader: vi.fn().mockImplementation(() => {
|
||||
const actual = Object.create(ExtensionManager.prototype);
|
||||
Object.assign(actual, {
|
||||
enableExtension: mockEnableExtension,
|
||||
disableExtension: mockDisableExtension,
|
||||
getExtensions: mockGetExtensions,
|
||||
});
|
||||
return actual;
|
||||
}),
|
||||
getWorkingDir: () => '/test/dir',
|
||||
},
|
||||
},
|
||||
@@ -52,8 +110,9 @@ describe('extensionsCommand', () => {
|
||||
|
||||
describe('list', () => {
|
||||
it('should add an EXTENSIONS_LIST item to the UI', async () => {
|
||||
if (!extensionsCommand.action) throw new Error('Action not defined');
|
||||
await extensionsCommand.action(mockContext, '');
|
||||
const command = extensionsCommand();
|
||||
if (!command.action) throw new Error('Action not defined');
|
||||
await command.action(mockContext, '');
|
||||
|
||||
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
|
||||
{
|
||||
@@ -65,8 +124,68 @@ describe('extensionsCommand', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('completeExtensions', () => {
|
||||
it.each([
|
||||
{
|
||||
description: 'should return matching extension names',
|
||||
partialArg: 'ext',
|
||||
expected: ['ext-one', 'ext-two'],
|
||||
},
|
||||
{
|
||||
description: 'should return --all when partialArg matches',
|
||||
partialArg: '--al',
|
||||
expected: ['--all'],
|
||||
},
|
||||
{
|
||||
description:
|
||||
'should return both extension names and --all when both match',
|
||||
partialArg: 'all',
|
||||
expected: ['--all', 'all-ext'],
|
||||
},
|
||||
{
|
||||
description: 'should return an empty array if no matches',
|
||||
partialArg: 'nomatch',
|
||||
expected: [],
|
||||
},
|
||||
{
|
||||
description:
|
||||
'should suggest only disabled extension names for the enable command',
|
||||
partialArg: 'ext',
|
||||
expected: ['ext-one'],
|
||||
command: 'enable',
|
||||
},
|
||||
{
|
||||
description:
|
||||
'should suggest only enabled extension names for the disable command',
|
||||
partialArg: 'ext',
|
||||
expected: ['ext-two'],
|
||||
command: 'disable',
|
||||
},
|
||||
])('$description', async ({ partialArg, expected, command }) => {
|
||||
if (command) {
|
||||
mockContext.invocation!.name = command;
|
||||
}
|
||||
const suggestions = completeExtensions(mockContext, partialArg);
|
||||
expect(suggestions).toEqual(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('completeExtensionsAndScopes', () => {
|
||||
it('expands the list of suggestions with --scope args', () => {
|
||||
const suggestions = completeExtensionsAndScopes(mockContext, 'ext');
|
||||
expect(suggestions).toEqual([
|
||||
'ext-one --scope user',
|
||||
'ext-one --scope workspace',
|
||||
'ext-one --scope session',
|
||||
'ext-two --scope user',
|
||||
'ext-two --scope workspace',
|
||||
'ext-two --scope session',
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('update', () => {
|
||||
const updateAction = extensionsCommand.subCommands?.find(
|
||||
const updateAction = extensionsCommand().subCommands?.find(
|
||||
(cmd) => cmd.name === 'update',
|
||||
)?.action;
|
||||
|
||||
@@ -230,92 +349,10 @@ describe('extensionsCommand', () => {
|
||||
expect.any(Number),
|
||||
);
|
||||
});
|
||||
|
||||
describe('completion', () => {
|
||||
const updateCompletion = extensionsCommand.subCommands?.find(
|
||||
(cmd) => cmd.name === 'update',
|
||||
)?.completion;
|
||||
|
||||
if (!updateCompletion) {
|
||||
throw new Error('Update completion not found');
|
||||
}
|
||||
|
||||
const extensionOne: GeminiCLIExtension = {
|
||||
name: 'ext-one',
|
||||
id: 'ext-one-id',
|
||||
version: '1.0.0',
|
||||
isActive: true,
|
||||
path: '/test/dir/ext-one',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
const extensionTwo: GeminiCLIExtension = {
|
||||
name: 'another-ext',
|
||||
id: 'another-ext-id',
|
||||
version: '1.0.0',
|
||||
isActive: true,
|
||||
path: '/test/dir/another-ext',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
const allExt: GeminiCLIExtension = {
|
||||
name: 'all-ext',
|
||||
id: 'all-ext-id',
|
||||
version: '1.0.0',
|
||||
isActive: true,
|
||||
path: '/test/dir/all-ext',
|
||||
contextFiles: [],
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
autoUpdate: false,
|
||||
source: 'https://github.com/some/extension.git',
|
||||
},
|
||||
};
|
||||
|
||||
it.each([
|
||||
{
|
||||
description: 'should return matching extension names',
|
||||
extensions: [extensionOne, extensionTwo],
|
||||
partialArg: 'ext',
|
||||
expected: ['ext-one'],
|
||||
},
|
||||
{
|
||||
description: 'should return --all when partialArg matches',
|
||||
extensions: [],
|
||||
partialArg: '--al',
|
||||
expected: ['--all'],
|
||||
},
|
||||
{
|
||||
description:
|
||||
'should return both extension names and --all when both match',
|
||||
extensions: [allExt],
|
||||
partialArg: 'all',
|
||||
expected: ['--all', 'all-ext'],
|
||||
},
|
||||
{
|
||||
description: 'should return an empty array if no matches',
|
||||
extensions: [extensionOne],
|
||||
partialArg: 'nomatch',
|
||||
expected: [],
|
||||
},
|
||||
])('$description', async ({ extensions, partialArg, expected }) => {
|
||||
mockGetExtensions.mockReturnValue(extensions);
|
||||
const suggestions = await updateCompletion(mockContext, partialArg);
|
||||
expect(suggestions).toEqual(expected);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('explore', () => {
|
||||
const exploreAction = extensionsCommand.subCommands?.find(
|
||||
const exploreAction = extensionsCommand().subCommands?.find(
|
||||
(cmd) => cmd.name === 'explore',
|
||||
)?.action;
|
||||
|
||||
@@ -398,4 +435,141 @@ describe('extensionsCommand', () => {
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('when enableExtensionReloading is true', () => {
|
||||
it('should include enable and disable subcommands', () => {
|
||||
const command = extensionsCommand(true);
|
||||
const subCommandNames = command.subCommands?.map((cmd) => cmd.name);
|
||||
expect(subCommandNames).toContain('enable');
|
||||
expect(subCommandNames).toContain('disable');
|
||||
});
|
||||
});
|
||||
|
||||
describe('when enableExtensionReloading is false', () => {
|
||||
it('should not include enable and disable subcommands', () => {
|
||||
const command = extensionsCommand(false);
|
||||
const subCommandNames = command.subCommands?.map((cmd) => cmd.name);
|
||||
expect(subCommandNames).not.toContain('enable');
|
||||
expect(subCommandNames).not.toContain('disable');
|
||||
});
|
||||
});
|
||||
|
||||
describe('when enableExtensionReloading is not provided', () => {
|
||||
it('should not include enable and disable subcommands by default', () => {
|
||||
const command = extensionsCommand();
|
||||
const subCommandNames = command.subCommands?.map((cmd) => cmd.name);
|
||||
expect(subCommandNames).not.toContain('enable');
|
||||
expect(subCommandNames).not.toContain('disable');
|
||||
});
|
||||
});
|
||||
|
||||
describe('enable', () => {
|
||||
let enableAction: SlashCommand['action'];
|
||||
|
||||
beforeEach(() => {
|
||||
enableAction = extensionsCommand(true).subCommands?.find(
|
||||
(cmd) => cmd.name === 'enable',
|
||||
)?.action;
|
||||
|
||||
expect(enableAction).not.toBeNull();
|
||||
|
||||
mockContext.invocation!.name = 'enable';
|
||||
});
|
||||
|
||||
it('should show usage if no extension name is provided', async () => {
|
||||
await enableAction!(mockContext, '');
|
||||
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
|
||||
{
|
||||
type: MessageType.ERROR,
|
||||
text: 'Usage: /extensions enable <extension> [--scope=<user|workspace|session>]',
|
||||
},
|
||||
expect.any(Number),
|
||||
);
|
||||
});
|
||||
|
||||
it('should call enableExtension with the provided scope', async () => {
|
||||
await enableAction!(mockContext, `${inactiveExt.name} --scope=user`);
|
||||
expect(mockEnableExtension).toHaveBeenCalledWith(
|
||||
inactiveExt.name,
|
||||
SettingScope.User,
|
||||
);
|
||||
|
||||
await enableAction!(mockContext, `${inactiveExt.name} --scope workspace`);
|
||||
expect(mockEnableExtension).toHaveBeenCalledWith(
|
||||
inactiveExt.name,
|
||||
SettingScope.Workspace,
|
||||
);
|
||||
});
|
||||
|
||||
it('should support --all', async () => {
|
||||
mockGetExtensions.mockReturnValue([
|
||||
inactiveExt,
|
||||
{ ...inactiveExt, name: 'another-inactive-ext' },
|
||||
]);
|
||||
await enableAction!(mockContext, '--all --scope session');
|
||||
expect(mockEnableExtension).toHaveBeenCalledWith(
|
||||
inactiveExt.name,
|
||||
SettingScope.Session,
|
||||
);
|
||||
expect(mockEnableExtension).toHaveBeenCalledWith(
|
||||
'another-inactive-ext',
|
||||
SettingScope.Session,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('disable', () => {
|
||||
let disableAction: SlashCommand['action'];
|
||||
|
||||
beforeEach(() => {
|
||||
disableAction = extensionsCommand(true).subCommands?.find(
|
||||
(cmd) => cmd.name === 'disable',
|
||||
)?.action;
|
||||
|
||||
expect(disableAction).not.toBeNull();
|
||||
|
||||
mockContext.invocation!.name = 'disable';
|
||||
});
|
||||
|
||||
it('should show usage if no extension name is provided', async () => {
|
||||
await disableAction!(mockContext, '');
|
||||
expect(mockContext.ui.addItem).toHaveBeenCalledWith(
|
||||
{
|
||||
type: MessageType.ERROR,
|
||||
text: 'Usage: /extensions disable <extension> [--scope=<user|workspace|session>]',
|
||||
},
|
||||
expect.any(Number),
|
||||
);
|
||||
});
|
||||
|
||||
it('should call disableExtension with the provided scope', async () => {
|
||||
await disableAction!(mockContext, `${activeExt.name} --scope=user`);
|
||||
expect(mockDisableExtension).toHaveBeenCalledWith(
|
||||
activeExt.name,
|
||||
SettingScope.User,
|
||||
);
|
||||
|
||||
await disableAction!(mockContext, `${activeExt.name} --scope workspace`);
|
||||
expect(mockDisableExtension).toHaveBeenCalledWith(
|
||||
activeExt.name,
|
||||
SettingScope.Workspace,
|
||||
);
|
||||
});
|
||||
|
||||
it('should support --all', async () => {
|
||||
mockGetExtensions.mockReturnValue([
|
||||
activeExt,
|
||||
{ ...activeExt, name: 'another-active-ext' },
|
||||
]);
|
||||
await disableAction!(mockContext, '--all --scope session');
|
||||
expect(mockDisableExtension).toHaveBeenCalledWith(
|
||||
activeExt.name,
|
||||
SettingScope.Session,
|
||||
);
|
||||
expect(mockDisableExtension).toHaveBeenCalledWith(
|
||||
'another-active-ext',
|
||||
SettingScope.Session,
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user