Document Spring SDK 8.6.7+ Testing support #4845

megglos · 2025-01-14T07:45:19Z

Description

This PR adds all changes needed to make transparent that with the 8.6.7 release going forward the official Spring SDK has testing support on-par with the former community SDK that we aimed towards with this epic camunda/camunda#26423 .

It also adds a note to announcements and the update guide on the actual switch and end-of-life of the community project, which seemed to have been missed previously.

closes
camunda/camunda#26598
camunda/camunda#26600

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2025-01-14T07:45:45Z

👋 🤖 🤔 Hello, @mesellings! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

docs/reference/announcements/860.md

These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.

versioned_docs/version-8.6/reference/announcements.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

megglos · 2025-01-14T07:47:22Z

docs/apis-tools/spring-zeebe-sdk/getting-started.md

@@ -162,3 +162,44 @@ public void handleJobFoo(final ActivatedJob job) {
 ```

 See [the configuration documentation](/apis-tools/spring-zeebe-sdk/configuration.md) for a more in-depth discussion on parameters and configuration options for job workers.
+
+## Writing test cases


taken with minor changes from https://github.com/camunda-community-hub/spring-zeebe/blob/main/README.md#writing-test-cases

closes camunda/camunda#26600

mesellings · 2025-01-14T11:03:44Z

@megglos Are you happy for me to make changes directly to the branch rather than trying to fit them into individual comments? They are all basically rewording, but might just be a lot cleaner?

saig0

@megglos thank you for adding these changes. 👍 I have a few minor comments and I recommend moving the docs to a different place. Please have a look. 🍪

docs/components/best-practices/development/testing-process-definitions.md

versioned_docs/version-8.6/components/best-practices/development/testing-process-definitions.md

saig0 · 2025-01-14T13:20:18Z

docs/apis-tools/spring-zeebe-sdk/getting-started.md

+You can start up an in-memory test engine and do assertions by adding this Maven dependency:
+
+```xml
+<dependency>
+  <groupId>io.camunda</groupId>
+  <artifactId>spring-boot-starter-camunda-test</artifactId>
+  <version>8.6.x</version>
+  <scope>test</scope>
+</dependency>
+```
+
+Note that **the test engine requires Java version >= 21**. If you cannot run on this Java version, you can use [Testcontainers](https://www.testcontainers.org/) **instead**. Testcontainers require that you have a Docker installation locally available on the developer machine. Use this dependency:
+
+```xml
+<!--
+  Alternative dependency if you cannot run Java 21, so you will leverage Testcontainer
+  Make sure NOT to have spring-zeebe-test on the classpath in parallel!
+-->
+<dependency>
+  <groupId>io.camunda</groupId>
+  <artifactId>spring-boot-starter-camunda-test-testcontainer</artifactId>
+    <version>8.6.x</version>
+  <scope>test</scope>
+</dependency>
+```
+
+Then, start up the test engine in your test case by adding `@ZeebeSpringTest`
+
+```java
+@SpringBootTest
+@ZeebeSpringTest
+public class TestMyProcess {
+  // ...
+```
+
+An example test case is [available here](https://github.com/camunda-community-hub/camunda-cloud-examples/blob/main/twitter-review-java-springboot/src/test/java/org/camunda/community/examples/twitter/TestTwitterProcess.java).
+
+> Please do not use `zeebeTestEngine.waitForBusyState(...)` to wait for a timer. This will not work as this is also triggered by an incoming job activation.


❌ We should add this content to the Zeebe Process Test docs instead of the Spring SDK docs. Just add a link in the Spring SDK docs. The Zeebe Process Test docs contain information about writing tests.

With 8.7, Camunda Process Test will become the default testing library and we should change the link to the Camunda Process Test docs.

We can keep the content in the Zeebe Process Test docs for users that still use Zeebe Process Test.

Thank you for that suggestion, will apply this!

Addressed with aca17e2

Co-authored-by: Philipp Ossler <philipp.ossler@gmail.com>

akeller · 2025-01-14T19:44:06Z

@mesellings I didn't see a commit from you with changes. Will you get to this tomorrow? It looks like we want to move quickly on this PR and I'm wondering if we should pull in a US-based tech writer so you can enjoy your evening.

mesellings · 2025-01-14T19:46:25Z

Thanks @akeller I was waiting for the changes from @saig0 to be made before I reviewed, but this must have got lost in the churn today - if another writer can take the review that would be great please, otherwise I can take a look?

akeller · 2025-01-14T19:47:56Z

@conceptualshark @christinaausley can one of you have a look at this PR so we can (hopefully) get it reviewed and merged today?

mesellings · 2025-01-14T20:06:32Z

@akeller I'll give this a quick TW review before I finish, so it will jsut be grammar, writing etc rather than anything technical, but at least should help to get it merged, with follow-up PRs tomorrow if need be

megglos · 2025-01-14T20:20:18Z

@mesellings I'm done addressing the comments from @saig0 , please address any language matters directly. Thank you! 🙇

mesellings · 2025-01-14T20:21:06Z

Actually @akeller I don't think I can manage this review tonight, I did start but changes were still just being committed, so I want to wait until it is closer to completion before I review - I can take a look first thing tomorrow morning though?

akeller · 2025-01-14T20:24:50Z

@megglos I thought you'd be offline for sure! If another TW is available, they'll visit this PR. If not, Mark will get it tomorrow morning.

saig0

@megglos 👍

mesellings

@megglos I've made some TW edits directly in the commits and backported for 8.6, nice work, happy to approve! 👍 🚀

mesellings · 2025-01-15T10:15:51Z

@megglos Are you happy for me to merge and release the docs now, or are we still awaiting any other reviews?

megglos · 2025-01-15T10:36:24Z

Thank you @mesellings & @saig0 for the quick feedback loop! @mesellings yes, lets merge and publish.

github-actions · 2025-01-15T10:39:10Z

🧹 Preview environment for this PR has been torn down.

alexcorremans · 2025-01-16T09:18:05Z

@mesellings is there a reason why the announcement reads 'Spring SDK test support support in 8.6.7' or is the double 'support' helping overlooked?

mesellings · 2025-01-17T16:43:49Z

@alexcorremans Well spotted - that's a typo, I'll get that fixed - thank you for noticing this! 🚀 👀

mesellings · 2025-01-17T16:57:18Z

@alexcorremans Fixing this in #4871

Add Spring SDK test library docs to Getting Started page

09cebbf

github-actions bot assigned megglos Jan 14, 2025

megglos added the 8.7.0-alpha3 January 2024 alpha release label Jan 14, 2025

megglos requested review from a team and nicpuppa January 14, 2025 07:46

megglos commented Jan 14, 2025

View reviewed changes

megglos requested a review from felix-mueller January 14, 2025 07:47

megglos force-pushed the meg-26598-spring-sdk-test branch from b9a9579 to c833ef2 Compare January 14, 2025 07:50

megglos added 3 commits January 14, 2025 08:51

Update caution to reflect availability of spring sdk test support

e67de8d

Add announcement on Spring SDK 8.6.7 test support

64b8bd1

Add note to Spring-Zeebe replacement by official SDK to update guide

3c8c34c

closes camunda/camunda#26600

megglos force-pushed the meg-26598-spring-sdk-test branch from c833ef2 to 3c8c34c Compare January 14, 2025 07:51

megglos requested a review from saig0 January 14, 2025 07:52

nicpuppa added the deploy Stand up a temporary docs site with this PR label Jan 14, 2025

github-actions bot temporarily deployed to camunda-docs January 14, 2025 09:02 Destroyed

mesellings requested review from mesellings and removed request for a team January 14, 2025 10:11

saig0 mentioned this pull request Jan 14, 2025

docs: updated statement on spring test support camunda/zeebe-process-test#1416

Merged

7 tasks

saig0 requested changes Jan 14, 2025

View reviewed changes

megglos and others added 2 commits January 14, 2025 19:57

Rename to Camunda Spring SDK

797670b

Co-authored-by: Philipp Ossler <philipp.ossler@gmail.com>

Change assertion link to internal docs

feb40b3

Co-authored-by: Philipp Ossler <philipp.ossler@gmail.com>

github-actions bot temporarily deployed to camunda-docs January 14, 2025 19:11 Destroyed

Move Camunda SDK Support to Zeebe Process Test Docs

aca17e2

megglos requested a review from saig0 January 14, 2025 20:20

github-actions bot temporarily deployed to camunda-docs January 14, 2025 20:32 Destroyed

saig0 previously approved these changes Jan 15, 2025

View reviewed changes

TW edits for Next version

3139b76

mesellings dismissed saig0’s stale review via 3139b76 January 15, 2025 09:59

github-actions bot temporarily deployed to camunda-docs January 15, 2025 10:12 Destroyed

Backport TW edits for 8.6

5217550

mesellings approved these changes Jan 15, 2025

View reviewed changes

Merge branch 'main' into meg-26598-spring-sdk-test

d4c4466

github-actions bot temporarily deployed to camunda-docs January 15, 2025 10:28 Destroyed

mesellings merged commit 2872c5a into main Jan 15, 2025
8 checks passed

mesellings deleted the meg-26598-spring-sdk-test branch January 15, 2025 10:36

mesellings mentioned this pull request Jan 17, 2025

Fix typo on Announcements page #4871

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document Spring SDK 8.6.7+ Testing support #4845

Document Spring SDK 8.6.7+ Testing support #4845

megglos commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 14, 2025 •

edited

Loading

megglos Jan 14, 2025 •

edited

Loading

mesellings commented Jan 14, 2025 •

edited

Loading

saig0 left a comment

saig0 Jan 14, 2025

megglos Jan 14, 2025

megglos Jan 14, 2025

akeller commented Jan 14, 2025

mesellings commented Jan 14, 2025

akeller commented Jan 14, 2025

mesellings commented Jan 14, 2025

megglos commented Jan 14, 2025

mesellings commented Jan 14, 2025

akeller commented Jan 14, 2025

saig0 left a comment

mesellings left a comment

mesellings commented Jan 15, 2025

megglos commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

alexcorremans commented Jan 16, 2025

mesellings commented Jan 17, 2025

mesellings commented Jan 17, 2025

Document Spring SDK 8.6.7+ Testing support #4845

Document Spring SDK 8.6.7+ Testing support #4845

Conversation

megglos commented Jan 14, 2025 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Jan 14, 2025 • edited Loading

megglos Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

mesellings commented Jan 14, 2025 • edited Loading

saig0 left a comment

Choose a reason for hiding this comment

saig0 Jan 14, 2025

Choose a reason for hiding this comment

megglos Jan 14, 2025

Choose a reason for hiding this comment

megglos Jan 14, 2025

Choose a reason for hiding this comment

akeller commented Jan 14, 2025

mesellings commented Jan 14, 2025

akeller commented Jan 14, 2025

mesellings commented Jan 14, 2025

megglos commented Jan 14, 2025

mesellings commented Jan 14, 2025

akeller commented Jan 14, 2025

saig0 left a comment

Choose a reason for hiding this comment

mesellings left a comment

Choose a reason for hiding this comment

mesellings commented Jan 15, 2025

megglos commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

alexcorremans commented Jan 16, 2025

mesellings commented Jan 17, 2025

mesellings commented Jan 17, 2025

megglos commented Jan 14, 2025 •

edited

Loading

github-actions bot commented Jan 14, 2025 •

edited

Loading

megglos Jan 14, 2025 •

edited

Loading

mesellings commented Jan 14, 2025 •

edited

Loading