mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-05-13 05:12:55 -07:00
Simplify auth in interactive tests. (#10921)
This commit is contained in:
committed by
GitHub
parent
a6e00d9183
commit
a64bb433b0
@@ -21,8 +21,7 @@ describe('Interactive Mode', () => {
|
|||||||
it('should trigger chat compression with /compress command', async () => {
|
it('should trigger chat compression with /compress command', async () => {
|
||||||
await rig.setup('interactive-compress-test');
|
await rig.setup('interactive-compress-test');
|
||||||
|
|
||||||
const { ptyProcess } = rig.runInteractive();
|
const ptyProcess = await rig.runInteractive();
|
||||||
await rig.ensureReadyForInput(ptyProcess);
|
|
||||||
|
|
||||||
const longPrompt =
|
const longPrompt =
|
||||||
'Dont do anything except returning a 1000 token long paragragh with the <name of the scientist who discovered theory of relativity> at the end to indicate end of response. This is a moderately long sentence.';
|
'Dont do anything except returning a 1000 token long paragragh with the <name of the scientist who discovered theory of relativity> at the end to indicate end of response. This is a moderately long sentence.';
|
||||||
@@ -50,18 +49,12 @@ describe('Interactive Mode', () => {
|
|||||||
it.skip('should handle compression failure on token inflation', async () => {
|
it.skip('should handle compression failure on token inflation', async () => {
|
||||||
await rig.setup('interactive-compress-test');
|
await rig.setup('interactive-compress-test');
|
||||||
|
|
||||||
const { ptyProcess } = rig.runInteractive();
|
const ptyProcess = await rig.runInteractive();
|
||||||
await rig.ensureReadyForInput(ptyProcess);
|
|
||||||
|
|
||||||
await type(ptyProcess, '/compress');
|
await type(ptyProcess, '/compress');
|
||||||
await new Promise((resolve) => setTimeout(resolve, 100));
|
await new Promise((resolve) => setTimeout(resolve, 100));
|
||||||
await type(ptyProcess, '\r');
|
await type(ptyProcess, '\r');
|
||||||
|
|
||||||
const compressionFailed = await rig.waitForText(
|
await rig.waitForText('compression was not beneficial', 25000);
|
||||||
'compression was not beneficial',
|
|
||||||
25000,
|
|
||||||
);
|
|
||||||
|
|
||||||
expect(compressionFailed).toBe(true);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -7,33 +7,36 @@
|
|||||||
import { describe, it, expect } from 'vitest';
|
import { describe, it, expect } from 'vitest';
|
||||||
import * as os from 'node:os';
|
import * as os from 'node:os';
|
||||||
import { TestRig } from './test-helper.js';
|
import { TestRig } from './test-helper.js';
|
||||||
|
import * as pty from '@lydell/node-pty';
|
||||||
|
|
||||||
|
function waitForExit(ptyProcess: pty.IPty): Promise<number> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const timer = setTimeout(
|
||||||
|
() =>
|
||||||
|
reject(
|
||||||
|
new Error(`Test timed out: process did not exit within a minute.`),
|
||||||
|
),
|
||||||
|
60000,
|
||||||
|
);
|
||||||
|
ptyProcess.onExit(({ exitCode }) => {
|
||||||
|
clearTimeout(timer);
|
||||||
|
resolve(exitCode);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
describe('Ctrl+C exit', () => {
|
describe('Ctrl+C exit', () => {
|
||||||
it('should exit gracefully on second Ctrl+C', async () => {
|
it('should exit gracefully on second Ctrl+C', async () => {
|
||||||
const rig = new TestRig();
|
const rig = new TestRig();
|
||||||
await rig.setup('should exit gracefully on second Ctrl+C');
|
await rig.setup('should exit gracefully on second Ctrl+C');
|
||||||
|
|
||||||
const { ptyProcess, promise } = rig.runInteractive();
|
const ptyProcess = await rig.runInteractive();
|
||||||
|
|
||||||
let output = '';
|
|
||||||
ptyProcess.onData((data) => {
|
|
||||||
output += data;
|
|
||||||
});
|
|
||||||
|
|
||||||
// Wait for the app to be ready by looking for the initial prompt indicator
|
|
||||||
await rig.poll(() => output.includes('▶'), 5000, 100);
|
|
||||||
|
|
||||||
// Send first Ctrl+C
|
// Send first Ctrl+C
|
||||||
ptyProcess.write('\x03');
|
ptyProcess.write('\x03');
|
||||||
|
|
||||||
// Wait for the exit prompt
|
await rig.waitForText('Press Ctrl+C again to exit', 5000);
|
||||||
await rig.poll(
|
|
||||||
() => output.includes('Press Ctrl+C again to exit'),
|
|
||||||
1500,
|
|
||||||
50,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Send second Ctrl+C
|
|
||||||
if (os.platform() === 'win32') {
|
if (os.platform() === 'win32') {
|
||||||
// This is a workaround for node-pty/winpty on Windows.
|
// This is a workaround for node-pty/winpty on Windows.
|
||||||
// Reliably sending a second Ctrl+C signal to a process that is already
|
// Reliably sending a second Ctrl+C signal to a process that is already
|
||||||
@@ -44,50 +47,21 @@ describe('Ctrl+C exit', () => {
|
|||||||
// simulating a successful exit. We accept that we cannot test the
|
// simulating a successful exit. We accept that we cannot test the
|
||||||
// graceful shutdown message on Windows in this automated context.
|
// graceful shutdown message on Windows in this automated context.
|
||||||
ptyProcess.kill();
|
ptyProcess.kill();
|
||||||
} else {
|
|
||||||
// On Unix-like systems, send the second Ctrl+C to trigger the graceful exit.
|
|
||||||
ptyProcess.write('\x03');
|
|
||||||
}
|
|
||||||
|
|
||||||
const timeout = new Promise((_, reject) =>
|
const exitCode = await waitForExit(ptyProcess);
|
||||||
setTimeout(
|
|
||||||
() =>
|
|
||||||
reject(
|
|
||||||
new Error(
|
|
||||||
`Test timed out: process did not exit within a minute. Output: ${output}`,
|
|
||||||
),
|
|
||||||
),
|
|
||||||
60000,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
|
|
||||||
const result = await Promise.race([promise, timeout]);
|
|
||||||
|
|
||||||
// On Windows, killing the process may result in a non-zero exit code. On
|
|
||||||
// other platforms, a graceful exit is code 0.
|
|
||||||
if (os.platform() === 'win32') {
|
|
||||||
// On Windows, the exit code after ptyProcess.kill() can be unpredictable
|
// On Windows, the exit code after ptyProcess.kill() can be unpredictable
|
||||||
// (often 1), so we accept any non-null exit code as a pass condition,
|
// (often 1), so we accept any non-null exit code as a pass condition,
|
||||||
// focusing on the fact that the process did terminate.
|
// focusing on the fact that the process did terminate.
|
||||||
expect(
|
expect(exitCode, `Process exited with code ${exitCode}.`).not.toBeNull();
|
||||||
result.exitCode,
|
return;
|
||||||
`Process exited with code ${result.exitCode}. Output: ${result.output}`,
|
|
||||||
).not.toBeNull();
|
|
||||||
} else {
|
|
||||||
// Expect a graceful exit (code 0) on non-Windows platforms
|
|
||||||
expect(
|
|
||||||
result.exitCode,
|
|
||||||
`Process exited with code ${result.exitCode}. Output: ${result.output}`,
|
|
||||||
).toBe(0);
|
|
||||||
|
|
||||||
// Only check for the quitting message on non-Windows platforms due to the
|
|
||||||
// forceful kill workaround.
|
|
||||||
const quittingMessage = 'Agent powering down. Goodbye!';
|
|
||||||
// The regex below is intentionally matching the ESC control character (\x1b)
|
|
||||||
// to strip ANSI color codes from the terminal output.
|
|
||||||
// eslint-disable-next-line no-control-regex
|
|
||||||
const cleanOutput = output.replace(/\x1b\[[0-9;]*m/g, '');
|
|
||||||
expect(cleanOutput).toContain(quittingMessage);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Send second Ctrl+C
|
||||||
|
ptyProcess.write('\x03');
|
||||||
|
|
||||||
|
const exitCode = await waitForExit(ptyProcess);
|
||||||
|
expect(exitCode, `Process exited with code ${exitCode}.`).toBe(0);
|
||||||
|
|
||||||
|
await rig.waitForText('Agent powering down. Goodbye!', 5000);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -23,23 +23,7 @@ describe('Interactive file system', () => {
|
|||||||
rig.setup('interactive-read-then-write');
|
rig.setup('interactive-read-then-write');
|
||||||
rig.createFile(fileName, '1.0.0');
|
rig.createFile(fileName, '1.0.0');
|
||||||
|
|
||||||
const { ptyProcess } = rig.runInteractive();
|
const ptyProcess = await rig.runInteractive();
|
||||||
|
|
||||||
const authDialogAppeared = await rig.waitForText(
|
|
||||||
'How would you like to authenticate',
|
|
||||||
5000,
|
|
||||||
);
|
|
||||||
|
|
||||||
// select the second option if auth dialog come's up
|
|
||||||
if (authDialogAppeared) {
|
|
||||||
ptyProcess.write('2');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wait for the app to be ready
|
|
||||||
const isReady = await rig.waitForText('Type your message', 30000);
|
|
||||||
expect(isReady, 'CLI did not start up in interactive mode correctly').toBe(
|
|
||||||
true,
|
|
||||||
);
|
|
||||||
|
|
||||||
// Step 1: Read the file
|
// Step 1: Read the file
|
||||||
const readPrompt = `Read the version from ${fileName}`;
|
const readPrompt = `Read the version from ${fileName}`;
|
||||||
@@ -49,11 +33,7 @@ describe('Interactive file system', () => {
|
|||||||
const readCall = await rig.waitForToolCall('read_file', 30000);
|
const readCall = await rig.waitForToolCall('read_file', 30000);
|
||||||
expect(readCall, 'Expected to find a read_file tool call').toBe(true);
|
expect(readCall, 'Expected to find a read_file tool call').toBe(true);
|
||||||
|
|
||||||
const containsExpectedVersion = await rig.waitForText('1.0.0', 30000);
|
await rig.waitForText('1.0.0', 30000);
|
||||||
expect(
|
|
||||||
containsExpectedVersion,
|
|
||||||
'Expected to see version "1.0.0" in output',
|
|
||||||
).toBe(true);
|
|
||||||
|
|
||||||
// Step 2: Write the file
|
// Step 2: Write the file
|
||||||
const writePrompt = `now change the version to 1.0.1 in the file`;
|
const writePrompt = `now change the version to 1.0.1 in the file`;
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
* SPDX-License-Identifier: Apache-2.0
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
import { expect } from 'vitest';
|
||||||
import { execSync, spawn } from 'node:child_process';
|
import { execSync, spawn } from 'node:child_process';
|
||||||
import { mkdirSync, writeFileSync, readFileSync } from 'node:fs';
|
import { mkdirSync, writeFileSync, readFileSync } from 'node:fs';
|
||||||
import { join, dirname } from 'node:path';
|
import { join, dirname } from 'node:path';
|
||||||
@@ -189,6 +190,11 @@ export class TestRig {
|
|||||||
otlpEndpoint: '',
|
otlpEndpoint: '',
|
||||||
outfile: telemetryPath,
|
outfile: telemetryPath,
|
||||||
},
|
},
|
||||||
|
security: {
|
||||||
|
auth: {
|
||||||
|
selectedType: 'gemini-api-key',
|
||||||
|
},
|
||||||
|
},
|
||||||
model: DEFAULT_GEMINI_MODEL,
|
model: DEFAULT_GEMINI_MODEL,
|
||||||
sandbox: env.GEMINI_SANDBOX !== 'false' ? env.GEMINI_SANDBOX : false,
|
sandbox: env.GEMINI_SANDBOX !== 'false' ? env.GEMINI_SANDBOX : false,
|
||||||
...options.settings, // Allow tests to override/add settings
|
...options.settings, // Allow tests to override/add settings
|
||||||
@@ -801,11 +807,11 @@ export class TestRig {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
async waitForText(text: string, timeout?: number): Promise<boolean> {
|
async waitForText(text: string, timeout?: number) {
|
||||||
if (!timeout) {
|
if (!timeout) {
|
||||||
timeout = this.getDefaultTimeout();
|
timeout = this.getDefaultTimeout();
|
||||||
}
|
}
|
||||||
return this.poll(
|
const found = await this.poll(
|
||||||
() =>
|
() =>
|
||||||
stripAnsi(this._interactiveOutput)
|
stripAnsi(this._interactiveOutput)
|
||||||
.toLowerCase()
|
.toLowerCase()
|
||||||
@@ -813,12 +819,10 @@ export class TestRig {
|
|||||||
timeout,
|
timeout,
|
||||||
200,
|
200,
|
||||||
);
|
);
|
||||||
|
expect(found, `Did not find expected text: "${text}"`).toBe(true);
|
||||||
}
|
}
|
||||||
|
|
||||||
runInteractive(...args: string[]): {
|
async runInteractive(...args: string[]): Promise<pty.IPty> {
|
||||||
ptyProcess: pty.IPty;
|
|
||||||
promise: Promise<{ exitCode: number; signal?: number; output: string }>;
|
|
||||||
} {
|
|
||||||
const { command, initialArgs } = this._getCommandAndArgs(['--yolo']);
|
const { command, initialArgs } = this._getCommandAndArgs(['--yolo']);
|
||||||
const commandArgs = [...initialArgs, ...args];
|
const commandArgs = [...initialArgs, ...args];
|
||||||
const isWindows = os.platform() === 'win32';
|
const isWindows = os.platform() === 'win32';
|
||||||
@@ -850,60 +854,9 @@ export class TestRig {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const promise = new Promise<{
|
// Wait for the app to be ready
|
||||||
exitCode: number;
|
await this.waitForText('Type your message', 30000);
|
||||||
signal?: number;
|
|
||||||
output: string;
|
|
||||||
}>((resolve) => {
|
|
||||||
ptyProcess.onExit(({ exitCode, signal }) => {
|
|
||||||
resolve({ exitCode, signal, output: this._interactiveOutput });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
return { ptyProcess, promise };
|
return ptyProcess;
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Waits for an interactive session to be fully ready for input.
|
|
||||||
* This is a higher-level utility to be used with `runInteractive`.
|
|
||||||
*
|
|
||||||
* It handles the initial setup boilerplate:
|
|
||||||
* 1. Automatically handles the authentication prompt if it appears.
|
|
||||||
* 2. Waits for the "Type your message" prompt to ensure the CLI is ready for input.
|
|
||||||
*
|
|
||||||
* Throws an error if the session fails to become ready within the timeout.
|
|
||||||
*
|
|
||||||
* @param ptyProcess The process returned from `runInteractive`.
|
|
||||||
*/
|
|
||||||
async ensureReadyForInput(ptyProcess: pty.IPty): Promise<void> {
|
|
||||||
const timeout = 25000;
|
|
||||||
const pollingInterval = 200;
|
|
||||||
const startTime = Date.now();
|
|
||||||
let authPromptHandled = false;
|
|
||||||
|
|
||||||
while (Date.now() - startTime < timeout) {
|
|
||||||
const output = stripAnsi(this._interactiveOutput).toLowerCase();
|
|
||||||
|
|
||||||
// If the ready prompt appears, we're done.
|
|
||||||
if (output.includes('type your message')) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the auth prompt appears and we haven't handled it yet.
|
|
||||||
if (
|
|
||||||
!authPromptHandled &&
|
|
||||||
output.includes('how would you like to authenticate')
|
|
||||||
) {
|
|
||||||
ptyProcess.write('2');
|
|
||||||
authPromptHandled = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wait for the next poll.
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, pollingInterval));
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error(
|
|
||||||
`CLI did not start up in interactive mode correctly. Output: ${this._interactiveOutput}`,
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user