@tsed/testcontainers-mongo 7.80.0 → 7.80.2

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/testcontainers-mongo",
   "description": "A module to test Ts.ED code that use MongoDB as database using Test Containers",
   "type": "commonjs",
-  "version": "7.80.0",
+  "version": "7.80.2",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",
@@ -11,6 +11,7 @@
     ".": {
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
       "default": "./lib/cjs/index.js"
     },
     "./vitest/setup": {
@@ -29,12 +30,12 @@
   },
   "devDependencies": {
     "@testcontainers/mongodb": ">=10.11.0",
-    "@tsed/barrels": "7.80.0",
-    "@tsed/common": "7.80.0",
-    "@tsed/core": "7.80.0",
-    "@tsed/di": "7.80.0",
-    "@tsed/mongoose": "7.80.0",
-    "@tsed/typescript": "7.80.0",
+    "@tsed/barrels": "7.80.2",
+    "@tsed/common": "7.80.2",
+    "@tsed/core": "7.80.2",
+    "@tsed/di": "7.80.2",
+    "@tsed/mongoose": "7.80.2",
+    "@tsed/typescript": "7.80.2",
     "eslint": "^8.57.0",
     "testcontainers": ">=10.11.0",
     "typescript": "4.9.5"
@@ -42,7 +43,7 @@
   "peerDependencies": {
     "@testcontainers/mongodb": ">=10.11.0",
     "@tsed/common": "workspace:*",
-    "@tsed/core": "7.80.0",
+    "@tsed/core": "7.80.2",
     "@tsed/di": "workspace:*",
     "@tsed/mongoose": "workspace:*",
     "testcontainers": ">=10.11.0"

package/readme.md

@@ -3,7 +3,7 @@
 </p>
 
 <div align="center">
-   <h1>Mongoose testing</h1>
+   <h1>TestContainers Mongo</h1>
 
 [![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
 [![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
@@ -29,111 +29,123 @@
 
 A package of Ts.ED framework. See website: https://tsed.io/
 
-This package is an helper to create unit test base on `@tsed/mongoose` package.
+This package allows you to test your code using the [TestContainers](https://node.testcontainers.org/) library.
 
 # Installation
 
-```bash
-npm install --save @tsed/testing-mongoose
+To use the `@tsed/testcontainers-mongo` package, you need to install the package:
+
+```sh [npm]
+npm install --save-dev @tsed/testcontainers-mongo
 ```
 
-## Example usage
+```sh [yarn]
+yarn add --dev @tsed/testcontainers-mongo
+```
 
-### Testing server
+```sh [pnpm]
+pnpm add --dev @tsed/testcontainers-mongo
+```
 
-Here an example to your server with a mocked database:
+```sh [bun]
+bun add --dev @tsed/testcontainers-mongo
+```
 
-```typescript
-import {PlatformTest} from "@tsed/common";
-import {PlatformExpress} from "@tsed/platform-express";
-import {TestMongooseContext} from "@tsed/testing-mongoose";
-import {expect} from "chai";
-import * as SuperTest from "supertest";
-import {Server} from "../Server.js";
-
-describe("Rest", () => {
-  // bootstrap your Server to load all endpoints before run your test
-  let request: SuperTest.Agent;
-
-  before(TestMongooseContext.bootstrap(Server, {platform: PlatformExpress})); // Create a server with mocked database
-  before((done) => {
-    request = SuperTest(PlatformTest.callback());
-    done();
-  });
+### Configuration
 
-  after(TestMongooseContext.reset); // reset database and injector
+Add or update your jest or vitest configuration file to add a global setup file:
 
-  describe("GET /rest/calendars", () => {
-    it("should do something", async () => {
-      const response = await request.get("/rest/calendars").expect(200);
+#### Jest
 
-      expect(response.body).to.be.an("array");
-    });
-  });
-});
-```
-
-::: tip
-To increase mocha timeout from 2000ms to 10000ms use option `--timeout 10000`.
-:::
-
-### Testing server with Replica set
+```ts
+// jest.config.js
+module.exports = {
+  globalSetup: ["jest.setup.js"],
+  globalTeardown: ["jest.teardown.js"]
+};
 
-A [ReplicaSet](https://github.com/nodkz/mongodb-memory-server#replica-set-start) can be easily started with:
+// jest.setup.js
+const {TestContainersMongo} = require("@tsed/testcontainers-mongo");
+module.exports = async () => {
+  await TestContainersMongo.startMongoServer();
+};
 
-```typescript
-import {PlatformTest} from "@tsed/common";
-import {PlatformExpress} from "@tsed/platform-express";
-import {TestMongooseContext} from "@tsed/testing-mongoose";
-import {expect} from "chai";
-import * as SuperTest from "supertest";
-import {Server} from "../Server.js";
-
-describe("Rest", () => {
-  // bootstrap your Server to load all endpoints before run your test
-  let request: SuperTest.Agent;
-
-  before(
-    TestMongooseContext.bootstrap(Server, {
-      platform: PlatformExpress,
-      mongod: {
-        replicaSet: true
-      }
-    })
-  ); // Create a server with mocked database
-  before((done) => {
-    request = SuperTest(PlatformTest.callback());
-    done();
-  });
+// jest.teardown.js
+const {TestContainersMongo} = require("@tsed/testcontainers-mongo");
+module.exports = async () => {
+  await TestContainersMongo.stopMongoServer();
+};
+```
 
-  after(TestMongooseContext.reset); // reset database and injector
+### Vitest
 
-  describe("GET /rest/calendars", () => {
-    it("should do something", async () => {
-      const response = await request.get("/rest/calendars").expect(200);
+```ts
+import {defineConfig} from "vitest/config";
 
-      expect(response.body).to.be.an("array");
-    });
-  });
+export default defineConfig({
+  test: {
+    globalSetup: [import.meta.resolve("@tsed/testcontainers-mongo/vitest/setup")]
+  }
 });
 ```
 
-## Jest additional setup
+:::
 
-Add a script to close connection after all unit test. In your jest configuration file add the following line:
+### Usage
 
-```json
-{
-  "globalTeardown": "./scripts/jest/teardown.js"
+```ts
+import {PlatformTest} from "@tsed/common";
+import {Property, Required} from "@tsed/schema";
+import {Model, MongooseModel, ObjectID, PostHook, PreHook, Unique} from "@tsed/mongoose";
+import {TestContainersMongo} from "@tsed/testcontainers-mongo";
+
+@Model({schemaOptions: {timestamps: true}})
+@PreHook("save", (user: UserModel, next: any) => {
+  user.pre = "hello pre";
+
+  next();
+})
+@PostHook("save", (user: UserModel, next: any) => {
+  user.post = "hello post";
+
+  next();
+})
+export class UserModel {
+  @ObjectID("id")
+  _id: string;
+
+  @Property()
+  @Required()
+  @Unique()
+  email: string;
+
+  @Property()
+  pre: string;
+
+  @Property()
+  post: string;
 }
-```
 
-And create the script with the following content:
+describe("UserModel", () => {
+  beforeEach(() => TestContainersMongo.create());
+  afterEach(() => TestContainersMongo.reset("users")); // clean users collection after each test
 
-```js
-module.exports = async () => {
-  await global.__MONGOD__.stop();
-};
+  it("should run pre and post hook", async () => {
+    const userModel = PlatformTest.get<MongooseModel<UserModel>>(UserModel);
+
+    // GIVEN
+    const user = new userModel({
+      email: "test@test.fr"
+    });
+
+    // WHEN
+    await user.save();
+
+    // THEN
+    expect(user.pre).toEqual("hello pre");
+    expect(user.post).toEqual("hello post");
+  });
+});
 ```
 
 ## Contributors