Package io.flowcov.camunda.junit.rules
Class FlowCovProcessEngineRuleBuilder
- java.lang.Object
-
- io.flowcov.camunda.junit.rules.FlowCovProcessEngineRuleBuilder
-
public class FlowCovProcessEngineRuleBuilder extends java.lang.ObjectFluent Builder for TestCoverageProcessEngineRule.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_ASSERT_AT_LEAST_PROPERTYIf 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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowCovProcessEngineRuleBuilderassertClassCoverageAtLeast(double percentage)Asserts if the class coverage is greater than the passed percentage.FlowCovProcessEngineRulebuild()Builds the coverage rule.static FlowCovProcessEngineRuleBuildercreate()Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.static FlowCovProcessEngineRuleBuildercreate(org.camunda.bpm.engine.ProcessEngine processEngine)Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.static FlowCovProcessEngineRuleBuildercreateBase()static FlowCovProcessEngineRuleBuildercreateBase(org.camunda.bpm.engine.ProcessEngine processEngine)FlowCovProcessEngineRuleBuilderexcludeProcessDefinitionKeys(java.lang.String... processDefinitionKeys)FlowCovProcessEngineRuleBuilderhandleClassCoverage(boolean needHandleClassCoverage)Configures whenever class coverage handling is needed.FlowCovProcessEngineRuleBuilderoptionalAssertCoverageAtLeastProperty(java.lang.String key)Set the system property name for minimal class coverage assertion.FlowCovProcessEngineRuleBuildersetCoverageTestRunStateFactory(CoverageTestRunStateFactory coverageTestRunStateFactory)Configures CoverageTestRunStateFactory used to create CoverageTestRunState.FlowCovProcessEngineRuleBuilderwithDetailedCoverageLogging()Enables detailed logging of individual class and method coverage objects.
-
-
-
Field Detail
-
DEFAULT_ASSERT_AT_LEAST_PROPERTY
public static final java.lang.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 FlowCovProcessEngineRuleBuilder create()
Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.- Returns:
-
create
public static FlowCovProcessEngineRuleBuilder create(org.camunda.bpm.engine.ProcessEngine processEngine)
Creates a TestCoverageProcessEngineRuleBuilder with the default class coverage assertion property activated.- Returns:
-
optionalAssertCoverageAtLeastProperty
public FlowCovProcessEngineRuleBuilder optionalAssertCoverageAtLeastProperty(java.lang.String key)
Set the system property name for minimal class coverage assertion.- Parameters:
key- System property name.- Returns:
-
createBase
public static FlowCovProcessEngineRuleBuilder createBase()
- Returns:
- a basic builder with nothing preconfigured
-
createBase
public static FlowCovProcessEngineRuleBuilder createBase(org.camunda.bpm.engine.ProcessEngine processEngine)
- Returns:
- a basic builder with nothing preconfigured
-
withDetailedCoverageLogging
public FlowCovProcessEngineRuleBuilder withDetailedCoverageLogging()
Enables detailed logging of individual class and method coverage objects.- Returns:
-
handleClassCoverage
public FlowCovProcessEngineRuleBuilder handleClassCoverage(boolean needHandleClassCoverage)
Configures whenever class coverage handling is needed.- Parameters:
needHandleClassCoverage- boolean- Returns:
-
setCoverageTestRunStateFactory
public FlowCovProcessEngineRuleBuilder setCoverageTestRunStateFactory(CoverageTestRunStateFactory coverageTestRunStateFactory)
Configures CoverageTestRunStateFactory used to create CoverageTestRunState. Useful for sharing state between several test-classes- Parameters:
coverageTestRunStateFactory-- Returns:
-
assertClassCoverageAtLeast
public FlowCovProcessEngineRuleBuilder assertClassCoverageAtLeast(double percentage)
Asserts if the class coverage is greater than the passed percentage.- Parameters:
percentage-- Returns:
-
excludeProcessDefinitionKeys
public FlowCovProcessEngineRuleBuilder excludeProcessDefinitionKeys(java.lang.String... processDefinitionKeys)
-
build
public FlowCovProcessEngineRule build()
Builds the coverage rule.- Returns:
-
-