org.camunda.bpm.extension.process_test_coverage.junit.rules

Class TestCoverageProcessEngineRuleBuilder

java.lang.Object

org.camunda.bpm.extension.process_test_coverage.junit.rules.TestCoverageProcessEngineRuleBuilder

public class TestCoverageProcessEngineRuleBuilder
extends Object

Fluent Builder for TestCoverageProcessEngineRule.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ASSERT_AT_LEAST_PROPERTY If you set this property to a ratio (e.g.

Method Summary

Methods

Modifier and Type	Method and Description
TestCoverageProcessEngineRuleBuilder	assertClassCoverageAtLeast(double percentage) Asserts if the class coverage is greater than the passed percentage.
TestCoverageProcessEngineRule	build() Builds the coverage rule.
static TestCoverageProcessEngineRuleBuilder	create() Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.
static TestCoverageProcessEngineRuleBuilder	create(org.camunda.bpm.engine.ProcessEngine processEngine) Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.
static TestCoverageProcessEngineRuleBuilder	createBase()
static TestCoverageProcessEngineRuleBuilder	createBase(org.camunda.bpm.engine.ProcessEngine processEngine)
TestCoverageProcessEngineRuleBuilder	excludeProcessDefinitionKeys(String... processDefinitionKeys)
TestCoverageProcessEngineRuleBuilder	optionalAssertCoverageAtLeastProperty(String key) Set the system property name for minimal class coverage assertion.
TestCoverageProcessEngineRuleBuilder	withDetailedCoverageLogging() Enables detailed logging of individual class and method coverage objects.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ASSERT_AT_LEAST_PROPERTY

public static final String DEFAULT_ASSERT_AT_LEAST_PROPERTY

If you set this property to a ratio (e.g. "1.0" for full coverage), the @ClassRule will fail the test run if the coverage is less.
Example parameter for running java:
-Dorg.camunda.bpm.extension.process_test_coverage.ASSERT_AT_LEAST=1.0

See Also:

Constant Field Values

Method Detail

create

public static TestCoverageProcessEngineRuleBuilder create()

Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.

Returns:

create

public static TestCoverageProcessEngineRuleBuilder create(org.camunda.bpm.engine.ProcessEngine processEngine)

Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.

Returns:

optionalAssertCoverageAtLeastProperty

public TestCoverageProcessEngineRuleBuilder optionalAssertCoverageAtLeastProperty(String key)

Set the system property name for minimal class coverage assertion.

Parameters:

key - System property name.

Returns:

createBase

public static TestCoverageProcessEngineRuleBuilder createBase()

Returns:

a basic builder with nothing preconfigured

createBase

public static TestCoverageProcessEngineRuleBuilder createBase(org.camunda.bpm.engine.ProcessEngine processEngine)

Returns:

a basic builder with nothing preconfigured

withDetailedCoverageLogging

public TestCoverageProcessEngineRuleBuilder withDetailedCoverageLogging()

Enables detailed logging of individual class and method coverage objects.

Returns:

assertClassCoverageAtLeast

public TestCoverageProcessEngineRuleBuilder assertClassCoverageAtLeast(double percentage)

Asserts if the class coverage is greater than the passed percentage.

Parameters:

percentage -

Returns:

excludeProcessDefinitionKeys

public TestCoverageProcessEngineRuleBuilder excludeProcessDefinitionKeys(String... processDefinitionKeys)

build

public TestCoverageProcessEngineRule build()

Builds the coverage rule.

Returns: