Building JMeter

Acquiring the source

The full source is distributed alongside the binary, and you can also find source repositories here .

The source archive, SVN and GIT do not contain any of the required library files.

Compiling and packaging JMeter using Eclipse

Option 1 : Setting up Eclipse project with Ant task

Once you have downloaded the sources using git or svn, you can setup the Eclipse project by running:

ant setup-eclipse-project

You can then import the project using File → Import → Existing projects into Workspace and select the folder containing JMeter sources.

Option 2 : Setting up Eclipse project manually

The first step is to download dependencies by running the Ant command:

ant download_jars

Or you can download the binary distribution archive for a release and unpack it into the same directory structure as the source. This will ensure that the lib/ directory contains the jar files needed for running JMeter. There are a few additional jars that are needed to build JMeter, download these using:

ant download_jars

This will retrieve any missing jars.

If you are behind a proxy, you can set a few build properties in build-local.properties for ant to use the proxy:

proxy.use=true
proxy.host=proxy.example.invalid
proxy.port=8080
proxy.user=your_user_name
proxy.pass=your_password

You might also want to skip some tests - that are failing without proper access to the internet - by adding some more properties into build-local.properties:

skip.bug52310=true
skip.bug60607=true
skip.batchtest_Http4ImplPreemptiveBasicAuth=true
skip.batchtest_SlowCharsFeature=true
skip.batchtest_TestKeepAlive=true
skip.test_http=true
skip.test_TestDNSCacheManager.testWithCustomResolverAnd1Server=true

Once you have downloaded the source from SVN or the release archives and run the ant download_jars target to install the dependent jars, you can configure Eclipse. The easiest way to do this is to replace the Eclipse .classpath file with the eclipse.classpath file provided with JMeter. This will set up the source-paths and most of the libraries.

Ensure you read eclipse.md for project configuration.

Compiling and packaging JMeter using Ant

JMeter can be built entirely using Ant. The basic command is:

ant [install]

See build.xml (or call ant -p) for the other targets that can be used.

Contributing to JMeter

We love contribution

We are very grateful to you if you take some time to contribute to the project. If you have some time to spend on the project you can pick existing enhancement or bug from Issues page.
You can also contribute to translation, see JMeter Localisation (Translator's Guide).

Submitting a patch

If you want to contribute to JMeter for a bug fix or enhancement, here is the procedure to follow:

Check your patch

Before submitting your patch ensure you do the following:
Check that patch compiles and follows Tab space policy by running:

ant package-and-check

Check that patch does not break JUnit tests by running:

ant test

Create a PR using GIT

Open a bugzilla issue, see Issues page
Fork Apache JMeter mirror

Clone your forked repository locally :

git clone https://github.com/yourid/jmeter/

Create a branch using for example bugzilla id:
```
git branch BUGID
```
Checkout the new branch :
```
git checkout BUGID
```

commit your fix there :

git commit -m 'Fix to BUGID' list of files

Add JMeter repository as upstream :

git remote add upstream http://www.github.com/apache/jmeter

push it :
```
git push origin BUGID
```
Create a PR and link it in the bugzilla issue

Create a PR using Patch

Open a bugzilla issue, see Issues page
Checkout Apache JMeter source
Code your fix
Create your patch by Right clicking on Eclipse project and select Team → Create Patch …
Attach your patch to the bugzilla issue

Automated builds

Automated (nightly) builds

As part of the development process, the JMeter project has access to various Continuous Integration (CI) server builds. The build output can be useful for testing recent changes to the code-base.

Please note that the builds have not undergone any QA and should only be used for development testing. For further information, see the Nightly builds for developers page.

Building Add-Ons

There is no need to build JMeter if you just want to build an add-on. Just download the binary archive and add the jars to the classpath or use Maven artifacts to build your add-ons. You may want to also download the source so it can be used by the IDE.

See the extras/addons* files in the source tree for some suggestions