plugins {
  id "org.sonarqube" version "2.7.1"
}

More details on https://plugins.gradle.org/plugin/org.sonarqube

Assuming a local SonarQube server with out-of-the-box settings is up and running, no further mandatory configuration is required.

2 - Run analysis

Execute gradle sonarqube and wait until the build has completed, then open the web page indicated at the bottom of the console output. You should now be able to browse the analysis results.

Configure analysis properties

The SonarQube Scanner for Gradle leverages information contained in Gradle's object model to provide smart defaults for many of the standard SonarQube properties. The defaults are summarized in the tables below.

sonar.projectKey

sonar.projectName

${project.name}

sonar.projectDescription

${project.description}

sonar.projectVersion

${project.version}

sonar.projectBaseDir

${project.projectDir}

sonar.working.directory

${project.buildDir}/sonar

sonar.sourceEncoding

${project.compileJava.options.encoding}

sonar.java.source

${project.sourceCompatibility}

sonar.java.target

${project.targetCompatibility}

sonar.sources

sonar.tests

sonar.java.binaries

${sourceSets.main.output.classesDir}

sonar.java.libraries

sonar.java.test.binaries

sonar.java.test.libraries

sonar.junit.reportPaths

sonar.groovy.binaries

sonarqube {
    androidVariant 'fullDebug'
}

sonarqube {
    properties {
        property "sonar.exclusions", "**/*Generated.java"
    }
}

sonarqube {
    properties {
        property "sonar.sourceEncoding", "UTF-8"
    }
}

subprojects {
    sonarqube {
        properties {
            property "sonar.sources", "src"
        }
    }
}

Individual configuration settings

project(":project1") {
    sonarqube {
        properties {
            property "sonar.branch", "Foo"
        }
    }}

Skipping analysis of a project

project(":project2") {
    sonarqube {
        skipProject = true
    }
}

Entries in the properties map can be read and written with the usual Groovy syntax. To facilitate their manipulation, values still have their “idiomatic” type (File, List, etc.). After the sonarProperties block has been evaluated, values are converted to Strings as follows: Collection values are (recursively) converted to comma-separated Strings, and all other values are converted by calling their toString() method.

Because the sonarProperties block is evaluated lazily, properties of Gradle's object model can be safely referenced from within the block, without having to fear that they have not yet been set.

Setting properties from the Command Line

SonarQube properties can also be set from the command line, by setting a system property named exactly like the SonarQube property in question. This can be useful when dealing with sensitive information (e.g. credentials), environment information, or for ad-hoc configuration.
 

gradle sonarqube -Dsonar.host.url=http://sonar.mycompany.com -Dsonar.verbose=true

While certainly useful at times, we do recommend to keep the bulk of the configuration in a (versioned) build script, readily available to everyone.

A SonarQube property value set via a system property overrides any value set in a build script (for the same property). When analyzing a project hierarchy, values set via system properties apply to the root project of the analyzed hierarchy. Each system property starting with ""sonar." will be taken into account.

Task dependencies

Before executing the sonarqube task, all tasks producing output to be included in the SonarQube analysis need to be executed. Typically, these are compile tasks, test tasks, and code coverage tasks. To meet these needs, the plugins adds a task dependency from sonarqube on test if the java plugin is applied. Further task dependencies can be added as needed. For example:

project.tasks["sonarqube"].dependsOn "anotherTask"