dev.jeka.plugins.sonarqube

Class JkSonarqube

java.lang.Object

dev.jeka.plugins.sonarqube.JkSonarqube

public final class JkSonarqube
extends java.lang.Object

Sonar wrapper class for launching sonar analysis in a convenient way. This Sonar wrapper is not specific to Java project so can be used for to analyse any kind of project supported by SonarQube.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkSonarqube.QualityGateResponse

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINARIES
static java.lang.String	BRANCH
static java.lang.String	CLOVER_REPORTS_PATH
static java.lang.String	COVERTURA_REPORTS_PATH
static java.lang.String	DEFAULT_SCANNER__VERSION
static java.lang.String	DYNAMIC_ANALYSIS
static java.lang.String	EXCLUSIONS
static java.lang.String	HOST_URL
static java.lang.String	JACOCO_LEGACY_REPORTS_PATHS
static java.lang.String	JACOCO_XML_REPORTS_PATHS
static java.lang.String	JAVA_BINARIES
static java.lang.String	JAVA_LIBRARIES
static java.lang.String	JAVA_TEST_BINARIES
static java.lang.String	JAVA_TEST_LIBRARIES
static java.lang.String	JDBC_PASSWORD
static java.lang.String	JDBC_URL
static java.lang.String	JDBC_USERNAME
static java.lang.String	JUNIT_REPORTS_PATH
static java.lang.String	LANGUAGE
static java.lang.String	LIBRARIES
static java.lang.String	PROFILE
static java.lang.String	PROJECT_BASE_DIR
static java.lang.String	PROJECT_KEY
static java.lang.String	PROJECT_NAME
static java.lang.String	PROJECT_VERSION
static java.lang.String	SKIP_DESIGN
static java.lang.String	SOURCE_ENCODING
static java.lang.String	SOURCES
static java.lang.String	SUREFIRE_REPORTS_PATH
static java.lang.String	TEST
static java.lang.String	TEST_INCLUSIONS
static java.lang.String	TOKEN
static java.lang.String	VERBOSE
static java.lang.String	WORKING_DIRECTORY

Method Summary

Modifier and Type	Method and Description
JkSonarqube.QualityGateResponse	checkQualityGate()
JkSonarqube	configureFor(dev.jeka.core.api.project.JkProject project)
JkSonarqube	configureFor(dev.jeka.core.api.project.JkProject project, boolean provideProdLibs, boolean provideTestLibs) Configures Sonarqube for the supplied JkProject.
JkSonarqube	copyWithoutProperties() Returns a copy of the current JkSonarqube object with the same field values, except for the properties "logOutput" and "pingServer" which are set to the same as the original object.
JkSonarqube	copyWithProperties() Returns a copy of the current JkSonarqube object with the same field values.
java.lang.String	getProperty(java.lang.String key) Returns the value of the property with the specified key.
static JkSonarqube	ofVersion(dev.jeka.core.api.depmanagement.resolution.JkDependencyResolver dependencyResolver, java.lang.String scannerVersion)
static JkSonarqube	ofVersion(dev.jeka.core.api.depmanagement.JkRepoSet repos, java.lang.String scannerVersion) Creates a JkSonarqube object configured for the supplied scanner version, fetched from the specified repos.
static JkSonarqube	ofVersion(java.lang.String scannerVersion) Creates a JkSonarqube object configured for the supplied scanner version, fetched from Maven central.
void	run() Executes SonarQube analysis.
JkSonarqube	setBinaries(java.lang.Iterable<java.nio.file.Path> files)
JkSonarqube	setBinaries(java.nio.file.Path... files)
JkSonarqube	setHostUrl(java.lang.String url)
JkSonarqube	setJdbcPassword(java.lang.String pwd)
JkSonarqube	setJdbcUrl(java.lang.String url)
JkSonarqube	setJdbcUserName(java.lang.String userName)
JkSonarqube	setLogOutput(boolean logOutput) Determines whether SonarQube scanner logs should be displayed.
JkSonarqube	setPathProperty(java.lang.String key, java.lang.Iterable<java.nio.file.Path> value) Sets a sonarqube property (aka analysis parameter) with a list of paths.
JkSonarqube	setPingServer(boolean pingServer) Sets the flag whether to ping the server during SonarQube analysis.
JkSonarqube	setProjectBaseDir(java.nio.file.Path baseDir)
JkSonarqube	setProjectId(java.lang.String projectKey, java.lang.String projectName, java.lang.String version) Sets the project ID for SonarQube analysis.
JkSonarqube	setProperties(dev.jeka.core.api.system.JkProperties properties) Sets all properties stating with 'sonar." prefix from the specified object.
JkSonarqube	setProperties(java.util.Map<java.lang.String,java.lang.String> props) Adds SonarQube analysis properties.
JkSonarqube	setProperty(java.lang.String key, java.lang.String value) Sets a sonarqube property (aka analysis parameter) as listed here.
JkSonarqube	setSkipDesign(boolean skip)
JkSonarqube	setVersion(dev.jeka.core.api.depmanagement.JkRepoSet downloadRepos, java.lang.String scannerVersion) Sets the version of the SonarQube scanner and the repositories from which to download it.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCANNER__VERSION

public static final java.lang.String DEFAULT_SCANNER__VERSION

See Also:

Constant Field Values

PROJECT_KEY

public static final java.lang.String PROJECT_KEY

See Also:

Constant Field Values

PROJECT_NAME

public static final java.lang.String PROJECT_NAME

See Also:

Constant Field Values

PROJECT_VERSION

public static final java.lang.String PROJECT_VERSION

See Also:

Constant Field Values

LANGUAGE

public static final java.lang.String LANGUAGE

See Also:

Constant Field Values

PROFILE

public static final java.lang.String PROFILE

See Also:

Constant Field Values

BRANCH

public static final java.lang.String BRANCH

See Also:

Constant Field Values

TOKEN

public static final java.lang.String TOKEN

See Also:

Constant Field Values

SOURCE_ENCODING

public static final java.lang.String SOURCE_ENCODING

See Also:

Constant Field Values

VERBOSE

public static final java.lang.String VERBOSE

See Also:

Constant Field Values

WORKING_DIRECTORY

public static final java.lang.String WORKING_DIRECTORY

See Also:

Constant Field Values

JUNIT_REPORTS_PATH

public static final java.lang.String JUNIT_REPORTS_PATH

See Also:

Constant Field Values

SUREFIRE_REPORTS_PATH

public static final java.lang.String SUREFIRE_REPORTS_PATH

See Also:

Constant Field Values

JACOCO_LEGACY_REPORTS_PATHS

public static final java.lang.String JACOCO_LEGACY_REPORTS_PATHS

See Also:

Constant Field Values

JACOCO_XML_REPORTS_PATHS

public static final java.lang.String JACOCO_XML_REPORTS_PATHS

See Also:

Constant Field Values

COVERTURA_REPORTS_PATH

public static final java.lang.String COVERTURA_REPORTS_PATH

See Also:

Constant Field Values

CLOVER_REPORTS_PATH

public static final java.lang.String CLOVER_REPORTS_PATH

See Also:

Constant Field Values

DYNAMIC_ANALYSIS

public static final java.lang.String DYNAMIC_ANALYSIS

See Also:

Constant Field Values

PROJECT_BASE_DIR

public static final java.lang.String PROJECT_BASE_DIR

See Also:

Constant Field Values

SOURCES

public static final java.lang.String SOURCES

See Also:

Constant Field Values

BINARIES

public static final java.lang.String BINARIES

See Also:

Constant Field Values

JAVA_BINARIES

public static final java.lang.String JAVA_BINARIES

See Also:

Constant Field Values

TEST

public static final java.lang.String TEST

See Also:

Constant Field Values

TEST_INCLUSIONS

public static final java.lang.String TEST_INCLUSIONS

See Also:

Constant Field Values

LIBRARIES

public static final java.lang.String LIBRARIES

See Also:

Constant Field Values

EXCLUSIONS

public static final java.lang.String EXCLUSIONS

See Also:

Constant Field Values

JAVA_LIBRARIES

public static final java.lang.String JAVA_LIBRARIES

See Also:

Constant Field Values

JAVA_TEST_LIBRARIES

public static final java.lang.String JAVA_TEST_LIBRARIES

See Also:

Constant Field Values

JAVA_TEST_BINARIES

public static final java.lang.String JAVA_TEST_BINARIES

See Also:

Constant Field Values

SKIP_DESIGN

public static final java.lang.String SKIP_DESIGN

See Also:

Constant Field Values

HOST_URL

public static final java.lang.String HOST_URL

See Also:

Constant Field Values

JDBC_URL

public static final java.lang.String JDBC_URL

See Also:

Constant Field Values

JDBC_USERNAME

public static final java.lang.String JDBC_USERNAME

See Also:

Constant Field Values

JDBC_PASSWORD

public static final java.lang.String JDBC_PASSWORD

See Also:

Constant Field Values

Method Detail

ofVersion

public static JkSonarqube ofVersion(dev.jeka.core.api.depmanagement.JkRepoSet repos,
                                    java.lang.String scannerVersion)

Creates a JkSonarqube object configured for the supplied scanner version, fetched from the specified repos.

Parameters:

scannerVersion - The scanner version to use. If null, the embedded scanner version will be used.

ofVersion

public static JkSonarqube ofVersion(dev.jeka.core.api.depmanagement.resolution.JkDependencyResolver dependencyResolver,
                                    java.lang.String scannerVersion)

See Also:

ofVersion(JkRepoSet, String)

ofVersion

public static JkSonarqube ofVersion(java.lang.String scannerVersion)

Creates a JkSonarqube object configured for the supplied scanner version, fetched from Maven central.

Parameters:

scannerVersion - The scanner version to use. If null, the embedded scanner version will be used.

copyWithProperties

public JkSonarqube copyWithProperties()

Returns a copy of the current JkSonarqube object with the same field values.

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns the value of the property with the specified key.

copyWithoutProperties

public JkSonarqube copyWithoutProperties()

Returns a copy of the current JkSonarqube object with the same field values, except for the properties "logOutput" and "pingServer" which are set to the same as the original object. This method is useful for creating immutable copies of the object.

setVersion

public JkSonarqube setVersion(dev.jeka.core.api.depmanagement.JkRepoSet downloadRepos,
                              java.lang.String scannerVersion)

Sets the version of the SonarQube scanner and the repositories from which to download it.

Parameters:

downloadRepos - The repositories from which to download the SonarQube scanner.

scannerVersion - The version of the SonarQube scanner. It should be in the format "org.sonarsource.scanner.cli:sonar-scanner-cli:VERSION".

setProjectId

public JkSonarqube setProjectId(java.lang.String projectKey,
                                java.lang.String projectName,
                                java.lang.String version)

Sets the project ID for SonarQube analysis.

setLogOutput

public JkSonarqube setLogOutput(boolean logOutput)

Determines whether SonarQube scanner logs should be displayed.

Parameters:

logOutput - 'true' if the logs should be displayed, 'false' otherwise.

Returns:

an instance of JkSonarqube with the updated logOutput setting.

setPingServer

public JkSonarqube setPingServer(boolean pingServer)

Sets the flag whether to ping the server during SonarQube analysis.

run

public void run()

Executes SonarQube analysis.

checkQualityGate

public JkSonarqube.QualityGateResponse checkQualityGate()

setProperty

public JkSonarqube setProperty(java.lang.String key,
                               java.lang.String value)

Sets a sonarqube property (aka analysis parameter) as listed here.

Sonarqube properties all start with prefix 'sonar.' but you can omit it, as it will be prepended at launch time, if missing.

setPathProperty

public JkSonarqube setPathProperty(java.lang.String key,
                                   java.lang.Iterable<java.nio.file.Path> value)

Sets a sonarqube property (aka analysis parameter) with a list of paths.

Parameters:

key - The key of the property.

value - The iterable collection of paths.

Returns:

An instance of JkSonarqube with the updated property.

See Also:

SonarQube Analysis Parameters

setProperties

public JkSonarqube setProperties(java.util.Map<java.lang.String,java.lang.String> props)

Adds SonarQube analysis properties.

setProperties

public JkSonarqube setProperties(dev.jeka.core.api.system.JkProperties properties)

Sets all properties stating with 'sonar." prefix from the specified object.

See Also:

setProperty(String, String)

setProjectBaseDir

public JkSonarqube setProjectBaseDir(java.nio.file.Path baseDir)

setBinaries

public JkSonarqube setBinaries(java.lang.Iterable<java.nio.file.Path> files)

setBinaries

public JkSonarqube setBinaries(java.nio.file.Path... files)

setSkipDesign

public JkSonarqube setSkipDesign(boolean skip)

setHostUrl

public JkSonarqube setHostUrl(java.lang.String url)

setJdbcUrl

public JkSonarqube setJdbcUrl(java.lang.String url)

setJdbcUserName

public JkSonarqube setJdbcUserName(java.lang.String userName)

setJdbcPassword

public JkSonarqube setJdbcPassword(java.lang.String pwd)

configureFor

public JkSonarqube configureFor(dev.jeka.core.api.project.JkProject project,
                                boolean provideProdLibs,
                                boolean provideTestLibs)

Configures Sonarqube for the supplied JkProject.

Parameters:

provideProdLibs - If true, the list of production dependency files will be provided to sonarqube.

provideTestLibs - If true, the list of test dependency files will be provided to sonarqube.

configureFor

public JkSonarqube configureFor(dev.jeka.core.api.project.JkProject project)

See Also:

configureFor(JkProject, boolean, boolean)