dev.jeka.plugins.jacoco

Class JkJacoco

java.lang.Object

dev.jeka.plugins.jacoco.JkJacoco

public final class JkJacoco
extends java.lang.Object

Provides convenient methods to deal with Jacoco agent and report tool.

< Note : May sometime fall in this issue when running from IDE : ...

See command-line documentation : ... ...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkJacoco.RepoToolProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VERSION
static java.lang.String	OUTPUT_HTML_RELATIVE_PATH
static java.lang.String	OUTPUT_RELATIVE_PATH Relative location to the output folder of the generated jacoco report file
static java.lang.String	OUTPUT_XML_RELATIVE_PATH

Method Summary

Modifier and Type	Method and Description
JkJacoco	addAgentOptions(java.lang.String... args)
JkJacoco	addReportOptions(java.lang.String... args) See ... for report option
void	applyTo(dev.jeka.core.api.testing.JkTestProcessor testProcessor) Applies this Jacoco settings to the specified JkTestProcessor, in order it runs with Jacoco.
JkJacoco	configureAndApplyTo(dev.jeka.core.api.project.JkProject project) Concise method for configuring Jacoco based on the specified project and applying the settings to the designated project's testProcessor.
JkJacoco	configureFor(dev.jeka.core.api.project.JkProject project) Configures Jacoco settings in accordance to the specified project.
void	generateExport() Generates XML and HTML reports from the exec report file.
java.nio.file.Path	getAgentJar() The agent jar path, used to instrument tests
java.nio.file.Path	getExecFile() Exec file is the binary report file generated by Jacoco
java.util.List<java.lang.String>	getReportOptions()
static JkJacoco	ofVersion(dev.jeka.core.api.depmanagement.resolution.JkDependencyResolver dependencyResolver, java.lang.String version) Returns the JkJacoco object relying on jacoco-agent and jacoco-cli hosted on repository.
static JkJacoco	ofVersion(dev.jeka.core.api.depmanagement.JkRepoSet repos, java.lang.String version)
static JkJacoco	ofVersion(java.lang.String version)
JkJacoco	setClassDir(java.nio.file.Path classDir) Necessary to produce XML report
JkJacoco	setClassDirFilter(dev.jeka.core.api.file.JkPathMatcher pathMatcher)
JkJacoco	setClassDirFilter(java.lang.String pathDirExcludes)
JkJacoco	setExecFile(java.nio.file.Path destFile)
JkJacoco	setHtmlReport(boolean htmlReport)
JkJacoco	setSources(java.util.List<java.nio.file.Path> sourceDirs)
JkJacoco	setXmlReport(boolean xmlReport)

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_RELATIVE_PATH

public static final java.lang.String OUTPUT_RELATIVE_PATH

Relative location to the output folder of the generated jacoco report file

See Also:

Constant Field Values

OUTPUT_XML_RELATIVE_PATH

public static final java.lang.String OUTPUT_XML_RELATIVE_PATH

See Also:

Constant Field Values

OUTPUT_HTML_RELATIVE_PATH

public static final java.lang.String OUTPUT_HTML_RELATIVE_PATH

See Also:

Constant Field Values

DEFAULT_VERSION

public static final java.lang.String DEFAULT_VERSION

See Also:

Constant Field Values

Method Detail

ofVersion

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

Returns the JkJacoco object relying on jacoco-agent and jacoco-cli hosted on repository.

ofVersion

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

See Also:

ofVersion(JkDependencyResolver, String)

ofVersion

public static JkJacoco ofVersion(java.lang.String version)

See Also:

ofVersion(JkDependencyResolver, String)

configureFor

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

Configures Jacoco settings in accordance to the specified project. It basically sets the report locations and instructs where source code is lying.

configureAndApplyTo

public JkJacoco configureAndApplyTo(dev.jeka.core.api.project.JkProject project)

Concise method for configuring Jacoco based on the specified project and applying the settings to the designated project's testProcessor.

applyTo

public void applyTo(dev.jeka.core.api.testing.JkTestProcessor testProcessor)

Applies this Jacoco settings to the specified JkTestProcessor, in order it runs with Jacoco.

setHtmlReport

public JkJacoco setHtmlReport(boolean htmlReport)

Parameters:

htmlReport - if true, produces an xml report.

setXmlReport

public JkJacoco setXmlReport(boolean xmlReport)

Parameters:

xmlReport - if true, produces an xml report.

setExecFile

public JkJacoco setExecFile(java.nio.file.Path destFile)

addAgentOptions

public JkJacoco addAgentOptions(java.lang.String... args)

setClassDir

public JkJacoco setClassDir(java.nio.file.Path classDir)

Necessary to produce XML report

setClassDirFilter

public JkJacoco setClassDirFilter(dev.jeka.core.api.file.JkPathMatcher pathMatcher)

setClassDirFilter

public JkJacoco setClassDirFilter(java.lang.String pathDirExcludes)

addReportOptions

public JkJacoco addReportOptions(java.lang.String... args)

See ... for report option

setSources

public JkJacoco setSources(java.util.List<java.nio.file.Path> sourceDirs)

getReportOptions

public java.util.List<java.lang.String> getReportOptions()

generateExport

public void generateExport()

Generates XML and HTML reports from the exec report file.

getAgentJar

public java.nio.file.Path getAgentJar()

The agent jar path, used to instrument tests

getExecFile

public java.nio.file.Path getExecFile()

Exec file is the binary report file generated by Jacoco