Easily install and run MongoDB to test your code against it.
- Introduction
- How to play with MongoDB
- Debugging
- Configuration
- CLI Usage
- TravisCI Integration
- Mocha Integration
This is a tool I wrote for a node app using MongoDB that I was working on. I wanted other contributors to have the database, MongoDB, just work without any extra steps once they cloned the repo and installed app dependencies.
Then I wanted to be able to test using different versions and configurations of mongo. This tool allowed me to test new releases and configurations of mongo before changing anything in our app servers on AWS.
npm install -g mongodb-runner;
mongodb-runner start; # downloads mongodb and starts locally
mongo; # Shell opens connected to mongodb://localhost:27017mongodb-runner uses the debug module so if something isn't working correctly, set the DEBUG environment variable to DEBUG=mongodb-* for lots of helpful messages.
The latest stable version of MongoDB will automatically be downloaded and installed by default when start is run.
[Default: stable]
The port MongoDB will be accessible locally on.
[Default: 27017]
The base path for data storage. [Default: ~/.mongodb/data/standalone]
The base directory for data to be stored. [Default: ~/.mongodb/logs/standalone.log]
One of standalone, replicaset, or cluster [Default: standalone].
only applicable when
topologyisreplicaset
The number of arbiter processes to start [Default: 0].
The number of passive processes to start [Default: 1].
How many secondary instances to start [Default: 2].
only applicable when
topologyiscluster
Number of shards in the cluster [Default: 2].
Number of router processes to start [Default: 2].
Number of config server processes to start [Default: 1].
Port number to start incrementing from when starting routers [Default 50000].
Port number to start incrementing from when starting shard members [Default 31000].
Port number to start incrementing from when starting config servers [Default 35000].
| Option | Environment Variable |
|---|---|
version |
MONGODB_VERSION |
port |
MONGODB_PORT |
topology |
MONGODB_TOPOLOGY |
arbiters |
MONGODB_ARBITERS |
secondaries |
MONGODB_SECONDARIES |
passives |
MONGODB_PASSIVES |
shards |
MONGODB_SHARDS |
routers |
MONGODB_ROUTERS |
configs |
MONGODB_CONFIGS |
shards_port |
MONGODB_SHARDS_PORT |
configs_port |
MONGODB_CONFIGS_PORT |
arbiters |
MONGODB_ARBITERS |
secondaries |
MONGODB_SECONDARIES |
passives |
MONGODB_PASSIVES |
Usage: mongodb-runner <start|stop> [options]
Start/stop mongodb for testing.
Options:
--topology=<topology> One of standalone, replicaset, or cluster [Default: `standalone`].
--pidpath=<pidpath> Where to put pid files [Default: `~/.mongodb/pids`].
--bin=<path> Path to mongod|mongos binary [Default: `which mongod|mongos`].
Options depending on `--topology`:
--topology=standalone
--name=<name> The replSet name [Default: `my-standalone`].
--port=<port> Port to start mongod on [Default: `27017`].
--dbpath=<dbpath> Where to put the data [Default: `~/.mongodb/data/[standalone]`]
--logpath=<logpath> [Default: `~/.mongodb/#{name}.log`]
--topology=replicaset
--name=<name> The replSet name [Default: `my-replicaset`].
--port=<port> The starting port to use for mongod instances [Default: `31000`].
--dbpath=<dbpath> [Default: `~/.mongodb/data/#{name}-#{instance_id}`]
--logpath=<logpath> [Default: `~/.mongodb/#{name}.log/#{instance_id}.log`]
--arbiters=<n> How many arbiters to start [Default: `0`].
--passives=<n> How many passive instances to start [Default: `1`].
--secondaries=<n> How many secondary instances to start [Default: `2`]. Maps to `secondaries` option.
--topology=cluster
--shards=<n> Number of shards in the cluster [Default: `2`].
--routers=<n> Number of router instances [Default: `2`].
--configs=<n> Number of config servers [Default: `1`].
--routerPort=<port> Port number to start incrementing from when starting routers [Default `50000`].
--port=<port> Port number to start incrementing from when starting shard members [Default `31000`].
--configPort=<port> Port number to start incrementing from when starting shard members [Default `35000`].
Environment Variables:
MONGODB_VERSION What version of MongoDB should be installed and available [Default: `stable`]
MONGODB_TOPOLOGY See `--topology`
MONGODB_PORT See `--port`
MONGODB_TOPOLOGY See `topology`
MONGODB_ARBITERS See `arbiters`
MONGODB_SECONDARIES See `secondaries`
MONGODB_PASSIVES See `passives`
MONGODB_SHARDS See `--shards`
MONGODB_ROUTERS See `--routers`
MONGODB_CONFIGS See `--configs`
MONGODB_SHARDS_PORT See `--shardPort`
MONGODB_CONFIGS_PORT See `--configPort`
MONGODB_ARBITERS See `--arbiters`
MONGODB_SECONDARIES See `--secondaries`
MONGODB_PASSIVES See `--passives`
Modify your package.json to start and stop MongoDB before and after your tests
automatically when you run npm test:
{
"scripts": {
"pretest": "mongodb-runner start",
"test": "mocha",
"posttest": "mongodb-runner stop"
}
}Update your .travis.yml to run your tests against the full version + topology matrix:
language: node_js
cache:
directories:
- node_modules
env:
- MONGODB_VERSION=^3.6.0 MONGODB_TOPOLOGY=standalone
- MONGODB_VERSION=stable MONGODB_TOPOLOGY=standalone
- MONGODB_VERSION=unstable MONGODB_TOPOLOGY=standalone
- MONGODB_VERSION=^3.6.0 MONGODB_TOPOLOGY=replicaset
- MONGODB_VERSION=stable MONGODB_TOPOLOGY=replicaset
- MONGODB_VERSION=unstable MONGODB_TOPOLOGY=replicaset
- MONGODB_VERSION=^3.6.0 MONGODB_TOPOLOGY=cluster
- MONGODB_VERSION=stable MONGODB_TOPOLOGY=cluster
- MONGODB_VERSION=unstable MONGODB_TOPOLOGY=clusterAnd 🎉 Now you're fully covered for all of those all of those edge cases the full version + topology matrix can present!
Mocha before/after hooks make writing tests for code that depends on MongoDB insanely simple:
describe('my app', function() {
before(require('mongodb-runner/mocha/before'));
after(require('mongodb-runner/mocha/after'));
it('should connect', function(done) {
require('mongodb').connect('mongodb://localhost:27017/', done);
});
});Global hooks are also supported. Add the following to a new file called test/mongodb.js:
before(require('mongodb-runner/mocha/before'));
after(require('mongodb-runner/mocha/after'));And then just require it:
mocha --require test/mongodb.js test/*.test.js
Apache 2.0
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent