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 65 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:


Declaring an XML namespace for Ant tasks is optional but always recommended if you mix tasks from different libraries.

Additional analysis parameters can be set within <property> nodes of the sonar Ant task.


Execute the following command from the project base directory:

It's recommended to build the project before, usually to get bytecode and unit test reports.

Since version 1.2 you can specify sonar.libraries using path-like structure as following:

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

Let's say that we have a project "Parent" containing two modules "Child1" and "Child2" and we want Sonar to be able to analyze the overall Parent multi-module project:

The first thing to do is to declare all the modules in the build.xml file of the Parent with the sonar.modules property:

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

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

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