https://github.com/marcl/unit-test-express-routes
Example of how to unit test Express routes
https://github.com/marcl/unit-test-express-routes
Last synced: 4 months ago
JSON representation
Example of how to unit test Express routes
- Host: GitHub
- URL: https://github.com/marcl/unit-test-express-routes
- Owner: MarcL
- License: mit
- Created: 2016-11-06T21:05:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-15T00:01:52.000Z (over 9 years ago)
- Last Synced: 2025-05-29T15:11:34.591Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 7.81 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unit Testing Express Routes
Example project to show how to unit test Express routes using [Mocha](https://mochajs.org/), [Sinon](http://sinonjs.org/), [Chai](http://chaijs.com/) and [Proxyquire](https://github.com/thlorenz/proxyquire).
## Install
Clone this repository and install the dependencies as follows:
```
git clone git@github.com:MarcL/unit-test-express-routes.git
npm install
```
## Running the tests
The code sets up a basic Express server with a few routes and szome tests which just cover testing the server setup. The middlewares have no tests as they're simply there for stubbing expectations in the `launch.test.js` tests. Run the test suite using npm:
```
npm test
```
The tests assert that the routes are set up with the expected middleware. In my mind, it helps to complete code coverage, and also helps to guarantee that the routes are called with all of the expected middleware. A good example is for routes that are locked down using an authentication layer. Your tests can now assert that the authentication middleware is **definitely** called on the the expected routes. In this case it means that these test almost become and additional set of security tests too.
I'd expect there to be an additional layer of integration testing using [supertest](https://github.com/visionmedia/supertest) and [nock](https://github.com/node-nock/nock) which would better verify the full flow on each route too.
I've written a blog post about the reasoning behind why and how you would unit test Express routes here:
[How To Unit Test Express Routes](http://www.marclittlemore.com/how-to-unit-test-express-routes/?utm_source=github&utm_campaign=unit-test-express-routes&utm_medium=repository)