feat: add tests example (#19)

* feat: add tests example

* update: cleanup dependencies

* update: add use strict on top

Co-authored-by: James Sumners <james@sumners.email>

* refactor: split server to a separated file

* refactor: use only fastify-mongodb

* update: add use strict

* update: use teardown to cleanup db

* update: remove onClose hook

Co-authored-by: James Sumners <james@sumners.email>

Author: RafaelGSS

README.md

@@ -15,6 +15,7 @@ Here a list of the projects with a description, search in this page what you are
 | [validation-messages] | `schema` `validation` | How you can customize the error messages of input schema validation |
 | [winston-logger] | `logger` | Example how to use winston as a custom logger |
 | [typescript decorators] | `typescript` | Example how to use typescript decorators to build application |
+| [tests] | `tests` | Example of how to test your fastify application |
 
 
 ## External Projects

tests/app.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const fastifyMongodb = require('fastify-mongodb')
+
+function app(fastify, config, done) {
+  fastify.register(fastifyMongodb, { url: config.mongodb.url })
+  fastify.get('/', async function (_req, reply) {
+    const db = this.mongo.client.db()
+    const results = await db.collection('examples').find()
+    return reply.send(results)
+  })
+
+  done()
+}
+
+module.exports = app

tests/database-connection/mongodb-setup.js

@@ -0,0 +1,37 @@
+'use strict'
+
+const Fastify = require('fastify')
+const fp = require('fastify-plugin')
+
+const clean = require('mongo-clean')
+
+const App = require('../app')
+
+const url = 'mongodb://localhost/prod'
+const database = 'tests'
+
+// Fill in this config with all the configurations
+// needed for testing the application
+function config () {
+  return {
+    mongodb: {
+      url,
+    }
+  }
+}
+
+// automatically build and tear down our instance
+function build (t) {
+  const app = Fastify()
+  app.register(fp(App), config())
+
+  t.teardown(async () => {
+    await clean(app.mongo.client.db(database))
+    await app.close()
+  })
+  return app
+}
+
+module.exports = {
+  build
+}

tests/database-connection/mongodb.test.js

@@ -0,0 +1,18 @@
+const { test } = require('tap')
+const { build } = require('./mongodb-setup')
+
+test('GET / • returns 200', (t) => {
+  t.plan(2);
+  const fastify = build(t);
+
+  fastify.inject(
+    {
+      method: 'GET',
+      url: '/',
+    },
+    (err, response) => {
+      t.error(err);
+      t.strictEqual(response.statusCode, 200);
+    },
+  );
+});

tests/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "database-connection",
+  "version": "1.0.0",
+  "description": "example of tests using database",
+  "main": "mongodb-test.js",
+  "scripts": {
+    "test:database": "tap ./database-connection/mongodb.test.js"
+  },
+  "author": "Fastify",
+  "license": "MIT",
+  "dependencies": {
+    "fastify": "^2.3.0",
+    "fastify-mongodb": "^4.1.0",
+    "fastify-plugin": "^3.0.0"
+  },
+  "devDependencies": {
+    "mongo-clean": "^2.0.0",
+    "tap": "^14.11.0"
+  }
+}

tests/server.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const Fastify = require('fastify')
+const fp = require('fastify-plugin')
+const app = require('./app')
+
+async function server() {
+  const fastify = Fastify({ logger: true })
+  const database = process.env.MONGO_URI || 'mongodb://localhost/prod'
+  fastify.register(
+    fp(app),
+    {
+      mongodb: {
+        url: database
+      }
+    }
+  )
+
+  fastify.listen(3000)
+}
+
+server()