File size: 6,776 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 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import * as fs from 'node:fs';
import * as path from 'node:path';
import * as os from 'node:os';
import { ExtensionManager } from './extension-manager.js';
import { createTestMergedSettings } from './settings.js';
import { cleanupTmpDir } from '@google/gemini-cli-test-utils';
import {
loadAgentsFromDirectory,
loadSkillsFromDir,
} from '@google/gemini-cli-core';
let currentTempHome = '';
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
homedir: () => currentTempHome,
debugLogger: {
log: vi.fn(),
error: vi.fn(),
warn: vi.fn(),
},
loadAgentsFromDirectory: vi.fn().mockImplementation(async () => ({
agents: [],
errors: [],
})),
loadSkillsFromDir: vi.fn().mockImplementation(async () => []),
};
});
describe('ExtensionManager Settings Scope', () => {
const extensionName = 'test-extension';
let tempWorkspace: string;
let extensionsDir: string;
let extensionDir: string;
beforeEach(async () => {
vi.mocked(loadAgentsFromDirectory).mockResolvedValue({
agents: [],
errors: [],
});
vi.mocked(loadSkillsFromDir).mockResolvedValue([]);
currentTempHome = fs.mkdtempSync(
path.join(os.tmpdir(), 'gemini-cli-test-home-'),
);
tempWorkspace = fs.mkdtempSync(
path.join(os.tmpdir(), 'gemini-cli-test-workspace-'),
);
extensionsDir = path.join(currentTempHome, '.gemini', 'extensions');
extensionDir = path.join(extensionsDir, extensionName);
fs.mkdirSync(extensionDir, { recursive: true });
// Create gemini-extension.json
const extensionConfig = {
name: extensionName,
version: '1.0.0',
settings: [
{
name: 'Test Setting',
envVar: 'TEST_SETTING',
description: 'A test setting',
},
],
};
fs.writeFileSync(
path.join(extensionDir, 'gemini-extension.json'),
JSON.stringify(extensionConfig),
);
// Create install metadata
const installMetadata = {
source: extensionDir,
type: 'local',
};
fs.writeFileSync(
path.join(extensionDir, 'install-metadata.json'),
JSON.stringify(installMetadata),
);
});
afterEach(async () => {
await cleanupTmpDir(currentTempHome);
await cleanupTmpDir(tempWorkspace);
vi.clearAllMocks();
});
it('should prioritize workspace settings over user settings and report correct scope', async () => {
// 1. Set User Setting
const userSettingsPath = path.join(extensionDir, '.env');
fs.writeFileSync(userSettingsPath, 'TEST_SETTING=user-value');
// 2. Set Workspace Setting
const workspaceSettingsPath = path.join(tempWorkspace, '.env');
fs.writeFileSync(workspaceSettingsPath, 'TEST_SETTING=workspace-value');
const extensionManager = new ExtensionManager({
workspaceDir: tempWorkspace,
requestConsent: async () => true,
requestSetting: async () => '',
settings: createTestMergedSettings({
telemetry: { enabled: false },
experimental: { extensionConfig: true },
security: { folderTrust: { enabled: false } },
}),
});
const extensions = await extensionManager.loadExtensions();
const extension = extensions.find((e) => e.name === extensionName);
expect(extension).toBeDefined();
// Verify resolved settings
const setting = extension?.resolvedSettings?.find(
(s) => s.envVar === 'TEST_SETTING',
);
expect(setting).toBeDefined();
expect(setting?.value).toBe('workspace-value');
expect(setting?.scope).toBe('workspace');
expect(setting?.source).toBe(workspaceSettingsPath);
// Verify output string contains (Workspace - <path>)
const output = extensionManager.toOutputString(extension!);
expect(output).toContain(
`Test Setting: workspace-value (Workspace - ${workspaceSettingsPath})`,
);
});
it('should fallback to user settings if workspace setting is missing', async () => {
// 1. Set User Setting
const userSettingsPath = path.join(extensionDir, '.env');
fs.writeFileSync(userSettingsPath, 'TEST_SETTING=user-value');
// 2. No Workspace Setting
const extensionManager = new ExtensionManager({
workspaceDir: tempWorkspace,
requestConsent: async () => true,
requestSetting: async () => '',
settings: createTestMergedSettings({
telemetry: { enabled: false },
experimental: { extensionConfig: true },
security: { folderTrust: { enabled: false } },
}),
});
const extensions = await extensionManager.loadExtensions();
const extension = extensions.find((e) => e.name === extensionName);
expect(extension).toBeDefined();
// Verify resolved settings
const setting = extension?.resolvedSettings?.find(
(s) => s.envVar === 'TEST_SETTING',
);
expect(setting).toBeDefined();
expect(setting?.value).toBe('user-value');
expect(setting?.scope).toBe('user');
expect(setting?.source?.endsWith(path.join(extensionName, '.env'))).toBe(
true,
);
// Verify output string contains (User - <path>)
const output = extensionManager.toOutputString(extension!);
expect(output).toContain(
`Test Setting: user-value (User - ${userSettingsPath})`,
);
});
it('should report unset if neither is present', async () => {
// No settings files
const extensionManager = new ExtensionManager({
workspaceDir: tempWorkspace,
requestConsent: async () => true,
requestSetting: async () => '',
settings: createTestMergedSettings({
telemetry: { enabled: false },
experimental: { extensionConfig: true },
security: { folderTrust: { enabled: false } },
}),
});
const extensions = await extensionManager.loadExtensions();
const extension = extensions.find((e) => e.name === extensionName);
expect(extension).toBeDefined();
// Verify resolved settings
const setting = extension?.resolvedSettings?.find(
(s) => s.envVar === 'TEST_SETTING',
);
expect(setting).toBeDefined();
expect(setting?.value).toBeUndefined();
expect(setting?.scope).toBeUndefined();
// Verify output string does not contain scope
const output = extensionManager.toOutputString(extension!);
expect(output).toContain('Test Setting: [not set]');
expect(output).not.toContain('Test Setting: [not set] (User)');
expect(output).not.toContain('Test Setting: [not set] (Workspace)');
});
});
|