Add black box testing and console commands

Author: hirsch88

package.json

@@ -10,14 +10,16 @@
     "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts'",
     "serve:debug": "npm run serve -- --debug=6666",
     "lint": "./node_modules/.bin/gulp lint",
-    "test": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --coverage",
-    "test:black-box": "NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i",
+    "test": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --verbose --coverage",
+    "test:black-box": "NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i --verbose",
     "build": "./node_modules/.bin/gulp build",
     "clean": "./node_modules/.bin/gulp clean",
     "zip": "./node_modules/.bin/gulp zip",
     "db:migrate": "./node_modules/.bin/knex migrate:latest",
     "db:migrate:rollback": "./node_modules/.bin/knex migrate:rollback",
     "db:seed": "./node_modules/.bin/knex seed:run",
+    "db:reset": "npm run console db:reset",
+    "console": "./node_modules/.bin/ts-node ./src/console/commander.ts",
     "start": "node src/index.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
@@ -51,6 +53,7 @@
     "@types/bluebird": "^3.5.2",
     "@types/body-parser": "^1.16.3",
     "@types/bookshelf": "^0.8.38",
+    "@types/commander": "^2.9.0",
     "@types/cors": "^2.8.1",
     "@types/debug": "0.0.29",
     "@types/dotenv": "^4.0.0",
@@ -70,6 +73,7 @@
     "bookshelf": "^0.10.3",
     "bookshelf-camelcase": "^1.1.4",
     "class-validator": "^0.7.0",
+    "commander": "^2.9.0",
     "compression": "^1.6.2",
     "cors": "^2.8.1",
     "debug": "^2.6.0",

src/api/repositories/UserRepository.ts

@@ -46,7 +46,8 @@ export class UserRepository {
     public static async create(data: any): Promise<User> {
         const user = User.forge<User>(data);
         try {
-            return await user.save();
+            const createdUser = await user.save();
+            return await User.fetchById(createdUser.id);
         } catch (error) {
             throw new DatabaseException('Could not create the user!', error);
         }

src/console/DatabaseResetCommand.ts

@@ -0,0 +1,50 @@
+import '../core';
+import { Log } from '../core/log';
+
+import * as Knex from 'knex';
+const options = require('../../knexfile.ts');
+const log = new Log('app:console:DatabaseResetCommand');
+
+
+export class DatabaseResetCommand {
+
+    static command = 'db:reset';
+    static description = 'Reverse all migrations and migrate to latest.';
+
+    static async action(): Promise<void> {
+        try {
+            await DatabaseResetCommand.run();
+            process.exit(0);
+        } catch (e) {
+            process.exit(1);
+        }
+    }
+
+    static async run(): Promise<void> {
+        const knex = Knex(options);
+
+        const migrate: any = knex.migrate;
+
+        // Force unlock in case of bad state
+        await migrate.forceFreeMigrationsLock();
+
+        // Get completed migrations
+        log.info('Get completed migrations');
+        const completedMigrations = await migrate._listCompleted();
+
+        // Rollback migrations
+        log.info('Rollback migrations');
+        await migrate._waterfallBatch(0, completedMigrations.reverse(), 'down');
+
+        // Migrate to latest
+        log.info('Migrate to latest');
+        await migrate.latest();
+
+        // Close connection to the database
+        await knex.destroy();
+        log.info('Done');
+    }
+
+}
+
+

src/console/commander.ts

@@ -0,0 +1,12 @@
+import * as commander from 'commander';
+import { DatabaseResetCommand } from './DatabaseResetCommand';
+
+/**
+ * DatabaseResetCommand
+ */
+commander
+    .command(DatabaseResetCommand.command)
+    .description(DatabaseResetCommand.description)
+    .action(() => DatabaseResetCommand.action());
+
+commander.parse(process.argv);

src/core/Knex.ts

@@ -8,8 +8,8 @@ export const Knex: knex = knex({
     pool: {
         min: Environment.get<number>('DB_POOL_MIN'),
         max: Environment.get<number>('DB_POOL_MAX')
-    },
-    migrations: {
-        tableName: Environment.get<string>('DB_MIGRATION_TABLE')
     }
+    // migrations: {
+    //     tableName: Environment.get<string>('DB_MIGRATION_TABLE')
+    // }
 });

test/black-box/home.test.ts

@@ -1,7 +1,7 @@
 import { api } from './lib/api';
 
 
-test('GET / - should return the api info as a json', async () => {
+test('GET   [/] - should return the api info as a json', async () => {
     const res = await api('GET', '/api');
     res.expectJson();
     res.expectStatusCode(200);

test/black-box/lib/ApiResponeTest.ts

@@ -5,7 +5,11 @@ export class ApiResponeTest {
     constructor(private res: any) { }
 
     getBody<T>(): T {
-        return JSON.parse(this.res['body']);
+        return this.res['body'];
+    }
+
+    getData<T>(): T {
+        return this.getBody()['data'];
     }
 
     getHeaders<T>(): T {
@@ -24,8 +28,10 @@ export class ApiResponeTest {
 
     expectData(keys: string[]): ApiResponeTest {
         const a = keys.sort();
-        const b = Object.keys(this.getBody()).sort();
+        const d = _.isArray(this.getData()) ? this.getData()[0] : this.getData();
+        const b = Object.keys(d).sort();
         expect(_.isEqual(a, b)).toBeTruthy();
+        expect(this.getBody()['success']).toBeTruthy();
         return this;
     }
 }

test/black-box/lib/api.ts

@@ -1,12 +1,23 @@
 require('dotenv').config();
 import * as request from 'request-promise';
-import { OptionsWithUri } from 'request-promise';
+import { Options } from 'request-promise';
 import { ApiResponeTest } from './ApiResponeTest';
 
 
-export const api = async (method: string, path: string, options: OptionsWithUri = { uri: '' }) => {
-    options.method = method;
-    options.uri = `${process.env.APP_HOST}:${process.env.APP_PORT}${path}`;
-    options.resolveWithFullResponse = true;
-    return new ApiResponeTest(await request(options));
+export interface ApiOptions<T> {
+    body?: T;
+    headers?: any;
+}
+
+
+export const api = async <T>(method: string, path: string, options: ApiOptions<T> = {}) => {
+    let o: Options = {
+        method: method,
+        uri: `${process.env.APP_HOST}:${process.env.APP_PORT}${path}`,
+        resolveWithFullResponse: true,
+        headers: options.headers,
+        json: true,
+        body: options.body
+    };
+    return new ApiResponeTest(await request(o));
 };

test/black-box/user.test.ts

@@ -0,0 +1,44 @@
+import { api } from './lib/api';
+import { DatabaseResetCommand } from '../../src/console/DatabaseResetCommand';
+
+let createdId;
+const userKeys = ['id', 'firstName', 'lastName', 'email', 'updatedAt', 'createdAt'];
+
+beforeAll(async () => {
+    await DatabaseResetCommand.run();
+});
+
+test('POST  [/v1/user] - should create a new user', async () => {
+    const res = await api('POST', '/api/v1/user', {
+        body: {
+            firstName: 'Hans',
+            lastName: 'Muster',
+            email: 'hans@muster.ch'
+        }
+    });
+    res.expectJson();
+    res.expectStatusCode(201);
+    res.expectData(userKeys);
+    createdId = res.getData()['id'];
+});
+
+test('GET   [/v1/user] - should return the api info as a json', async () => {
+    const res = await api('GET', '/api/v1/user');
+    res.expectJson();
+    res.expectStatusCode(200);
+    res.expectData(userKeys);
+});
+
+test('GET   [/v1/user/:id] - should return the api info as a json', async () => {
+    const res = await api('GET', `/api/v1/user/${createdId}`);
+    res.expectJson();
+    res.expectStatusCode(200);
+    res.expectData(userKeys);
+
+    const user: any = res.getData();
+    expect(user.firstName).toBe('Hans');
+    expect(user.lastName).toBe('Muster');
+    expect(user.email).toBe('hans@muster.ch');
+});
+
+

yarn.lock

@@ -29,6 +29,12 @@
     "@types/knex" "*"
     "@types/lodash" "*"
 
+"@types/commander@^2.9.0":
+  version "2.9.0"
+  resolved "https://registry.yarnpkg.com/@types/commander/-/commander-2.9.0.tgz#dd07af1fc35d76833e0da26ea67a2be088b5fafc"
+  dependencies:
+    "@types/node" "*"
+
 "@types/cors@^2.8.1":
   version "2.8.1"
   resolved "https://registry.yarnpkg.com/@types/cors/-/cors-2.8.1.tgz#54073caf3b7a741e67fb82483f83a6cadfba7501"
@@ -1150,7 +1156,7 @@ combined-stream@^1.0.5, combined-stream@~1.0.5:
   dependencies:
     delayed-stream "~1.0.0"
 
-commander@^2.2.0:
+commander@^2.2.0, commander@^2.9.0:
   version "2.9.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.9.0.tgz#9c99094176e12240cb22d6c5146098400fe0f7d4"
   dependencies: