Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cihat-kose/campus-api-tests
Automated API testing framework for the Mersys Campus platform, utilizing Rest Assured and TestNG to ensure the reliability and accuracy of backend services.
https://github.com/cihat-kose/campus-api-tests
api-testing automated-testing java maven rest-assured testng
Last synced: 4 days ago
JSON representation
Automated API testing framework for the Mersys Campus platform, utilizing Rest Assured and TestNG to ensure the reliability and accuracy of backend services.
- Host: GitHub
- URL: https://github.com/cihat-kose/campus-api-tests
- Owner: cihat-kose
- License: mit
- Created: 2023-05-09T16:09:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-04T18:15:41.000Z (8 days ago)
- Last Synced: 2025-01-04T19:20:44.182Z (8 days ago)
- Topics: api-testing, automated-testing, java, maven, rest-assured, testng
- Language: Java
- Homepage: https://test.mersys.io
- Size: 590 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mersys Campus API Tests
---
## Table of Contents
1. [Project Overview](#project-overview)
2. [Features](#features)
3. [Installation](#installation)
4. [Configuration](#configuration)
5. [Usage](#usage)
6. [Folder Structure](#folder-structure)
7. [Dependencies](#dependencies)
8. [Reporting and Logs](#reporting-and-logs)
9. [HTTP Status Codes](#http-status-codes)
10. [Contributors](#contributors)
11. [License](#license)
12. [Contact](#contact)
---
## Project Overview
The **campus-api-tests** repository is a comprehensive API testing framework for Mersys Campus endpoints.
This project leverages **Rest Assured, TestNG, Hamcrest, and JavaFaker** to automate API tests, ensuring stability and accuracy of backend services.
---
## Features
- **API Automation** – Supports CRUD operations via `GET`, `POST`, `PUT`, and `DELETE` requests.
- **Data-Driven Testing** – Uses JavaFaker for dynamic data generation.
- **Modular Design** – Reusable request/response specifications for enhanced test scalability.
- **Comprehensive Logging** – Logs API requests/responses for better debugging and reporting.
- **Parallel Test Execution** – Executes tests concurrently to reduce runtime.
- **Reporting** – Detailed HTML reports via TestNG.
---
## Installation
### 1. Clone the Repository
```bash
git clone https://github.com/cihat-kose/campus-api-tests.git
```
### 2. Import the Project (IntelliJ IDEA)
1. **File > New > Project from Version Control**
2. Enter Repository URL:
```bash
https://github.com/cihat-kose/campus-api-tests.git
```
3. **Maven auto-import** should download dependencies automatically.
---
## Configuration
### IntelliJ Plugins (Recommended)
- **TestNG**
- **Maven Helper**
- **REST Client**
- **Lombok Plugin** *(Optional - if Lombok is used in the project)*
---
## Usage
### Running Tests
#### 1. Run All Tests
```bash
mvn clean test
```
#### 2. Run Specific Tests (via IntelliJ IDEA)
- Right-click `testng.xml`
- Select **Run 'testng.xml'**
---
## Folder Structure
```plaintext
campus-api-tests/
│
├── src/
│ └── test/
│ ├── java/
│ │ ├── campus/ # Campus-related API tests
│ │ │ ├── Cam02_PositionCategoriesTests.java # Tests for Position Categories
│ │ │ ├── Cam03_AttestationsTests.java # Tests for Attestations
│ │ │ ├── Cam04_DocumentTypesTests.java # Tests for Document Types
│ │ │ └── ... # Other campus test cases
│ │ └── mersys/ # Mersys system tests
│ │ ├── Login.java # Login tests for Mersys platform
│ │ └── MersysStudentGroupsTests.java # Tests for Mersys student groups
│ └── resources/
│ └── testng.xml # TestNG configuration for running tests
├── target/ # Build output directory
├── images/ # Project-related images
│ └── HTTP_Status_Codes.png # Image for HTTP Status Codes
├── LICENSE # Project license (MIT License)
├── pom.xml # Maven configuration and dependencies
└── README.md # Project documentation
```
## Dependencies
Dependencies are managed in `pom.xml`. Key dependencies include:
- **RestAssured**: For making HTTP requests to test APIs.
- **TestNG**: For organizing and managing test execution.
- **Hamcrest**: For enhanced assertions in test validations.
- **Jackson**: For JSON serialization and deserialization.
- **JavaFaker**: For generating random test data.
- **SLF4J (Simple Logging Facade for Java)**: For logging support.
---
## Reporting and Logs
- **HTML Reports** – After tests, HTML reports are generated in the `target/surefire-reports` directory.
- **Logs** – Request and response bodies are logged for debugging.
```bash
cat target/surefire-reports/emailable-report.html
```
---
## HTTP Status Codes
This project commonly encounters a variety of HTTP status codes in responses.
Below is a summary of some frequently used status codes and their meanings:
---
## Contributors
- [cihat-kose](https://github.com/cihat-kose) – **Team Lead / Software Tester**
- [AyseGun18](https://github.com/AyseGun18) – **Software Tester**
- [CihanDilber](https://github.com/CihanDilber) – **Software Tester**
- [HavvaGonul](https://github.com/HavvaGonul) – **Software Tester**
- [seretto](https://github.com/seretto) – **Software Tester**
- [seymanuripek](https://github.com/seymanuripek) – **Software Tester**
- [TlpAyn](https://github.com/TlpAyn) – **Software Tester**
- [yilmazas](https://github.com/yilmazas) – **Software Tester**
- [Zafer-Yilmaz](https://github.com/Zafer-Yilmaz) – **Software Tester**
To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a Pull Request.
---
## License
This project is licensed under the MIT License.
See the [LICENSE](LICENSE) file for details.
---
## Contact
For any questions or contributions, please open an issue in this repository.