chore: change interface of describeWithMongoDB

himanshusinghs · himanshusinghs · commit 3eba90688346 · 2025-10-14T14:13:14.000+02:00
The number of parameters were increasing as I wanted to add elicitInput
as another argument. This commit compacts the rest of the config
parameters in an object and modifies the usage to call the method
correctly.

Additionally, in places where we were just doing the defaults, this
commit modifies those calls to not pass anything and rely on default.
diff --git a/tests/integration/common/connectionManager.oidc.test.ts b/tests/integration/common/connectionManager.oidc.test.ts
@@ -3,7 +3,12 @@ import { describe, beforeEach, afterAll, it, expect, vi } from "vitest";
 import semver from "semver";
 import process from "process";
 import type { MongoDBIntegrationTestCase } from "../tools/mongodb/mongodbHelpers.js";
-import { describeWithMongoDB, isCommunityServer, getServerVersion } from "../tools/mongodb/mongodbHelpers.js";
+import {
+    describeWithMongoDB,
+    isCommunityServer,
+    getServerVersion,
+    defaultTestSuiteConfig,
+} from "../tools/mongodb/mongodbHelpers.js";
 import { defaultTestConfig, responseAsText, timeout, waitUntil } from "../helpers.js";
 import type { ConnectionStateConnected, ConnectionStateConnecting } from "../../../src/common/connectionManager.js";
 import type { UserConfig } from "../../../src/common/config.js";
@@ -137,14 +142,20 @@ describe.skipIf(process.platform !== "linux")("ConnectionManager OIDC Tests", as
 
                 addCb?.(oidcIt);
             },
-            () => oidcConfig,
-            () => ({
-                ...setupDriverConfig({
-                    config: oidcConfig,
-                    defaults: {},
-                }),
-            }),
-            { runner: true, downloadOptions: { enterprise: true, version: mongodbVersion }, serverArgs }
+            {
+                ...defaultTestSuiteConfig,
+                getUserConfig: () => oidcConfig,
+                getDriverOptions: () =>
+                    setupDriverConfig({
+                        config: oidcConfig,
+                        defaults: {},
+                    }),
+                downloadOptions: {
+                    runner: true,
+                    downloadOptions: { enterprise: true, version: mongodbVersion },
+                    serverArgs,
+                },
+            }
         );
     }
 
diff --git a/tests/integration/indexCheck.test.ts b/tests/integration/indexCheck.test.ts
@@ -1,5 +1,5 @@
 import { defaultTestConfig, getResponseContent } from "./helpers.js";
-import { describeWithMongoDB } from "./tools/mongodb/mongodbHelpers.js";
+import { defaultTestSuiteConfig, describeWithMongoDB } from "./tools/mongodb/mongodbHelpers.js";
 import { beforeEach, describe, expect, it } from "vitest";
 
 describe("IndexCheck integration tests", () => {
@@ -313,10 +313,13 @@ describe("IndexCheck integration tests", () => {
                     });
                 });
             },
-            () => ({
-                ...defaultTestConfig,
-                indexCheck: true, // Enable indexCheck
-            })
+            {
+                ...defaultTestSuiteConfig,
+                getUserConfig: () => ({
+                    ...defaultTestConfig,
+                    indexCheck: true, // Enable indexCheck
+                }),
+            }
         );
     });
 
@@ -424,10 +427,13 @@ describe("IndexCheck integration tests", () => {
                     expect(content).not.toContain("Index check failed");
                 });
             },
-            () => ({
-                ...defaultTestConfig,
-                indexCheck: false, // Disable indexCheck
-            })
+            {
+                ...defaultTestSuiteConfig,
+                getUserConfig: () => ({
+                    ...defaultTestConfig,
+                    indexCheck: false, // Disable indexCheck
+                }),
+            }
         );
     });
 
@@ -456,10 +462,13 @@ describe("IndexCheck integration tests", () => {
                     expect(response.isError).toBeFalsy();
                 });
             },
-            () => ({
-                ...defaultTestConfig,
-                // indexCheck not specified, should default to false
-            })
+            {
+                ...defaultTestSuiteConfig,
+                getUserConfig: () => ({
+                    ...defaultTestConfig,
+                    // indexCheck not specified, should default to false
+                }),
+            }
         );
     });
 });
diff --git a/tests/integration/resources/exportedData.test.ts b/tests/integration/resources/exportedData.test.ts
@@ -4,7 +4,7 @@ import { EJSON, Long, ObjectId } from "bson";
 import { describe, expect, it, beforeEach, afterAll } from "vitest";
 import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { defaultTestConfig, getDataFromUntrustedContent, resourceChangedNotification, timeout } from "../helpers.js";
-import { describeWithMongoDB } from "../tools/mongodb/mongodbHelpers.js";
+import { defaultTestSuiteConfig, describeWithMongoDB } from "../tools/mongodb/mongodbHelpers.js";
 import { contentWithResourceURILink } from "../tools/mongodb/read/export.test.js";
 import type { UserConfig } from "../../../src/lib.js";
 
@@ -173,5 +173,8 @@ describeWithMongoDB(
             });
         });
     },
-    () => userConfig
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: () => userConfig,
+    }
 );
diff --git a/tests/integration/server.test.ts b/tests/integration/server.test.ts
@@ -1,5 +1,5 @@
 import { defaultDriverOptions, defaultTestConfig, expectDefined, setupIntegrationTest } from "./helpers.js";
-import { describeWithMongoDB } from "./tools/mongodb/mongodbHelpers.js";
+import { defaultTestSuiteConfig, describeWithMongoDB } from "./tools/mongodb/mongodbHelpers.js";
 import { describe, expect, it } from "vitest";
 
 describe("Server integration test", () => {
@@ -15,12 +15,14 @@ describe("Server integration test", () => {
                 expect(atlasTools.length).toBeLessThanOrEqual(0);
             });
         },
-        () => ({
-            ...defaultTestConfig,
-            apiClientId: undefined,
-            apiClientSecret: undefined,
-        }),
-        () => defaultDriverOptions
+        {
+            ...defaultTestSuiteConfig,
+            getUserConfig: () => ({
+                ...defaultTestConfig,
+                apiClientId: undefined,
+                apiClientSecret: undefined,
+            }),
+        }
     );
 
     describe("with atlas", () => {
diff --git a/tests/integration/tools/mongodb/connect/connect.test.ts b/tests/integration/tools/mongodb/connect/connect.test.ts
@@ -1,12 +1,11 @@
-import { describeWithMongoDB } from "../mongodbHelpers.js";
+import { defaultTestSuiteConfig, describeWithMongoDB } from "../mongodbHelpers.js";
 import {
     defaultDriverOptions,
     getResponseContent,
     getResponseElements,
     validateThrowsForInvalidArguments,
     validateToolMetadata,
 } from "../../../helpers.js";
-import { config } from "../../../../../src/common/config.js";
 import { defaultTestConfig, setupIntegrationTest } from "../../../helpers.js";
 import { beforeEach, describe, expect, it } from "vitest";
 
@@ -82,66 +81,65 @@ describeWithMongoDB(
             });
         });
     },
-    (mdbIntegration) => ({
-        ...config,
-        connectionString: mdbIntegration.connectionString(),
-    })
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: (mdbIntegration) => ({
+            ...defaultTestConfig,
+            connectionString: mdbIntegration.connectionString(),
+        }),
+    }
 );
 
-describeWithMongoDB(
-    "Connect tool",
-    (integration) => {
-        validateToolMetadata(
-            integration,
-            "connect",
-            "Connect to a MongoDB instance. The config resource captures if the server is already connected to a MongoDB cluster. If the user has configured a connection string or has previously called the connect tool, a connection is already established and there's no need to call this tool unless the user has explicitly requested to switch to a new MongoDB cluster.",
-            [
-                {
-                    name: "connectionString",
-                    description: "MongoDB connection string (in the mongodb:// or mongodb+srv:// format)",
-                    type: "string",
-                    required: true,
-                },
-            ]
-        );
+describeWithMongoDB("Connect tool", (integration) => {
+    validateToolMetadata(
+        integration,
+        "connect",
+        "Connect to a MongoDB instance. The config resource captures if the server is already connected to a MongoDB cluster. If the user has configured a connection string or has previously called the connect tool, a connection is already established and there's no need to call this tool unless the user has explicitly requested to switch to a new MongoDB cluster.",
+        [
+            {
+                name: "connectionString",
+                description: "MongoDB connection string (in the mongodb:// or mongodb+srv:// format)",
+                type: "string",
+                required: true,
+            },
+        ]
+    );
 
-        validateThrowsForInvalidArguments(integration, "connect", [{}, { connectionString: 123 }]);
+    validateThrowsForInvalidArguments(integration, "connect", [{}, { connectionString: 123 }]);
 
-        it("doesn't have the switch-connection tool registered", async () => {
-            const { tools } = await integration.mcpClient().listTools();
-            const tool = tools.find((tool) => tool.name === "switch-connection");
-            expect(tool).toBeUndefined();
-        });
+    it("doesn't have the switch-connection tool registered", async () => {
+        const { tools } = await integration.mcpClient().listTools();
+        const tool = tools.find((tool) => tool.name === "switch-connection");
+        expect(tool).toBeUndefined();
+    });
 
-        describe("with connection string", () => {
-            it("connects to the database", async () => {
-                const response = await integration.mcpClient().callTool({
-                    name: "connect",
-                    arguments: {
-                        connectionString: integration.connectionString(),
-                    },
-                });
-                const content = getResponseContent(response.content);
-                expect(content).toContain("Successfully connected");
+    describe("with connection string", () => {
+        it("connects to the database", async () => {
+            const response = await integration.mcpClient().callTool({
+                name: "connect",
+                arguments: {
+                    connectionString: integration.connectionString(),
+                },
             });
+            const content = getResponseContent(response.content);
+            expect(content).toContain("Successfully connected");
         });
+    });
 
-        describe("with invalid connection string", () => {
-            it("returns error message", async () => {
-                const response = await integration.mcpClient().callTool({
-                    name: "connect",
-                    arguments: { connectionString: "mangodb://localhost:12345" },
-                });
-                const content = getResponseContent(response.content);
-                expect(content).toContain("The configured connection string is not valid.");
-
-                // Should not suggest using the config connection string (because we don't have one)
-                expect(content).not.toContain("Your config lists a different connection string");
+    describe("with invalid connection string", () => {
+        it("returns error message", async () => {
+            const response = await integration.mcpClient().callTool({
+                name: "connect",
+                arguments: { connectionString: "mangodb://localhost:12345" },
             });
+            const content = getResponseContent(response.content);
+            expect(content).toContain("The configured connection string is not valid.");
+
+            // Should not suggest using the config connection string (because we don't have one)
+            expect(content).not.toContain("Your config lists a different connection string");
         });
-    },
-    () => config
-);
+    });
+});
 
 describe("Connect tool when disabled", () => {
     const integration = setupIntegrationTest(
diff --git a/tests/integration/tools/mongodb/mongodbHelpers.ts b/tests/integration/tools/mongodb/mongodbHelpers.ts
@@ -66,12 +66,22 @@ export type MongoDBIntegrationTestCase = IntegrationTest &
 
 export type MongoSearchConfiguration = { search: true; image?: string };
 
+export type TestSuiteConfig = {
+    getUserConfig: (mdbIntegration: MongoDBIntegrationTest) => UserConfig;
+    getDriverOptions: (mdbIntegration: MongoDBIntegrationTest) => DriverOptions;
+    downloadOptions: MongoClusterConfiguration;
+};
+
+export const defaultTestSuiteConfig: TestSuiteConfig = {
+    getUserConfig: () => defaultTestConfig,
+    getDriverOptions: () => defaultDriverOptions,
+    downloadOptions: DEFAULT_MONGODB_PROCESS_OPTIONS,
+};
+
 export function describeWithMongoDB(
     name: string,
     fn: (integration: MongoDBIntegrationTestCase) => void,
-    getUserConfig: (mdbIntegration: MongoDBIntegrationTest) => UserConfig = () => defaultTestConfig,
-    getDriverOptions: (mdbIntegration: MongoDBIntegrationTest) => DriverOptions = () => defaultDriverOptions,
-    downloadOptions: MongoClusterConfiguration = DEFAULT_MONGODB_PROCESS_OPTIONS
+    { getUserConfig, getDriverOptions, downloadOptions }: TestSuiteConfig = defaultTestSuiteConfig
 ): void {
     describe.skipIf(!MongoDBClusterProcess.isConfigurationSupportedInCurrentEnv(downloadOptions))(name, () => {
         const mdbIntegration = setupMongoDBIntegrationTest(downloadOptions);
diff --git a/tests/integration/tools/mongodb/read/aggregate.test.ts b/tests/integration/tools/mongodb/read/aggregate.test.ts
@@ -6,7 +6,12 @@ import {
     defaultTestConfig,
 } from "../../../helpers.js";
 import { beforeEach, describe, expect, it, vi, afterEach } from "vitest";
-import { describeWithMongoDB, getDocsFromUntrustedContent, validateAutoConnectBehavior } from "../mongodbHelpers.js";
+import {
+    defaultTestSuiteConfig,
+    describeWithMongoDB,
+    getDocsFromUntrustedContent,
+    validateAutoConnectBehavior,
+} from "../mongodbHelpers.js";
 import * as constants from "../../../../../src/helpers/constants.js";
 import { freshInsertDocuments } from "./find.test.js";
 
@@ -282,7 +287,10 @@ describeWithMongoDB(
             );
         });
     },
-    () => ({ ...defaultTestConfig, maxDocumentsPerQuery: 20 })
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: () => ({ ...defaultTestConfig, maxDocumentsPerQuery: 20 }),
+    }
 );
 
 describeWithMongoDB(
@@ -339,7 +347,10 @@ describeWithMongoDB(
             );
         });
     },
-    () => ({ ...defaultTestConfig, maxBytesPerQuery: 200 })
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: () => ({ ...defaultTestConfig, maxBytesPerQuery: 200 }),
+    }
 );
 
 describeWithMongoDB(
@@ -369,5 +380,8 @@ describeWithMongoDB(
             expect(content).toContain(`Returning 990 documents.`);
         });
     },
-    () => ({ ...defaultTestConfig, maxDocumentsPerQuery: -1, maxBytesPerQuery: -1 })
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: () => ({ ...defaultTestConfig, maxDocumentsPerQuery: -1, maxBytesPerQuery: -1 }),
+    }
 );
diff --git a/tests/integration/tools/mongodb/read/export.test.ts b/tests/integration/tools/mongodb/read/export.test.ts
@@ -10,7 +10,7 @@ import {
     validateThrowsForInvalidArguments,
     validateToolMetadata,
 } from "../../../helpers.js";
-import { describeWithMongoDB } from "../mongodbHelpers.js";
+import { defaultTestSuiteConfig, describeWithMongoDB } from "../mongodbHelpers.js";
 import type { UserConfig } from "../../../../../src/lib.js";
 
 const userConfig: UserConfig = {
@@ -458,5 +458,8 @@ describeWithMongoDB(
             });
         });
     },
-    () => userConfig
+    {
+        ...defaultTestSuiteConfig,
+        getUserConfig: () => userConfig,
+    }
 );
diff --git a/tests/integration/tools/mongodb/read/find.test.ts b/tests/integration/tools/mongodb/read/find.test.ts
diff --git a/tests/integration/tools/mongodb/search/listSearchIndexes.test.ts b/tests/integration/tools/mongodb/search/listSearchIndexes.test.ts
