JavaScript-Unit-Testing-examples

learning-zone · learning-zone · commit a22265070767 · 2019-09-20T09:43:04.000+05:30
diff --git a/js-unit-testing-examples/.babelrc b/js-unit-testing-examples/.babelrc
@@ -0,0 +1,3 @@
+{
+    "presets": ["es2015"]
+}
diff --git a/js-unit-testing-examples/.editorconfig b/js-unit-testing-examples/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+
+[*.{js,md}]
+indent_style = space
+indent_size = 4
+
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2
diff --git a/js-unit-testing-examples/.eslintrc.json b/js-unit-testing-examples/.eslintrc.json
@@ -0,0 +1,35 @@
+{
+    "env": {
+        "es6": true,
+        "node": true,
+        "mocha": true
+    },
+    "globals": {
+        "chai": true,
+        "expect": true,
+        "sinon": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ],
+        "no-console": "warn"
+    }
+}
diff --git a/js-unit-testing-examples/.gitignore b/js-unit-testing-examples/.gitignore
@@ -0,0 +1,37 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
diff --git a/js-unit-testing-examples/.vscode/settings.json b/js-unit-testing-examples/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "vsicons.presets.angular": false
+}
diff --git a/js-unit-testing-examples/LICENSE b/js-unit-testing-examples/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Marc Littlemore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/js-unit-testing-examples/README.md b/js-unit-testing-examples/README.md
@@ -0,0 +1,56 @@
+# JavaScript Unit Testing Examples
+
+Example project to allow me to show how best to unit test a JavaScript Express application.
+
+## Install
+
+Clone this repository and install the dependencies as follows:
+
+```
+git clone git@github.com:MarcL/js-unit-testing-framework.git
+npm install
+```
+
+## Running the tests
+
+The code sets up a basic Express server with a few routes and some tests which cover testing the server setup. Run the test suite using npm:
+
+```
+npm test
+```
+
+## JavaScript Tests
+
+Take a look in the `test` directory to see all of the test code. There are lots of examples of different types of tests and how to create them.
+
+### Asynchronous functions and promises
+
+Some examples of how to test asynchronous functions and promises, including some tips and tricks and gotchas.
+
+#### Asynchronous function
+- Timeout because `done` callback isn't called when function succeeds
+- Passing test but slow because timer isn't stubbed
+- Passing test and fast because timer is stubbed
+- Timeout because `done` callback isn't called when function throws an error
+- Passing test to call `done` callback when function throws an error
+
+#### Promise : resolving
+- Test passes incorrectly because Promise isn't returned
+- Passing test because promise is returned
+- Passing test because `done` callback is called after resolution
+- Passing test because `done` callback is called after resolution using `chai-as-promised` syntax
+
+#### Promise : rejecting
+- Test passes incorrectly because Promise isn't returned
+- Failing test because rejected Promise error isn't caught
+- Passing test because Promise is returned and rejection is caught
+- Passing test because Promise rejection is caught and `done` callback is called
+- Passing test because Promise rejection is caught and `done` callback is called using `chai-as-promised` syntax
+
+#### Slow tests
+- Passing test but is slow due to Promise function in chain taking a long time
+- Passing test and much faster as longer function is now stubbed to execute immediately
+
+## License
+
+See [LICENSE](LICENSE)
diff --git a/js-unit-testing-examples/index.js b/js-unit-testing-examples/index.js
@@ -0,0 +1,4 @@
+require('babel-register');
+
+var server = require('./src/launch');
+server.start();
diff --git a/js-unit-testing-examples/package.json b/js-unit-testing-examples/package.json
@@ -0,0 +1,47 @@
+{
+  "name": "js-unit-testing-framework",
+  "version": "0.0.1",
+  "description": "Unit testing Express routes using Mocha",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint src/ test/",
+    "precommit": "npm run lint",
+    "prepush": "npm run test",
+    "start": "node .",
+    "test": "mocha",
+    "test:watch": "mocha --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/MarcL/js-unit-testing-framework.git"
+  },
+  "keywords": [
+    "unit",
+    "testing",
+    "mocha",
+    "express",
+    "routes"
+  ],
+  "author": "Marc Littlemore",
+  "license": "MIT",
+  "homepage": "https://github.com/MarcL/unit-test-express-routes#readme",
+  "dependencies": {
+    "babel-preset-es2015": "^6.24.1",
+    "babel-register": "^6.24.1",
+    "bluebird": "^3.5.0",
+    "express": "^4.15.2"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "chai-as-promised": "~6.0.0",
+    "eslint": "^3.19.0",
+    "eslint-config-airbnb-base": "^11.1.3",
+    "eslint-plugin-import": "~2.2.0",
+    "husky": "^0.13.3",
+    "mocha": "~3.4.1",
+    "node-mocks-http": "^1.6.1",
+    "proxyquire": "^1.7.10",
+    "sinon": "^2.2.0",
+    "sinon-chai": "^2.10.0"
+  }
+}
diff --git a/js-unit-testing-examples/src/data/fakeData.js b/js-unit-testing-examples/src/data/fakeData.js
@@ -0,0 +1,4 @@
+export default {
+    events: []
+};
+
diff --git a/js-unit-testing-examples/src/launch.js b/js-unit-testing-examples/src/launch.js
@@ -0,0 +1,36 @@
+import express from 'express';
+
+import homepage from './middleware/homepage';
+import login from './middleware/login';
+import authenticate from './middleware/authenticate';
+import dashboard from './middleware/dashboard';
+import promiseTest from './middleware/promiseTest';
+import apiRoutes from './routes/api';
+
+function setupRoutes(app) {
+    app.get('/', homepage);
+    app.get('/login', login);
+    app.get('/dashboard',
+        authenticate,
+        dashboard
+    );
+    app.get('/promises', promiseTest);
+
+    app.use('/api', apiRoutes);
+}
+
+function start(port = 7080) {
+    const app = express();
+
+    setupRoutes(app);
+
+    const server = app.listen(port, () => {
+        console.log(`Server running on: ${port}`);
+    });
+
+    return server;
+}
+
+export {
+    start
+};
diff --git a/js-unit-testing-examples/src/middleware/api/eventsGetAll.js b/js-unit-testing-examples/src/middleware/api/eventsGetAll.js
@@ -0,0 +1,25 @@
+import * as events from '../../services/events';
+
+const eventsGetAll = (request, response) => {
+    const renderJsonResponse = (dataObject, success = true) => {
+        const jsonResponse = Object.assign(
+            dataObject,
+            {success}
+        );
+        response.json(jsonResponse);
+    };
+
+    return events.getAll()
+        .then((data) => {
+            renderJsonResponse({
+                data
+            });
+        })
+        .catch((error) => {
+            renderJsonResponse({
+                message: error.name
+            }, false);
+        });
+};
+
+export default eventsGetAll;
diff --git a/js-unit-testing-examples/src/middleware/authenticate.js b/js-unit-testing-examples/src/middleware/authenticate.js
@@ -0,0 +1,7 @@
+function authenticate(request, response, next) {
+    // TODO: Authenticate request and redirect to login if not authenticated
+    console.log('verify authentication or redirect');
+    next();
+}
+
+export default authenticate;
diff --git a/js-unit-testing-examples/src/middleware/dashboard.js b/js-unit-testing-examples/src/middleware/dashboard.js
@@ -0,0 +1,5 @@
+function dashboard(request, response) {
+    response.send('dashboard is here');
+}
+
+export default dashboard;
diff --git a/js-unit-testing-examples/src/middleware/homepage.js b/js-unit-testing-examples/src/middleware/homepage.js
@@ -0,0 +1,5 @@
+function homepage(request, response) {
+    response.send('homepage is here');
+}
+
+export default homepage;
diff --git a/js-unit-testing-examples/src/middleware/login.js b/js-unit-testing-examples/src/middleware/login.js
@@ -0,0 +1,5 @@
+function homepage(request, response) {
+    response.send('login is here');
+}
+
+export default homepage;
diff --git a/js-unit-testing-examples/src/middleware/promiseTest.js b/js-unit-testing-examples/src/middleware/promiseTest.js
@@ -0,0 +1,25 @@
+function promiseWrapper(shouldFail) {
+    return shouldFail ?
+        Promise.reject() :
+        Promise.resolve();
+}
+
+function promiseTest(request, response) {
+    const {fail: shouldFail = false} = request.query;
+
+    return promiseWrapper(shouldFail)
+        .then(() => {
+            response.json({
+                message: 'resolved Promise',
+                error: false
+            });
+        })
+        .catch(() => {
+            response.json({
+                message: 'rejected Promise',
+                error: true
+            });
+        });
+}
+
+export default promiseTest;
diff --git a/js-unit-testing-examples/src/routes/api.js b/js-unit-testing-examples/src/routes/api.js
@@ -0,0 +1,21 @@
+import express from 'express';
+import eventsGetAll from '../middleware/api/eventsGetAll';
+
+const router = express.Router();
+
+router.get('/', (request, response) => {
+    response.json({success: true});
+});
+
+// TODO
+// - Add GET for all data /events - return data + 200
+router.get('/events', eventsGetAll);
+//router.get('/events/:id', dataGetById);
+
+// - Add POST to add new data /events - return 201
+// - Add GET for single data element /events/:id -200 / 404
+// - Add PUT to update single data element /events/:id - 200/204 (no content)/4040
+// - Add DELETE to delete single data element /events/:id - 200/404
+// - Add authentication - basic auth - 'auth' -> 'key:' (no password) + base64 encoded - 401 if failed
+
+export default router;
diff --git a/js-unit-testing-examples/src/services/events.js b/js-unit-testing-examples/src/services/events.js
@@ -0,0 +1,9 @@
+import fakeData from '../data/fakeData';
+
+const getAll = () => {
+    return Promise.resolve(fakeData.events);
+};
+
+export {
+    getAll
+};
diff --git a/js-unit-testing-examples/test/examples/asynchronous.test.js b/js-unit-testing-examples/test/examples/asynchronous.test.js
diff --git a/js-unit-testing-examples/test/mocha.opts b/js-unit-testing-examples/test/mocha.opts
diff --git a/js-unit-testing-examples/test/src/launch.test.js b/js-unit-testing-examples/test/src/launch.test.js
diff --git a/js-unit-testing-examples/test/src/middleware/api/dataGetAll.test.js b/js-unit-testing-examples/test/src/middleware/api/dataGetAll.test.js
diff --git a/js-unit-testing-examples/test/src/middleware/promiseTest.test.js b/js-unit-testing-examples/test/src/middleware/promiseTest.test.js
diff --git a/js-unit-testing-examples/test/src/middleware/services/events.test.js b/js-unit-testing-examples/test/src/middleware/services/events.test.js
diff --git a/js-unit-testing-examples/test/support/base.js b/js-unit-testing-examples/test/support/base.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "vsicons.presets.angular": false`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +export default {
 +    events: []
 +};
++