org.gradle.api.plugins.sonar.model
[Groovy] Class SonarRootModel

java.lang.Object
  org.gradle.api.plugins.sonar.model.SonarRootModel

All Implemented Interfaces:

SonarModel

class SonarRootModel

Configuration options for a project that has the sonar plugin applied.

bootstrapDir

File bootstrapDir

Directory where the Sonar client library will be stored. The correct version of the client library is automatically downloaded from the Sonar server before analysis begins. Defaults to $project.buildDir/sonar.

branch

@SonarProperty("sonar.branch")
String branch

Name of the version control branch that is analyzed. Two branches of the same project are considered as different projects in Sonar. Defaults to null.

childModels

List childModels

Configuration options for child projects of this project.

database

@IncludeProperties
SonarDatabase database

Configuration options related to the Sonar database.

gradleVersion

String gradleVersion

The Gradle version to be reported to the Sonar client library. Only used for identification purposes. Defaults to the current Gradle version.

profile

@SonarProperty("sonar.profile")
String profile

Selects one of the quality profiles configured via the Sonar web interface, overriding any selection made there. Defaults to null.

project

SonarProject project

Per-project configuration options.

propertyProcessors

List propertyProcessors

Post-processors for global Sonar properties.

See Also:

withGlobalProperties

server

@IncludeProperties
SonarServer server

Configuration options related to the Sonar server.

database

void database(Closure config)

Configures database configuration options. The specified closure delegates to an instance of SonarDatabase.

Parameters:

database - configuration options

project

void project(Closure config)

Configures per-project configuration options. The specified closure delegates to an instance of SonarProject.

Parameters:

per-project - configuration options

server

void server(Closure config)

Configures server configuration options. The specified closure delegates to an instance of SonarServer.

Parameters:

server - configuration options

withGlobalProperties

void withGlobalProperties(Closure block)

Registers a closure for post-processing the global Sonar properties covered by SonarRootModel, and for adding further properties not covered by that model. The properties are passed to the closure as a map of String keys and values. Keys correspond to the Sonar properties as described in the Sonar documentation.

Evaluation of the closure is deferred until build execution time. If this method is called multiple times, closures will be evaluated in the order they have been registered.

Example:

 withGlobalProperties { props ->
     // add further properties
     props["some.sonar.property"] = "some value"
     props["another.sonar.property"] = "another value"

     // modify existing properties (rarely necessary)
     props["sonar.branch"] = "some-branch"
     props.remove("sonar.profile")
 }
 

Parameters:

block - a closure for post-processing global Sonar properties