Move mockTool into test-utils (#7245)

This commit is contained in:
Adam Weidman
2025-08-27 20:18:15 +00:00
committed by GitHub
parent 19f2a07efa
commit da7901acaf
10 changed files with 15 additions and 21 deletions

View File

@@ -106,6 +106,3 @@ export * from './telemetry/index.js';
export { sessionId } from './utils/session.js';
export * from './utils/browser.js';
export { Storage } from './config/storage.js';
// Export test utils
export * from './test-utils/index.js';

View File

@@ -1,7 +0,0 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
export * from './mock-tool.js';

View File

@@ -1,110 +0,0 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { vi } from 'vitest';
import type {
ToolCallConfirmationDetails,
ToolInvocation,
ToolResult,
} from '../tools/tools.js';
import {
BaseDeclarativeTool,
BaseToolInvocation,
Kind,
} from '../tools/tools.js';
type MockToolOptions = {
name: string;
displayName?: string;
description?: string;
canUpdateOutput?: boolean;
isOutputMarkdown?: boolean;
shouldConfirmExecute?: (
...args: unknown[]
) => Promise<ToolCallConfirmationDetails | false>;
execute?: (...args: unknown[]) => Promise<ToolResult>;
params?: object;
};
class MockToolInvocation extends BaseToolInvocation<
{ [key: string]: unknown },
ToolResult
> {
constructor(
private readonly tool: MockTool,
params: { [key: string]: unknown },
) {
super(params);
}
execute(
signal: AbortSignal,
updateOutput?: (output: string) => void,
terminalColumns?: number,
terminalRows?: number,
): Promise<ToolResult> {
return this.tool.execute(
this.params,
signal,
updateOutput,
terminalColumns,
terminalRows,
);
}
override shouldConfirmExecute(
abortSignal: AbortSignal,
): Promise<ToolCallConfirmationDetails | false> {
return this.tool.shouldConfirmExecute(this.params, abortSignal);
}
getDescription(): string {
return `A mock tool invocation for ${this.tool.name}`;
}
}
/**
* A highly configurable mock tool for testing purposes.
*/
export class MockTool extends BaseDeclarativeTool<
{ [key: string]: unknown },
ToolResult
> {
execute: (...args: unknown[]) => Promise<ToolResult>;
shouldConfirmExecute: (
...args: unknown[]
) => Promise<ToolCallConfirmationDetails | false>;
constructor(options: MockToolOptions) {
super(
options.name,
options.displayName ?? options.name,
options.description ?? options.name,
Kind.Other,
options.params,
options.isOutputMarkdown ?? false,
options.canUpdateOutput ?? false,
);
if (options.shouldConfirmExecute) {
this.shouldConfirmExecute = options.shouldConfirmExecute;
} else {
this.shouldConfirmExecute = vi.fn().mockResolvedValue(false);
}
if (options.execute) {
this.execute = options.execute;
} else {
this.execute = vi.fn();
}
}
protected createInvocation(params: {
[key: string]: unknown;
}): ToolInvocation<{ [key: string]: unknown }, ToolResult> {
return new MockToolInvocation(this, params);
}
}