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 : https://stackoverflow.com/questions/31720139/jacoco-code-coverage-report-generator-showing-error-classes-in-bundle-code-c See command-line documentation : https://www.jacoco.org/jacoco/trunk/doc/cli.html https://www.jacoco.org/jacoco/trunk/doc/agent.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkJacoco.AgentJarAndReportFile
static class	JkJacoco.RepoToolProvider

Field Summary

Fields

Modifier and Type	Field and Description
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 https://www.jacoco.org/jacoco/trunk/doc/cli.html for report option
static JkJacoco	configure(dev.jeka.core.api.project.JkProject project, java.lang.String jacocoVersion, boolean xmlReport, boolean htmlReport)
void	configure(dev.jeka.core.api.testing.JkTestProcessor testProcessor)
void	generateExport()
java.nio.file.Path	getExecFile()
java.util.List<java.lang.String>	getReportOptions()
JkJacoco.RepoToolProvider	getToolProvider()
static JkJacoco	ofManaged(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	ofManaged(dev.jeka.core.api.depmanagement.JkRepoSet repos, java.lang.String version)
static JkJacoco	ofManaged(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	setExecFile(java.nio.file.Path destFile)
JkJacoco	setSources(java.util.List<java.nio.file.Path> sourceDirs)

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

Method Detail

ofManaged

public static JkJacoco ofManaged(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.

ofManaged

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

configure

public static JkJacoco configure(dev.jeka.core.api.project.JkProject project,
                                 java.lang.String jacocoVersion,
                                 boolean xmlReport,
                                 boolean htmlReport)

ofManaged

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

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)

addReportOptions

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

See https://www.jacoco.org/jacoco/trunk/doc/cli.html for report option

setSources

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

getReportOptions

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

configure

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

generateExport

public void generateExport()

getToolProvider

public JkJacoco.RepoToolProvider getToolProvider()

getExecFile

public java.nio.file.Path getExecFile()