Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/camunda-community-hub/camunda-process-test-coverage
Community Extension Helper library to visualize which parts of a BPMN process have been covered by a process test.
https://github.com/camunda-community-hub/camunda-process-test-coverage
bpmn camunda coverage testing
Last synced: 4 days ago
JSON representation
Community Extension Helper library to visualize which parts of a BPMN process have been covered by a process test.
- Host: GitHub
- URL: https://github.com/camunda-community-hub/camunda-process-test-coverage
- Owner: camunda-community-hub
- License: apache-2.0
- Created: 2015-10-07T12:56:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:02:41.000Z (2 months ago)
- Last Synced: 2024-10-29T12:06:33.536Z (2 months ago)
- Topics: bpmn, camunda, coverage, testing
- Language: Kotlin
- Homepage: https://camunda-community-hub.github.io/camunda-process-test-coverage/
- Size: 11.7 MB
- Stars: 76
- Watchers: 20
- Forks: 44
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#stable-)
[](https://github.com/camunda-community-hub/community)
# 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:
## 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.17.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 11 and 17
* Works with Java starting with 1.8 and following (depending on support by version of used Camunda Platform)
* Supports **JUnit 4.13.1+** (4.11 does not work) or **JUnit 5**
* Can be used inside Spring Tests
## 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 
0
### JUnit5 (Platform 7 or Platform 8)
```xml
org.camunda.community.process_test_coverage
camunda-process-test-coverage-junit5-platform-7
${camunda-process-test-coverage.version}
test
```
## Configuration
Use the **ProcessCoverageInMemProcessEngineConfiguration**, e.g. in your `camunda.cfg.xml` (only needed for Platform 7)
```xml
...
```
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.