Add test to show how we can redefine mounting using express server

Author: olegdovger

.eslintrc.js

@@ -1,5 +1,9 @@
 module.exports = {
     "extends": "airbnb-base",
+    "env": {
+      node: true,
+      mocha: true
+    },
     "rules": {
         "max-len": "off",
         "func-names": "off",

.nycrc

@@ -0,0 +1,12 @@
+{
+  "exclude": [
+    "examples/**/*.js",
+    "examples/**/*.json",
+    "examples/**/*.xml",
+    "test/mocks/**/*.js",
+    "test/mocks/**/*.json",
+    "test/mocks/**/*.xml",
+
+    "test/**/*.spec.js"
+  ]
+}

examples/redefine-default-mounting/example.js

@@ -0,0 +1,12 @@
+const express = require('../../node_modules/express');
+const apiMocker = require('../../index');
+
+const app = express();
+
+// default response
+app.use('/', apiMocker('states/base'));
+
+// definite state, where default response can be changed
+app.use('/', apiMocker('states/my-own-state'));
+
+app.listen(9090);

examples/redefine-default-mounting/states/base/profile/GET.js

@@ -0,0 +1,14 @@
+module.exports = function (req, res, next) {
+  next();
+
+  try {
+    res.send({
+      profile: {
+        first_name: 'Aaron',
+        last_name: 'Pol'
+      }
+    });
+  } catch (e) {
+    //
+  }
+};

examples/redefine-default-mounting/states/my-own-state/profile/GET.json

@@ -0,0 +1,6 @@
+{
+  "profile": {
+    "first_name": "Bryan",
+    "last_name": "Cranston"
+  }
+}

package.json

@@ -4,7 +4,7 @@
   "description": "A connect middleware to serve a RESTful api by some json, xml or js files",
   "main": "index.js",
   "scripts": {
-    "test": "nyc --reporter=html --reporter=text mocha --exit",
+    "test": "nyc --reporter=html --reporter=text mocha --ui bdd ./test --exit",
     "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
     "travis-deploy-once": "travis-deploy-once",
     "semantic-release": "semantic-release"

test/api-mocker.spec.js

@@ -1,13 +1,14 @@
-var request = require('supertest');
-var express = require('express');
-var apiMocker = require('../index');
-var fs = require('fs');
-var app = express();
+const request = require('supertest');
+const express = require('express');
+const fs = require('fs');
+const apiMocker = require('..');
 
-var deleteFolderRecursive = function(path) {
+const app = express();
+
+const deleteFolderRecursive = function (path) {
   if (fs.existsSync(path)) {
-    fs.readdirSync(path).forEach(function(file, index){
-      var curPath = path + "/" + file;
+    fs.readdirSync(path).forEach((file) => {
+      const curPath = `${path}/${file}`;
       if (fs.lstatSync(curPath).isDirectory()) { // recurse
         deleteFolderRecursive(curPath);
       } else { // delete file
@@ -20,24 +21,24 @@ var deleteFolderRecursive = function(path) {
 
 app.use('/api', apiMocker('test/mocks'));
 app.use('/v2', apiMocker({
-    target: 'test/mocks',
-    nextOnNotFound: true,
-    verbose: true
+  target: 'test/mocks',
+  nextOnNotFound: true,
+  verbose: true
 }));
-app.use('/v2', function (req, res) {
-    res.json({
-        message: 'Fallback'
-    })
+app.use('/v2', (req, res) => {
+  res.json({
+    message: 'Fallback'
+  });
 });
 app.use(apiMocker('/v3', 'test/mocks'));
 app.use(apiMocker('/v4', {
-    target: 'test/mocks'
+  target: 'test/mocks'
 }));
 app.use('/notdefined', apiMocker('notdefined'));
 app.use(apiMocker('/xml', {
   target: 'test/mocks',
   type: 'xml',
-  verbose: function (msg) {
+  verbose() {
     // sth with message
   }
 }));
@@ -46,8 +47,8 @@ app.use(apiMocker('/dyn', {
   type: 'auto'
 }));
 
-describe('Simple configuration with baseUrl', function () {
-  it('responds for simple GET request', function (done) {
+describe('Simple configuration with baseUrl', () => {
+  it('responds for simple GET request', (done) => {
     request(app)
       .get('/api/users/1')
       .expect('Content-Type', /json/)
@@ -57,7 +58,7 @@ describe('Simple configuration with baseUrl', function () {
       }, done);
   });
 
-  it('responds for simple POST request', function (done) {
+  it('responds for simple POST request', (done) => {
     request(app)
       .post('/api/users/1')
       .expect('Content-Type', /json/)
@@ -67,7 +68,7 @@ describe('Simple configuration with baseUrl', function () {
       }, done);
   });
 
-  it('custom response will not cache', function (done) {
+  it('custom response will not cache', (done) => {
     fs.mkdirSync('./test/mocks/users/2');
     fs.writeFileSync('./test/mocks/users/2/GET.js', fs.readFileSync('./test/mocks/users/__user_id__/GET_example1.js'));
 
@@ -83,15 +84,15 @@ describe('Simple configuration with baseUrl', function () {
       .post('/api/users/2')
       .expect({
         version: 2
-      }, function () {
+      }, () => {
         done();
         deleteFolderRecursive('./test/mocks/users/2');
       });
   });
 });
 
-describe('nextOnNotFound setting', function () {
-  it('returns correct response when mock is exits', function (done) {
+describe('nextOnNotFound setting', () => {
+  it('returns correct response when mock is exits', (done) => {
     request(app)
       .get('/v2/users/1')
       .expect('Content-Type', /json/)
@@ -101,7 +102,7 @@ describe('nextOnNotFound setting', function () {
       }, done);
   });
 
-  it('returns fallback when mock is not exits', function (done) {
+  it('returns fallback when mock is not exits', (done) => {
     request(app)
       .get('/v2/non-existing-resource')
       .expect('Content-Type', /json/)
@@ -112,8 +113,8 @@ describe('nextOnNotFound setting', function () {
   });
 });
 
-describe('Simple configuration without baseUrl', function () {
-  it('returns correct response', function (done) {
+describe('Simple configuration without baseUrl', () => {
+  it('returns correct response', (done) => {
     request(app)
       .get('/v3/users/1')
       .expect('Content-Type', /json/)
@@ -124,8 +125,8 @@ describe('Simple configuration without baseUrl', function () {
   });
 });
 
-describe('Configuration with object and without baseUrl', function () {
-  it('returns correct response', function (done) {
+describe('Configuration with object and without baseUrl', () => {
+  it('returns correct response', (done) => {
     request(app)
       .get('/v4/users/1')
       .expect('Content-Type', /json/)
@@ -136,14 +137,14 @@ describe('Configuration with object and without baseUrl', function () {
   });
 });
 
-describe('Wildcard feature', function () {
-  it('works properly when no mock exist for request', function (done) {
+describe('Wildcard feature', () => {
+  it('works properly when no mock exist for request', (done) => {
     request(app)
       .get('/notdefined/products/1')
       .expect(404, done);
   });
 
-  it('wildcard mock works properly', function (done) {
+  it('wildcard mock works properly', (done) => {
     request(app)
       .get('/api/users/2812391232')
       .expect(200)
@@ -154,7 +155,7 @@ describe('Wildcard feature', function () {
       }, done);
   });
 
-  it('wildcard mock works properly with nested resources', function (done) {
+  it('wildcard mock works properly with nested resources', (done) => {
     request(app)
       .get('/api/users/1/nested')
       .expect(200)
@@ -164,13 +165,13 @@ describe('Wildcard feature', function () {
       }, done);
   });
 
-  it('wildcard json methods should work on any given method', function (done) {
+  it('wildcard json methods should work on any given method', (done) => {
     request(app)
       .get('/api/users/1/any-json-request')
       .expect(200)
       .expect({
         method: 'ANY'
-      }, function() {
+      }, () => {
         request(app)
           .post('/api/users/1/any-json-request')
           .expect(200)
@@ -180,13 +181,13 @@ describe('Wildcard feature', function () {
       });
   });
 
-  it('wildcard js methods should work on any given method', function (done) {
+  it('wildcard js methods should work on any given method', (done) => {
     request(app)
       .get('/api/users/1/any-js-request')
       .expect(200)
       .expect({
         anyMethod: 'GET'
-      }, function() {
+      }, () => {
         request(app)
           .post('/api/users/1/any-js-request')
           .expect(200)
@@ -198,59 +199,57 @@ describe('Wildcard feature', function () {
 });
 
 
-describe('Response type config', function () {
-  it('works properly with xml responses', function (done) {
+describe('Response type config', () => {
+  it('works properly with xml responses', (done) => {
     request(app)
       .get('/xml/users/1')
       .expect('Content-Type', /xml/)
       .expect(200, done);
   });
 
-  it('works properly with auto type (xml)', function (done) {
+  it('works properly with auto type (xml)', (done) => {
     request(app)
       .get('/dyn/users/1')
       .set('Accept', 'application/xml')
       .expect('Content-Type', /xml/)
       .expect(200, done);
   });
 
-  it('works properly with auto type (json)', function (done) {
+  it('works properly with auto type (json)', (done) => {
     request(app)
       .get('/dyn/users/1')
       .set('Accept', 'application/json')
       .expect('Content-Type', /json/)
       .expect(200, done);
   });
 
-  it('works properly with auto type (xml not found)', function (done) {
+  it('works properly with auto type (xml not found)', (done) => {
     request(app)
       .post('/dyn/users/2')
       .set('Accept', 'application/xml')
       .expect(404, done);
-
   });
 });
 
-describe('Handling request body', function () {
-  it('should work with request body json', function (done) {
+describe('Handling request body', () => {
+  it('should work with request body json', (done) => {
     request(app)
       .post('/api/users')
       .set('Content-Type', 'application/json')
-      .send({name: 'A name'})
+      .send({ name: 'A name' })
       .expect(201)
       .expect({
         name: 'A name'
-      }, done)
+      }, done);
   });
 
-  it('shouldnt break to capability of reading raw request body', function (done) {
+  it('shouldnt break to capability of reading raw request body', (done) => {
     request(app)
       .patch('/api/users')
       .send('A text content')
       .expect(200)
       .expect({
         requestString: 'A text content'
       }, done);
-  })
-
-})
+  });
+});

test/examples.spec.js

@@ -0,0 +1,37 @@
+const request = require('supertest');
+const express = require('express');
+const apiMocker = require('..');
+
+const app = express();
+
+app.use('/api/v1', apiMocker('examples/redefine-default-mounting/states/base'));
+
+describe('Redefine default mounting', () => {
+  it('responds for simple GET request', (done) => {
+    request(app)
+      .get('/api/v1/profile')
+      .expect('Content-Type', /json/)
+      .expect(200)
+      .expect({
+        profile: {
+          first_name: 'Aaron',
+          last_name: 'Pol'
+        }
+      }, done);
+  });
+
+  it('redefine GET response', (done) => {
+    app.use('/api/v1', apiMocker('examples/redefine-default-mounting/states/my-own-state'));
+
+    request(app)
+      .get('/api/v1/profile')
+      .expect('Content-Type', /json/)
+      .expect(200)
+      .expect({
+        profile: {
+          first_name: 'Bryan',
+          last_name: 'Cranston'
+        }
+      }, done);
+  });
+});

wallaby.js

@@ -4,16 +4,19 @@ module.exports = function w() {
       'index.js',
       { pattern: 'test/mocks/**/*.js', instrument: false },
       { pattern: 'test/mocks/**/*.json', instrument: false },
-      { pattern: 'test/mocks/**/*.xml', instrument: false }
+      { pattern: 'test/mocks/**/*.xml', instrument: false },
+      { pattern: 'examples/**/*.js', instrument: false },
+      { pattern: 'examples/**/*.json', instrument: false },
+      { pattern: 'examples/**/*.xml', instrument: false }
     ],
     tests: [
-      'test/**/*.spec.js',
+      'test/**/*.spec.js'
     ],
     env: {
       type: 'node',
-      runner: 'node',
+      runner: 'node'
     },
 
-    testFramework: 'mocha',
+    testFramework: 'mocha'
   };
 };