org.sonarqube.gradle

Class SonarQubeExtension

java.lang.Object

org.sonarqube.gradle.SonarQubeExtension

public class SonarQubeExtension
extends java.lang.Object

An extension for configuring the SonarQube analysis.

The extension is added to all projects that have the "sonar-gradle" plugin applied, and all of their subprojects.

Example usage:

 sonarqube {
   skipProject = false // this is the default
   properties {
     property "sonar.host.url", "http://my.sonar.server" // adding a single property
     properties mapOfProperties // adding multiple properties at once
     properties["sonar.sources"] += sourceSets.other.java.srcDirs // manipulating an existing property }
   }
 }
 

SonarQube Properties

The SonarQube configuration is provided by using the properties(org.gradle.api.Action) method and specifying properties. Certain properties are required, such as "sonar.host.url" which provides the address of the SonarQube server. For details on what properties are available, see Analysis Parameters in the SonarQube documentation.

The "sonar-gradle" plugin adds default values for several plugins depending on the nature of the project. Please see the SonarQube Gradle documentation for details on which properties are set and their values.

Please see the SonarQubeProperties class for more information on the mechanics of setting SonarQube properties, including laziness and property types.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SONARQUBE_EXTENSION_NAME
static java.lang.String	SONARQUBE_TASK_NAME

Constructor Summary

Constructors

Constructor and Description
SonarQubeExtension(ActionBroadcast<SonarQubeProperties> propertiesActions)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAndroidVariant()
boolean	isSkipProject() Defaults to false.
void	properties(org.gradle.api.Action<? super SonarQubeProperties> action) Adds an action that configures SonarQube properties for the associated Gradle project.
void	setAndroidVariant(java.lang.String androidVariant)
void	setSkipProject(boolean skipProject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SONARQUBE_EXTENSION_NAME

public static final java.lang.String SONARQUBE_EXTENSION_NAME

See Also:

Constant Field Values

SONARQUBE_TASK_NAME

public static final java.lang.String SONARQUBE_TASK_NAME

See Also:

Constant Field Values

Constructor Detail

SonarQubeExtension

public SonarQubeExtension(ActionBroadcast<SonarQubeProperties> propertiesActions)

Method Detail

properties

public void properties(org.gradle.api.Action<? super SonarQubeProperties> action)

Adds an action that configures SonarQube properties for the associated Gradle project.

Global SonarQube properties (e.g. server connection settings) have to be set on the "root" project of the SonarQube run. This is the project that has the sonar-gradle plugin applied.

The action is passed an instance of SonarQubeProperties. Evaluation of the action is deferred until sonarqube.properties is requested. Hence it is safe to reference other Gradle model properties from inside the action.

SonarQube properties can also be set via system properties (and therefore from the command line). This is mainly useful for global SonarQube properties like database credentials. Every system property starting with "sonar." is automatically set on the "root" project of the SonarQube run (i.e. the project that has the sonar-gradle plugin applied). System properties take precedence over properties declared in build scripts.

Parameters:

action - an action that configures SonarQube properties for the associated Gradle project

isSkipProject

public boolean isSkipProject()

Defaults to false.

Returns:

true if the project should be excluded from analysis.

setSkipProject

public void setSkipProject(boolean skipProject)

getAndroidVariant

public java.lang.String getAndroidVariant()

Returns:

Name of the variant to analyze. If null we'll take the first release variant

setAndroidVariant

public void setAndroidVariant(java.lang.String androidVariant)