Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamcharankumar/api_test_framework
A Backend Test Framework for developing regression suites.
https://github.com/iamcharankumar/api_test_framework
curl-logs data-driven discord-bot fail-safe-mechanism java logback maven parallelization reportportal rest-api rest-assured rest-assured-framework test-automation-framework testng
Last synced: about 2 hours ago
JSON representation
A Backend Test Framework for developing regression suites.
- Host: GitHub
- URL: https://github.com/iamcharankumar/api_test_framework
- Owner: iamcharankumar
- Created: 2023-09-23T10:36:56.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-21T02:13:40.000Z (about 1 month ago)
- Last Synced: 2024-10-21T05:32:17.239Z (30 days ago)
- Topics: curl-logs, data-driven, discord-bot, fail-safe-mechanism, java, logback, maven, parallelization, reportportal, rest-api, rest-assured, rest-assured-framework, test-automation-framework, testng
- Language: Java
- Homepage:
- Size: 71.3 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ABOUT
#### A REST API Test Framework for developing the regression suites. The test cases can be run locally or through CI/CD.
# TEST FRAMEWORK DESIGN
- Triggering the automation through a maven command or a testng xml file is the starting point.
# STEPS FOR INTEGRATING TESTNG & REPORT PORTAL
1. Download the latest docker-compose.yml
from [here](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml), a quicker way to download
this is to use below command
`curl https://raw.githubusercontent.com/reportportal/reportportal/master/docker-compose.yml -o docker-compose.yml`
2. Once downloaded, execute the below command to pull the required images and start containers
`docker-compose -p reportportal up -d --force-recreate`
3. Verify login http://localhost:8080/ui/#login with `default\1q2w3e` or `superadmin\erebus`
4. Create a blank project and copy and paste the below config in `reportportal.properties` under `src/test/resources`.
See the table below.
5. Read these great posts written below by [Automation Hacks](https://github.com/automationhacks) to configure the Report
portal.
By far, these are the only posts with accurate steps.
1. Further reading on setting up the reportportal
is [here](https://automationhacks.io/2020/03/02/how-to-setup-reportportal-on-a-local-docker-instance/).
2. Further reading on configuring logback with reportportal to push logs
is [here](https://automationhacks.io/2020/09/25/logging-integration-with-logback-testng-in-report-portal/).
| Sl.No | Report portal Property Name | Report portal Property Value |
|-------|-----------------------------|------------------------------|
| 1 | rp.endpoint | http://localhost:8080 |
| 2 | rp.api.key | |
| 3 | rp.launch | Java launch |
| 4 | rp.project | api_tests |
#### REPORT PORTAL OUTPUTS
# STEPS FOR INTEGRATING TEST REPORTS [REPORT PORTAL URL] WITH DISCORD MESSAGE SERVICE
1. Create a discord account and follow the steps
given [here](https://www.svix.com/resources/guides/how-to-make-webhook-discord/) to configure a message channel and
send the test reports after the test execution.
2. Pass your channel's webhook token in the `ApiConstants` class.
3. Here we will send the Report Portal Launch URL along with test case metrics. So make sure that your report portal is
up and running.
4. You're ready to execute your tests now. Follow the below section.
#### DISCORD OUTPUTS
# STEPS FOR THE TEST EXECUTION
The TestNG **has a default value of** `thread = 5` for parallel testing.
To override the thread values use `-DthreadPoolSize=3 -Ddataproviderthreadcount=3` in the below maven command
**1. git clone https://github.com/iamcharankumar/api_test_framework.git**
**2. cd api_test_framework**
**3. git pull**
**4. mvn clean test -Dgroups=ALL_SMOKE,ALL_REGRESSION -Dtestng.parallel=methods**
**Note:**
- To run specific test cases, use appropriate Test groups present in the 'TestGroups' class.