Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shelfio/jest-mongodb
Jest preset for MongoDB in-memory server
https://github.com/shelfio/jest-mongodb
jest jest-environment jest-preset mongodb nodejs npm-package tests
Last synced: 1 day ago
JSON representation
Jest preset for MongoDB in-memory server
- Host: GitHub
- URL: https://github.com/shelfio/jest-mongodb
- Owner: shelfio
- License: mit
- Created: 2018-02-15T00:22:42.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T21:34:12.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:11:32.764Z (about 1 month ago)
- Topics: jest, jest-environment, jest-preset, mongodb, nodejs, npm-package, tests
- Language: TypeScript
- Homepage:
- Size: 519 KB
- Stars: 591
- Watchers: 26
- Forks: 83
- Open Issues: 46
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-jest - jest-mongodb
- stars - jest-mongodb - memory server | shelfio | 594 | (TypeScript)
- stars - jest-mongodb - memory server | shelfio | 594 | (TypeScript)
README
# jest-mongodb [](https://circleci.com/gh/shelfio/jest-mongodb/tree/master)  [](https://www.npmjs.com/package/@shelf/jest-mongodb)
> Jest preset to run MongoDB memory server
## Usage
### 0. Install
```
$ yarn add @shelf/jest-mongodb --dev
```
Make sure `mongodb` is installed in the project as well, as it's required as a peer dependency.
### 1. Create `jest.config.js`
```js
module.exports = {
preset: '@shelf/jest-mongodb',
};
```
If you have a custom `jest.config.js` make sure you remove `testEnvironment` property, otherwise it will conflict with the preset.
### 2. Create `jest-mongodb-config.js`
See [mongodb-memory-server](https://github.com/nodkz/mongodb-memory-server#available-options)
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
version: '4.0.3',
skipMD5: true,
},
autoStart: false,
instance: {},
},
};
```
To use the same database for all tests pass the config like this:
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
version: '4.0.3',
skipMD5: true,
},
instance: {
dbName: 'jest',
},
autoStart: false,
},
};
```
To use separate database for each jest worker pass the `useSharedDBForAllJestWorkers: false` (doesn't create `process.env` variable when using this option):
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
skipMD5: true,
},
autoStart: false,
instance: {},
},
useSharedDBForAllJestWorkers: false,
};
```
To use dynamic database name you must pass empty object for instance field:
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
version: '4.0.3',
skipMD5: true,
},
instance: {},
autoStart: false,
},
};
```
To use another uri environment variable name you must set mongoURLEnvName field:
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
version: '4.0.3',
skipMD5: true,
},
instance: {},
autoStart: false,
},
mongoURLEnvName: 'MONGODB_URI',
};
```
To use mongo as a replica set you must add the `replSet` config object and set
`count` and `storageEngine` fields:
```js
module.exports = {
mongodbMemoryServerOptions: {
binary: {
skipMD5: true,
},
autoStart: false,
instance: {},
replSet: {
count: 3,
storageEngine: 'wiredTiger',
},
},
};
```
### 3. Configure MongoDB client
Library sets the `process.env.MONGO_URL` for your convenience, but using of `global.__MONGO_URI__` is preferable as it works with ` useSharedDBForAllJestWorkers: false`
```js
const {MongoClient} = require('mongodb');
describe('insert', () => {
let connection;
let db;
beforeAll(async () => {
connection = await MongoClient.connect(global.__MONGO_URI__, {
useNewUrlParser: true,
useUnifiedTopology: true,
});
db = await connection.db();
});
afterAll(async () => {
await connection.close();
});
});
```
### 4. PROFIT! Write tests
```js
it('should insert a doc into collection', async () => {
const users = db.collection('users');
const mockUser = {_id: 'some-user-id', name: 'John'};
await users.insertOne(mockUser);
const insertedUser = await users.findOne({_id: 'some-user-id'});
expect(insertedUser).toEqual(mockUser);
});
```
Cache MongoDB binary in CI by putting this folder to the list of cached paths: `./node_modules/.cache/mongodb-memory-server/mongodb-binaries`
You can enable debug logs by setting environment variable `DEBUG=jest-mongodb:*`
#### 5. Clean collections before each test (optional)
```js
beforeEach(async () => {
await db.collection('COLLECTION_NAME').deleteMany({});
});
```
See [this issue](https://github.com/shelfio/jest-mongodb/issues/173) for discussion
#### 6. Jest watch mode gotcha
This package creates the file `globalConfig.json` in the project root, when using jest `--watch` flag, changes to `globalConfig.json` can cause an infinite loop
In order to avoid this unwanted behaviour, add `globalConfig` to ignored files in watch mode in the Jest configuation
```js
// jest.config.js
module.exports = {
watchPathIgnorePatterns: ['globalConfig'],
};
```
## See Also
- [jest-dynamodb](https://github.com/shelfio/jest-dynamodb)
## Publish
```sh
$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tags
```
## License
MIT © [Shelf](https://shelf.io)