Citrus

What Citrus is

Citrus is a test framework for automated integration testing of messaging applications and microservices, with a focus on enterprise integration scenarios. A test can operate as both client and server across supported messaging interfaces, then check the contents of messages. Endpoints include HTTP, Kafka, JMS, Apache Camel, mail, FTP/SFTP, OpenAPI, SOAP, Docker, Kubernetes, Knative, SQL, and SSH. Citrus validates JSON and XML payloads and elements, supports XML schema and DTD validation, and can check database data. Test cases can sequence messages and include loops, delays, retries, parallel sections, and timeouts. Tests can be authored in Java, XML, YAML, or Cucumber BDD feature format. The framework integrates with JUnit 5, Cucumber, JBang, Quarkus, Spring Boot, TestNG, and JUnit 4. Citrus runs on Linux; version 4.0 and later requires Java 17 or newer. Setup documentation describes adding modules as test-scoped Maven dependencies and also provides Gradle guidance. Citrus is free of charge under the Apache License 2.0, may be used to test commercial applications, and is listed as free. The project invites contributions, feature requests, and issue reports through its community repository.

Who it suits

Citrus suits teams building enterprise integration tests for messaging scenarios and microservices. It is especially relevant when tests need to exercise multiple interfaces and validate messages, schemas, or database data.

Limits

Citrus 4.0 and later requires Java 17 or newer. The listed plan is free and includes the test automation framework under the Apache License 2.0.

Getting started

1. Review the download guide at https://citrusframework.org/.
2. Add the required Citrus modules as test-scoped Maven dependencies, or consult the Gradle setup documentation.
3. Use Java 17 or newer to run Citrus 4.0 and later.
4. Write tests in Java, XML, YAML, or as Cucumber BDD features.
5. Integrate Citrus with a supported runtime such as JUnit 5, Cucumber, JBang, Quarkus, Spring Boot, TestNG, or JUnit 4.

Verdict

Choose Citrus for Linux-based integration testing across messaging endpoints and microservices, particularly when message validation and flexible test logic matter. Look elsewhere if your environment cannot meet the Java 17-or-newer requirement for Citrus 4.0 and later.