Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nodkz/mongodb-memory-server

Spinning up mongod in memory for fast tests. If you run tests in parallel this lib helps to spin up dedicated mongodb servers for every test file in MacOS, *nix, Windows or CI environments (in most cases with zero-config).
https://github.com/nodkz/mongodb-memory-server

mock mongodb mongoose testing testing-tools tests

Last synced: 23 days ago
JSON representation

Spinning up mongod in memory for fast tests. If you run tests in parallel this lib helps to spin up dedicated mongodb servers for every test file in MacOS, *nix, Windows or CI environments (in most cases with zero-config).

Lists

README 

        
# MongoDB In-Memory Server



[![Node.js CI](https://github.com/nodkz/mongodb-memory-server/workflows/Node.js%20CI/badge.svg)](https://github.com/nodkz/mongodb-memory-server/actions/workflows/tests.yml?query=workflow%3A%22Node.js+CI%22)

[![NPM version](https://img.shields.io/npm/v/mongodb-memory-server.svg)](https://www.npmjs.com/package/mongodb-memory-server)

[![Downloads stat](https://img.shields.io/npm/dt/mongodb-memory-server.svg)](http://www.npmtrends.com/mongodb-memory-server)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![TypeScript compatible](https://img.shields.io/badge/typescript-compatible-brightgreen.svg)](https://www.typescriptlang.org)

[![codecov.io](https://codecov.io/github/nodkz/mongodb-memory-server/coverage.svg?branch=master)](https://codecov.io/github/nodkz/mongodb-memory-server?branch=master)

[![Backers on Open Collective](https://opencollective.com/mongodb-memory-server/backers/badge.svg)](#backers)

[![Sponsors on Open Collective](https://opencollective.com/mongodb-memory-server/sponsors/badge.svg)](#sponsors)

[![mongodb-memory-server-core](https://snyk.io/advisor/npm-package/mongodb-memory-server-core/badge.svg)](https://snyk.io/advisor/npm-package/mongodb-memory-server-core)



This package spins up an actual/real MongoDB server programmatically from within nodejs, for testing or mocking during development. By default it holds the data in memory. A fresh spun up `mongod` process takes about 7Mb of memory. The server will allow you to connect your favorite ODM or client library to the MongoDB server and run integration tests isolated from each other.



On install, this [package downloads](#configuring-which-mongod-binary-to-use) the latest MongoDB binaries and saves them to a cache folder. (only `mongodb-memory-server-core` does not download on `postinstall`)



On starting a new instance of the memory server, if the binary cannot be found, it will be auto-downloaded (if [`RUNTIME_DOWNLOAD`](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#runtime_download) option is truthy), thus the first run may take some time. All further runs will be fast, because they will use the downloaded binaries.



This package automatically downloads binaries from [https://fastdl.mongodb.org/](https://fastdl.mongodb.org/) according to your operating system. You can see all available versions for [Linux](https://www.mongodb.org/dl/linux) (Ubuntu, RHEL, Debian, SUSE, Amazon), [OSX](https://www.mongodb.org/dl/osx), and [Windows](https://www.mongodb.org/dl/win32).



> If your network is behind a proxy, make sure that it is configured through the `HTTPS_PROXY` or `HTTP_PROXY` environment variable.



Every `MongoMemoryServer` instance creates and starts a fresh MongoDB server on some free port. You may start up several `mongod` simultaneously. When you terminate your script or call `stop()`, the MongoDB server(s) will be automatically shutdown.



Works perfectly with any CI runner that can run NodeJS applications.



**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*



- [Installation](#installation)

  - [Requirements](#requirements)

  - [Choose the Correct Package](#choose-the-correct-package)

  - [Configuring which mongod binary to use](#configuring-which-mongod-binary-to-use)

- [Usage](#usage)

  - [Simple server start](#simple-server-start)

  - [Available options for MongoMemoryServer](#available-options-for-mongomemoryserver)

  - [Replica Set start](#replica-set-start)

  - [Available options for MongoMemoryReplSet](#available-options-for-mongomemoryreplset)

  - [Config Options](#config-options)

  - [Simple test with MongoClient in Jest](#simple-test-with-mongoclient-in-jest)

  - [Provide connection string to mongoose](#provide-connection-string-to-mongoose)

  - [Test Runner Examples](#test-runner-examples)

  - [Docker Alpine](#docker-alpine)

  - [Enable Debug Mode](#enable-debug-mode)

- [Contributing](#contributing)

- [Join Our Discord Server](#join-our-discord-server)

- [Documentation](#documentation)

- [Credits](#credits)

  - [Inspired by](#inspired-by)

  - [Maintainers](#maintainers)

- [Funding](#funding)

  - [Contributors](#contributors)

  - [Backers](#backers)

  - [Sponsors](#sponsors)

- [License](#license)



## Installation



This tool provides three packages for different purposes:



- With auto-download mongod binary on npm install (`mongodb-memory-server`, `mongodb-memory-server-global-*`)

- Without auto-download on npm install (`mongodb-memory-server-core`)



Choose any package, because they are the same. They differ only in the default configuration, which you may override (see section [Available options](#available-options-for-mongomemoryserver)).



### Requirements



- NodeJS: 14.20.1+

- Typescript: 5.0+ (if used)



And one of those (on Linux):



- having `lsb-core` installed (or any that provides the `lsb_release` command)

- having an `/etc/os-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html)

- having an `/etc/*-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html) (and does not include `lsb`)

- manually specify which version & system should be used



On Linux, you will also need `libcurl4` (or `libcurl3` on some older distro versions). This will probably only be an issue on "slim" Docker images.



### Choose the Correct Package



[Choose the right package for the task](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide#choose-the-right-package)



### Configuring which mongod binary to use



The default behavior is that version `6.0.14` for your OS will be downloaded. By setting [Environment variables](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options) you are able to specify which version and binary will be downloaded:



```sh

export MONGOMS_DOWNLOAD_URL=https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-4.2.8.tgz

export MONGOMS_VERSION=4.2.8

```



## Usage



### Simple server start



A Normal Server can be easily started with:



```ts

import { MongoMemoryServer } from 'mongodb-memory-server';



// This will create an new instance of "MongoMemoryServer" and automatically start it

const mongod = await MongoMemoryServer.create();



const uri = mongod.getUri();



// The Server can be stopped again with

await mongod.stop();

```



### Available options for MongoMemoryServer



All options with `?` are optional, some options upon specified are required.



```js

const mongod = new MongoMemoryServer({

  instance?: {

    port?: number, // by default choose any free port

    ip?: string, // by default '127.0.0.1', for binding to all IP addresses set it to `::,0.0.0.0`,

    dbName?: string, // by default '' (empty string)

    dbPath?: string, // by default create in temp directory

    storageEngine?: string, // by default `ephemeralForTest`(unless mongodb 7.0.0, where its `wiredTiger`), available engines: [ 'ephemeralForTest', 'wiredTiger' ]

    replSet?: string, // by default no replica set, replica set name

    args?: string[], // by default no additional arguments, any additional command line arguments for `mongod` `mongod` (ex. ['--notablescan'])

    auth?: boolean, // add "--auth" argument, dont use this directly use top-level "auth"

  },

  binary?: {

    version?: string, // by default '6.0.14'

    downloadDir?: string, // see the documentation on what is chosen by default https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#download_dir

    platform?: string, // by default os.platform()

    arch?: string, // by default os.arch()

    checkMD5?: boolean, // by default false OR process.env.MONGOMS_MD5_CHECK

    systemBinary?: string, // by default undefined or process.env.MONGOMS_SYSTEM_BINARY

  },

  // using "auth" will manage "instance.auth"

  auth?: {

    // enable needs to be set to "true", otherwise automatic user creation is by default disabled

    enable?: boolean, // enable automatic user creation

    customRootName?: string, // by default "mongodb-memory-server-root"

    customRootPwd?: string, // by default "rootuser"

    force?: boolean, // force creation of users

    keyfileContent?: string, // by default "0123456789" (only useful for replsets)

    extraUsers?: [{

      // see mongodb documentation https://docs.mongodb.com/manual/reference/method/db.createUser/#definition)

      createUser: string, // user name

      pwd: string, // user password

      roles: UserRoles[], // user roles

      database?: string, // which database the user is created on

      customData?: Record, // any arbitrary information, see mongodb documentation

      mechanisms?: ('SCRAM-SHA-1' | 'SCRAM-SHA-256')[],

      authenticationRestrictions?: {

        clientSource?: string;

        serverAddress?: string;

      }[],

      digestPassword?: boolean,

    }],

  },

});

```



### Replica Set start



A ReplicaSet can be easily started with:



```ts

import { MongoMemoryReplSet } from 'mongodb-memory-server';



// This will create an new instance of "MongoMemoryReplSet" and automatically start all Servers

const replset = await MongoMemoryReplSet.create({ replSet: { count: 4 } }); // This will create an ReplSet with 4 members



const uri = replset.getUri();



// The ReplSet can be stopped again with

await replset.stop();

```



### Available options for MongoMemoryReplSet



All options are optional.



```js

const replSet = new MongoMemoryReplSet({

  binary: binaryOpts, // same as for MongoMemoryServer

  instanceOpts: [

    {

      args, // any additional instance specific args

      port, // port number for the instance

      dbPath, // path to database files for this instance

      storageEngine, // same storage engine options

    },

    // each entry will result in a MongoMemoryServer (replSet.count will not limit the amount spawned by "instanceOpts")

  ],

  // unless otherwise noted below these values will be in common with all instances spawned:

  replSet: {

    name, // replica set name (default: 'testset')

    auth?: boolean | AutomaticAuth, // enable auth, for options see #available-options-for-mongomemoryserver

    args, // any args specified here will be combined with any per instance args from `instanceOpts`

    count, // number of additional `mongod` processes to start (will not start any extra if instanceOpts.length > replSet.count); (default: 1)

    dbName, // default database for db URI strings

    ip, // by default '127.0.0.1', for binding to all IP addresses set it to `::,0.0.0.0`

    spawn, // spawn options when creating the child processes

    storageEngine, // default storage engine for instance. (Can be overridden per instance)

    configSettings: {

      // Optional settings for 'replSetInitiate' command. See https://docs.mongodb.com/manual/reference/command/replSetInitiate/

      chainingAllowed: boolean, // When true it allows secondary members to replicate from other secondary members. When false, secondaries can replicate only from the primary.

      heartbeatTimeoutSecs: number, // Number of seconds that the replica set members wait for a successful heartbeat from each other. If a member does not respond in time, other members mark the delinquent member as inaccessible.

      heartbeatIntervalMillis: number, // The frequency in milliseconds of the heartbeats.

      electionTimeoutMillis: number, // The time limit in milliseconds for detecting when a replica set’s primary is unreachable.

      catchUpTimeoutMillis: number, // Time limit for a newly elected primary to sync (catch up) with the other replica set members that may have more recent writes.

    },

  },

});

```



### Config Options



[Documentation of Config Options](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options)



### Simple test with MongoClient in Jest



A example test file for a *single* [MongoMemoryServer](https://github.com/nodkz/mongodb-memory-server/blob/master/packages/mongodb-memory-server-core/src/__tests__/singleDB.test.ts) within jest.



A example test file for *multiple* [MongoMemoryServer](https://github.com/nodkz/mongodb-memory-server/blob/master/packages/mongodb-memory-server-core/src/__tests__/multipleDB.test.ts) within jest.



A example test file for a *single* [MongoMemoryReplSet](https://github.com/nodkz/mongodb-memory-server/blob/master/packages/mongodb-memory-server-core/src/__tests__/replset-multi.test.ts) within jest.



### Provide connection string to mongoose



```js

// assuming [email protected]

import mongoose from 'mongoose';

import { MongoMemoryServer } from 'mongodb-memory-server';



const mongoServer = await MongoMemoryServer.create();



(async () => {

  await mongoose.connect(mongoServer.getUri(), { dbName: "verifyMASTER" });



  // your code here

  

  await mongoose.disconnect();

})();

```



### Test Runner Examples



[Documentation for Test Runner Integration Examples](https://nodkz.github.io/mongodb-memory-server/docs/guides/integration-examples/test-runners)



### Docker Alpine



There isn't currently an official MongoDB release for alpine linux. This means that we can't pull binaries for Alpine

(or any other platform that isn't officially supported by MongoDB), but you can use a Docker image that already has mongod

built in and then set the [`MONGOMS_SYSTEM_BINARY`](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#system_binary) variable to point at that binary. This should allow you to use `mongodb-memory-server` on any system on which you can install mongod manually.



### Enable Debug Mode



The Debug mode can be enabled with an Environment-Variable or in the package.json "config" section:



```sh

MONGOMS_DEBUG=1 # also available case-insensitive values: "on" "yes" "true"

```



or



```json

{

  "config": {

    "mongodbMemoryServer": {

      "debug": "1", // also available case-insensitive values: "on" "yes" "true"

    }

  }

}

```



Also see the [Enable Debug Mode](https://nodkz.github.io/mongodb-memory-server/docs/guides/enable-debug-mode) Guide.



## Contributing



Contributing Guidelines are setup in [CONTRIBUTING](./.github/CONTRIBUTING.md)



## Join Our Discord Server



To ask questions or just talk with us, [join our Discord Server](https://discord.gg/bgCrRP9).



## Documentation



- [Documentation](https://nodkz.github.io/mongodb-memory-server/docs/api/index-api)

- [Quick start guide](https://nodkz.github.io/mongodb-memory-server/docs/guides/quick-start-guide/)

- [Known Issues](https://nodkz.github.io/mongodb-memory-server/docs/guides/known-issues)



## Credits



### Inspired by



Inspired by alternative runners for [mongodb-prebuilt](https://github.com/winfinit/mongodb-prebuilt):



- [mockgoose](https://github.com/mockgoose/Mockgoose)

- [mongomem](https://github.com/CImrie/mongomem)



### Maintainers



- [@nodkz](https://github.com/nodkz) Pavel Chertorogov

- [@AJRdev](https://github.com/AJRdev) Andre Ranarivelo

- [@hasezoey](https://github.com/hasezoey)



## Funding



### Contributors



This project exists thanks to all the people who contribute.




### Backers



Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/mongodb-memory-server#backer)]






### Sponsors



Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/mongodb-memory-server#sponsor)]
























## License



MIT