Skip to end of metadata
Go to start of metadata

Description / Features

This plugin enhances the Java Plugin to analyze Android projects within SonarQube:

  • Adds a new set of rules based on Android lint
  • On top of Java files, Android Manifest and resources (such as layouts or pictures) are analyzed

It is compatible with the SonarQube Eclipse plugin to track issues while coding. It is also compatible with the Issues Report plugin to run pre-commit local analysis.

Prerequisites

The Android SDK must be installed on the machine(s) running the SonarQube analyses. The ANDROID_HOME environment variable should be configured to point to the installation directory of the Android SDK.

Note that you have to install the different Patforms/API that your projects are built with.

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Usage

Run an Analysis with the SonarQube Runner (Recommended method)

To run an analysis of your Android project, use the SonarQube Runner.

A sample project is available on GitHub that can be browsed or downloaded/projects/languages/android/android-sonarqube-runner

Run an Analysis with the other Analyzers

Maven and Ant can also be used to launch analysis on Android projects.

Code Coverage

To display code coverage data:

  1. Prior to the SonarQube analysis, execute your unit tests and generate the Emma 2.0 reports (.em and .ec files)
  2. Import these reports while running the SonarQube analysis by setting the sonar.android.emma.report property to the path of the directory containing the Emma reports. The path may be absolute or relative to the project base directory for standard projects, relative to the module base directory for multi-module projects.

Metrics

See Metrics documentation page.

Extending Coding Rules using XPath

See Extending Coding Rules for Java.

SQALE

Since the SQALE model for Java is already provided by the Java Ecosystem, the SQALE model for Android has to be applied manually:

  1. Download the XML file containing the SQALE model
  2. Log in as a System Administrator
  3. Go to Settings > SQALE > Back Up / Restore > Merge Model
  4. Upload the XML file
  5. Click on Restore
  • No labels