🖥️ Contact List API - Testing Project using Postman and Newman (html-extra report)

✔️ Test Status:

This repo is destined to store a set of API testing, using postman test scripts and Newman with html-extra template to report the test execution results. The flow is set in continuous integration (CI) pipeline with Github Actions. For each update, the routine runs, and a report is generated at the "Actions" tab.

🗒️ About the service under Test

The Contact List API is a service provide as example in the book "The Complete Software Tester" by Kristin Jackvony, that i'm currently reading. To this service is available some HTTP methods to manipulate users and contacts. To practice, I planned and executed tests exploring the scenarios (successfullies and failures) involving the contacts resource. For each request, a different situation is tested and automatically validated using the postaman library (JavaScript based).

▶️ How to run this project

📌 Getting the last execution report

• Click on "Actions" tab in this repo;
  
• Click on the last workflow run;
  
• In the page bottom, you can verify the "Artifacts" session;
  

• Download the html report file, and open it in your favorite browswer to verify the test results.
  

⏭️ Running tests on GitHub Actions

• Access the "Actions" tab;
• Select the last run workflow;
• Click in "Re-run all jobs".

💾 Running tests locally

• Install postman;
  
• Download the collection and environment files in the directory /files, and import it in postaman;
• Run the collection to verify the test results.

or, to generate a html-extra report, aditionally:

• Install npm;
  
• Instal newman library;
  
• Install "htmlextra" template reporter;
  
• Run on terminal:

newman run files/Contact-List.postman_collection.json -e files/Contact-list.postman_environment.json -r htmlextra

• In your project folder will be created a new folder with the html report file generated by newman. You can run it using your favorite browser.

---

Author: Ana Carolina Cerqueira ✌️