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.

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	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	TOKEN
static java.lang.String	VERBOSE
static java.lang.String	WORKING_DIRECTORY

Method Summary

Modifier and Type	Method and Description
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.
static JkSonarqube	ofEmbedded() Creates a JkSonarqube object using the embedded scanner.
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()
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)
JkSonarqube	setProjectBaseDir(java.nio.file.Path baseDir)
JkSonarqube	setProjectId(java.lang.String projectKey, java.lang.String projectName, java.lang.String version)
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) Convenient method to pass a bulk of sonar properties..
JkSonarqube	setProperty(java.lang.String key, java.lang.Iterable<java.nio.file.Path> value) Convenient method to pass a list of path, as property value.
JkSonarqube	setProperty(java.lang.String key, java.lang.String value) Set a sonarqube property (aka analysis parameter) as listed here.
JkSonarqube	setSkipDesign(boolean skip)

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

LIBRARIES

public static final java.lang.String LIBRARIES

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

ofEmbedded

public static JkSonarqube ofEmbedded()

Creates a JkSonarqube object using the embedded scanner.

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.

configureFor

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

See Also:

configureFor(JkProject, boolean, boolean)

setProjectId

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

setLogOutput

public JkSonarqube setLogOutput(boolean logOutput)

run

public void run()

setProperty

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

Set 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.

setProperty

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

Convenient method to pass a list of path, as property value.

See Also:

setProperty(String, String)

setProperties

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

Convenient method to pass a bulk of sonar properties..

See Also:

setProperty(String, String)

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.