Merge pull request #414 from nmarklund10/nmarklund10/issue-413/healthv2

blakenan-bellese · web-flow · commit 245046baa5c8 · 2022-04-20T09:22:05.000-04:00
Nmarklund10/issue 413/healthv2
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -78,8 +78,8 @@
     "babel-loader": "^8.2.3",
     "chakram": "^1.5.0",
     "codecov": "3.7.2",
-    "eslint": "^8.10.0",
-    "eslint-plugin-mocha": "8.0.0",
+    "eslint": "^8.12.0",
+    "eslint-plugin-mocha": "^10.0.3",
     "nyc": "15.0.0",
     "sequelize-cli": "^6.4.1"
   },
diff --git a/src/api-docs/v2/swagger.json b/src/api-docs/v2/swagger.json
@@ -3,7 +3,7 @@
   "servers": [
     {
       "description": "localhost",
-      "url": "http://localhost:3000"
+      "url": "http://localhost:3001"
     }
   ],
   "info": {
@@ -91,8 +91,7 @@
         "security": [],
         "tags": [
           "operations",
-          "read-only",
-          "unimplemented"
+          "read-only"
         ],
         "summary": "Checks the health of the application; will be renamed to '/health'.",
         "description": "The health of individual application components is verified.",
diff --git a/src/index.js b/src/index.js
@@ -54,8 +54,8 @@ app.get('/help', (req, res) => {
 // Api Docs
 const apiVersions = fs.readdirSync(`${__dirname}/api-docs`)
 for (const version of apiVersions) {
-  const swaggerDocument = require(`./api-docs/${version}/swagger.json`)
   app.use(`/${version}/api-docs`, apiLimiter, swaggerUi.serve, (req, res) => {
+    const swaggerDocument = require(`./api-docs/${version}/swagger.json`)
     let html = swaggerUi.generateHTML(swaggerDocument, swaggerOptions)
     res.send(html)
   })
diff --git a/src/routes/v2/health.js b/src/routes/v2/health.js
@@ -0,0 +1,37 @@
+import { Router } from 'express'
+import utils from '../../utils'
+import { sequelize } from '../../models'
+
+const router = new Router()
+
+const checkDatabase = async () => {
+  const databaseCheckResult = {
+    'name': 'database',
+    'status': 'healthy',
+    'message': 'N/A'
+  }
+  try {
+    // https://sequelize.org/docs/v6/getting-started/#testing-the-connection
+    await sequelize.authenticate()
+  }
+  catch (error) {
+    console.error(`Database seems to be down: '${error}'`)
+    databaseCheckResult.status = 'down'
+    databaseCheckResult.message = error.message
+  }
+  return databaseCheckResult
+}
+
+router.get('/', async (req, res) => {
+  res.status(200).json({
+    uptime: utils.formatTime(process.uptime()),
+    environment: process.env.NODE_ENV || 'n/a',
+    version: process.env.npm_package_version || 'n/a',
+    requestId: req.id,
+    checks: [
+      await checkDatabase()
+    ]
+  })
+})
+
+export default router
diff --git a/src/routes/v2/index.js b/src/routes/v2/index.js
@@ -0,0 +1,8 @@
+import health from './health'
+// Exports object of routes we import above. Add to this if you're adding new routes.
+
+const routeExports = {
+  health
+}
+
+module.exports = routeExports
diff --git a/src/tests/v1/contact.routes.spec.js b/src/tests/v1/contact.routes.spec.js
@@ -26,7 +26,7 @@ const entity = {
   type: 'Test'
 }
 
-describe('Contact tests', function() {
+describe(`Contact tests (v${VERSION})`, function() {
   const authed = new Login(VERSION)
   let token
   let authHeader
diff --git a/src/tests/v1/csv.routes.spec.js b/src/tests/v1/csv.routes.spec.js
@@ -4,7 +4,7 @@ import { Login } from '../../utils/login'
 import app from '../..'
 
 const VERSION = '1'
-describe('CSV Dump Negative Tests', function() {
+describe(`CSV Dump Negative Tests (v${VERSION})`, function() {
   const authed = new Login(VERSION)
   let token
 
diff --git a/src/tests/v1/entity.routes.spec.js b/src/tests/v1/entity.routes.spec.js
@@ -29,7 +29,7 @@ const contact = {
   ]
 }
 
-describe('Entity tests', function() {
+describe(`Entity tests (v${VERSION})`, function() {
   const authed = new Login(VERSION)
   let token
 
diff --git a/src/tests/v1/index.spec.js b/src/tests/v1/index.spec.js
@@ -5,7 +5,7 @@ import app from '../..'
 const VERSION = '1'
 const {expect} = chai
 
-describe('API Integration Tests', function() {
+describe(`API Integration Tests (v${VERSION})`, function() {
   it('should return uptime', function(done) {
     request(app)
       .get(`/v${VERSION}/health`)
diff --git a/src/tests/v1/user.routes.spec.js b/src/tests/v1/user.routes.spec.js
@@ -8,7 +8,7 @@ const VERSION = '1'
 const { expect } = chai
 const user = { email: `${randomWords()}@test.test`, password: 'Abcdefg42!', roles: ['admin'] }
 
-describe('User tests', function() {
+describe(`User tests (v${VERSION})`, function() {
   const authed = new Login(VERSION)
   let token
 
diff --git a/src/tests/v1/userRole.routes.spec.js b/src/tests/v1/userRole.routes.spec.js
@@ -7,7 +7,7 @@ const VERSION = '1'
 const { expect, assert } = chai
 const role = { role: 'test' + Date.now(), path: '/test', method: 'GET' }
 
-describe('User roles positive tests', function() {
+describe(`User roles positive tests (v${VERSION})`, function() {
   const authed = new Login(VERSION)
   let token
 
diff --git a/src/tests/v1/utils.spec.js b/src/tests/v1/utils.spec.js
@@ -6,7 +6,7 @@ import { Response } from '../../utils/response'
 const VERSION = '1'
 const { assert, expect } = chai
 
-describe('Utils Tests', function() {
+describe(`Utils Tests (v${VERSION})`, function() {
   it('should return 00:00:01', function(done) {
     expect(utils.formatTime(1)).to.equal('00:00:01')
     done()
diff --git a/src/tests/v2/index.spec.js b/src/tests/v2/index.spec.js
@@ -0,0 +1,111 @@
+import chai from 'chai'
+import request from 'supertest'
+import app from '../..'
+
+const VERSION = '2'
+const {expect} = chai
+
+describe(`API Integration Tests (v${VERSION})`, function() {
+  it('should return uptime', function(done) {
+    request(app)
+      .get(`/v${VERSION}/health`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT uptime error: ${err}`)
+        }
+
+        expect(res.body.uptime).to.be.ok
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+  it('should return environment', function(done) {
+    request(app)
+      .get(`/v${VERSION}/health`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT environment error: ${err}`)
+        }
+
+        expect(res.body.environment).to.be.ok
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+  it('should return version number', function(done) {
+    request(app)
+      .get(`/v${VERSION}/health`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+
+        expect(res.body.version).to.be.ok
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+  it('should return request id', function(done) {
+    request(app)
+      .get(`/v${VERSION}/health`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+
+        expect(res.body.requestId).to.be.ok
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+  it('should return checks', function(done) {
+    request(app)
+      .get(`/v${VERSION}/health`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+
+        expect(res.body.checks).to.be.ok
+        expect(res.body.checks.length).to.equal(1)
+        expect(res.body.checks[0].name).to.equal('database')
+        expect(res.body.checks[0].status).to.equal('healthy')
+        expect(res.body.checks[0].message).to.equal('N/A')
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+  it('should redirect home request', function(done) {
+    request(app)
+      .get('/')
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+        expect(res.statusCode).to.equal(302)
+        done()
+      })
+  })
+  it('should redirect help request', function(done) {
+    request(app)
+      .get('/help')
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+        expect(res.statusCode).to.equal(302)
+        done()
+      })
+  })
+  it('should return swagger', function(done) {
+    request(app)
+      .get(`/v${VERSION}/api-docs/`)
+      .end((err, res) => {
+        if (err) {
+          console.error(`IT version error: ${err}`)
+        }
+        expect(res.statusCode).to.equal(200)
+        done()
+      })
+  })
+})
diff --git a/src/utils/index.js b/src/utils/index.js
@@ -36,7 +36,7 @@ var adapter
 
 /**
  * Loads Casbin for role validation
- * 
+ *
  * @returns {Object}
  */
 const loadCasbin = async () => {
@@ -71,7 +71,7 @@ const loadCasbin = async () => {
     })
   }
 
-  return await newEnforcer(casbinConf, adapter)
+  return newEnforcer(casbinConf, adapter)
 }
 
 /**
@@ -108,9 +108,9 @@ const validateToken = async req => {
 
 /**
  * Validates a user role.
- * 
+ *
  * @param {*} req The request object
- * 
+ *
  * @return {Boolean}
  */
 const validateRoles = async (req) => {
@@ -119,13 +119,13 @@ const validateRoles = async (req) => {
 
   /** @todo refactor this... */
   const email = (req.context.me.email[0].address !== undefined) ? req.context.me.email[0].address : req.context.me.email
-  const isAllowed = await e.enforce(email, path, method)
-  return isAllowed
+  return e.enforce(email, path, method)
+
 }
 
 /**
  * Middleware function used to validate a user token
- * 
+ *
  * @param {*} req the request object
  * @param {*} res the response object
  * @param {*} next the next handler in the chain
@@ -167,27 +167,26 @@ const encryptPassword = (password, salt) => {
 
 /**
  * Generates a JWT
- * 
- * @param {int} userId 
- * @param {String} email 
- * @param {String} expiresIn 
- * 
+ *
+ * @param {int} userId
+ * @param {String} email
+ * @param {String} expiresIn
+ *
  * @returns {String}
  */
 const getToken = async (userId, email, type, expiresIn = '1d') => {
-  const token = jwt.sign(
+  return jwt.sign(
     { userId, email, type },
     process.env.JWT_KEY,
     { expiresIn }
   )
-  return token
 }
 
 /**
  * Checks array of emails for validitiy
- * 
+ *
  * @param {Array} emails
- * 
+ *
  * @return {Boolean}
  */
 const validateEmails = async emails => {
@@ -200,9 +199,9 @@ const validateEmails = async emails => {
 
 /**
  * Checks the user's new password for complexity
- * 
- * @param {String} pass 
- * 
+ *
+ * @param {String} pass
+ *
  * @return {Boolean}
  */
 const validatePassword = pass => {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ const entity = {`
`26`	`26`	`type: 'Test'`
`27`	`27`	`}`
`28`	`28`
`29`		`-describe('Contact tests', function() {`
	`29`	+describe(`Contact tests (v${VERSION})`, function() {
`30`	`30`	`const authed = new Login(VERSION)`
`31`	`31`	`let token`
`32`	`32`	`let authHeader`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ const contact = {`
`29`	`29`	`]`
`30`	`30`	`}`
`31`	`31`
`32`		`-describe('Entity tests', function() {`
	`32`	+describe(`Entity tests (v${VERSION})`, function() {
`33`	`33`	`const authed = new Login(VERSION)`
`34`	`34`	`let token`
`35`	`35`