Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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
https://github.com/lissy93/quick-example-of-testing-in-nodejs

assertions behavior-driven-development code-quality continuous-integration coverage-testing dependency-manager istanbul mocha stubbing test-driven-development unit-testing

Last synced: 1 day ago
JSON representation

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

Host: GitHub
URL: https://github.com/lissy93/quick-example-of-testing-in-nodejs
Owner: Lissy93
Created: 2015-08-24T15:48:08.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-02-22T07:05:19.000Z (9 months ago)
Last Synced: 2024-04-14T21:37:02.297Z (7 months ago)
Topics: assertions, behavior-driven-development, code-quality, continuous-integration, coverage-testing, dependency-manager, istanbul, mocha, stubbing, test-driven-development, unit-testing
Language: JavaScript
Homepage: https://goo.gl/YCdqoj
Size: 17.6 KB
Stars: 23
Watchers: 3
Forks: 77
Open Issues: 2
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

🛠️ 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](http://mochajs.org/) - *testing framework*
- [Chai](http://chaijs.com/) - *assertion library*
- [Istanbul](https://github.com/gotwarlost/istanbul) - *coverage testing*
- [SinonJs](http://sinonjs.org/) - *stubs and splices for mocking data*

The following online tools are used to monitor results

- [Travis CI](https://travis-ci.org/) - *Continuous Integration*
- [David DM](https://david-dm.org/) - *Dependency Management*
- [Codacy](https://www.codacy.com/) - *Automated Code Quality Reviews*
- [Inch CI](https://inch-ci.org/) - *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

---