Simple Java API to run performance tests, using JMeter as engine, in a Git and programmers friendly way.
If you like this project, please give it a star ⭐! This helps the project be more visible, gain relevance and encourages us to invest more effort in new features.
Please join discord server or create GitHub issues and discussions to be part of the community and clear out doubts, get latest news, propose ideas, report issues, etc.
If you use maven, just include following dependency:
<dependency>
<groupId>us.abstracta.jmeter</groupId>
<artifactId>jmeter-java-dsl</artifactId>
<version>0.64</version>
<scope>test</scope>
</dependency>Here is a simple example test in JUnit 5+ with 2 threads/users iterating 10 times each to send HTTP POST requests with a JSON body to http://my.service:
import static org.assertj.core.api.Assertions.assertThat;
import static us.abstracta.jmeter.javadsl.JmeterDsl.*;
import java.io.IOException;
import java.time.Duration;
import java.time.Instant;
import org.apache.http.entity.ContentType;
import org.junit.jupiter.api.Test;
import us.abstracta.jmeter.javadsl.core.TestPlanStats;
public class PerformanceTest {
@Test
public void testPerformance() throws IOException {
TestPlanStats stats = testPlan(
threadGroup(2, 10,
httpSampler("http://my.service")
.post("{\"name\": \"test\"}", ContentType.APPLICATION_JSON)
),
//this is just to log details of each request stats
jtlWriter("test" + Instant.now().toString().replace(":", "-") + ".jtl")
).run();
assertThat(stats.overall().sampleTimePercentile99()).isLessThan(Duration.ofSeconds(5));
}
}This example also uses AssertJ for assertions, but you can use whatever assertion library you chose.
More examples can be found in tests
Here is a sample project for reference or for starting new projects from scratch.
Tip 1: Check jmx2dsl provided tool, which allows easy conversion of JMX files to JMeter DSL code.
Tip 2: Since JMeter uses log4j2, if you want to control logging level or output, you can use something similar to the tests included log4j2.xml.
Tip 3: When working with multiple samplers in a test plan, specify their names to easily check their respective statistics.
Check here for details on some interesting use cases, like running tests at scale in BlazeMeter or OctoPerf, saving and loading test plans from JMX, publishing test metrics to InfluxDB (and visualizing them from Grafana), and general usage guides.
Check more about the motivation and analysis of alternatives here
- Developer’s friendly tools for continuous performance testing: Walk-through from Fiddler recording to JMeter DSL test plan. Here is a russian version.
- JMeterDSL: Bringing Performance Testing Closer to Developers: Intro to JMeter DSL and scaling execution in BlazeMeter.
- Performance testing tools trend: A quick review of different alternatives for performance testing in Java and associated trend.
- JMeter scripting: la pieza faltante: Spanish demo at QA Minds.
- Getting Started with JMeter DSL: Intro to JMeter DSL and general thoughts. Here is the video version.
- Virtual Threads: JMeter meets Project Loom: Experimenting with Virtual Threads in JMeter using JMeter DSL as prototyping tool. Here is the spanish version
- JMeter Scripts Written in Java??: JMeter DSL demo and discussion at PerfBytes session.
- JMeter: test as code solutions: JMeter DSL & Taurus review.
Currently, the project covers the most used features required when implementing JMeter performance tests, but not everything the JMeter supports/provides.
We invest in development of DSL according to community's (your) interest, which we evaluate reviewing GitHub stars evolution, features requests and contributions.
To keep improving the DSL we need you to please create an issue for any particular feature or need that you have.
We also really appreciate pull requests. Check the CONTRIBUTING guide for an explanation of main library components and how can you extend the library.