Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osandadeshan/gatling-java-performance-test-boilerplate
This project serves as a boilerplate for performance testing using Gatling and Java.
https://github.com/osandadeshan/gatling-java-performance-test-boilerplate
gatling java maven performance-testing
Last synced: about 19 hours ago
JSON representation
This project serves as a boilerplate for performance testing using Gatling and Java.
- Host: GitHub
- URL: https://github.com/osandadeshan/gatling-java-performance-test-boilerplate
- Owner: osandadeshan
- Created: 2024-01-13T08:01:52.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-06-11T02:52:11.000Z (5 months ago)
- Last Synced: 2024-06-11T05:32:14.383Z (5 months ago)
- Topics: gatling, java, maven, performance-testing
- Language: Java
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gatling Java Maven Boilerplate for Performance Testing
This project serves as a boilerplate for performance testing using Gatling and Java. The performance test scripts are created using Gatling, with scripts written in Java and build using Maven. For more information and documentation, can go [here](https://gatling.io/docs/gatling/).
## Project Setup
Install the following to ensure smooth execution of the performance test script:
- [Java JDK 11](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
- [IntelliJ IDEA](https://www.jetbrains.com/idea/download/?section=mac)
After importing the perf test script to IntelliJ IDEA, run Maven build first.
In settings, ensure that the java compiler used is JDK 11 and the Maven JVM selected is `Project SDK`. Once selected, the Maven JVM and java compiler both should be of same version.
## Project Structure
Business processes for the performance tests are located in `/scenario` folder.
Structure is of following:
```
└── scenario
│ ├── BusinessProcessService.java
│ ├── AddProductBusinessProcessServiceImpl.java
│ ├── UpdateProductBusinessProcessServiceImpl.java
│ ├── GetAllProductsBusinessProcessServiceImpl.java
│ ├── BusinessProcessSimulation.java
```
For util files that are used in the tests, they are located in the `/core` folder.
Structure is of following:
```
├── core
│ ├── constant
│ │ └── ApiPayloadConstant.java
│ │ └── BusinessProcess.java
│ │ └── EnvironmentConstant.java
│ │ └── PerformanceTestType.java
│ │ └── TestConfiguration.java
│ ├── controller
│ │ ├── AuthController.java
│ │ ├── ProductController.java
│ └── util
│ ├── ExecutionUtil.java
│ ├── HttpProtocol.java
│ ├── PropertyFileReader.java
│ └── RequestBodyGenerator.java
```
## Test Script Execution
### Method 1: Test Script Execution via IntelliJ IDEA
1. Execute the below command in the terminal
`mvn gatling:test -Dgatling.simulationClass= -Denv= -Dbp= -DtestType= -Dgatling.core.runDescription=`
Example:
`mvn gatling:test -Dgatling.simulationClass=PerformanceTestRunner -Denv=SIT -Dbp=BP1 -DtestType=LOAD -Dgatling.core.runDescription="BP1 Load Test"`
2. Wait till test execution is completed
3. Once test is completed, the report will be stored at `/target/gatling/`
## Test Data File Usage and Directory
If csv data files are required to use for the requests, pls place it in `test/resources/data` directory. Ensure that the data files are named clearly to prevent confusion.
** Do note that if you have added data files that is only meant for testing locally, please do not commit them into the repository.
## Generate Gatling HTML Reports from simulation.log
### 1. Download Gatling Highcharts Standalone Bundle
Visit the [Gatling Download page](https://repo1.maven.org/maven2/io/gatling/highcharts/gatling-charts-highcharts-bundle/3.11.3/gatling-charts-highcharts-bundle-3.11.3.zip) and download the Gatling Highcharts Standalone bundle. Ensure that the version matches your Gatling version.
### 2. Extract the Bundle
Extract the downloaded archive to a location on your machine.
### 3. Copy the simulation.log File
Go to `target/gatling/` and copy your `simulation.log` file to the `user-files/simulations/` directory inside the extracted Gatling bundle.
### 4. Run the Report Generation
Open a terminal, navigate to the Gatling bundle directory, and run the following command:
```bash
sh bin/gatling.sh -ro /Users/osanda/Downloads/gatling-charts-highcharts-bundle-3.10.3/user-files/simulations/
```
### 5. View Report
Open the `index.html` file inside the `user-files/simulations/` directory.
## Gatling Recorder
`mvn gatling:recorder`
## Important Things to Note
- Before every test execution, remember to check and ensure that the API base URL is pointing to the right environment.
- For test report generated at the end of the test, they report folder name will be look like: `performancetestrunner-`