mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-19 18:40:57 -07:00
refactor common settings logic for skills,agents (#17490)
Co-authored-by: ved015 <vedant.04.mahajan@gmail.com> Co-authored-by: Tommaso Sciortino <sciortino@gmail.com>
This commit is contained in:
147
packages/cli/src/utils/agentSettings.test.ts
Normal file
147
packages/cli/src/utils/agentSettings.test.ts
Normal file
@@ -0,0 +1,147 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2026 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi } from 'vitest';
|
||||
import {
|
||||
SettingScope,
|
||||
type LoadedSettings,
|
||||
type LoadableSettingScope,
|
||||
} from '../config/settings.js';
|
||||
import { enableAgent, disableAgent } from './agentSettings.js';
|
||||
|
||||
function createMockLoadedSettings(opts: {
|
||||
userSettings?: Record<string, unknown>;
|
||||
workspaceSettings?: Record<string, unknown>;
|
||||
userPath?: string;
|
||||
workspacePath?: string;
|
||||
}): LoadedSettings {
|
||||
const scopes: Record<
|
||||
string,
|
||||
{
|
||||
settings: Record<string, unknown>;
|
||||
originalSettings: Record<string, unknown>;
|
||||
path: string;
|
||||
}
|
||||
> = {
|
||||
[SettingScope.User]: {
|
||||
settings: opts.userSettings ?? {},
|
||||
originalSettings: opts.userSettings ?? {},
|
||||
path: opts.userPath ?? '/home/user/.gemini/settings.json',
|
||||
},
|
||||
[SettingScope.Workspace]: {
|
||||
settings: opts.workspaceSettings ?? {},
|
||||
originalSettings: opts.workspaceSettings ?? {},
|
||||
path: opts.workspacePath ?? '/project/.gemini/settings.json',
|
||||
},
|
||||
};
|
||||
|
||||
return {
|
||||
forScope: vi.fn((scope: LoadableSettingScope) => scopes[scope]),
|
||||
setValue: vi.fn(),
|
||||
} as unknown as LoadedSettings;
|
||||
}
|
||||
|
||||
describe('agentSettings', () => {
|
||||
describe('agentStrategy (via enableAgent / disableAgent)', () => {
|
||||
describe('enableAgent', () => {
|
||||
it('should return no-op when the agent is already enabled in both scopes', () => {
|
||||
const settings = createMockLoadedSettings({
|
||||
userSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: true } } },
|
||||
},
|
||||
workspaceSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: true } } },
|
||||
},
|
||||
});
|
||||
|
||||
const result = enableAgent(settings, 'my-agent');
|
||||
|
||||
expect(result.status).toBe('no-op');
|
||||
expect(result.action).toBe('enable');
|
||||
expect(result.agentName).toBe('my-agent');
|
||||
expect(result.modifiedScopes).toHaveLength(0);
|
||||
expect(settings.setValue).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should enable the agent when not present in any scope', () => {
|
||||
const settings = createMockLoadedSettings({
|
||||
userSettings: {},
|
||||
workspaceSettings: {},
|
||||
});
|
||||
|
||||
const result = enableAgent(settings, 'my-agent');
|
||||
|
||||
expect(result.status).toBe('success');
|
||||
expect(result.action).toBe('enable');
|
||||
expect(result.agentName).toBe('my-agent');
|
||||
expect(result.modifiedScopes).toHaveLength(2);
|
||||
expect(settings.setValue).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('should enable the agent only in the scope where it is not enabled', () => {
|
||||
const settings = createMockLoadedSettings({
|
||||
userSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: true } } },
|
||||
},
|
||||
workspaceSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: false } } },
|
||||
},
|
||||
});
|
||||
|
||||
const result = enableAgent(settings, 'my-agent');
|
||||
|
||||
expect(result.status).toBe('success');
|
||||
expect(result.modifiedScopes).toHaveLength(1);
|
||||
expect(result.modifiedScopes[0].scope).toBe(SettingScope.Workspace);
|
||||
expect(result.alreadyInStateScopes).toHaveLength(1);
|
||||
expect(result.alreadyInStateScopes[0].scope).toBe(SettingScope.User);
|
||||
expect(settings.setValue).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('disableAgent', () => {
|
||||
it('should return no-op when agent is already explicitly disabled', () => {
|
||||
const settings = createMockLoadedSettings({
|
||||
userSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: false } } },
|
||||
},
|
||||
});
|
||||
|
||||
const result = disableAgent(settings, 'my-agent', SettingScope.User);
|
||||
|
||||
expect(result.status).toBe('no-op');
|
||||
expect(result.action).toBe('disable');
|
||||
expect(result.agentName).toBe('my-agent');
|
||||
expect(settings.setValue).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should disable the agent when it is currently enabled', () => {
|
||||
const settings = createMockLoadedSettings({
|
||||
userSettings: {
|
||||
agents: { overrides: { 'my-agent': { enabled: true } } },
|
||||
},
|
||||
});
|
||||
|
||||
const result = disableAgent(settings, 'my-agent', SettingScope.User);
|
||||
|
||||
expect(result.status).toBe('success');
|
||||
expect(result.action).toBe('disable');
|
||||
expect(result.modifiedScopes).toHaveLength(1);
|
||||
expect(result.modifiedScopes[0].scope).toBe(SettingScope.User);
|
||||
expect(settings.setValue).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('should return error for an invalid scope', () => {
|
||||
const settings = createMockLoadedSettings({});
|
||||
|
||||
const result = disableAgent(settings, 'my-agent', SettingScope.Session);
|
||||
|
||||
expect(result.status).toBe('error');
|
||||
expect(result.error).toContain('Invalid settings scope');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user