vitest-environment-mongodb 1.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/README.md

@@ -0,0 +1,74 @@
+# vitest-environment-mongodb
+
+Setup a MongoDB environment for Vitest tests using mongodb-memory-server.
+
+This package provides a Vitest environment that uses `mongodb-memory-server` to create an in-memory MongoDB instance for testing purposes. It is designed to be used with Vitest, a Vite-native test framework.
+
+It will spin up a memory server instance, and set the connection string on
+`process.env.MONGO_CONNECTION_STRING` by default, or value you can configure
+with `mongoUrlEnvName` option.
+
+## Installation
+
+Use your favorite package manager to install the package:
+
+```bash
+npm install --save-dev vitest-environment-mongodb
+```
+
+or
+
+```bash
+yarn add --dev vitest-environment-mongodb
+```
+
+or
+
+```bash
+pnpm add --save-dev vitest-environment-mongodb
+```
+
+## Usage
+
+Once installed, you can use the environment in your Vitest configuration per the
+[documentation](https://vitest.dev/guide/environment.html).
+
+### Use in Vitest config
+
+```js
+import { defineConfig } from "vitest/config"
+
+export default defineConfig({
+  test: {
+    environment: "mongodb",
+    environmentOptions: {
+      mongoUrlEnvName: "MONGO_CONNECTION_STRING", // optional, default is MONGO_CONNECTION_STRING
+      replicaSet: false, // optional, default is false
+      serverOptions: MongoMemoryServerOpts | MongoMemoryReplSetOpts, //optional, server options for the chosen server type
+    },
+  },
+})
+```
+
+### Use control comment in a test file
+
+```js
+// @vitest-environment mongodb
+import { expect, test } from "vitest"
+import { UserCollection } from "./models/UserCollection"
+
+test("should create a user", async () => {
+  const { insertedId } = await UserCollection.insertOne({ name: "John Doe" })
+  const user = await UserCollection.findOne({ _id: insertedId })
+  expect(user).toBeDefined()
+  expect(user).toHaveProperty("name")
+  expect(user).toHaveProperty("_id")
+  expect(user.name).toBe("John Doe")
+})
+```
+
+## Options
+
+- `mongoUrlEnvName` (string): The name of the environment variable that will contain the MongoDB connection string. Default is `MONGO_CONNECTION_STRING`.
+- `replicaSet` (boolean): Whether to use a replica set. Default is `false`.
+  And any other options that are supported by `mongodb-memory-server` package.

package/dist/mongodb-environment.d.ts

@@ -0,0 +1,3 @@
+import type { Environment } from "vitest/environments";
+declare const _default: Environment;
+export default _default;

package/dist/mongodb-environment.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongodb_memory_server_1 = require("mongodb-memory-server");
+exports.default = {
+    name: "mongodb",
+    transformMode: "ssr",
+    async setup(_, options) {
+        // parse out options
+        const isReplicaSet = options?.replicaSet;
+        const serverOptions = options?.serverOptions ?? {};
+        const mongoUrlEnvName = options?.mongoUrlEnvName ?? "MONGO_CONNECTION_STRING";
+        // create server
+        const mongoServer = isReplicaSet
+            ? await mongodb_memory_server_1.MongoMemoryServer.create(serverOptions)
+            : await mongodb_memory_server_1.MongoMemoryReplSet.create(serverOptions);
+        // put the connection string in the environment
+        process.env[mongoUrlEnvName] = mongoServer.getUri();
+        return {
+            async teardown() {
+                // stop the server
+                await mongoServer.stop();
+            },
+        };
+    },
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "vitest-environment-mongodb",
+  "version": "1.0.0",
+  "description": "Sets up a MongoDB memory-server environment for testing with Vitest.",
+  "main": "dist/mongodb-environment.js",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "prepack": "npm run build",
+    "semantic-release": "semantic-release"
+  },
+  "keywords": [],
+  "author": "Joseph Gilgen <2569898+jb-1980@users.noreply.github.com>",
+  "license": "MIT",
+  "dependencies": {
+    "mongodb-memory-server": "^10.1.4"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.14",
+    "semantic-release": "^24.2.3",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  }
+}

package/src/mongodb-environment.ts

@@ -0,0 +1,45 @@
+import type { Environment } from "vitest/environments"
+import { MongoMemoryReplSet, MongoMemoryServer } from "mongodb-memory-server"
+
+type Options =
+  | {
+      replicaSet?: false
+      mongoUrlEnvName?: string
+      serverOptions?: NonNullable<
+        Parameters<(typeof MongoMemoryServer)["create"]>[0]
+      >
+    }
+  | {
+      replicaSet: true
+      mongoUrlEnvName?: string
+      serverOptions?: NonNullable<
+        Parameters<(typeof MongoMemoryReplSet)["create"]>[0]
+      >
+    }
+
+export default <Environment>{
+  name: "mongodb",
+  transformMode: "ssr",
+  async setup(_, options?: Options) {
+    // parse out options
+    const isReplicaSet = options?.replicaSet
+    const serverOptions = options?.serverOptions ?? {}
+    const mongoUrlEnvName =
+      options?.mongoUrlEnvName ?? "MONGO_CONNECTION_STRING"
+
+    // create server
+    const mongoServer = isReplicaSet
+      ? await MongoMemoryServer.create(serverOptions)
+      : await MongoMemoryReplSet.create(serverOptions)
+
+    // put the connection string in the environment
+    process.env[mongoUrlEnvName] = mongoServer.getUri()
+
+    return {
+      async teardown() {
+        // stop the server
+        await mongoServer.stop()
+      },
+    }
+  },
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "target": "esnext",
+    "strict": true,
+    "outDir": "./dist",
+    "declaration": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}