File size: 10,346 Bytes
9332ccf | 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 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { act } from 'react';
import { renderHook } from '../../test-utils/render.js';
import { useAuthCommand, validateAuthMethodWithSettings } from './useAuth.js';
import {
AuthType,
type Config,
ProjectIdRequiredError,
} from '@google/gemini-cli-core';
import { AuthState } from '../types.js';
import type { LoadedSettings } from '../../config/settings.js';
// Mock dependencies
const mockLoadApiKey = vi.fn();
const mockValidateAuthMethod = vi.fn();
vi.mock('@google/gemini-cli-core', async (importOriginal) => {
const actual =
await importOriginal<typeof import('@google/gemini-cli-core')>();
return {
...actual,
loadApiKey: () => mockLoadApiKey(),
};
});
vi.mock('../../config/auth.js', () => ({
validateAuthMethod: (authType: AuthType) => mockValidateAuthMethod(authType),
}));
describe('useAuth', () => {
beforeEach(() => {
vi.resetAllMocks();
delete process.env['GEMINI_API_KEY'];
delete process.env['GEMINI_DEFAULT_AUTH_TYPE'];
});
afterEach(() => {
vi.restoreAllMocks();
});
describe('validateAuthMethodWithSettings', () => {
it('should return error if auth type is enforced and does not match', async () => {
const settings = {
merged: {
security: {
auth: {
enforcedType: AuthType.LOGIN_WITH_GOOGLE,
},
},
},
} as LoadedSettings;
const error = await validateAuthMethodWithSettings(
AuthType.USE_GEMINI,
settings,
);
expect(error).toContain('Authentication is enforced to be oauth');
});
it('should return null if useExternal is true', async () => {
const settings = {
merged: {
security: {
auth: {
useExternal: true,
},
},
},
} as LoadedSettings;
const error = await validateAuthMethodWithSettings(
AuthType.LOGIN_WITH_GOOGLE,
settings,
);
expect(error).toBeNull();
});
it('should return null if authType is USE_GEMINI', async () => {
const settings = {
merged: {
security: {
auth: {},
},
},
} as LoadedSettings;
const error = await validateAuthMethodWithSettings(
AuthType.USE_GEMINI,
settings,
);
expect(error).toBeNull();
});
it('should call validateAuthMethod for other auth types', async () => {
const settings = {
merged: {
security: {
auth: {},
},
},
} as LoadedSettings;
mockValidateAuthMethod.mockResolvedValue('Validation Error');
const error = await validateAuthMethodWithSettings(
AuthType.LOGIN_WITH_GOOGLE,
settings,
);
expect(error).toBe('Validation Error');
expect(mockValidateAuthMethod).toHaveBeenCalledWith(
AuthType.LOGIN_WITH_GOOGLE,
);
});
});
describe('useAuthCommand', () => {
const mockConfig = {
refreshAuth: vi.fn(),
} as unknown as Config;
const createSettings = (selectedType?: AuthType) =>
({
merged: {
security: {
auth: {
selectedType,
},
},
},
}) as LoadedSettings;
let deferredRefreshAuth: {
resolve: () => void;
reject: (e: Error) => void;
};
beforeEach(() => {
vi.mocked(mockConfig.refreshAuth).mockImplementation(
() =>
new Promise((resolve, reject) => {
deferredRefreshAuth = { resolve, reject };
}),
);
});
it('should initialize with Unauthenticated state', async () => {
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
// Because we defer refreshAuth, the initial state is safely caught here
expect(result.current.authState).toBe(AuthState.Unauthenticated);
await act(async () => {
deferredRefreshAuth.resolve();
});
expect(result.current.authState).toBe(AuthState.Authenticated);
});
it('should set error if no auth type is selected and no env key', async () => {
const { result } = await renderHook(() =>
useAuthCommand(createSettings(undefined), mockConfig),
);
// This happens synchronously, no deferred promise
expect(result.current.authError).toBe(
'No authentication method selected.',
);
expect(result.current.authState).toBe(AuthState.Updating);
});
it('should set error if no auth type is selected but env key exists', async () => {
process.env['GEMINI_API_KEY'] = 'env-key';
const { result } = await renderHook(() =>
useAuthCommand(createSettings(undefined), mockConfig),
);
expect(result.current.authError).toContain(
'Existing API key detected (GEMINI_API_KEY)',
);
expect(result.current.authState).toBe(AuthState.Updating);
});
it('should transition to AwaitingApiKeyInput if USE_GEMINI and no key found', async () => {
let deferredLoadKey: { resolve: (k: string | null) => void };
mockLoadApiKey.mockImplementation(
() =>
new Promise((resolve) => {
deferredLoadKey = { resolve };
}),
);
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.USE_GEMINI), mockConfig),
);
await act(async () => {
deferredLoadKey.resolve(null);
});
expect(result.current.authState).toBe(AuthState.AwaitingApiKeyInput);
});
it('should authenticate if USE_GEMINI and key is found', async () => {
let deferredLoadKey: { resolve: (k: string | null) => void };
mockLoadApiKey.mockImplementation(
() =>
new Promise((resolve) => {
deferredLoadKey = { resolve };
}),
);
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.USE_GEMINI), mockConfig),
);
await act(async () => {
deferredLoadKey.resolve('stored-key');
});
await act(async () => {
deferredRefreshAuth.resolve();
});
expect(mockConfig.refreshAuth).toHaveBeenCalledWith(AuthType.USE_GEMINI);
expect(result.current.authState).toBe(AuthState.Authenticated);
expect(result.current.apiKeyDefaultValue).toBe('stored-key');
});
it('should authenticate if USE_GEMINI and env key is found', async () => {
process.env['GEMINI_API_KEY'] = 'env-key';
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.USE_GEMINI), mockConfig),
);
await act(async () => {
deferredRefreshAuth.resolve();
});
expect(mockConfig.refreshAuth).toHaveBeenCalledWith(AuthType.USE_GEMINI);
expect(result.current.authState).toBe(AuthState.Authenticated);
expect(result.current.apiKeyDefaultValue).toBe('env-key');
});
it('should prioritize env key over stored key when both are present', async () => {
process.env['GEMINI_API_KEY'] = 'env-key';
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.USE_GEMINI), mockConfig),
);
await act(async () => {
deferredRefreshAuth.resolve();
});
expect(mockConfig.refreshAuth).toHaveBeenCalledWith(AuthType.USE_GEMINI);
expect(result.current.authState).toBe(AuthState.Authenticated);
expect(result.current.apiKeyDefaultValue).toBe('env-key');
});
it('should set error if validation fails', async () => {
mockValidateAuthMethod.mockResolvedValue('Validation Failed');
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
expect(result.current.authError).toBe('Validation Failed');
expect(result.current.authState).toBe(AuthState.Updating);
});
it('should set error if GEMINI_DEFAULT_AUTH_TYPE is invalid', async () => {
process.env['GEMINI_DEFAULT_AUTH_TYPE'] = 'INVALID_TYPE';
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
expect(result.current.authError).toContain(
'Invalid value for GEMINI_DEFAULT_AUTH_TYPE',
);
expect(result.current.authState).toBe(AuthState.Updating);
});
it('should authenticate successfully for valid auth type', async () => {
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
await act(async () => {
deferredRefreshAuth.resolve();
});
expect(mockConfig.refreshAuth).toHaveBeenCalledWith(
AuthType.LOGIN_WITH_GOOGLE,
);
expect(result.current.authState).toBe(AuthState.Authenticated);
expect(result.current.authError).toBeNull();
});
it('should handle refreshAuth failure', async () => {
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
await act(async () => {
deferredRefreshAuth.reject(new Error('Auth Failed'));
});
expect(result.current.authError).toContain('Failed to sign in');
expect(result.current.authState).toBe(AuthState.Updating);
});
it('should handle ProjectIdRequiredError without "Failed to login" prefix', async () => {
const projectIdError = new ProjectIdRequiredError();
const { result } = await renderHook(() =>
useAuthCommand(createSettings(AuthType.LOGIN_WITH_GOOGLE), mockConfig),
);
await act(async () => {
deferredRefreshAuth.reject(projectIdError);
});
expect(result.current.authError).toBe(
'This account requires setting the GOOGLE_CLOUD_PROJECT or GOOGLE_CLOUD_PROJECT_ID env var. See https://goo.gle/gemini-cli-auth-docs#workspace-gca',
);
expect(result.current.authError).not.toContain('Failed to login');
expect(result.current.authState).toBe(AuthState.Updating);
});
});
});
|