📅 You're Invited: Meet the Socket team at RSAC (April 28 – May 1).RSVP

vitest-mongodb

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vitest-mongodb

Run your tests using Vitest and MongoDB in Memory server.

1.0.1
latest
Version published
Weekly downloads
6.4K
22.09%
Maintainers
1
Weekly downloads
 
Created

vitest-mongodb

Run your tests with Vitest and MongoDB Memory server.

Installation

yarn add -D vitest-mongodb
npm i -D vitest-mongodb
pnpm i -D vitest-mongodb

Usage

An example project can be found at /example.

  • Create a setup file.
// ./setup/mongo-memory-server.ts
import { afterAll, beforeAll } from "vitest";
import { setup, teardown } from "vitest-mongodb";

beforeAll(async () => {
  await setup();
});

afterAll(async () => {
  await teardown();
});
  • Include that setup file in your Vitest config.
// vitest.config.ts
import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    setupFiles: ["./setup/mongo-memory-server.ts"],
  },
});
  • Connect to the server in tests using the globalThis.__MONGO_URI__ global variable.
import { MongoClient } from "mongodb";
import { it, expect } from "vitest";
it("connects to mongodb", () => {
  expect(async () => {
    const client = new MongoClient(globalThis.__MONGO_URI__);
    try {
      const db = client.db("test");
      await db.command({ ping: 1 });
    } finally {
      await client.close();
    }
  }).not.toThrow();
});

Configuration

The setup function provides some configuration options.

Setup Options:

type Options =
  | {
      type?: "default";
      serverOptions?: Partial<MongoMemoryServerOpts>;
    }
  | {
      type: "replSet";
      serverOptions?: Partial<MongoMemoryReplSetOpts>;
    };

Example: create a ReplSet

// ./setup/mongo-memory-server.ts
import { afterAll, beforeAll } from "vitest";
import { setup, teardown } from "vitest-mongodb";

beforeAll(async () => {
  await setup({ type: "replSet", serverOptions: { replSet: { count: 4 } } });
});

afterAll(async () => {
  await teardown();
});

TypeScript

To get __MONGO_URI__ on your globalThis object, add the follow file:

// test/global.d.ts
declare var __MONGO_URI__: string;

Comparison to jest-mongodb

These two packages are fairly similar with slightly different configuration.

jest-mongodb Options

The following is how to get the desired effect as jest-mongodb options.

  • useSharedDBForAllJestWorkers: Run vitest with option --no-threads so that the setup file is only called once.
  • mongoURLEnvName: No plans to implement.

FAQs

Package last updated on 22 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts