Add e2e example

Author: hirsch88

README.md

@@ -42,6 +42,7 @@ Try it!! We are happy to hear your feedback or any kind of new features.
 - **API Documentation** thanks to [swagger](http://swagger.io/).
 - **API Monitoring** thanks to [express-status-monitor](https://github.com/RafalWilinski/express-status-monitor).
 - **Integrated Testing Tool** thanks to [Jest](https://facebook.github.io/jest).
+- **E2E API Testing** thanks to [supertest](https://github.com/visionmedia/supertest).
 - **Basic Security Features** thanks to [Helmet](https://helmetjs.github.io/).
 - **Easy event dispatching** thanks to [event-dispatch](https://github.com/pleerock/event-dispatch).
 - **Fast Database Building** with simple migration from [TypeORM](https://github.com/typeorm/typeorm).
@@ -389,6 +390,7 @@ npm start db.seed
 | [Helmet](https://helmetjs.github.io/) | Helmet helps you secure your Express apps by setting various HTTP headers. It’s not a silver bullet, but it can help! |
 | [Auth0 API Documentation](https://auth0.com/docs/api/management/v2) | Authentification service |
 | [Jest](http://facebook.github.io/jest/) | Delightful JavaScript Testing Library for unit and e2e tests |
+| [supertest](https://github.com/visionmedia/supertest) | Super-agent driven library for testing node.js HTTP servers using a fluent API |
 | [swagger Documentation](http://swagger.io/) | API Tool to describe and document your api. |
 | [SQLite Documentation](https://www.sitepoint.com/getting-started-sqlite3-basic-commands/) | Getting Started with SQLite3 – Basic Commands. |
 | [GraphQL Documentation](http://graphql.org/graphql-js/) | A query language for your API. |

package-scripts.js

@@ -119,6 +119,7 @@ module.exports = {
                     script: 'nps "test.integration --verbose"'
                 },
                 run: {
+                    // -i. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
                     script: 'cross-env NODE_ENV=test jest --testPathPattern=integration -i'
                 },
             },
@@ -127,7 +128,6 @@ module.exports = {
                     script: series(
                         'nps banner.test',
                         'nps test.e2e.pretest',
-                        runInNewWindow(series('nps build', 'nps start')),
                         'nps test.e2e.run'
                     )
                 },
@@ -136,11 +136,10 @@ module.exports = {
                 },
                 verbose: {
                     script: 'nps "test.e2e --verbose"'
+                },run: {
+                    // -i. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
+                    script: 'cross-env NODE_ENV=test jest --testPathPattern=e2e -i'
                 },
-                run: series(
-                    `wait-on --timeout 120000 http-get://localhost:3000/api/info`,
-                    'cross-env NODE_ENV=test jest --testPathPattern=e2e -i'
-                )
             }
         },
         /**

package.json

@@ -50,6 +50,7 @@
     "@types/reflect-metadata": "0.0.5",
     "@types/request": "^2.0.8",
     "@types/serve-favicon": "^2.2.29",
+    "@types/supertest": "^2.0.4",
     "@types/uuid": "^3.4.3",
     "@types/winston": "^2.3.7",
     "body-parser": "^1.18.2",
@@ -84,6 +85,7 @@
     "request": "^2.83.0",
     "routing-controllers": "^0.7.6",
     "serve-favicon": "^2.4.5",
+    "supertest": "^3.0.0",
     "swagger-ui-express": "^2.0.10",
     "ts-node": "^3.3.0",
     "tslint": "^5.8.0",

src/app.ts

@@ -27,7 +27,7 @@ import { eventDispatchLoader } from './loaders/eventDispatchLoader';
 bootstrapMicroframework({
     /**
      * Loader is a place where you can configure all your modules during microframework
-     * bootstrap. All loaders are executed one by one in a sequential order.
+     * bootstrap process. All loaders are executed one by one in a sequential order.
      */
     loaders: [
         winstonLoader,

src/loaders/expressLoader.ts

@@ -34,7 +34,10 @@ export const expressLoader: MicroframeworkLoader = (settings: MicroframeworkSett
         });
 
         // Run application to listen on given port
-        expressApp.listen(env.app.port);
+        if (!env.isTest) {
+            const server = expressApp.listen(env.app.port);
+            settings.setData('express_server', server);
+        }
 
         // Here we can set the data for other loaders
         settings.setData('express_app', expressApp);

test/e2e/api/info.test.ts

@@ -0,0 +1,20 @@
+import { Application } from 'express';
+import * as request from 'supertest';
+import { bootstrapApp } from '../utils/app';
+
+describe('/api', () => {
+
+    let app: Application;
+    beforeAll(async () => app = await bootstrapApp());
+
+    test('GET: / should return the api-version', async (done) => {
+        const response = await request(app)
+            .get('/api')
+            .expect('Content-Type', /json/)
+            .expect(200);
+
+        console.log(response);
+        done();
+    });
+
+});

test/e2e/utils/app.ts

@@ -0,0 +1,30 @@
+
+
+import { bootstrapMicroframework, Microframework } from 'microframework';
+import { Application } from 'express';
+import { expressLoader } from './../../../src/loaders/expressLoader';
+import { winstonLoader } from './../../../src/loaders/winstonLoader';
+import { typeormLoader } from './../../../src/loaders/typeormLoader';
+import { swaggerLoader } from './../../../src/loaders/swaggerLoader';
+import { monitorLoader } from './../../../src/loaders/monitorLoader';
+import { homeLoader } from './../../../src/loaders/homeLoader';
+import { publicLoader } from './../../../src/loaders/publicLoader';
+import { iocLoader } from './../../../src/loaders/iocLoader';
+import { graphqlLoader } from './../../../src/loaders/graphqlLoader';
+import { eventDispatchLoader } from './../../../src/loaders/eventDispatchLoader';
+
+export const bootstrapApp = async (): Promise<Application> => {
+    const framework = await bootstrapMicroframework({
+        loaders: [
+            winstonLoader,
+            iocLoader,
+            eventDispatchLoader,
+            typeormLoader,
+            expressLoader,
+            homeLoader,
+            // publicLoader,
+            // graphqlLoader,
+        ],
+    });
+    return framework.settings.getData('express_app') as Application;
+};

yarn.lock

@@ -113,6 +113,18 @@
     "@types/express-serve-static-core" "*"
     "@types/mime" "*"
 
+"@types/superagent@*":
+  version "3.5.6"
+  resolved "https://registry.yarnpkg.com/@types/superagent/-/superagent-3.5.6.tgz#9cf2632c075ba9e601f6a610aadc23992d02394c"
+  dependencies:
+    "@types/node" "*"
+
+"@types/supertest@^2.0.4":
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/@types/supertest/-/supertest-2.0.4.tgz#28770e13293365e240a842d7d5c5a1b3d2dee593"
+  dependencies:
+    "@types/superagent" "*"
+
 "@types/uuid@^3.4.3":
   version "3.4.3"
   resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-3.4.3.tgz#121ace265f5569ce40f4f6d0ff78a338c732a754"
@@ -868,7 +880,7 @@ component-bind@1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/component-bind/-/component-bind-1.0.0.tgz#00c608ab7dcd93897c0009651b1d3a8e1e73bbd1"
 
-component-emitter@1.2.1:
+component-emitter@1.2.1, component-emitter@^1.2.0:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.2.1.tgz#137918d6d78283f7df7a6b7c5a63e140e69425e6"
 
@@ -960,6 +972,10 @@ cookie@0.3.1, cookie@^0.3.1:
   version "0.3.1"
   resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.3.1.tgz#e7e0a1f9ef43b4c8ba925c5c5a96e806d16873bb"
 
+cookiejar@^2.1.0:
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.1.tgz#41ad57b1b555951ec171412a81942b1e8200d34a"
+
 copyfiles@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/copyfiles/-/copyfiles-1.2.0.tgz#a8da3ac41aa2220ae29bd3c58b6984294f2c593c"
@@ -1445,7 +1461,7 @@ express@^4.16.2:
     utils-merge "1.0.1"
     vary "~1.1.2"
 
-extend@~3.0.0, extend@~3.0.1:
+extend@^3.0.0, extend@~3.0.0, extend@~3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444"
 
@@ -1561,22 +1577,26 @@ forever-agent@~0.6.1:
   version "0.6.1"
   resolved "https://registry.yarnpkg.com/forever-agent/-/forever-agent-0.6.1.tgz#fbc71f0c41adeb37f96c577ad1ed42d8fdacca91"
 
-form-data@~2.1.1:
-  version "2.1.4"
-  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.1.4.tgz#33c183acf193276ecaa98143a69e94bfee1750d1"
+form-data@^2.3.1, form-data@~2.3.1:
+  version "2.3.1"
+  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.3.1.tgz#6fb94fbd71885306d73d15cc497fe4cc4ecd44bf"
   dependencies:
     asynckit "^0.4.0"
     combined-stream "^1.0.5"
     mime-types "^2.1.12"
 
-form-data@~2.3.1:
-  version "2.3.1"
-  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.3.1.tgz#6fb94fbd71885306d73d15cc497fe4cc4ecd44bf"
+form-data@~2.1.1:
+  version "2.1.4"
+  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.1.4.tgz#33c183acf193276ecaa98143a69e94bfee1750d1"
   dependencies:
     asynckit "^0.4.0"
     combined-stream "^1.0.5"
     mime-types "^2.1.12"
 
+formidable@^1.1.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/formidable/-/formidable-1.1.1.tgz#96b8886f7c3c3508b932d6bd70c4d3a88f35f1a9"
+
 forwarded@~0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.1.2.tgz#98c23dab1175657b8c0573e8ceccd91b0ff18c84"
@@ -2774,7 +2794,7 @@ merge@^1.1.3:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/merge/-/merge-1.2.0.tgz#7531e39d4949c281a66b8c5a6e0265e8b05894da"
 
-methods@~1.1.2:
+methods@^1.1.1, methods@~1.1.2:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee"
 
@@ -2820,6 +2840,10 @@ mime@1.4.1:
   version "1.4.1"
   resolved "https://registry.yarnpkg.com/mime/-/mime-1.4.1.tgz#121f9ebc49e3766f311a76e1fa1c8003c4b03aa6"
 
+mime@^1.4.1:
+  version "1.6.0"
+  resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1"
+
 mimic-fn@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.1.0.tgz#e667783d92e89dbd342818b5230b9d62a672ad18"
@@ -3501,7 +3525,7 @@ read-pkg@^2.0.0:
     normalize-package-data "^2.3.2"
     path-type "^2.0.0"
 
-readable-stream@2.3.3, readable-stream@^2.0.2, readable-stream@^2.0.6, readable-stream@^2.1.4, readable-stream@^2.1.5:
+readable-stream@2.3.3, readable-stream@^2.0.2, readable-stream@^2.0.5, readable-stream@^2.0.6, readable-stream@^2.1.4, readable-stream@^2.1.5:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.3.tgz#368f2512d79f9d46fdfc71349ae7878bbc1eb95c"
   dependencies:
@@ -4051,6 +4075,28 @@ subarg@^1.0.0:
   dependencies:
     minimist "^1.1.0"
 
+superagent@^3.0.0:
+  version "3.8.2"
+  resolved "https://registry.yarnpkg.com/superagent/-/superagent-3.8.2.tgz#e4a11b9d047f7d3efeb3bbe536d9ec0021d16403"
+  dependencies:
+    component-emitter "^1.2.0"
+    cookiejar "^2.1.0"
+    debug "^3.1.0"
+    extend "^3.0.0"
+    form-data "^2.3.1"
+    formidable "^1.1.1"
+    methods "^1.1.1"
+    mime "^1.4.1"
+    qs "^6.5.1"
+    readable-stream "^2.0.5"
+
+supertest@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/supertest/-/supertest-3.0.0.tgz#8d4bb68fd1830ee07033b1c5a5a9a4021c965296"
+  dependencies:
+    methods "~1.1.2"
+    superagent "^3.0.0"
+
 supports-color@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-0.2.0.tgz#d92de2694eb3f67323973d7ae3d8b55b4c22190a"