Configuration

[!WARNING]

Discontinued/Moved

Due to the end of live of Camunda 7 CE with 7.24, we decided to discontinue this extension and archive the repository. The Release 3.0.1 will be the last one. If you are looking for functionality for Camunda 8, please refer to official Camunda Process Testing documentation.

However, we included the current state of the extension into the holunda-io/c7 repository, where we will maintain it together with other extensions and keep it working for future C7-EE releases.

Setup reporting directory

Optionally, you might configure output path for reports. By default, the reports are written to ./target/process-test-coverage/. Depending on your preference there are multiple ways to change this.

JUnit5

When registering the extension programmatically, there is an option to change the report directory. See the following example, that uses the directory build which will typically be used by grade builds.

@RegisterExtension
var extension: ProcessEngineCoverageExtension = ProcessEngineCoverageExtension.builder()
    .assertClassCoverageAtLeast(1.0)
    .reportDirectory("build/process-test-coverage")
    .build()

Spring Testing

For the spring test execution listener, the configuration is provided through a configuration in the application context. If a bean of type ProcessEngineCoverageProperties is present in the application context, it will be used for configuration and supports changing the report directory.

@Bean
public ProcessEngineCoverageProperties processEngineCoverageProperties() {
    return ProcessEngineCoverageProperties.builder()
            .assertClassCoverageAtLeast(1.0)
            .reportDirectory("build/process-test-coverage")
            .build();
}

Maven aggregation plugin

For the maven aggregation plugin the report directory can be changed via the plugin configuration. It's also possible to configure the output directory for the aggregation report inside the report directory (by default it's "all").

<plugin>
    <groupId>org.camunda.community.process_test_coverage</groupId>
    <artifactId>camunda-process-test-coverage-report-aggregator-maven-plugin</artifactId>
    <version>@project.version@</version>
    <executions>
        <execution>
            <id>aggregate-reports</id>
            <goals>
                <goal>aggregate</goal>
            </goals>
            <configuration>
                <reportDirectory>build/camunda-tests</reportDirectory>
                <outputDirectory>aggregation</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

Gradle aggregation plugin

For the gradle plugin it's also possible to change the report directory as well as the output directory for the aggregation report. This can be done via an extension setting in the gradle build file.

plugins {
    id 'org.camunda.community.process_test_coverage.report-aggregator'
}

aggregateProcessTestCoverage {
    reportDirectory = 'build/camunda-tests'
    outputDirectory = 'aggregation'
}

Legacy way via system property

We still support the old way to configure the reporting directory via system property camunda-process-test-coverage.target-dir-root.

Maven

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
  <systemPropertyVariables>
    <camunda-process-test-coverage.target-dir-root>${project.build.directory}/my-coverage-reports/</camunda-process-test-coverage.target-dir-root>
  </systemPropertyVariables>
</configuration>
</plugin>

Gradle (KTS)

tasks {
    withType<Test> {
        systemProperties = mapOf(
            "camunda-process-test-coverage.target-dir-root" to "$buildDir/my-coverage-reports/"
        )
    }
}