Table of Contents Prerequisites Usage Simple Project Multi-module Project Known Limitations Migrating from Sonar Ant Task 1.X to Sonar Ant Task 2.0

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

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

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

   Declaring a 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.

    

2. 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:

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:

Of course additional but optional Sonar properties can also be defined in each module to provide for instance the binary directories, the list of libraries, etc.

Here is the source code of a sample Ant muli-module project.

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.

.