MongoDB testing recipe #1357

CImrie · 2017-04-13T13:30:22Z

Includes a recipe detailing how to run isolated MongoDB tests using an in-memory MongoDB server.
Includes 'extra' steps to run with Mongoose.
As request in #807 .

novemberborn

Thanks for taking the effort to share this knowledge. I have a bunch of comments, hope you don't mind 😊 😄 The upshot is that there are some AVA features I think this can take advantage of.

Should the test.always.after() teardown be documented? You mention it here: #807 (comment).

I tried to find the source for mongomem but https://www.npmjs.com/package/mongomem doesn't have a link?

novemberborn · 2017-04-13T16:03:53Z

docs/recipes/isolating-mongodb-integration-tests.md

@@ -0,0 +1,86 @@
+# Setting up Ava for Isolated MongoDB Integration Tests


It's AVA in all-caps 😄

🙈 apologies!

novemberborn · 2017-04-13T16:04:56Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+## Using MongoMem
+In your test file, import the module and run the server. 
+*Make sure to run the server at the start of your file, outside of any test cases.*


Did you intend for this to be on its own line? Cause GitHub renders it right after "run the server."

novemberborn · 2017-04-13T16:05:48Z

docs/recipes/isolating-mongodb-integration-tests.md

+*Make sure to run the server at the start of your file, outside of any test cases.*
+
+```javascript
+import { MongoDBServer } from 'mongomem';


Perhaps add the import test from "ava" line as well.

novemberborn · 2017-04-13T16:06:10Z

docs/recipes/isolating-mongodb-integration-tests.md

+let hasStarted = MongoDBServer.start();
+
+// ES6 promise syntax
+test('some feature - es6', t => {


We're pretty vocal in advocating async with AVA. I don't think we should include this example.

novemberborn · 2017-04-13T16:07:15Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+```javascript
+import { MongoDBServer } from 'mongomem';
+let hasStarted = MongoDBServer.start();


This may work even nicer with before:

test.before(async () => { await MongoDBServer.start() })

Now tests don't have to await hasStarted.

This should also work but might not be as obvious:

test.before(() => MongoDBServer.start())

novemberborn · 2017-04-13T16:32:01Z

docs/recipes/isolating-mongodb-integration-tests.md

+test('my mongoose model integration test', async t => {
+	await hasStarted;
+	const odm = new mongoose.Mongoose();
+	odm.connect(await MongoDBServer.getConnectionString());


Should odm.connect() be awaited?

novemberborn · 2017-04-13T16:32:34Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+test('my mongoose model integration test', async t => {
+	await hasStarted;
+	const odm = new mongoose.Mongoose();


Is db a more common name for this variable?

novemberborn · 2017-04-13T16:33:44Z

docs/recipes/isolating-mongodb-integration-tests.md

+	Object.keys(mongoose.models).forEach(name => {
+		let model = mongoose.models[name];
+		odm.model(name, model.schema);
+	});


There is a modelNames() function. I think this might be better:

for (const name of mongoose.modelNames()) { odm.model(name, mongoose.model(name)) }

novemberborn · 2017-04-13T16:38:58Z

docs/recipes/isolating-mongodb-integration-tests.md

+You can easily request a new instance of Mongoose.
+First, call `new mongoose.Mongoose()` to get the new instance, and then call `connect` with a database connection string provided by the `mongomem` package.
+
+*You will need to re-attach the old models from the global mongoose to the new one as it does not carry this information over.*


Perhaps:

You will have to manually copy models from the global instance to your new instance.

novemberborn · 2017-04-13T16:40:55Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+	// Now you can test with Mongoose using the 'odm' variable...
+});
+```


Perhaps all this is better done in a beforeEach:

test.beforeEach(async t => { const db = new mongoose.Mongoose() await db.connect(await MongoDBServer.getConnectionString()) for (const name of mongoose.modelNames()) { db.model(name, mongoose.model(name)) } t.context.db = db }) test('my mongoose model integration test', async t => { const {db} = t.context // do something… })

I agree with all of your comments. This was written in haste during my lunch hour so thanks for looking over it so thoroughly!

A big thanks for dropping the const {db} = t.context knowledge-bomb on me. Didn't realise I could destructure an object inline like that. It's not so different to the import syntax but it just never occurred to me! 🥇

…ar-down.

CImrie · 2017-04-13T20:18:21Z

npm is now referenced to the source code and readme :)

… schema, not the model.

novemberborn

Sweet. Almost good to go.

novemberborn · 2017-04-14T10:38:13Z

docs/recipes/isolating-mongodb-integration-tests.md

+# Setting up AVA for Isolated MongoDB Integration Tests
+
+This recipe outlines how to run disposable MongoDB databases in your AVA tests with per-test isolation.
+This uses `mongomem` and is available on [npm](https://www.npmjs.com/package/mongomem).


"which is available"

novemberborn · 2017-04-14T10:39:20Z

docs/recipes/isolating-mongodb-integration-tests.md

+This is normally cleaned up by your operating system but it is good practise to do it manually to avoid OS-specific issues.
+
+```javascript
+test.after.always('cleanup', async t => {


This doesn't look like it has to be async?

novemberborn · 2017-04-14T10:39:57Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+test.beforeEach(async t => {
+  const db = new mongoose.Mongoose();
+    await db.connect(await MongoDBServer.getConnectionString());


Too much indentation here.

novemberborn · 2017-04-14T10:41:27Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+test('my mongoose model integration test', async t => {
+	const {db} = t.context;
+      // do something…


Too much indentation here as well.

The "do something" comment is a bit flippant (my bad!). Perhaps something like // Now use the isolated DB instance in your test.

Ha, no worries. I'm not sure what has been going on with my grammar in this pull request! 😅

In terms of indentation, what do you normally use for AVA? 4 spaces?
I tend to stick to tab, so I'll need to change it for the next submission depending on your answer.

Let's go with the readme, which uses tabs (except for package.json which uses two spaces because of npm).

novemberborn · 2017-04-14T10:45:28Z

docs/recipes/isolating-mongodb-integration-tests.md

+	const connectionString = await MongoDBServer.getConnectionString();
+
+	// connectionString === 'mongodb://localhost:27017/3411fd12-b5d6-4860-854c-5bbdb011cb93'
+	// use connectionString to connect to the database with a client of your choice. See below for usage with Mongoose.


This has tab indentation, unlike the other code samples. It looks a bit odd when the Markdown is rendered.

novemberborn · 2017-04-14T10:46:23Z

docs/recipes/isolating-mongodb-integration-tests.md

+
+```javascript
+import mongoose from 'mongoose';
+import { MongoDBServer } from 'mongomem'


For consistency, this should end with a ; 😜

CImrie · 2017-04-17T20:05:13Z

Does this seem ok now? Indentation on Github seems rather excessive to me, but my editor definitely reports a sensible number of tabs.

novemberborn · 2017-04-18T08:38:35Z

Great! I'll leave this open for a day or so in case anybody else wants to chime in.

sindresorhus · 2017-04-18T08:54:10Z

docs/recipes/isolating-mongodb-integration-tests.md

+After you have run your tests, you should include a `test.after.always` method to clean up the MongoDB server.
+This will remove any temporary files the server used while running.
+
+This is normally cleaned up by your operating system but it is good practise to do it manually to avoid OS-specific issues.


avoid OS-specific issues

What kind of issues?

sindresorhus · 2017-04-18T09:02:06Z

Looks good. I did some minor cleanup.

This needs to be added to the Recipes section in the main readme: https://github.com/avajs/ava#recipes

sindresorhus · 2017-05-05T16:40:05Z

ping @CImrie :)

Connor Imrie added 2 commits April 13, 2017 14:18

Add mongodb isolated testing recipe.

1a81a29

Update temporary variable reference in mongodb recipe.

fbb2fef

novemberborn requested changes Apr 13, 2017

View reviewed changes

Adjust testing recipe to feedback. Include documentation on server te…

134e3b1

…ar-down.

Fix buggy code in copying models to new mongoose instance. Should use…

2f72002

… schema, not the model.

novemberborn requested changes Apr 14, 2017

View reviewed changes

CImrie added 4 commits April 17, 2017 20:56

Indent with tabs

3b4423f

Retry without phpstorm ruining my life.

6fe2ec1

Make tab indentation consistent

8d621d7

Merge tab indent fixes

8883b5d

novemberborn approved these changes Apr 18, 2017

View reviewed changes

sindresorhus reviewed Apr 18, 2017

View reviewed changes

sindresorhus changed the title ~~Mongodb testing recipe~~ MongoDB testing recipe Apr 18, 2017

Update isolating-mongodb-integration-tests.md

0fd5733

Connor Imrie and others added 3 commits May 6, 2017 14:56

Add mongodb integration recipe to recipes list in readme

a6b48c4

Update isolating-mongodb-integration-tests.md

a625c65

Update readme.md

3881926

sindresorhus merged commit 970872c into avajs:master May 6, 2017

CImrie deleted the mongodb-testing-recipe branch May 6, 2017 14:07

sindresorhus added a commit that referenced this pull request May 6, 2017

Clean up #1357

cf5c459

renovate-bot mentioned this pull request Jun 28, 2017

Update dependency ava to version 0.20.0 singapore/gl-got#31

Merged

		@@ -0,0 +1,86 @@
		# Setting up Ava for Isolated MongoDB Integration Tests

MongoDB testing recipe #1357

MongoDB testing recipe #1357

Uh oh!

Conversation

CImrie commented Apr 13, 2017

Uh oh!

novemberborn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CImrie commented Apr 13, 2017

Uh oh!

novemberborn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CImrie commented Apr 17, 2017

Uh oh!

novemberborn commented Apr 18, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sindresorhus commented Apr 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sindresorhus commented May 5, 2017

Uh oh!

Uh oh!

sindresorhus commented Apr 18, 2017 •

edited

Loading