add black-box testing

Author: hirsch88

README.md

@@ -73,11 +73,5 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 ## License
  [MIT](/LICENSE)
 
-## ToDo's
-https://blog.risingstack.com/10-best-practices-for-writing-node-js-rest-apis/
-[ ] Add api doc - http://apidocjs.com
-[ ] Add black box testing https://www.npmjs.com/package/supertest
-
-
 ---
 Made with ♥ by Gery Hirschfeld ([@GeryHirschfeld1](https://twitter.com/GeryHirschfeld1)) and [contributors](https://github.com/w3tecch/express-typescript-boilerplate/graphs/contributors)

package.json

@@ -10,7 +10,8 @@
     "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 --coverage",
+    "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",
     "build": "./node_modules/.bin/gulp build",
     "clean": "./node_modules/.bin/gulp clean",
     "zip": "./node_modules/.bin/gulp zip",
@@ -62,6 +63,7 @@
     "@types/morgan": "^1.7.32",
     "@types/reflect-metadata": "0.0.5",
     "@types/request": "0.0.42",
+    "@types/request-promise": "^4.1.33",
     "@types/serve-favicon": "^2.2.28",
     "@types/winston": "^2.3.1",
     "body-parser": "^1.17.1",
@@ -102,7 +104,8 @@
     "path": "^0.12.7",
     "pg": "^6.1.5",
     "reflect-metadata": "^0.1.10",
-    "request": "^2.79.0",
+    "request": "^2.81.0",
+    "request-promise": "^4.2.1",
     "require-dir": "^0.3.1",
     "run-sequence": "^1.2.2",
     "serve-favicon": "^2.4.2",

test/black-box/home.test.ts

@@ -0,0 +1,14 @@
+import { api } from './lib/api';
+
+
+test('GET / - should return the api info as a json', async () => {
+    const res = await api('GET', '/api');
+    res.expectJson();
+    res.expectStatusCode(200);
+
+    const body = res.getBody<any>();
+    const pkg = require('../../package.json');
+    expect(body.name).toBe(pkg.name);
+    expect(body.version).toBe(pkg.version);
+    expect(body.description).toBe(pkg.description);
+});

test/black-box/lib/ApiResponeTest.ts

@@ -0,0 +1,31 @@
+import * as _ from 'lodash';
+
+
+export class ApiResponeTest {
+    constructor(private res: any) { }
+
+    getBody<T>(): T {
+        return JSON.parse(this.res['body']);
+    }
+
+    getHeaders<T>(): T {
+        return this.res['headers'];
+    }
+
+    expectStatusCode(code: number): ApiResponeTest {
+        expect(this.res['statusCode']).toBe(code);
+        return this;
+    }
+
+    expectJson(): ApiResponeTest {
+        expect(this.getHeaders()['content-type']).toContain('json');
+        return this;
+    }
+
+    expectData(keys: string[]): ApiResponeTest {
+        const a = keys.sort();
+        const b = Object.keys(this.getBody()).sort();
+        expect(_.isEqual(a, b)).toBeTruthy();
+        return this;
+    }
+}

test/black-box/lib/api.ts

@@ -0,0 +1,12 @@
+require('dotenv').config();
+import * as request from 'request-promise';
+import { OptionsWithUri } 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));
+};

yarn.lock

@@ -111,7 +111,14 @@
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/@types/reflect-metadata/-/reflect-metadata-0.0.5.tgz#9c042bfa9803d577aad4f57dfbca4b7cae4286fe"
 
-"@types/request@0.0.42":
+"@types/request-promise@^4.1.33":
+  version "4.1.33"
+  resolved "https://registry.yarnpkg.com/@types/request-promise/-/request-promise-4.1.33.tgz#b0cde534f80ebae026eb5fa470e45a192682ca1e"
+  dependencies:
+    "@types/bluebird" "*"
+    "@types/request" "*"
+
+"@types/request@*", "@types/request@0.0.42":
   version "0.0.42"
   resolved "https://registry.yarnpkg.com/@types/request/-/request-0.0.42.tgz#e47a53bf0b130464854fb693297746a0c0479c31"
   dependencies:
@@ -820,7 +827,7 @@ block-stream@*:
   dependencies:
     inherits "~2.0.0"
 
-bluebird@^3.1.1, bluebird@^3.4.3, bluebird@^3.4.6:
+bluebird@^3.1.1, bluebird@^3.4.3, bluebird@^3.4.6, bluebird@^3.5.0:
   version "3.5.0"
   resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.0.tgz#791420d7f551eea2897453a8a77653f96606d67c"
 
@@ -4625,6 +4632,21 @@ replace-ext@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/replace-ext/-/replace-ext-1.0.0.tgz#de63128373fcbf7c3ccfa4de5a480c45a67958eb"
 
+request-promise-core@1.1.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/request-promise-core/-/request-promise-core-1.1.1.tgz#3eee00b2c5aa83239cfb04c5700da36f81cd08b6"
+  dependencies:
+    lodash "^4.13.1"
+
+request-promise@^4.2.1:
+  version "4.2.1"
+  resolved "https://registry.yarnpkg.com/request-promise/-/request-promise-4.2.1.tgz#7eec56c89317a822cbfea99b039ce543c2e15f67"
+  dependencies:
+    bluebird "^3.5.0"
+    request-promise-core "1.1.1"
+    stealthy-require "^1.1.0"
+    tough-cookie ">=2.3.0"
+
 request@^2.79.0, request@^2.81.0:
   version "2.81.0"
   resolved "https://registry.yarnpkg.com/request/-/request-2.81.0.tgz#c6928946a0e06c5f8d6f8a9333469ffda46298a0"
@@ -4954,6 +4976,10 @@ stack-trace@0.0.x:
   version "1.3.1"
   resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.3.1.tgz#faf51b9eb74aaef3b3acf4ad5f61abf24cb7b93e"
 
+stealthy-require@^1.1.0:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/stealthy-require/-/stealthy-require-1.1.1.tgz#35b09875b4ff49f26a777e509b3090a3226bf24b"
+
 stream-combiner@~0.0.4:
   version "0.0.4"
   resolved "https://registry.yarnpkg.com/stream-combiner/-/stream-combiner-0.0.4.tgz#4d5e433c185261dde623ca3f44c586bcf5c4ad14"
@@ -5216,7 +5242,7 @@ touch@1.0.0, touch@^1.0.0:
   dependencies:
     nopt "~1.0.10"
 
-tough-cookie@^2.0.0, tough-cookie@^2.3.2, tough-cookie@~2.3.0:
+tough-cookie@>=2.3.0, tough-cookie@^2.0.0, tough-cookie@^2.3.2, tough-cookie@~2.3.0:
   version "2.3.2"
   resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-2.3.2.tgz#f081f76e4c85720e6c37a5faced737150d84072a"
   dependencies: