Skip to content

chore: fix tests #112

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.

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
merged 1 commit into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
76 changes: 2 additions & 74 deletions tests/integration/helpers.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { InMemoryTransport } from "./inMemoryTransport.js";
import { Server } from "../../src/server.js";
import runner, { MongoCluster } from "mongodb-runner";
import path from "path";
import fs from "fs/promises";
import { MongoClient, ObjectId } from "mongodb";
import { toIncludeAllMembers } from "jest-extended";
import { ObjectId } from "mongodb";
import { config, UserConfig } from "../../src/config.js";
import { McpError } from "@modelcontextprotocol/sdk/types.js";
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { Session } from "../../src/session.js";
import { toIncludeAllMembers } from "jest-extended";

interface ParameterInfo {
name: string;
Expand Down Expand Up @@ -98,31 +95,9 @@ export function setupIntegrationTest(userConfig: UserConfig = config): Integrati
return mcpServer;
};

const getConnectionString = () => {
if (!mongoCluster) {
throw new Error("beforeAll() hook not ran yet");
}

return mongoCluster.connectionString;
};

return {
mcpClient: getMcpClient,
mcpServer: getMcpServer,
mongoClient: () => {
if (!mongoClient) {
mongoClient = new MongoClient(getConnectionString());
}
return mongoClient;
},
connectionString: getConnectionString,
connectMcpClient: async () => {
await getMcpClient().callTool({
name: "connect",
arguments: { options: [{ connectionString: getConnectionString() }] },
});
},
randomDbName: () => randomDbName,
};
}

Expand Down Expand Up @@ -199,52 +174,6 @@ export function validateToolMetadata(
});
}

export function validateAutoConnectBehavior(
integration: IntegrationTest,
name: string,
validation: () => {
args: { [x: string]: unknown };
expectedResponse?: string;
validate?: (content: unknown) => void;
},
beforeEachImpl?: () => Promise<void>
): void {
describe("when not connected", () => {
if (beforeEachImpl) {
beforeEach(() => beforeEachImpl());
}

it("connects automatically if connection string is configured", async () => {
config.connectionString = integration.connectionString();

const validationInfo = validation();

const response = await integration.mcpClient().callTool({
name,
arguments: validationInfo.args,
});

if (validationInfo.expectedResponse) {
const content = getResponseContent(response.content);
expect(content).toContain(validationInfo.expectedResponse);
}

if (validationInfo.validate) {
validationInfo.validate(response.content);
}
});

it("throws an error if connection string is not configured", async () => {
const response = await integration.mcpClient().callTool({
name,
arguments: validation().args,
});
const content = getResponseContent(response.content);
expect(content).toContain("You need to connect to a MongoDB instance before you can access its data.");
});
});
}

export function validateThrowsForInvalidArguments(
integration: IntegrationTest,
name: string,
Expand All @@ -253,7 +182,6 @@ export function validateThrowsForInvalidArguments(
describe("with invalid arguments", () => {
for (const arg of args) {
it(`throws a schema error for: ${JSON.stringify(arg)}`, async () => {
await integration.connectMcpClient();
try {
await integration.mcpClient().callTool({ name, arguments: arg });
expect.fail("Expected an error to be thrown");
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
dbOperationInvalidArgTests,
} from "../../../helpers.js";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
} from "../../../helpers.js";
import { IndexDirection } from "mongodb";
Expand Down
4 changes: 1 addition & 3 deletions tests/integration/tools/mongodb/create/insertMany.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
} from "../../../helpers.js";

Expand Down
4 changes: 1 addition & 3 deletions tests/integration/tools/mongodb/delete/deleteMany.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
} from "../../../helpers.js";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
dbOperationInvalidArgTests,
} from "../../../helpers.js";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
dbOperationInvalidArgTests,
} from "../../../helpers.js";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseElements,
getResponseContent,
setupIntegrationTest,
dbOperationParameters,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
dbOperationInvalidArgTests,
} from "../../../helpers.js";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
setupIntegrationTest,
dbOperationParameters,
validateToolMetadata,
validateAutoConnectBehavior,
dbOperationInvalidArgTests,
validateThrowsForInvalidArguments,
} from "../../../helpers.js";
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/tools/mongodb/metadata/connect.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";

import { getResponseContent, setupIntegrationTest, validateToolMetadata } from "../../../helpers.js";
import { getResponseContent, validateToolMetadata } from "../../../helpers.js";

import { config } from "../../../../../src/config.js";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseElements,
getResponseContent,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
dbOperationInvalidArgTests,
} from "../../../helpers.js";
Expand Down
10 changes: 2 additions & 8 deletions tests/integration/tools/mongodb/metadata/listDatabases.test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseElements,
getParameters,
setupIntegrationTest,
validateAutoConnectBehavior,
} from "../../../helpers.js";
import { toIncludeSameMembers } from "jest-extended";
import { getResponseElements, getParameters } from "../../../helpers.js";

describeWithMongoDB("listDatabases tool", (integration) => {
const defaultDatabases = ["admin", "config", "local"];
Expand Down
48 changes: 47 additions & 1 deletion tests/integration/tools/mongodb/mongodbHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import runner, { MongoCluster } from "mongodb-runner";
import path from "path";
import fs from "fs/promises";
import { MongoClient, ObjectId } from "mongodb";
import { IntegrationTest, setupIntegrationTest } from "../../helpers.js";
import { getResponseContent, IntegrationTest, setupIntegrationTest } from "../../helpers.js";
import { UserConfig, config } from "../../../../src/config.js";

interface MongoDBIntegrationTest {
Expand Down Expand Up @@ -111,3 +111,49 @@ export function setupMongoDBIntegrationTest(
randomDbName: () => randomDbName,
};
}

export function validateAutoConnectBehavior(
integration: IntegrationTest & MongoDBIntegrationTest,
name: string,
validation: () => {
args: { [x: string]: unknown };
expectedResponse?: string;
validate?: (content: unknown) => void;
},
beforeEachImpl?: () => Promise<void>
): void {
describe("when not connected", () => {
if (beforeEachImpl) {
beforeEach(() => beforeEachImpl());
}

it("connects automatically if connection string is configured", async () => {
config.connectionString = integration.connectionString();

const validationInfo = validation();

const response = await integration.mcpClient().callTool({
name,
arguments: validationInfo.args,
});

if (validationInfo.expectedResponse) {
const content = getResponseContent(response.content);
expect(content).toContain(validationInfo.expectedResponse);
}

if (validationInfo.validate) {
validationInfo.validate(response.content);
}
});

it("throws an error if connection string is not configured", async () => {
const response = await integration.mcpClient().callTool({
name,
arguments: validation().args,
});
const content = getResponseContent(response.content);
expect(content).toContain("You need to connect to a MongoDB instance before you can access its data.");
});
});
}
4 changes: 1 addition & 3 deletions tests/integration/tools/mongodb/read/count.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import { describeWithMongoDB } from "../mongodbHelpers.js";
import { describeWithMongoDB, validateAutoConnectBehavior } from "../mongodbHelpers.js";

import {
getResponseContent,
dbOperationParameters,
setupIntegrationTest,
validateToolMetadata,
validateAutoConnectBehavior,
validateThrowsForInvalidArguments,
} from "../../../helpers.js";

Expand Down
Loading