BDD Style API Automation Framework for Pet Store API

Overview

This project is a BDD-style API automation framework built with .NET 8.0, Reqnroll, RestSharp, NUnit, Fluent Assertions, Log4Net, Allure Reporting, and written in C#. It is designed to test the functionality of the Pet Store API https://petstore.swagger.io/#/ by automating API test scenarios using behavior-driven development principles.

Features

1. Uses the latest Reqnroll version considering the decommissioning of SpecFLow from .net 8.0.
2. API Testing is achieved with RestSharp librabry for sending HTTP requests and handling responses, which is much faster and has built-in serialization.
3. Assertions using Fluent Assertions for improved test readability and maintainability.
4. Advanced OOP concepts such as objects, constructors, method overloading, static, getters/setters etc. have been used and demonstrated.
5. Useful techniques such as JsonSerializar, Reqnroll Data Table helpers, Reqnroll Hooks, exception handling etc. have been adapted.
6. Coding is performed with the high sense of code reusability, easy maintenance and easy to understand.
7. Required test data is always imported from the test framework, via a POST request to API, and deleted in the end so that tests are not prone to the public test data and not become flaky.
8. Logging with Log4Net for enhanced debugging and traceability.
9. NUnit is used as the backbone framework to run the tests.
10. Allure Reporting for structured test results. Allure reports get generated as part of the Hooks after every test run and gets stored DATETIME-wise.
11. Test can run on CI pipeline on GitHub actions. [Refer notes].
12. Supports Parallel Execution to improve test performance.

Note

1. The project does not ensure 100% test coverage. Just 1 or 2 tests for the main endpoints are showcased to demonstrate different ways of handling different types of requests and responses. It needs to be improved by adding more functional, negative and validation tests for each endpoint.
2. CI/CD integration with GitHub Actions is still in progress and needs some more fixes to see a successful run. However, workflows, yml file etc. are already set up and able to show failed runs at this stage.

Prerequisites

Ensure you have the following installed: .NET 8.0 SDK Visual Studio 2022 or JetBrains Rider Allure Command-Line Tool (Scoop)

Installation

Clone the repository: git clone https://github.com/sbhat6/SubuBhat-CBA-Test cd SubuBhat-CBA-Test

Running Tests

Execute tests using Visual Studio Test Explorer Or run the command from the Terminal dotnet test

Logging & Reports

Logs are captured using Log4Net at info, debug, error, fetal levels.