Demo project to automate API testing for service Petstore swagger

Swagger is a toolkit for API developers from SmartBear Software and the former specification on which the OpenAPI specification is based.

📂 Table of contents

• Description
• Tools and technologies
• How to run
• Test results report in Allure Report
• Allure TestOps integration
• Jira integration
• Telegram Notifications

💡 Description

The test project consists of API tests.
A brief list of interesting facts about the project:

• Fake data generating with Faker library
• Using Lombok for models for API tests
• Objects serialization/deserialization for API requests/responses using Jackson
• Using request/response specifications for API tests
• Custom Allure listener for beautiful API requests/responses logging
• Allure TestOps integration
• Autotests as test documentation
• Jira integration

🧑‍💻 Tools and a technologies

The autotests in this project are written in Java.
Gradle - is used as a build automation tool.
JUnit5 - to execute tests.
REST Assured - for easy API testing of REST services.
Jenkins - CI/CD for running tests remotely.
Allure Report - for test results visualisation.
Telegram Bot - for test results notifications.
Allure TestOps - as Test Management System.

💻 How to run

Local running tests

gradle clean test

Remote running tests

Running tests in Jenkins

Main page of the build:

After build is completed, in the Builds history opposite the build number will appear the Allure Report icon, clicking on which will open the page with the generated html-report.

Test results report in Allure Report

Integration with Allure TestOps

Main dashboard

Test results

Integration with Jira

Telegram notifications using a bot

After the build is completed, a special bot created in Telegram, automatically processes and sends a test run report message.

back to Contents ⬆