The Citrus community is happy to announce the release of Citrus 5.2.0! This release brings significant improvements to the Cucumber integration, the JBang CLI, test reporting and YAML/XML DSL completeness.
The release contains 22 new features and enhancements, 13 bug fixes and several dependency and migration updates. Here is a look at the highlights.
Java 21 required
As announced with the 5.1.0 release, Citrus 5.2.0 requires Java 21 as the minimum version. Java 17 is no longer supported. If you have not migrated yet, please update your runtime before upgrading to Citrus 5.2.0.
JBang CLI ported to Aesh
The Citrus JBang CLI has been ported from Picocli to Aesh (#1574), the same command-line framework used by Apache Camel and Quarkus. Aesh provides interactive shell capabilities, command completion and a consistent user experience across the Camel ecosystem. If you use the Citrus JBang commands, the switch is transparent — all existing commands continue to work, and you benefit from improved tab completion and interactive mode support.
Cucumber 8 improvements
Citrus 5.2.0 brings a substantial overhaul of the Cucumber integration:
-
Suite hooks, DocString/DataTable steps and parallel scenarios — Cucumber tests can now use
@BeforeAll/@AfterAllsuite hooks, DocString and DataTable step definitions, and run scenarios in parallel (#1889) - Glue selection, package-private glue and named hooks — leverages Cucumber 8’s improved glue class scanning, supports package-private step definitions, and enables named hooks for better traceability (#1874)
- JUnit Platform engine migration — the Cucumber runtime and all cucumber-steps modules have been migrated from the legacy runner to the JUnit Platform engine, aligning with modern JUnit 5 test execution (#1858, #1860)
Complete HTTP YAML/XML DSL parity
The HTTP module now has full DSL parity across Java, YAML and XML (#1919). Every HTTP test action that was previously only available in the Java DSL can now be expressed in YAML and XML as well. This is part of a broader effort to ensure that all Citrus capabilities are available in every DSL flavor.
Simplified messaging endpoint definitions
Messaging endpoint definitions in YAML and XML have been streamlined (#1888). The new simplified syntax reduces boilerplate when declaring endpoints, making test definitions cleaner and easier to read.
Test reporting improvements
Test reporting has been enhanced in several areas:
- Nested action reporting — test action containers now report the execution of their nested actions, giving better visibility into what happens inside iterating, conditional and parallel containers (#1938)
- Container lifecycle callbacks — a new container listener allows hooking into lifecycle events of action containers for custom reporting or monitoring (#1936)
- Dedicated finally section — final (cleanup) actions are now reported in their own section, clearly separated from the main test flow (#1851)
- Skipped tests in JUnit XML — the JUnit XML report now correctly includes skipped tests, improving compatibility with CI dashboards and test aggregation tools (#1319)
YAML/XML DSL and catalog improvements
- Catalog metadata and unknown action rejection — the YAML action catalog now carries rich metadata descriptions and rejects unknown action names with helpful error messages instead of silently ignoring them (#1918)
- Colon-delimited action names — schema aggregate catalogs now use colon delimiters for test action names, providing a cleaner namespace hierarchy (#1850)
-
Test variable metadata in schemas —
@SchemaTypeannotations now include test variable metadata, and the generated JSON schemas carry this information for tooling support (#1973) - Minified JSON schemas — generated JSON schema files are now minified, reducing artifact size (#1981)
-
Endpoint dependency detection — Citrus now detects endpoint dependencies from
createEndpointtest actions, improving dependency tracking and validation (#1852)
Camel integration improvements
- Verify running integrations by name — the Camel verify action can now find already-running Camel integrations by name, useful when testing against long-lived integration routes (#1970)
-
Skip plugins option —
CamelRunIntegrationActionsupports a new--skip-pluginsoption for faster startup when plugins are not needed (#1957) -
EndpointProducerBuilder support —
CamelExchangeActionBuildernow accepts Camel’sEndpointProducerBuilderfor type-safe endpoint URIs -
Auto-set properties — a new
autoSetPropertiesoption on the Camel CLI run action simplifies property configuration (#1882)
Notable fixes
- Thread safety — static lookup caches are now thread-safe on first use, and header validator resolution avoids the lookup lock to prevent deadlocks (#1878, #1884)
-
SQL script resolution — SQL scripts are now resolved by prefix (
classpath:,file:, URL) and execute in declaration order (#1174, #701) - Dynamic HTTP server ports — the actual bound server port is now correctly resolved when using dynamic port allocation (#1960)
- Deterministic ZipMessage serialization — zip message payload serialization is now deterministic, eliminating flaky assertions caused by non-deterministic entry ordering (#1976)
- HTTP binary body logging — HTTP logging interceptors now summarize binary bodies instead of dumping raw bytes (#896)
Migration updates
- Cucumber runtime and step modules migrated to JUnit Platform engine (#1858, #1860)
- Tests migrated from TestNG to JUnit Jupiter (#1873)
- Date functions migrated from legacy
Calendartojava.timeAPI (#1864)
For the full list of changes see the release changelog.
Major library versions
Citrus 5.2.0 ships with the following major dependency versions:
| Library | Version |
|---|---|
| Apache Camel | 4.23.0 |
| Quarkus | 3.40.1.2 |
| Spring Framework | 7.0.10 |
| Spring Boot | 4.1.2 |
| Kafka | 4.4.0 |
| Selenium | 4.52.0 |
| Playwright | 1.65.0 |
| Cucumber | 8.0.4 |
| JUnit Jupiter | 6.1.3 |
| TestNG | 7.12.0 |
| Testcontainers | 2.0.5 |
| Kubernetes Client | 8.0.0 |
| Apache ActiveMQ Artemis | 2.57.0 |
| Vert.x | 5.2.3 |
| Jetty | 12.1.15 |
| Netty | 4.2.20.Final |
Update
Update the Citrus BOM in your pom.xml:
<dependency>
<groupId>org.citrusframework</groupId>
<artifactId>citrus-bom</artifactId>
<version>5.2.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Thank you to everyone who contributed to this release!