Skip to content

shaolilaowu/jmeter-maven-plugin

 
 

JMeter Maven Plugin

License Build Status codecov

GitHub release Maven Central Javadocs JitPack

Stack Overflow Open Source Helpers Twitter

A Maven plugin that provides the ability to run JMeter tests as part of your build

See the CHANGELOG for change information.

All the documentation you need to configure the plugin is available on the github wiki.

Latest version is 2.8.6, it requires Maven >= 3.5.0 and uses by default Apache JMeter 5.1.

This plugin requires a JDK between 8 and 11. If using Java 11, ensure you use recent version to avoid facing this [bug](https://bugs.openjdk.java.net/browse/JDK-8210005, see also this.

Tutorial

Basic Usage


Add the plugin to your project

Add the plugin to the build section of your pom's project :

<plugin>
    <groupId>com.lazerycode.jmeter</groupId>
    <artifactId>jmeter-maven-plugin</artifactId>
    <version>2.8.6</version>
    <executions>
	   <!-- Run JMeter tests -->
       <execution>
            <id>jmeter-tests</id>
            <goals>
                <goal>jmeter</goal>
            </goals>
       </execution>
       <!-- Fail build on errors in test -->
       <execution>
            <id>jmeter-check-results</id>
            <goals>
                <goal>results</goal>
            </goals>
       </execution>
    </executions>
</plugin>

Reference JMX files and CSV data

Once you have created your JMeter tests, you'll need to copy them to <Project Dir>/src/test/jmeter. By default this plugin will pick up all the .jmx files in that directory. To specify which tests should be run, see the project documentation.

You can also put data files in this folder and reference them in your plan.

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.

Beginners should start with the Basic Configuration section.

For advanced POM configuration settings have a look at the Advanced Configuration section.

Book


If you'd like to thank the maintainer of this project and some developers of Apache JMeter, you can buy this book:

Want to help


Have a look at our list of outstanding issues:

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

Group Email: [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

Group Email: [email protected]

Website

The official website is available at https://jmeter.lazerycode.com

We love it when people Contribute!

About

The JMeter Maven Plugin

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 99.7%
  • Shell 0.3%