camunda-process-test-coverage

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #machine-learning #deep-learning #linux #macos #windows #cli #kubernetes #pytorch #security #ios #mcp

camunda-process-test-coverage

(★ 75)

Community Extension Helper library to visualize which parts of a BPMN process have been covered by a process test.

camunda-process-test-coverage Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![](https://img.shields.io/badge/Lifecycle-Deprecated-red)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#deprecated-[https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#relocated-)
[![](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community)
![Compatible with: Camunda Platform 7](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%207-26d07c)
![Compatible with: Camunda Platform 8](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-26d07c)
![Supported Camunda versions](https://img.shields.io/badge/Camunda%20Version-%207.20%20to%207.24%20and%208-orange.svg)

> [!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](https://docs.camunda.io/docs/next/apis-tools/testing/getting-started/) documentation.
>
> However, we included the current state of the extension into the [holunda-io/c7](https://github.com/holunda-io/c7/) repository, where we will maintain it together with other extensions and keep it working for future C7-EE releases.

# Camunda Process Test Coverage

This Camunda Platform 7 and Platform 8 community extension **visualises** test process **paths** and **checks** your process model **coverage** ratio. Running  typical JUnit tests now leaves **html** files in your build output. Just open one and check yourself what your test did:

![Coverage report](https://raw.githubusercontent.com/camunda-community-hub/camunda-process-test-coverage/master/docs/assets/img/flowcov_coverage_report.png)

## Highlights

* **Visually verify** the paths covered by individual tests **methods** and whole test **classes**
* Visually check gateway **expressions** and transaction borders (**save points**) used by your process
* Calculate and **verify** the nodes (_and_ sequence flow) **coverage** ratio reached by tests methods and classes.

## Just use it

* Integrates with all versions of Camunda Platform 7 starting with 7.20.0 and upwards as well as Camunda Platform 8
* Is continuously checked against the latest Camunda Platform 7 releases (check out our compatibility CI/CD pipeline)
* Tested with JDKs 17 and 21 and different operating systems (Windows, Mac and Linux).
* Supports **JUnit 4.13.1+** (4.11 does not work) or **JUnit 5** for Camunda 7
* Supports **JUnit 5** for Camunda 8 (uses Zeebe Process Test)
* Can be used inside Spring Tests

> [!IMPORTANT]
> If you're running with a Java version prior to 17 you have to use the old version 2.x (latest 2.8.0)

## Documentation

If you are interested in further documentation, please check our [Documentation Page](https://camunda-community-hub.github.io/camunda-process-test-coverage/snapshot/index.html)

## Installation

Add a **Maven test dependency** to your project <a href="https://maven-badges.herokuapp.com/maven-central/org.camunda.community.process_test_coverage/camunda-process-test-coverage-bom"><img src="https://maven-badges.herokuapp.com/maven-central/org.camunda.community.process_test_coverage/camunda-process-test-coverage-bom/badge.svg" align="right" /></a>

### JUnit5 (Platform 7 or Platform 8)

```xml
<dependency>
  <groupId>org.camunda.community.process_test_coverage</groupId>
  <artifactId>camunda-process-test-coverage-junit5-platform-7</artifactId>
  
  <version>${camunda-process-test-coverage.version}</version>
  <scope>test</scope>
</dependency>
```

## Configuration

Use the **ProcessCoverageInMemProcessEngineConfiguration**, e.g. in your `camunda.cfg.xml` (only needed for Platform 7)

```xml
<bean id="processEngineConfiguration"
   class="org.camunda.community.process_test_coverage.engine.platform7.ProcessCoverageInMemProcessEngineConfiguration">
   ...
</bean>
```

Use the **ProcessEngineCoverageExtension** as your process engine JUnit extension (available for Platform 7 and Platform 8)

Either use `@ExtendWith`

Java
```java
@ExtendWith(ProcessEngineCoverageExtension.class)
public class MyProcessTest {}
```

Kotlin
```kotlin
@ExtendWith(ProcessEngineCoverageExtension::class)
class MyProcessTest
```
or `@RegisterExtension`

If you register the extension on a non-static field, no class coverage and therefore no report will be generated. This is due to the fact, that an instance of the extension will be created per test method.

The extension provides a Builder for programmatic creation, which takes either a path to a configuration resource, a process engine configuration or if nothing is passed uses the default configuration resources path (`camunda.cfg.xml`).

The process engine configuration needs to be configured for test coverage. So use **either** the provided `ProcessCoverageInMemProcessEngineConfiguration`, `SpringProcessWithCoverageEngineConfiguration` or initialize the configuration with `ProcessCoverageConfigurator.initializeProcessCoverageExtensions(configuration)`.

If you use Java:
```java
@RegisterExtension
static ProcessEngineCoverageExtension extension = ProcessEngineCoverageExtension
        .builder().assertClassCoverageAtLeast(0.9).build();
```

If you prefer Kotlin:
```kotlin
companion object {
    @JvmField
    @RegisterExtension
    var extension: ProcessEngineCoverageExtension = ProcessEngineCoverageExtension
            .builder(ProcessCoverageInMemProcessEngineConfiguration())
            .assertClassCoverageAtLeast(1.0).build()
}
```

## Running the tests

Running your JUnit tests now leaves **html** files for individual test methods as well as whole test classes in your project's `target/process-test-coverage` folder. Just open one, check yourself - and have fun with your process tests! :smile:

## News and Noteworthy & Contributors

There are plenty of contributors to this project. Its initial design has been created by the WDW eLab GmbH and some others,
but then the project has been abandoned for some time and received a full rewrite including the new architecture by members
of flowcov.io squad and BPM craftsmen from Holisticon AG. We appreciate any help and effort you put into maintenance
discussion and further development.

Please check the release notes of [individual releases](https://github.com/camunda-community-hub/camunda-process-test-coverage/releases) for the changes and involved contributors.

## License
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). See [LICENSE](LICENSE.md) file.

camunda-process-test-coverage

camunda-process-test-coverage Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

camunda-process-test-coverage

camunda-process-test-coverage Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README