Package org.sonarqube.gradle

Class SonarTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
    public class SonarTask
extends org.gradle.api.internal.ConventionTask
    Analyses one or more projects with the SonarQube Scanner. Can be used with or without the "sonar-gradle" plugin. If used together with the plugin, properties will be populated with defaults based on Gradle's object model and user-defined values configured via SonarExtension. If used without the plugin, all properties have to be configured manually. For more information on how to configure the SonarQube Scanner, and on which properties are available, see the SonarQube Scanner documentation.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        org.gradle.api.Task.Namer

    • Field Summary

      • Fields inherited from interface org.gradle.api.Task

        TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

    • Constructor Summary

      Constructors 
      Constructor Description
      SonarTask()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.sonarsource.scanner.api.LogOutput getLogOutput()  
      org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​java.lang.String>> getProperties()  
      void run()  
      void setLogOutput​(org.sonarsource.scanner.api.LogOutput logOutput)  
      void useLoggerLevel​(org.gradle.api.logging.LogLevel logLevel)
      Sets the LogLevel to use during Scanner execution.

      • Methods inherited from class org.gradle.api.internal.ConventionTask

        conventionMapping, conventionMapping, getConventionMapping

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.gradle.api.Task

        doNotTrackState, getConvention, notCompatibleWithConfigurationCache

    • Constructor Detail

      • SonarTask

        public SonarTask()

    • Method Detail

      • run

        public void run()

      • getProperties

        @Input
public org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​java.lang.String>> getProperties()
        Returns:
        The String key/value pairs to be passed to the SonarQube Scanner. null values are not permitted.

      • useLoggerLevel

        public void useLoggerLevel​(org.gradle.api.logging.LogLevel logLevel)
        Sets the LogLevel to use during Scanner execution. All logged messages from the Scanner at this level or greater will be printed at the LogLevel.LIFECYCLE level, which is the default level for Gradle tasks. This can be used to specify the level of Sonar Scanner which it output during standard task execution, without needing to override the log level for the full Gradle execution.

        This overrides the default LogOutput functionality, which passes logs through to the Gradle logger without modifying the log level.

        Parameters:
        logLevel - the minimum log level to include in LogLevel.LIFECYCLE logs

      • getLogOutput

        @Internal
public org.sonarsource.scanner.api.LogOutput getLogOutput()
        Returns:
        The LogOutput object to use during Scanner execution. All logged messages from the Scanner will pass through this object. If needed, a custom implementation can be used to handle logged output, such as printing LogLevel.INFO-level log output when Gradle is only configured at the LogLevel.LIFECYCLE level.

      • setLogOutput

        public void setLogOutput​(org.sonarsource.scanner.api.LogOutput logOutput)