Skip to content

Commit 82f9616

Browse files
committed
doc(Readme): Add Jest examples
closes #1
1 parent d10e8bb commit 82f9616

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

+33-6
Original file line numberDiff line numberDiff line change
@@ -164,28 +164,55 @@ const User = mongoose.model('User', new mongoose.Schema({ name: String })); // d
164164

165165

166166

167-
### Simple Mocha test example
167+
### Simple Mocha/Chai test example
168168
```js
169169
import mongoose from 'mongoose';
170170
import MongodbMemoryServer from 'mongodb-memory-server';
171171

172-
before(function(done) {
172+
before((done) => {
173173
const mongoServer = new MongodbMemoryServer();
174174
mongoServer.getConnectionString().then((mongoUri) => {
175-
mongoose.connect(mongoUri, function(err) {
175+
mongoose.connect(mongoUri, (err) => {
176176
done(err);
177177
});
178178
});
179179
});
180180

181-
describe('...', function() {
182-
it("...", function() {
183-
// ...
181+
describe('...', () => {
182+
it("...", async () => {
183+
const User = mongoose.model('User', new mongoose.Schema({ name: String }));
184+
const cnt = await User.count();
185+
expect(cnt).to.equal(0);
184186
});
185187
});
188+
```
189+
190+
### Simple Jest test example
191+
```js
192+
import mongoose from 'mongoose';
193+
import MongodbMemoryServer from 'mongodb-memory-server';
194+
195+
beforeAll(async () => {
196+
const mongoServer = new MongodbMemoryServer();
197+
const mongoUri = await mongoServer.getConnectionString();
198+
mongoose.connect(mongoUri, (err) => {
199+
console.error(err);
200+
});
201+
});
186202

203+
describe('...', () => {
204+
it("...", async () => {
205+
const User = mongoose.model('User', new mongoose.Schema({ name: String }));
206+
const cnt = await User.count();
207+
expect(cnt).toEqual(0);
208+
});
209+
});
187210
```
188211

212+
Additional examples of Jest tests:
213+
- simple example with `mongodb` in [tests in current package](https://github.com/nodkz/mongodb-memory-server/blob/master/src/__tests__/index-test.js)
214+
- more complex example with `mongoose` in [graphql-compose-mongoose](https://github.com/nodkz/graphql-compose-mongoose/blob/master/src/__mocks__/mongooseCommon.js)
215+
189216

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

0 commit comments

Comments
 (0)