kotlinx.kover.offline.runtime.api

Class KoverRuntime

java.lang.Object

kotlinx.kover.offline.runtime.api.KoverRuntime

public class KoverRuntime
extends java.lang.Object

Utility Kover to collect coverage inside JVM process in which the tests were run.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_FILE_PROPERTY_NAME JVM property name used to define the path to the file with Kover offline logs.
static java.lang.String	REPORT_PROPERTY_NAME JVM property name used to define the path where the offline report will be stored.

Constructor Summary

Constructors

Constructor and Description
KoverRuntime()

Method Summary

Modifier and Type	Method and Description
static java.util.List<ClassCoverage>	collect(java.util.List<byte[]> classFiles) Get classes coverage.
static java.util.List<ClassCoverage>	collectByDirs(java.util.List<java.io.File> classFileRoots) Get classes coverage.
static byte[]	getReport() Get content of the coverage binary report with ic format.
static void	saveReport(java.io.File file) Save coverage binary report in file with ic format.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_PROPERTY_NAME

public static final java.lang.String REPORT_PROPERTY_NAME

JVM property name used to define the path where the offline report will be stored.

If this property is specified, then at the end of the JVM process, the binary coverage report will be saved to a file at the path passed in the parameter value.

If the file does not exist, it will be created. If a file with that name already exists, it will be overwritten.

See Also:

Constant Field Values

LOG_FILE_PROPERTY_NAME

public static final java.lang.String LOG_FILE_PROPERTY_NAME

JVM property name used to define the path to the file with Kover offline logs.

If this property is not specified, the logs file will not be created.

See Also:

Constant Field Values

Constructor Detail

KoverRuntime

public KoverRuntime()

Method Detail

collectByDirs

public static java.util.List<ClassCoverage> collectByDirs(java.util.List<java.io.File> classFileRoots)

Get classes coverage. For the correct collection of coverage, an analysis of the class-files is required.

Calling this method is allowed only after all tests are completed. If the method is called in parallel with the execution of the measured code, the coverage value is unpredictable.

Parameters:

classFileRoots - root directories containing non-instrumented class-files the coverage of which needs to be measured. The search for class-files is recursive.

Returns:

Coverage of classes that were present in the directories passed in the classFileRoots parameter.

collect

public static java.util.List<ClassCoverage> collect(java.util.List<byte[]> classFiles)

Get classes coverage. For the correct collecting of coverage, an analysis of the class-files is required.

Calling this method is allowed only after all tests are completed. If the method is called in parallel with the execution of the measured code, the coverage value is unpredictable.

Parameters:

classFiles - a bytecode of non-instrumented application classes the coverage of which needs to be measured.

Returns:

Coverage of classes that were present in the classFiles parameter.

saveReport

public static void saveReport(java.io.File file)
                       throws java.io.IOException

Save coverage binary report in file with ic format. If the file does not exist, it will be created. If a file already exists, it will be overwritten.

Calling this method is allowed only after all tests are completed. If the method is called in parallel with the execution of the measured code, the coverage value is unpredictable.

Parameters:

file - the file to save binary report

Throws:

java.io.IOException - in case of any error working with files

getReport

public static byte[] getReport()
                        throws java.io.IOException

Get content of the coverage binary report with ic format. The resulting byte array can be directly saved to an ic file for working with the CLI

Calling this method is allowed only after all tests are completed. If the method is called in parallel with the execution of the measured code, the coverage value is unpredictable.

Returns:

byte array with binary report in ic format

Throws:

java.io.IOException - in case of any error working with files