moved around db access information. Set up proper testing blocks - will be adding more soon.

johndatserakis · johndatserakis · commit 15ef0bf039a8 · 2017-08-28T01:55:49.000-04:00
diff --git a/knexfile.js b/knexfile.js
@@ -1,23 +1,52 @@
-//This knexfile is just used for migrations. The actual
-//db object is built in ./src/db/db and is used throughout the app.
-
 require('dotenv').config();
 
 module.exports = {
-
-    client: 'mysql',
-    connection: {
-        host: process.env.DB_HOST,
-        port: process.env.DB_PORT,
-        user: process.env.DB_USER,
-        password: process.env.DB_PASSWORD,
-        database: process.env.DB_DATABASE,
+    testing: {
+        client: 'mysql',
+        debug: false,
+        connection: {
+            host: process.env.DB_HOST,
+            port: process.env.DB_PORT,
+            user: process.env.DB_USER,
+            password: process.env.DB_PASSWORD,
+            database: process.env.DB_DATABASE + '_testing',
+        },
+        migrations: {
+            directory: './src/db/migrations',
+        },
+        seeds: {
+            directory: './src/db/seeds/dev',
+        },
     },
-    migrations: {
-        directory: './src/db/migrations',
+    development: {
+        client: 'mysql',
+        debug: false,
+        connection: {
+            host: process.env.DB_HOST,
+            port: process.env.DB_PORT,
+            user: process.env.DB_USER,
+            password: process.env.DB_PASSWORD,
+            database: process.env.DB_DATABASE,
+        },
+        migrations: {
+            directory: './src/db/migrations',
+        },
+        seeds: {
+            directory: './src/db/seeds/dev',
+        },
     },
-    seeds: {
-        directory: './src/db/seeds/dev',
-    },
-
-};
+    production: {
+        client: 'mysql',
+        debug: false,
+        connection: {
+            host: process.env.DB_HOST,
+            port: process.env.DB_PORT,
+            user: process.env.DB_USER,
+            password: process.env.DB_PASSWORD,
+            database: process.env.DB_DATABASE,
+        },
+        migrations: {
+            directory: './src/db/migrations',
+        },
+    }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
   "name": "koa-vue-notes-api",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "A SPA using Koa as the backend and Vue as the frontend.",
   "author": "John Datserakis",
   "private": false,
   "scripts": {
     "watch": "NODE_ENV=development nodemon app.js --exec",
-    "test": "NODE_ENV=testing jest -forceExit",
+    "test": "NODE_ENV=testing jest --forceExit",
     "build": "NODE_ENV=production babel src -d build && npm run pretty",
     "pretty": "prettier --write --print-width 80 --single-quote --trailing-comma es5 --tab-width 4 --no-semi 'src/**/*.js'",
     "start-production": "NODE_ENV=production pm2 start ecosystem.json",
@@ -35,9 +35,9 @@
     "koa-router": "^7.0.1",
     "koa-useragent": "^1.0.0",
     "log4js": "^2.2.0",
+    "mysql": "^2.14.1",
     "npm": "^5.3.0",
     "pm2": "^2.6.1",
-    "promise-mysql": "^3.0.2",
     "randexp": "^0.4.5"
   },
   "devDependencies": {
diff --git a/readme.md b/readme.md
@@ -109,6 +109,10 @@ We use controllers to keep our router thin. The controller's responsibility is t
 
 Here is our database setup. This project uses Knex to manage migrations and execute queries. I initially wrote wrote all the MySQL calls using raw SQL, but the need for a migrations maanager pushed me towards an ORM for the MySQL database. Knex is awesome - very powerful, easy to use and make queries, and the migrations are nice to have for sure - especially for testing.
 
+For this project you'll need to make two databases in your development environment, `koa_vue_notes` and `koa_vue_notes_testing`. In your production environment you would just have `koa_vue_notes`. Tests use a different database because the data there is extremely volatile - as table information is created and destroyed on every test.
+
+The `knexfile.js` in the root of the project is all setup with the ability to read your `.env` file. Let's say you download this project - first you'll `npm install`, then create a `koa_vue_notes` database and a `koa_vue_notes_testing` database, then `knex migrate:latest` and `knex seed:run` to create and seed your tables. Currently it's set up to make five users and 100 notes distributed to those users.
+
 ### middleware
 
 Here I place any custom middleware the app is using. The custom middleware we're using is based on the `koa-jwt` library - but I had to tweak it because it mysteriously didn't report an expired token correctly. Strange, as I thought that would be an important requirement. No biggie.
@@ -129,6 +133,10 @@ Static files - just used for the favicon.
 
 index.js isn't a folder - it's the brain of the app. Here you'll see we are attaching a bunch of middleware to our Koa instance. Very slick and straight-forward.
 
+## Todo
+
+- Finish writing all the tests
+
 ## Hit Me Up
 
 Go ahead and fork the project! Message me here if you have questions or submit an issue if needed. I'll be making touch-ups as time goes on. Have fun with this!
diff --git a/src/controllers/NoteController.js b/src/controllers/NoteController.js
@@ -1,4 +1,3 @@
-import {} from 'dotenv/config'
 import joi from 'joi'
 import dateFormat from 'date-fns/format'
 
diff --git a/src/controllers/UserActionController.js b/src/controllers/UserActionController.js
@@ -1,4 +1,3 @@
-import {} from 'dotenv/config'
 import db from '../db/db'
 import joi from 'joi'
 import rand from 'randexp'
@@ -80,19 +79,21 @@ class UserController {
             var [result] = await db('users').insert(request).returning('id')
 
             //Let's send a welcome email.
-            let email = await fse.readFile('./src/email/welcome.html', 'utf8')
-            const emailData = {
-                to: request.email,
-                from: process.env.APP_EMAIL,
-                subject: 'Welcome To Koa-Vue-Notes-Api',
-                html: email,
-                categories: ['koa-vue-notes-api-new-user'],
-                substitutions: {
-                    appName: process.env.APP_NAME,
-                    appEmail: process.env.APP_EMAIL,
-                },
+            if (process.env.NODE_ENV !== 'testing') {
+                let email = await fse.readFile('./src/email/welcome.html', 'utf8')
+                const emailData = {
+                    to: request.email,
+                    from: process.env.APP_EMAIL,
+                    subject: 'Welcome To Koa-Vue-Notes-Api',
+                    html: email,
+                    categories: ['koa-vue-notes-api-new-user'],
+                    substitutions: {
+                        appName: process.env.APP_NAME,
+                        appEmail: process.env.APP_EMAIL,
+                    },
+                }
+                await sgMail.send(emailData)
             }
-            await sgMail.send(emailData)
 
             //And return our response.
             ctx.body = { message: 'SUCCESS', id: result }
diff --git a/src/db/db.js b/src/db/db.js
@@ -1,25 +1,4 @@
-const knex = require('knex')
+var environment = process.env.NODE_ENV || 'development';
+var config = require('../../knexfile.js')[environment];
 
-const config = {
-    client: 'mysql',
-    connection: {
-        host: process.env.DB_HOST,
-        port: process.env.DB_PORT,
-        user: process.env.DB_USER,
-        password: process.env.DB_PASSWORD,
-        database: process.env.DB_DATABASE,
-    },
-    migrations: {
-        directory: './src/db/migrations',
-    },
-}
-
-//Here we check to see if we are in testing mode. If we are,
-//we set the database name to one with a '_tests' at the end,
-//which we'll build and tear-down for each test.
-if (process.env.NODE_ENV === 'testing') {
-    config.connection.database = process.env.DB_DATABASE + '_tests'
-}
-
-const db = knex(config)
-export default db
+module.exports = require('knex')(config);
diff --git a/src/db/seeds/dev/seed_notes.js b/src/db/seeds/dev/seed_notes.js
@@ -6,7 +6,7 @@ exports.seed = async function(knex, Promise) {
     let seedData = [];
     for (let i = 0; i < 100; i++) {
         let testNote = {
-            userId: faker.random.number({min: 1, max: 10}),
+            userId: faker.random.number({min: 1, max: 5}),
             title: faker.lorem.sentence(),
             content: faker.lorem.sentences(Math.floor(Math.random() * 10) + 1)
         }
diff --git a/src/db/seeds/dev/seed_users.js b/src/db/seeds/dev/seed_users.js
@@ -7,7 +7,7 @@ exports.seed = async function(knex, Promise) {
     //the passwords to make it exactly like the real app. All their
     //passwords will be 'secret'
     let seedData = [];
-    for (let i = 0; i < 10; i++) {
+    for (let i = 0; i < 5; i++) {
         let password = 'secret'
         try {
             password = await bcrypt.hash(password, 12)
diff --git a/src/index.js b/src/index.js
@@ -3,7 +3,6 @@
 import Koa from 'koa'
 import bodyParser from 'koa-bodyparser'
 import cors from 'kcors'
-import {} from 'dotenv/config'
 import logger from './logs/log'
 import userAgent from 'koa-useragent'
 import error from 'koa-json-error'
diff --git a/src/logs/log.js b/src/logs/log.js
@@ -1,4 +1,3 @@
-import {} from 'dotenv/config'
 import log4js from 'log4js'
 
 log4js.configure({
diff --git a/src/models/Note.js b/src/models/Note.js
@@ -1,4 +1,3 @@
-import {} from 'dotenv/config'
 import db from '../db/db'
 import rand from 'randexp'
 
diff --git a/src/models/User.js b/src/models/User.js
@@ -1,4 +1,3 @@
-import {} from 'dotenv/config'
 import db from '../db/db'
 
 class User {
diff --git a/tests/test.js b/tests/test.js
@@ -1,4 +1,4 @@
-// //This starts the app up
+//This starts the app up
 import {server} from '../app'
 
 //Set up axios a little bit
@@ -9,34 +9,49 @@ const request = axios.create({ baseURL: url })
 //Grab the db variable
 import db from '../src/db/db'
 
-//Before each test we are going to rollback and
-//migrate out database to its latest version
-beforeEach(async () => {
-    await db.migrate.rollback()
-    await db.migrate.latest()
-    // await knex.seed.run()
-});
-
 //After all the tests are done we're going to close our server
 //and rollback our database.
 afterAll(async () => {
     await db.migrate.rollback()
+
+    //This closes the app but it doesn't stop the tests in
+    //Jest when done - that's why we have to --forceExit
+    //when running Jest for now.
     return server.close()
 });
 
-it('returns homepage', async () => {
-    expect.assertions(1)
-    const response = await request.get('/')
-    expect(response.status).toBe(200)
+describe('general actions', () => {
+    it('returns homepage', async () => {
+        expect.assertions(1)
+        const response = await request.get('/')
+        expect(response.status).toBe(200)
+    });
 });
 
-// const userSignup = require('./controllers/userActionController')
-// it('signs up a user', async () => {
-//     expect.assertions(1)
-
-//     const userActionController = new UserActionController();
-//     await userActionController.signup({});
-
-//   // const response = await request.get('/')
-//   // expect(response.status).toBe(200)
-// });
+describe('user account actions', () => {
+    beforeAll(async () => {
+        await db.migrate.rollback()
+        await db.migrate.latest()
+    });
+
+    it('signs up a user', async () => {
+        expect.assertions(1)
+        const response = await request.post('/api/v1/user/signup', {
+            "firstName": "TestFirstName",
+            "lastName": "TestLastName",
+            "username": "TestUsername",
+            "email": "TestEmail@example.com",
+            "password": "TestPassword"
+        })
+        expect(response.status).toBe(200)
+    });
+
+    it('authenticates a user', async () => {
+        expect.assertions(1)
+        const response = await request.post('/api/v1/user/authenticate', {
+            "username": "TestUsername",
+            "password": "TestPassword"
+        })
+        expect(response.status).toBe(200)
+    });
+})

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import {} from 'dotenv/config'`
`2`	`1`	`import joi from 'joi'`
`3`	`2`	`import dateFormat from 'date-fns/format'`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ exports.seed = async function(knex, Promise) {`
`6`	`6`	`let seedData = [];`
`7`	`7`	`for (let i = 0; i < 100; i++) {`
`8`	`8`	`let testNote = {`
`9`		`- userId: faker.random.number({min: 1, max: 10}),`
	`9`	`+ userId: faker.random.number({min: 1, max: 5}),`
`10`	`10`	`title: faker.lorem.sentence(),`
`11`	`11`	`content: faker.lorem.sentences(Math.floor(Math.random() * 10) + 1)`
`12`	`12`	`}`