Skip to content

Commit

Permalink
docs: Update Spring note in README
Browse files Browse the repository at this point in the history
Update the note about the Spring integration in the README.

Update the announcement about Camunda Process Test.
  • Loading branch information
saig0 committed Dec 13, 2024
1 parent bdaa836 commit 6cc2d7a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,17 @@
This project allows you to unit test your Camunda Platform 8 BPMN processes. It will start a Zeebe test engine
and provide you with a set of assertions you can use to verify your process behaves as expected.

> [!Note]
> Heads up! We are building a new Java testing library for Camunda 8.6+. The new library will replace Zeebe Process Test eventually.
> New features: Access to Camunda's new REST API, official Spring integration, process coverage, improved UX, and more ([ref](https://github.com/camunda/issues/issues/751)).
> Stay tuned for updates. 🚀
> [!NOTE]
> Heads up! We created a new Java testing library for Camunda 8.6+: Camunda Process Test. The new library will replace Zeebe Process Test eventually.
> New features: Access to Camunda's new REST API, official Spring integration, improved UX, and more.
> See the [documentation](https://docs.camunda.io/docs/apis-tools/testing/getting-started/) on how to get started. 🚀
## Prerequisites

* Java 21+ (17+ for <=`8.3.x`) when running with an embedded engine (`zeebe-process-test-extension`)
* Java 8+ and Docker when running using testcontainers (`zeebe-process-test-extension-testcontainer`)
* JUnit 5

**NOTE**: If you use **Spring** and want to write tests, please use `spring-zeebe-test` as a wrapper around Zeebe Process Test to hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details.

## Getting Started

### Dependency
Expand Down Expand Up @@ -65,7 +63,11 @@ Using Maven profiles you can also [switch the test dependencies based on the ava

### Spring support

If you use the Spring framework or Spring Boot and you want to write tests, please use `spring-zeebe-test` as a wrapper around this library. This will hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details.
If you use [Spring-Zeebe](https://github.com/camunda-community-hub/spring-zeebe) (community-maintained project) and want to write tests, please use `spring-zeebe-test` as a wrapper around Zeebe Process Test to hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details.

> [!IMPORTANT]
> Zeebe Process Test has no integration for the [Camunda Spring SDK](https://docs.camunda.io/docs/apis-tools/spring-zeebe-sdk/getting-started/). You could still use the library but without hooking into the Spring lifecycle.
> Alternatively, you could migrate to the new [Camunda Process Test](https://docs.camunda.io/docs/apis-tools/testing/getting-started/) library that has support for the Spring SDK.
### Annotation

Expand Down

0 comments on commit 6cc2d7a

Please sign in to comment.