feat(testcontainers-mongo): use mongodb to clean collection instead o…

…f @tsed/mongoose

The module can be used with mongoose or mikro-orm.

packages/orm/mikro-orm/package.json

@@ -35,6 +35,7 @@
     "@tsed/json-mapper": "workspace:*",
     "@tsed/logger": ">=6.7.5",
     "@tsed/schema": "workspace:*",
+    "@tsed/testcontainers-mongo": "workspace:*",
     "@tsed/typescript": "workspace:*",
     "cross-env": "7.0.3",
     "eslint": "^8.57.0",

packages/orm/mikro-orm/test/integration.spec.ts

@@ -10,33 +10,36 @@ import {Hooks} from "./helpers/services/Hooks.js";
 import {UnmanagedEventSubscriber1} from "./helpers/services/UnmanagedEventSubscriber1.js";
 import {UnmanagedEventSubscriber2} from "./helpers/services/UnmanagedEventSubscriber2.js";
 import {UserService} from "./helpers/services/UserService.js";
+import {TestContainersMongo} from "@tsed/testcontainers-mongo";
 
-describe.skip("MikroOrm integration", () => {
+describe("MikroOrm integration", () => {
   let spiedLogger!: Logger;
   let spiedTransactionalInterceptor!: TransactionalInterceptor;
   let spiedHooks!: Hooks;
 
   beforeEach(async () => {
-//    await TestMongooseContext.install({replicaSet: true});
-    // const {url: clientUrl} = await TestMongooseContext.getMongooseOptions();
+    const mongoSettings = TestContainersMongo.getMongoConnectionOptions();
     const bstrp = PlatformTest.bootstrap(Server, {
       disableComponentScan: true,
       imports: [MikroOrmModule],
       mikroOrm: [
         defineConfig({
-          clientUrl,
+          clientUrl: mongoSettings.url,
           entities: [User],
-          subscribers: [UnmanagedEventSubscriber1, new UnmanagedEventSubscriber2()]
+          subscribers: [UnmanagedEventSubscriber1, new UnmanagedEventSubscriber2()],
+          driverOptions: mongoSettings.connectionOptions
         }),
         defineConfig({
-          clientUrl,
+          clientUrl: mongoSettings.url,
           contextName: "db1",
-          entities: [User]
+          entities: [User],
+          driverOptions: mongoSettings.connectionOptions
         }),
         defineConfig({
-          clientUrl,
+          clientUrl: mongoSettings.url,
           contextName: "db2",
-          entities: [User]
+          entities: [User],
+          driverOptions: mongoSettings.connectionOptions
         })
       ]
     });
@@ -51,7 +54,7 @@ describe.skip("MikroOrm integration", () => {
   afterEach(async () => {
     reset<Hooks | TransactionalInterceptor | Logger>(spiedLogger, spiedTransactionalInterceptor, spiedHooks);
 
-    // await TestMongooseContext.reset();
+    await TestContainersMongo.reset();
   });
 
   it("should return repository", () => {

packages/orm/mikro-orm/tsconfig.json

@@ -22,7 +22,7 @@
       "path": "../../specs/schema/tsconfig.json"
     },
     {
-      "path": "../testing-mongoose/tsconfig.json"
+      "path": "../testcontainers-mongo/tsconfig.json"
     },
     {
       "path": "./tsconfig.cjs.json"

packages/orm/mikro-orm/vitest.config.mts

@@ -7,6 +7,8 @@ export default defineConfig(
     ...presets,
     test: {
       ...presets.test,
+      // @ts-ignore
+      globalSetup: [import.meta.resolve("@tsed/testcontainers-mongo/vitest/setup")],
       coverage: {
         ...presets.test.coverage,
         thresholds: {
@@ -18,4 +20,4 @@ export default defineConfig(
       }
     }
   }
-);
+);

packages/orm/mongoose/package.json

@@ -41,6 +41,7 @@
     "@tsed/json-mapper": "workspace:*",
     "@tsed/logger": ">=6.7.5",
     "@tsed/schema": "workspace:*",
+    "@tsed/testcontainers-mongo": "workspace:*",
     "@tsed/typescript": "workspace:*",
     "eslint": "^8.57.0",
     "mongoose": "6.12.7",

packages/orm/mongoose/test/array.integration.spec.ts

@@ -1,15 +1,16 @@
 import {serialize} from "@tsed/json-mapper";
 import {MyWorkspace, UserModel, UserWorkspace, Workspace, WorkspaceModel} from "./helpers/models/UserWorkspace.js";
 import {TestContainersMongo} from "@tsed/testcontainers-mongo";
+import {DITest} from "@tsed/di";
 
 describe("Mongoose", () => {
   describe("Array models", () => {
     beforeEach(() => TestContainersMongo.create());
     afterEach(() => TestContainersMongo.reset());
 
     it("should run pre and post hook", async () => {
-      const userModel = PlatformTest.get<UserModel>(UserWorkspace);
-      const workspaceModel = PlatformTest.get<WorkspaceModel>(Workspace);
+      const userModel = DITest.get<UserModel>(UserWorkspace);
+      const workspaceModel = DITest.get<WorkspaceModel>(Workspace);
 
       // GIVEN
       const user = new userModel();

packages/orm/mongoose/tsconfig.json

@@ -21,6 +21,9 @@
     {
       "path": "../../specs/schema/tsconfig.json"
     },
+    {
+      "path": "../testcontainers-mongo/tsconfig.json"
+    },
     {
       "path": "./tsconfig.cjs.json"
     },

packages/orm/testcontainers-mongo/package.json

@@ -34,9 +34,9 @@
     "@tsed/common": "workspace:*",
     "@tsed/core": "workspace:*",
     "@tsed/di": "workspace:*",
-    "@tsed/mongoose": "workspace:*",
     "@tsed/typescript": "workspace:*",
     "eslint": "^8.57.0",
+    "mongodb": "6.8.0",
     "testcontainers": ">=10.11.0",
     "typescript": "4.9.5"
   },
@@ -45,7 +45,7 @@
     "@tsed/common": "8.0.0-alpha.1",
     "@tsed/core": "8.0.0-alpha.1",
     "@tsed/di": "8.0.0-alpha.1",
-    "@tsed/mongoose": "8.0.0-alpha.1",
+    "mongodb": ">=6",
     "testcontainers": ">=10.11.0"
   }
 }

packages/orm/testcontainers-mongo/readme.md

@@ -91,7 +91,13 @@ export default defineConfig({
 
 :::
 
-### Usage
+## Usage
+
+### @tsed/mongoose
+
+#### Unit test
+
+Use the `TestContainersMongo.create` method to start the mongo server before your test:
 
 ```ts
 import {PlatformTest} from "@tsed/common";
@@ -148,6 +154,41 @@ describe("UserModel", () => {
 });
 ```
 
+#### Integration test
+
+Just use the `TestContainersMongo.bootstrap` method to start the mongo server before your test:
+
+```ts
+beforeEach(() => TestContainersMongo.bootstrap(Server, {}));
+```
+
+### Mikro ORM
+
+TestContainersMongo provides a method to get the connection options for MikroORM:
+
+```ts
+import {EntityManager, MikroORM} from "@mikro-orm/core";
+import {defineConfig} from "@mikro-orm/mongodb";
+import {PlatformTest} from "@tsed/common";
+import {TestContainersMongo} from "@tsed/testcontainers-mongo";
+
+beforeEach(async () => {
+  const mongoSettings = TestContainersMongo.getMongoConnectionOptions();
+  const bstrp = PlatformTest.bootstrap(Server, {
+    disableComponentScan: true,
+    imports: [MikroOrmModule],
+    mikroOrm: [
+      defineConfig({
+        clientUrl: mongoSettings.url,
+        driverOptions: mongoSettings.connectionOptions,
+        entities: [User],
+        subscribers: [UnmanagedEventSubscriber1, new UnmanagedEventSubscriber2()]
+      })
+    ]
+  });
+});
+```
+
 ## Contributors
 
 Please read [contributing guidelines here](https://tsed.io/contributing.html)

packages/orm/testcontainers-mongo/src/services/TestContainersMongo.ts

@@ -1,5 +1,5 @@
 import {PlatformTest} from "@tsed/common";
-import {MongooseService} from "@tsed/mongoose";
+import {MongoClient} from "mongodb";
 import {getMongoConnectionOptions, getMongoConnectionsOptions, startMongoServer, stopMongoServer} from "./ContainerUtils.js";
 
 export class TestContainersMongo {
@@ -8,19 +8,25 @@ export class TestContainersMongo {
   static getMongoConnectionsOptions = getMongoConnectionsOptions;
   static getMongoConnectionOptions = getMongoConnectionOptions;
 
+  private static configuration: ReturnType<typeof getMongoConnectionsOptions>;
+
   static create(options: Partial<TsED.Configuration> = {}) {
+    TestContainersMongo.configuration = getMongoConnectionsOptions();
+
     return PlatformTest.create({
       ...options,
-      mongoose: getMongoConnectionsOptions()
+      mongoose: TestContainersMongo.configuration
     });
   }
 
   static bootstrap(mod: unknown, opts: Partial<TsED.Configuration> = {}) {
-    return () =>
-      PlatformTest.bootstrap(mod, {
-        mongoose: getMongoConnectionsOptions(),
+    return () => {
+      TestContainersMongo.configuration = getMongoConnectionsOptions();
+      return PlatformTest.bootstrap(mod, {
+        mongoose: TestContainersMongo.configuration,
         ...opts
       })();
+    };
   }
 
   static async reset(collectionName?: string) {
@@ -31,16 +37,18 @@ export class TestContainersMongo {
     return PlatformTest.reset();
   }
 
-  static async cleanCollection(collectionName: string) {
-    const service = PlatformTest.injector.get<MongooseService>(MongooseService)!;
-
-    const {collections} = service.get("default")!;
-
-    if (!collections[collectionName]) {
-      console.error(`Collection ${collectionName} not found. Here available collection names: ${Object.keys(collections)}`);
-      return;
+  static async cleanCollection(collectionName: string, mongoSettings = TestContainersMongo.configuration) {
+    try {
+      const client = new MongoClient(mongoSettings[0].url, {
+        directConnection: true
+      });
+
+      await client.connect();
+      const db = client.db();
+      await db.collection(collectionName).deleteMany({});
+      await client.close();
+    } catch (er) {
+      console.error(`Collection ${collectionName} not found. ${er.message} ${er.stack}`);
     }
-
-    await collections[collectionName].deleteMany({});
   }
 }

packages/orm/testcontainers-mongo/tsconfig.json

@@ -15,9 +15,6 @@
     {
       "path": "../../di/tsconfig.json"
     },
-    {
-      "path": "../mongoose/tsconfig.json"
-    },
     {
       "path": "./tsconfig.cjs.json"
     },

yarn.lock

@@ -6897,7 +6897,7 @@ __metadata:
     "@tsed/json-mapper": "workspace:*"
     "@tsed/logger": "npm:>=6.7.5"
     "@tsed/schema": "workspace:*"
-    "@tsed/testing-mongoose": "workspace:*"
+    "@tsed/testcontainers-mongo": "workspace:*"
     "@tsed/typescript": "workspace:*"
     cross-env: "npm:7.0.3"
     eslint: "npm:^8.57.0"
@@ -6925,6 +6925,7 @@ __metadata:
     "@tsed/json-mapper": "workspace:*"
     "@tsed/logger": "npm:>=6.7.5"
     "@tsed/schema": "workspace:*"
+    "@tsed/testcontainers-mongo": "workspace:*"
     "@tsed/typescript": "workspace:*"
     change-case: "npm:4.1.2"
     eslint: "npm:^8.57.0"
@@ -8114,7 +8115,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@tsed/testcontainers-mongo@workspace:packages/orm/testcontainers-mongo":
+"@tsed/testcontainers-mongo@workspace:*, @tsed/testcontainers-mongo@workspace:packages/orm/testcontainers-mongo":
   version: 0.0.0-use.local
   resolution: "@tsed/testcontainers-mongo@workspace:packages/orm/testcontainers-mongo"
   dependencies:
@@ -8123,9 +8124,9 @@ __metadata:
     "@tsed/common": "workspace:*"
     "@tsed/core": "workspace:*"
     "@tsed/di": "workspace:*"
-    "@tsed/mongoose": "workspace:*"
     "@tsed/typescript": "workspace:*"
     eslint: "npm:^8.57.0"
+    mongodb: "npm:6.8.0"
     semver: "npm:^7.6.0"
     testcontainers: "npm:>=10.11.0"
     tslib: "npm:2.6.1"
@@ -8135,12 +8136,12 @@ __metadata:
     "@tsed/common": 8.0.0-alpha.1
     "@tsed/core": 8.0.0-alpha.1
     "@tsed/di": 8.0.0-alpha.1
-    "@tsed/mongoose": 8.0.0-alpha.1
+    mongodb: ">=6"
     testcontainers: ">=10.11.0"
   languageName: unknown
   linkType: soft
 
-"@tsed/testing-mongoose@workspace:*, @tsed/testing-mongoose@workspace:packages/orm/testing-mongoose":
+"@tsed/testing-mongoose@workspace:packages/orm/testing-mongoose":
   version: 0.0.0-use.local
   resolution: "@tsed/testing-mongoose@workspace:packages/orm/testing-mongoose"
   dependencies:
@@ -22375,25 +22376,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"mongodb@npm:^4.16.0":
-  version: 4.17.1
-  resolution: "mongodb@npm:4.17.1"
-  dependencies:
-    "@aws-sdk/credential-providers": "npm:^3.186.0"
-    "@mongodb-js/saslprep": "npm:^1.1.0"
-    bson: "npm:^4.7.2"
-    mongodb-connection-string-url: "npm:^2.6.0"
-    socks: "npm:^2.7.1"
-  dependenciesMeta:
-    "@aws-sdk/credential-providers":
-      optional: true
-    "@mongodb-js/saslprep":
-      optional: true
-  checksum: 10/2ce62912ab36885e927c109a699568174cc61025bc03e2d5c22e6070aaec967b2364d4b9d42c9131531c2547416b57d14952c50235d43fa66e76a6fbe4c96c37
-  languageName: node
-  linkType: hard
-
-"mongodb@npm:^6.5.0":
+"mongodb@npm:6.8.0, mongodb@npm:^6.5.0":
   version: 6.8.0
   resolution: "mongodb@npm:6.8.0"
   dependencies:
@@ -22427,6 +22410,24 @@ __metadata:
   languageName: node
   linkType: hard
 
+"mongodb@npm:^4.16.0":
+  version: 4.17.1
+  resolution: "mongodb@npm:4.17.1"
+  dependencies:
+    "@aws-sdk/credential-providers": "npm:^3.186.0"
+    "@mongodb-js/saslprep": "npm:^1.1.0"
+    bson: "npm:^4.7.2"
+    mongodb-connection-string-url: "npm:^2.6.0"
+    socks: "npm:^2.7.1"
+  dependenciesMeta:
+    "@aws-sdk/credential-providers":
+      optional: true
+    "@mongodb-js/saslprep":
+      optional: true
+  checksum: 10/2ce62912ab36885e927c109a699568174cc61025bc03e2d5c22e6070aaec967b2364d4b9d42c9131531c2547416b57d14952c50235d43fa66e76a6fbe4c96c37
+  languageName: node
+  linkType: hard
+
 "mongoose@npm:6.5.1":
   version: 6.5.1
   resolution: "mongoose@npm:6.5.1"