Skip to content

test: refactor tests to reduce duplication #1926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OrKoN merged 5 commits into from
Apr 21, 2026
Merged

test: refactor tests to reduce duplication #1926

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3c31ddc
test: refactor tests to reduce duplication
nroscino Apr 21, 2026
c202819
test: decoupling common logic
nroscino Apr 21, 2026
2e2d82f
Merge branch 'main' into chore/followup-tests
nroscino Apr 21, 2026
2596656
chore: move tool file check before function call
nroscino Apr 21, 2026
cf27e94
Merge branch 'main' into chore/followup-tests
nroscino Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 58 additions & 90 deletions tests/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ import {Client} from '@modelcontextprotocol/sdk/client/index.js';
import {StdioClientTransport} from '@modelcontextprotocol/sdk/client/stdio.js';
import {executablePath} from 'puppeteer';

import {
OFF_BY_DEFAULT_CATEGORIES,
ToolCategory,
} from '../src/tools/categories.js';
import type {ToolCategory} from '../src/tools/categories.js';
import {OFF_BY_DEFAULT_CATEGORIES} from '../src/tools/categories.js';
import type {ToolDefinition} from '../src/tools/ToolDefinition.js';

describe('e2e', () => {
Expand Down Expand Up @@ -80,44 +78,7 @@ describe('e2e', () => {
async client => {
const {tools} = await client.listTools();
const exposedNames = tools.map(t => t.name).sort();
const files = fs.readdirSync('build/src/tools');
const definedNames = [];
for (const file of files) {
if (
file === 'ToolDefinition.js' ||
file === 'tools.js' ||
file === 'slim'
) {
continue;
}
const fileTools = await import(`../src/tools/${file}`);
for (const maybeTool of Object.values<unknown>(fileTools)) {
if (typeof maybeTool === 'function') {
const tool = (maybeTool as (val: boolean) => ToolDefinition)(
false,
);
if (tool && typeof tool === 'object' && 'name' in tool) {
if (tool.annotations?.conditions) {
continue;
}
definedNames.push(tool.name);
}
continue;
}
if (
typeof maybeTool === 'object' &&
maybeTool !== null &&
'name' in maybeTool
) {
const tool = maybeTool as ToolDefinition;
if (tool.annotations?.conditions) {
continue;
}
definedNames.push(tool.name);
}
}
}

const definedNames = await getToolsWithFilteredCategories();
definedNames.sort();
assert.deepStrictEqual(exposedNames, definedNames);
},
Expand All @@ -129,54 +90,9 @@ describe('e2e', () => {
await withClient(async client => {
const {tools} = await client.listTools();
const exposedNames = tools.map(t => t.name).sort();
const files = fs.readdirSync('build/src/tools');
const definedNames = [];
for (const file of files) {
if (
file === 'ToolDefinition.js' ||
file === 'tools.js' ||
file === 'slim'
) {
continue;
}
const fileTools = await import(`../src/tools/${file}`);
for (const maybeTool of Object.values<unknown>(fileTools)) {
if (typeof maybeTool === 'function') {
const tool = (maybeTool as (val: boolean) => ToolDefinition)(false);
if (tool && typeof tool === 'object' && 'name' in tool) {
if (tool.annotations?.conditions) {
continue;
}
if (
tool.annotations?.category &&
tool.annotations?.category === ToolCategory.EXTENSIONS
) {
continue;
}
definedNames.push(tool.name);
}
continue;
}
if (
typeof maybeTool === 'object' &&
maybeTool !== null &&
'name' in maybeTool
) {
const tool = maybeTool as ToolDefinition;
if (tool.annotations?.conditions) {
continue;
}
if (
tool.annotations?.category &&
tool.annotations?.category === ToolCategory.EXTENSIONS
) {
continue;
}
definedNames.push(tool.name);
}
}
}

const definedNames = await getToolsWithFilteredCategories(
OFF_BY_DEFAULT_CATEGORIES,
);
definedNames.sort();
assert.deepStrictEqual(exposedNames, definedNames);
});
Expand Down Expand Up @@ -245,3 +161,55 @@ describe('e2e', () => {
);
});
});

async function getToolsWithFilteredCategories(
filterOutCategories: ToolCategory[] = [],
): Promise<string[]> {
const files = fs.readdirSync('build/src/tools');
const definedNames = [];
for (const file of files) {
if (
file === 'ToolDefinition.js' ||
file === 'tools.js' ||
file === 'slim'
) {
continue;
}
const fileTools = await import(`../src/tools/${file}`);
for (const maybeTool of Object.values<unknown>(fileTools)) {
let tool;
if (typeof maybeTool === 'function') {
tool = (maybeTool as (val: boolean) => ToolDefinition)(false);
} else {
tool = maybeTool as ToolDefinition;
}

if (toolShouldBeSkipped(tool, filterOutCategories)) {
continue;
}
definedNames.push(tool.name);
}
}
return definedNames;
}

function toolShouldBeSkipped(
tool: ToolDefinition,
filteredOutCategories: ToolCategory[],
) {
if (tool === null || typeof tool !== 'object' || !('name' in tool)) {
Comment thread
OrKoN marked this conversation as resolved.
Outdated
return true;
}

if (tool.annotations?.conditions) {
return true;
}
if (
tool.annotations?.category &&
filteredOutCategories.includes(tool.annotations?.category)
) {
return true;
}

return false;
}
Loading