Prerequisites

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+

Usage

Simple Project

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

build.xml

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

Security

Since Sonar 3.4, if a project cannot be accessed anonymously, the 'sonar.login' and 'sonar.password' properties are required to run an analysis on this project. These properties have to be set to the credentials of a user having the 'User' role on this project. You can set them either:

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

A project cannot be anonymously accessed when either:

the 'sonar.forceAuthentication' property is set to 'true'
or the 'sonar.forceAuthentication' property is set to 'false' and the 'Anyone' group has not been granted a 'User' role on the project

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:

module.sonar.language

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.

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.

Analyzing with Sonar Ant Task