Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmeter-maven-plugin/jmeter-maven-plugin
The JMeter Maven Plugin
https://github.com/jmeter-maven-plugin/jmeter-maven-plugin
continuous-integration java jmeter load-test load-testing maven-plugin performance-analysis performance-test performance-testing
Last synced: 1 day ago
JSON representation
The JMeter Maven Plugin
- Host: GitHub
- URL: https://github.com/jmeter-maven-plugin/jmeter-maven-plugin
- Owner: jmeter-maven-plugin
- License: apache-2.0
- Created: 2010-10-08T02:24:31.000Z (about 14 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T22:15:42.000Z (11 months ago)
- Last Synced: 2024-03-26T00:09:22.126Z (8 months ago)
- Topics: continuous-integration, java, jmeter, load-test, load-testing, maven-plugin, performance-analysis, performance-test, performance-testing
- Language: Java
- Homepage: http://jmeter.lazerycode.com
- Size: 1.86 MB
- Stars: 423
- Watchers: 45
- Forks: 236
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-jmeter - JMeter Maven Plugin - Maven plugin that provides the ability to run JMeter tests as part of the build. (CI / Tools & Plugins)
- awesome-learning - JMeter Maven Plugin
README
[![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![Build Status](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/jmeter-maven-plugin/jmeter-maven-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/jmeter-maven-plugin/jmeter-maven-plugin)[![GitHub release](https://img.shields.io/github/release/jmeter-maven-plugin/jmeter-maven-plugin.svg?colorB=brightgreen)](http://jmeter.lazerycode.com/)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.lazerycode.jmeter/jmeter-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.lazerycode.jmeter/jmeter-maven-plugin)
[![Javadocs](https://www.javadoc.io/badge/com.lazerycode.jmeter/jmeter-maven-plugin.svg)](https://www.javadoc.io/doc/com.lazerycode.jmeter/jmeter-maven-plugin)
[![JitPack](https://jitpack.io/v/jmeter-maven-plugin/jmeter-maven-plugin.svg)](https://jitpack.io/#jmeter-maven-plugin/jmeter-maven-plugin)[![Stack Overflow](https://img.shields.io/:stack%20overflow-jmeter_maven_plugin-brightgreen.svg)](https://stackoverflow.com/questions/tagged/jmeter-maven-plugin)
[![Open Source Helpers](https://www.codetriage.com/jmeter-maven-plugin/jmeter-maven-plugin/badges/users.svg)](https://www.codetriage.com/jmeter-maven-plugin/jmeter-maven-plugin)
[![Twitter](https://img.shields.io/twitter/url/https/github.com/jmeter-maven-plugin/jmeter-maven-plugin.svg?style=social)](https://twitter.com/intent/tweet?text=Integrate+easily+%40ApacheJMeter+in+your+%23Maven+project+with+jmeter-maven-plugin:&url=https%3A%2F%2Fgithub.com%2Fjmeter-maven-plugin%2Fjmeter-maven-plugin)A Maven plugin that provides the ability to run JMeter tests as part of your build
See the [CHANGELOG](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/blob/master/CHANGELOG.md) for change information.
All the documentation you need to configure the plugin is available on the [Github Wiki](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki).
The latest version is **3.8.0**, it requires Maven >= **3.9.0** and defaults to **Apache JMeter 5.6.2**.
This plugin requires a JDK between **8** and **17**. If using Java 11, ensure you use a recent version to avoid facing this [Bug](https://bugs.openjdk.java.net/browse/JDK-8210005), also read [This](https://stackoverflow.com/a/52510406/460802).
Running the GUI
-----Once you have added the plugin to your project you will be able to invoke the JMeter GUI using the following command:
```
mvn jmeter:configure jmeter:gui
```See the associated [Wiki](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki/Basic-Configuration#running-the-jmeter-gui) entry for more information.
Basic Usage
-----### Add the plugin to your project
Add the plugin to the build section of your pom's project :
```
com.lazerycode.jmeter
jmeter-maven-plugin
3.8.0
configuration
configure
jmeter-tests
jmeter
jmeter-check-results
results
```
### Reference JMX files and CSV data
Once you have created your JMeter tests, you'll need to copy them to `/src/test/jmeter`.
By default this plugin will pick up all the .jmx files in that directory, you can also put data files in this folder and reference them in your plan.
To specify which tests should be run, see the [Selecting-Tests-To-Run](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki/Selecting-Tests-To-Run#2) section of the Wiki.### Run the tests
```
mvn clean verify
```All your tests will run in maven!
Documentation
-----All the plugin configuration documentation is available on the [Github Wiki](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki).
Beginners should start with the [Basic Configuration](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki/Basic-Configuration) section.
For advanced POM configuration settings have a look at the [Advanced Configuration](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/wiki/Advanced-Configuration) section.
Tutorials
------ [Shift left your performance tests with JMeter and Maven](https://www.ubik-ingenierie.com/blog/shift-left-performance-tests-jmeter-maven/)
Support
-----If you'd like to help support the maintainers you can donate using the sponsorship button at the top of the page, or you can purchase this book:
[](https://leanpub.com/master-jmeter-from-load-test-to-devops/)
Want to help?
-----Have a look at our list of outstanding issues:
- [Next Milestone](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/milestone/30)
Community
-----### Users Group
A place to discuss usage of the maven-jmeter-plugin, let people know how you use it here.
Homepage: [http://groups.google.com/group/maven-jmeter-plugin-users](http://groups.google.com/group/maven-jmeter-plugin-users)
Group Email: [[email protected]](mailto:[email protected])
### Devs Group
A place to discuss the development of the maven-jmeter-plugin, or ask about features you would like to see added.
Homepage: [http://groups.google.com/group/maven-jmeter-plugin-devs]( http://groups.google.com/group/maven-jmeter-plugin-devs)
Group Email: [[email protected]](mailto:[email protected])
### Website
The official website is available at [https://jmeter.lazerycode.com](https://jmeter.lazerycode.com)
We love it when people [Contribute](https://github.com/jmeter-maven-plugin/jmeter-maven-plugin/blob/master/CONTRIBUTING.md)!