supertest_poc's Introduction

API Testing using SuperTest, Mocha and Chai

Don't forget to give a ⭐ to make the project popular.

What is it all about?

I have been using Rest-Assured framework all the time for testing APIs with Java. But this time it was my project's demand to perform API testing in Javascript. Being a newbie to JS, I googled for some tools and found SuperTest. To introduce SuperTest, it is a high level abstraction of HTTP requests, making it perfect for testing APIs. I decided to do a POC of this tool to understand it better, hence this project was created. I thought of sharing this on github, so it helps others as well who want to learn more about this tool. Checkout this link to learn more about SuperTest

Getting Started:

You need to have the following installed in your machine:

Node (Latest Version).
npm(Latest Version).
mocha framework is used for writing tests and chai for assertions, following command should help to install the required npm packages: npm i -D -g supertest mocha chai mochawesome
For running the tests, you need to type the command: npm run test. (Check Package.json for more details)
For generating the mochawesome report, run the command npm run report (Check Package.json for more details.) It will generate and export the report in mochawesome-report folder from which you can open the index.html file to view the report.

Talking more about the Scenarios Covered in this project:

I have covered, GET, POST, PUT, PATCH and DELETE requests. You will find the example code in the test folder of the repository.
End to End scenarios have been added for the restful booker APIs. If you need to get into more details about how to write tests using supertest, mocha and chai?, this blog is all you need to refer and get started.
Mochawesome reporter is used to generate the reports and show summary of the tests. I found it quite useful report as it shows the test description alongwith the tests and the time taken to run the tests.

❓ Need Assistance?

Discuss your queries by writing to me @ [email protected] OR ping me on any of the social media sites using the below link:
- Linktree

🚀 Trainings and Guidance

Contact me for 1:1 trainings/guidance for Software Testing, Mock Interviews, Test Automation tools queries, Mentoring and Coaching.

💭 Checkout the blogs related to Software Testing on my website

supertest_poc's People

Contributors

Stargazers

Watchers

supertest_poc's Issues

Add example tests for Delete Requests

Update libraries

Update and add mochawesome installation step as well as command to generate the report

Add mocha test reporter

Add mochawesome report and update readme

Update Readme

Add example tests for Patch Requests

Create e2e tests using restful booker.

Following steps needs to be automated

Create a Booking.
Save the Booking Id from create booking response.
Get Booking using the id in step 2 and compare with the create booking response.
Create auth token method
Update the booking dates and total price using the id in step 2 and auth token in step 4.
Assert the response of update booking
Update the fisrtname and last name using the Patch request and assert the response.
Delete the booking and assert the status code and response.
Get the Booking Id which is deleted(Booking Id from Step 2).

mfaisalkhatri / supertest_poc Goto Github PK