refactor: split test helpers #103
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| 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 { UserConfig, config } from "../../../../src/config.js"; | ||
|
|
||
| interface MongoDBIntegrationTest { | ||
| mongoClient: () => MongoClient; | ||
| connectionString: () => string; | ||
| connectMcpClient: () => Promise<void>; | ||
| randomDbName: () => string; | ||
| } | ||
|
|
||
| export function describeWithMongoDB( | ||
| name: number | string | Function | jest.FunctionLike, | ||
| fn: (integration: IntegrationTest & MongoDBIntegrationTest) => void | ||
| ): void { | ||
| describe("mongodb", () => { | ||
|
There was a problem hiding this comment. do we benefit from having this parent MongoDB describe? we could also set the variables inside the child There was a problem hiding this comment. the reason why I added the main one was because need separation of beforeAll/AfterAll from main setup and MongoDB one other ordering is not correct |
||
| const integration = setupIntegrationTest(); | ||
| const mdbIntegration = setupMongoDBIntegrationTest(integration); | ||
| describe(name, () => { | ||
| fn({ ...integration, ...mdbIntegration }); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| export function setupMongoDBIntegrationTest( | ||
| integration: IntegrationTest, | ||
| userConfig: UserConfig = config | ||
| ): MongoDBIntegrationTest { | ||
| let mongoCluster: runner.MongoCluster | undefined; | ||
| let mongoClient: MongoClient | undefined; | ||
| let randomDbName: string; | ||
|
|
||
| beforeEach(async () => { | ||
| randomDbName = new ObjectId().toString(); | ||
| }); | ||
|
|
||
| afterEach(async () => { | ||
| await integration.mcpServer().session.close(); | ||
| config.connectionString = undefined; | ||
|
|
||
| await mongoClient?.close(); | ||
| mongoClient = undefined; | ||
| }); | ||
|
|
||
| beforeAll(async function () { | ||
| // Downloading Windows executables in CI takes a long time because | ||
| // they include debug symbols... | ||
| const tmpDir = path.join(__dirname, "..", "..", "..", "tmp"); | ||
| await fs.mkdir(tmpDir, { recursive: true }); | ||
|
|
||
| // On Windows, we may have a situation where mongod.exe is not fully released by the OS | ||
| // before we attempt to run it again, so we add a retry. | ||
| let dbsDir = path.join(tmpDir, "mongodb-runner", "dbs"); | ||
| for (let i = 0; i < 10; i++) { | ||
| try { | ||
| mongoCluster = await MongoCluster.start({ | ||
| tmpDir: dbsDir, | ||
| logDir: path.join(tmpDir, "mongodb-runner", "logs"), | ||
| topology: "standalone", | ||
| }); | ||
|
|
||
| return; | ||
| } catch (err) { | ||
| if (i < 5) { | ||
| // Just wait a little bit and retry | ||
| console.error(`Failed to start cluster in ${dbsDir}, attempt ${i}: ${err}`); | ||
| await new Promise((resolve) => setTimeout(resolve, 1000)); | ||
| } else { | ||
| // If we still fail after 5 seconds, try another db dir | ||
| console.error( | ||
| `Failed to start cluster in ${dbsDir}, attempt ${i}: ${err}. Retrying with a new db dir.` | ||
| ); | ||
| dbsDir = path.join(tmpDir, "mongodb-runner", `dbs${i - 5}`); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| throw new Error("Failed to start cluster after 10 attempts"); | ||
| }, 120_000); | ||
|
|
||
| afterAll(async function () { | ||
| await mongoCluster?.close(); | ||
| mongoCluster = undefined; | ||
| }); | ||
|
|
||
| const getConnectionString = () => { | ||
| if (!mongoCluster) { | ||
| throw new Error("beforeAll() hook not ran yet"); | ||
| } | ||
|
|
||
| return mongoCluster.connectionString; | ||
| }; | ||
|
|
||
| return { | ||
| mongoClient: () => { | ||
| if (!mongoClient) { | ||
| mongoClient = new MongoClient(getConnectionString()); | ||
| } | ||
| return mongoClient; | ||
| }, | ||
| connectionString: getConnectionString, | ||
| connectMcpClient: async () => { | ||
| await integration.mcpClient().callTool({ | ||
| name: "connect", | ||
| arguments: { options: [{ connectionString: getConnectionString() }] }, | ||
| }); | ||
| }, | ||
| randomDbName: () => randomDbName, | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what if we were to mix MongoDB + Atlas flows? would that be its own describe statement?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we would need to do something like
describeAtlasMongoDB(...)