lissy93 / quick-example-of-testing-in-nodejs

🛡 An example TDD project in Node.js, with unit tests, coverage tests, a stubbed API, continuous integration, code quality reviews and automated dependency checking

🛠️ Unit Testing in Node.JS

A quick example of testing in Node.JS

Intro

This is a quick example project to show how a test environment can be setup in Node.js

It includes the following

• Mocha - testing framework
• Chai - assertion library
• Istanbul - coverage testing
• SinonJs - stubs and splices for mocking data

The following online tools are used to monitor results

• Travis CI - Continuous Integration
• David DM - Dependency Management
• Codacy - Automated Code Quality Reviews
• Inch CI - Documentation Reviews

---

The Project

The project is a very simple script that pulls current weather data from OpenWeatherMap for your location, it then analyses it and lists which items (umbrella, icecream, jumper...) you will need for the current weather.

Installation

• Navigate into your working directory, run the following commands:
• git clone https://github.com/Lissy93/quick-example-of-testing-in-nodejs.git to clone repo
• cd quick-example-of-testing-in-nodejs to navigate into project
• npm install to install the dependencies

Running

• npm start will run the main file (app.js) and display results
• node app --location Newcastle will run app.js for a custom location, e.g. Newcastle
• npm test will run the Mocha tests, output results and generate reports
• npm run cover will run the Istanbul coverage tests and output results and generate reports

---

Screenshots

Command Line Output: Tests Passing

Web Report: Some Tests Failing

Web Report: All Tests Passing

---

© Alicia Sykes 2011 - 2017
Licensed under MIT

quick-example-of-testing-in-nodejs's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.