Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 78 Next »

Table of Contents

This page describes how to integrate Sonar into a build script for Apache Ant.


You must have previously installed the Sonar Ant Task and read Analyzing Code Source.

Sonar Ant Task 2.0+


This page describes how to use the Sonar Ant Task 2.0+


Simple Project

Define a new Sonar Ant target in your Ant build script:


Run the following command from the project base directory to launch the Sonar analysis:


Since Sonar 3.4, if you have set the security property 'sonar.forceAuthentication' to 'true', to run the analysis, you have to set the 'sonar.login' and 'sonar.password' properties to an existing user, either:

  • directly on the command line by adding -Dsonar.login=myUser -Dsonar.password=myPassword
  • or in the build.xml file

Sample Projects

To help you getting started, a simple project sample is available on github that can be browsed or downloaded: projects/languages/java/ant/java-ant-simple

Multi-module Project

The Sonar configuration for parent and modules must be done in the parent build.xml file:

Parent build.xml

To help you getting started, project samples are available on github that can be browsed or downloaded:

  • Modules with the same structure: projects/multi-module/ant/java-ant-modules-same-structure
  • Modules with different structures: projects/multi-module/ant/java-ant-modules-different-structures

Multi-module and Multi-language Project

Since Sonar 3.3, it is possible to run an analysis on a multi-module project whose modules contains source code from different languages.

In addition to the multi-module configuration, the only mandatory property to set is the language for each module:


To help you getting started, a multi-language project sample is available on github that can be browsed or downloaded: projects/languages/multi-language/multi-language-java-javascript-ant

Advanced Usage

Additional analysis parameters can be defined in the build.xml file or through command-line parameters. 

Run tests and get code coverage with JaCoCo Ant Task

To help you getting started, project samples are available on github that can be browsed or downloaded:

  • Simple project: projects/code-coverage/ut/ant/ut-ant-jacoco-runTests
  • Multi-module project: projects/code-coverage/ut/ant/ut-ant-jacoco-modules-runTests

Known Limitations

  • Main sources and unit test sources can not be mixed in the same directory

Migrating from Sonar Ant Task 1.X to Sonar Ant Task 2.0

The Sonar Ant Task 2.0 can run analyses from configuration files designed for Sonar Ant Task 1.X.

This compatibility mode is automatically activated. But we highly recommend you to migrate to the new format as this compatibility mode will be dropped sooner or later in the next versions.

  • No labels