I just finished an effort setting up automated load tests against a GWT-RPC server interface. It took me some time to pull together the pieces from different sources and figure out what was possible and how I wanted to organize the whole thing. But once I was there the result is pretty simple. So I’m going to write it down here and hopefully save someone else the effort of figuring it out like I did.
So this post is the first part of the puzzle – how to create a project that will run JMeter tests with Maven. I got a lot of help from some other people’s posts on this subject. Jacobo Matute’s post Performance Tests with Jmeter, Maven and Hudson was a big help, but fortunately slightly out of date.
My goal with this project was to have something that works the maven way. All I should have to do is:
- Checkout the project.
- Run a maven goal.
I don’t want to have to install JMeter first. I don’t want to have to go get any dependencies. That’s what Maven’s for. This used to be a problem because there were no JMeter artifacts available, but that’s fortunately not true anymore.
1) Create a simple maven project
I use the quickstart archetype:
mvn archetype:generate -DgroupId=com.example -DartifactId=jmeter-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
This creates a basic java project named jmeter-demo, with and example App class and an AppTest test class. We don’t need either of these, so we can delete them. Make sure you keep src/main/java and src/test/java, but you can delete the com directory in each of these.
Now you should be able to
and get a build success, but nothing was built.
2) Add the JMeter Maven plugin
All of the heavy lifting will be done for us by the JMeter Maven plugin. Edit the pom.xml file in the jmeter-demo directory so it looks like this:
4.0.0 com.example jmeter-demo jar 1.0-SNAPSHOT jmeter-demo http://maven.apache.org com.lazerycode.jmeter jmeter-maven-plugin 1.4.1 jmeter-tests verify jmeter
So you’re removing the junit dependency and adding a build plugin that runs jmeter tests when you do the verify phase of the lifecycle. If you run mvn install now you will get a failure because you don’t have the jmeter test directory created.
3) Create a JMeter test
The JMeter plugin will run any test that it finds under the src/test/jmeter directory. A JMeter test is just xml, but it’s easiest to create this xml with the JMeter GUI. Currently you have to install JMeter in order to run the GUI, but hopefully very soon it will be possible to run the GUI directly from the JMeter plugin.
Using the GUI I created a simple test with a Thread Group that runs 10 times, an HTTP Request Sampler that requests the Google Home Page at http://www.google.com, and a View Results in Table that shows the timing results. Then I ran it in the GUI. I saved the test in a src/test/jmeter directory that I created.
4) Run it in Maven
Now I run
in my project directory. Here’s a piece of the output:
[INFO] --- jmeter-maven-plugin:1.4.1:jmeter (jmeter-tests) @ jmeter-demo --- [INFO] [INFO] ------------------------------------------------------- [INFO] P E R F O R M A N C E T E S T S [INFO] ------------------------------------------------------- [INFO] [WARNING] Unable to parse the 'jmeter.exit.check.pause' entry in jmeter.properties! Falling back to a default value of '2500'. [INFO] [INFO] Proxy server is not being used. [info] [debug] JMeter is called with the following command line arguments: -n -t C:\projects\jmeter-demo\jmeter-demo\src\test\jmeter\Demo Test.jmx -l C:\projects\jmeter-demo\jmeter-demo\target\jmeter\report\Demo Test-120416.jtl -d C:\projects\jmeter-demo\jmeter-demo\target\jmeter [info] Executing test: Demo Test.jmx INFO 2012-04-16 14:51:59.725 [jmeter.e] (): Listeners will be started after enabling running version INFO 2012-04-16 14:51:59.726 [jmeter.e] (): To revert to the earlier behaviour, define jmeterengine.startlistenerslater=false [info] Completed Test: Demo Test.jmx [info] [info] Building JMeter Report(s)... [info] [info] Raw results: C:\projects\jmeter-demo\jmeter-demo\target\jmeter\report\Demo Test-120416.jtl [info] Test report: C:\projects\jmeter-demo\jmeter-demo\target\jmeter\report\Demo Test-120416.jtl-report.html [INFO] [INFO] Test Results: [INFO] [INFO] Tests Run: 1, Failures: 0, Errors: 0 [INFO] [INFO]
We can see that the test ran successfully, the raw results are located at target/jmeter/report/Demo Test-120416.jtl and an html report is located at target/jmeter/report/Demo Test-120416.jtl-report.html.
You can grab the sample project from the Stage_1_JMeter_and_Maven branch of my jmeter-demo project.
Check out my next step in the automated load tests effort: