Skip to content

jmeter-maven-plugin/jmeter-maven-plugin

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
April 14, 2021 08:22
February 1, 2018 21:03
November 8, 2017 09:15
February 22, 2016 19:46

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.

The latest version is 3.7.0, it requires Maven >= 3.5.2 and defaults to Apache JMeter 5.5.

This plugin requires a JDK between 8 and 17. If using Java 11, ensure you use a recent version to avoid facing this Bug, also read This.

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 entry for more information.

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>3.7.0</version>
    <executions>
        <!-- Generate JMeter configuration -->
        <execution>
            <id>configuration</id>
            <goals>
                <goal>configure</goal>
            </goals>
        </execution>
        <!-- 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, 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 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.

Beginners should start with the Basic Configuration section.

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

Tutorials

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:

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: maven-jmeter-plugin-users@googlegroups.com

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: maven-jmeter-plugin-devs@googlegroups.com

Website

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

We love it when people Contribute!