refined comments in test files

Author: jakewmeyer

.travis.yml

@@ -10,4 +10,3 @@ notifications:
     on_failure: always
 after_success:
  - ./scripts/docker_build.sh
- 

app.js

@@ -1,3 +1,4 @@
+
 const express = require("express")
 const morgan = require("morgan")
 const cors = require("cors")
@@ -8,7 +9,6 @@ const MongoClient = require("mongodb")
 const Path = require("path")
 const app = express()
 
-// Define route paths
 const home  = require("./routes/v1-home")
 const info  = require("./routes/v1-info")
 const vehicles  = require("./routes/v1-vehicles")
@@ -17,13 +17,11 @@ const launches  = require("./routes/v1-launches")
 const upcoming  = require("./routes/v1-upcoming")
 const parts  = require("./routes/v1-parts")
 
-// Enable middleware
 app.use(compression())
 app.use(helmet())
 app.use(morgan("common"))
 app.use(cors())
 
-// Routes
 app.use("/v1", home)
 app.use("/v1/info", info)
 app.use("/v1/vehicles", vehicles)
@@ -37,7 +35,6 @@ app.use((req, res) => {
   res.status(404).sendFile(Path.join(__dirname + "/pages/404.html"))
 })
 
-// Create DB connection & start server
 MongoClient.connect(config.url, (err, database) => {
   if (err) return console.log(err)
   global.db = database

config.json

@@ -1,4 +1,3 @@
 {
-    "test" : "success",
     "url" : "mongodb://public:[email protected]:27017, spacex-api-shard-00-01-rzdz4.mongodb.net:27017,spacex-api-shard-00-02-rzdz4.mongodb.net:27017/spacex-api?ssl=true&replicaSet=spacex-api-shard-0&authSource=admin"
 }

test/v1-all.test.js

@@ -1,4 +1,3 @@
-// SpaceX API Tests
 
 const app = require("../app")
 const request = require("supertest")
@@ -9,30 +8,42 @@ beforeAll((done) => {
   })
 })
 
-// 404 Test
+//------------------------------------------------------------
+//                     404 Page
+//------------------------------------------------------------
+
 test("It should return 404 page", () => {
   return request(app).get("/v2").then(response => {
     expect(response.statusCode).toBe(404)
   })
 })
 
-// Home Tests
+//------------------------------------------------------------
+//                     Home Page
+//------------------------------------------------------------
+
 test("It should return home info", () => {
   return request(app).get("/v1").then(response => {
     expect(response.statusCode).toBe(200)
     expect(response.text).toContain("SpaceX-API")
   })
 })
 
-// Info Tests
+//------------------------------------------------------------
+//                     Company Info
+//------------------------------------------------------------
+
 test("It should return company info", () => {
   return request(app).get("/v1/info").then(response => {
     expect(response.statusCode).toBe(200)
     expect(response.text).toContain("Elon Musk")
   })
 })
 
-// Vehicle Tests
+//------------------------------------------------------------
+//                     Vehicles
+//------------------------------------------------------------
+
 test("It should return all vehicle info", () => {
   return request(app).get("/v1/vehicles").then(response => {
     expect(response.statusCode).toBe(200)
@@ -71,7 +82,10 @@ test("It should return Dragon info", () => {
   })
 })
 
-// Launchpad Tests
+//------------------------------------------------------------
+//                     Launchpads
+//------------------------------------------------------------
+
 test("It should return all launchpads", () => {
   return request(app).get("/v1/launchpads").then(response => {
     expect(response.statusCode).toBe(200)
@@ -93,7 +107,10 @@ test("It should return no launchpads found info", () => {
   })
 })
 
-// Past Launches Tests
+//------------------------------------------------------------
+//                    Past Launches
+//------------------------------------------------------------
+
 test("It should return all past launches", () => {
   return request(app).get("/v1/launches").then(response => {
     expect(response.statusCode).toBe(200)
@@ -163,7 +180,10 @@ test("It should return no launches with cap C403", () => {
   })
 })
 
-// Upcoming Launch Tests
+//------------------------------------------------------------
+//                    Upcoming Launches
+//------------------------------------------------------------
+
 test("It should return all upcoming launches", () => {
   return request(app).get("/v1/launches/upcoming").then(response => {
     expect(response.statusCode).toBe(200)
@@ -196,7 +216,10 @@ test("It should return no launches in the timeframe", () => {
   })
 })
 
-// Parts Tests
+//------------------------------------------------------------
+//                    Parts
+//------------------------------------------------------------
+
 test("It should return all capsule info", () => {
   return request(app).get("/v1/parts/caps").then(response => {
     expect(response.statusCode).toBe(200)