Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digipie/mocha-chai-mongoose
An example of how you can use Mocha and Chai to perform API testing for a Node-ExpressJS-Mongoose app.
https://github.com/digipie/mocha-chai-mongoose
api chai github-actions mocha mocha-chai mocha-chai-mongoose mongo-action mongodb mongoose nodejs testing
Last synced: 12 days ago
JSON representation
An example of how you can use Mocha and Chai to perform API testing for a Node-ExpressJS-Mongoose app.
- Host: GitHub
- URL: https://github.com/digipie/mocha-chai-mongoose
- Owner: DigiPie
- License: mit
- Created: 2020-02-23T04:36:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:00:38.000Z (over 1 year ago)
- Last Synced: 2024-10-24T08:12:25.123Z (2 months ago)
- Topics: api, chai, github-actions, mocha, mocha-chai, mocha-chai-mongoose, mongo-action, mongodb, mongoose, nodejs, testing
- Language: TypeScript
- Homepage:
- Size: 203 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mocha-chai-mongoose
## Introduction
An up-to-date 2021 example of how you can use Mocha and Chai to perform API testing for a Node-ExpressJS-Mongoose app. You will be able to test your code locally and also automatically using Github Action.
## Project
### Setup instructions
Read the [Test Guide](TEST_GUIDE.md) for instructions on how to perform local and automated testing.
### Test plan
In this project:
- `test/productRoutes.test.ts` contains unit and integration tests for `src/routes/productRoutes.ts`.
- `src/routes/productRoutes.ts` contains routes which interact with `src/services/ProductService.ts`.
- `src/services/ProductService.ts` contains service methods which interact with `src/models/Product.ts`.
View the [Test Plan](TEST_PLAN.md) for more information.
### Releases
**Stable release:** [`v0.1.3`](https://github.com/DigiPie/mocha-chai-mongoose/releases)
- Implementation of `GET`, `POST`, `PUT` and `DELETE` routes
- 16 unit test cases testing the API routes individually
- 6 integration test cases testing route pairs (e.g. `GET` and `PUT`)
**Current release:** [`v0.1.3`](https://github.com/DigiPie/mocha-chai-mongoose/releases)
This project will not be frequently worked on beyond [`v0.1.0`](https://github.com/DigiPie/mocha-chai-mongoose/releases).
### Contributing
If you have any suggestions, bugs to report or would like to contribute to this project, feel free to create an [Issue](https://github.com/DigiPie/mocha-chai-mongoose/issues) or [Pull Request](https://github.com/DigiPie/mocha-chai-mongoose/pulls).
## Background info
### What is [Mongoose](https://mongoosejs.com/)
MongooseJS provides a straight-forward solution to modeling your NodeJS application data easily in MongoDB. It handles all MongoDB validation, casting and business logic on your behalf.
### What is [Mocha](https://mochajs.org/)
Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser. It is the test environment of choice for this project.
### What is [Chai](https://www.chaijs.com/)
Chai is an assertion library for Node. Chai assertions and `chai-http` are used in Mocha to perform HTTP testing of the NodeJS API endpoints.