This repo demonstrates some testing, both unit and integration, of a RESTful api on a node.js server.
- The api is a simple restify user management app on the node server.
- Users are stored at a MongoDB and models are handled by the mongoose node module.
- To provide a quick start of the app, mockgoose is used, so there is no need to setup a real MongoDB.
Just do:
npm install
And:
node server.js
Create a user:
POST /users HTTP/1.1
Host: localhost:3000
Content-Type: application/json
{ "email": "[email protected]", "password": "bbbbbb", "world": "Peasant" }
Response:
{
"type": true,
"data": {
"__v": 0,
"email": "[email protected]",
"password": "bbbbbb",
"world": "Peasant",
"_id": "560be7bca6581744535d9aa4"
}
}
Find the user:
GET /users/560be7bca6581744535d9aa4 HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Response:
{
"type": true,
"data": {
"email": "[email protected]",
"password": "bbbbbb",
"world": "Peasant",
"_id": "560be7bca6581744535d9aa4",
"__v": 0
}
}
If you create some users in the "Bossland" world you will be able to retrieve them:
POST /users HTTP/1.1
Host: localhost:3000
Content-Type: application/json
{ "email": "[email protected]", "password": "bbbbbb", "world": "Bossland" }
GET /bosses HTTP/1.1
Host: localhost:3000
Content-Type: application/json
{
"type": true,
"data": [
{
"email": "[email protected]",
"password": "bbbbbb",
"world": "Bossland",
"_id": "560be927a6581744535d9aa5",
"__v": 0
}
]
}
Now here comes the interesting part.
- The
specfolder contains both unit and integration tests of the api. - Specs are run by mocha. That's solid ground.
- User unit spec makes use of chai and sinon. Sinon provides some stubs for the models, while chai does a good job regarding assertions.
- The integration spec adds hippie to the teapot. Hippie can wrap a server, and thus it becomes a good partner for E2E testing and CI, the same way as supertest is.
That said, you can stop the server and run:
npm test
And hopefully you will get an output similar to that:
Server
GET /users endpoint
V returns an existing user
V returns an error if the id is wrong format
V returns a not found if the user does not exist
POST /users endpoint
V creates a user
V fails on a 19th century user
GET /bosses endpoint
V returns only bosses
User
V finds the bosses in Bossland
7 passing (94ms)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent