We try to give you example projects as a good starting point for your very own Citrus testing project.
The Citrus sample applications try to demonstrate how Citrus works in different integration test scenarios. The projects are executable with Maven and should give you a detailed picture how Citrus testing works.
EIPSamples using Citrus to test Camel Enterprise Integration Patterns
→ samples-camel-eip
SPRINGSamples using Citrus to test Spring applications
→ samples-spring
QUARKUSSamples using Citrus to test Quarkus applications
→ samples-quarkus
JSONSamples using Json validation capabilities
→ samples-json
Demo projects using Citrus for integration testing
→ samples-demo
CAMELSamples using Citrus to test Camel Quarkus applications
→ samples-camel-quarkus
Samples using XML validation capabilities
→ samples-xml
Samples with SOAP WebServices client and server
→ samples-soap
Samples regarding Http protocol support
→ samples-http
Samples regarding Ftp protocol support
→ samples-ftp
Please have a look at the following code repositories that provide Citrus examples:
Each sample demonstrates a special aspect of how to use Citrus. Most of the samples use a simple system under test as an application, like the todo-list application. Explore the following categories of sample projects. We hope this helps to find the right sample project for your needs.
You can explore many more sample projects in the following section. The samples should help you to learn about the capabilities of Citrus. Please find following list of samples and their primary objective
| Configuration | Description | Sources |
|---|---|---|
| sample-annotation-config | Use Java annotation configuration | |
| sample-reporting | Add custom test reporting | |
| sample-javaconfig | Uses pure Java POJOs for configuration |
| CONNECTORS | Description | Sources |
|---|---|---|
| sample-kubernetes | Run tests in Kubernetes | |
| sample-docker | Shows how to use Citrus within Docker |
| DEMO | Description | Sources |
|---|---|---|
| sample-camel-context | Interact with Apache Camel | |
| sample-jbang | Prototype Citrus tests in minutes with JBang | |
| sample-selenium | Use Selenium for UI testing | |
| sample-cucumber | Shows BDD integration with Cucumber | |
| sample-quarkus | How to verify Quarkus applications with Citrus |
| EIP | Description | Sources |
|---|---|---|
| wire-tap | Testing the Wire Tap EIP in Apache Camel with Citrus across Quarkus and Spring Boot | |
| content-based-router | Testing the Content-Based Router EIP in Apache Camel with Citrus across Quarkus, Spring Boot and YAML DSL | |
| routing-slip | Testing the Routing Slip EIP in Apache Camel with Citrus across Quarkus and Spring Boot | |
| load-balancer | Testing the Load Balancer EIP in Apache Camel with Citrus across Quarkus and Spring Boot | |
| splitter | Testing the Splitter EIP in Apache Camel with Citrus across Quarkus, Spring Boot and YAML DSL | |
| messaging-bridge | Testing the Messaging Bridge EIP in Apache Camel with Citrus across Quarkus, Spring Boot and YAML DSL | |
| message-reliability | Testing Dead Letter Queue patterns in Apache Camel with Citrus across Quarkus and Spring Boot | |
| message-filter | Testing the Message Filter EIP in Apache Camel with Citrus across Quarkus, Spring Boot and YAML DSL |
| ENDPOINTS | Description | Sources |
|---|---|---|
| sample-dynamic-endpoints | Shows dynamic endpoint component usage | |
| sample-mail | Shows mail server activities in Citrus | |
| sample-soap-wssecurity | Configure SOAP web service client and server with WSSecurity | |
| sample-ftp | FTP client and server interaction in Citrus | |
| sample-http-loadtest | Calls REST API on Http server with multiple threads for load testing | |
| sample-https | Shows how to use SSL connectivity as a client and server | |
| sample-http | Shows REST API calls as a client | |
| sample-jms | Shows JMS message broker connectivity | |
| sample-jdbc | Validates stored data in relational database | |
| sample-soap-ssl | Shows SOAP secure web service support | |
| sample-kafka | Shows Kafka integration | |
| sample-wsdl | Auto generate tests from WSDL | |
| sample-swagger | Auto generate tests from Open API | |
| sample-rmi | Shows Remote Method Invocation support | |
| sample-soap-mtom | Handle MTOM enabled SOAP attachments | |
| sample-soap-attachment | How to send SOAP attachments to server | |
| sample-sftp | SFTP client and server interaction in Citrus | |
| sample-soap-wsaddressing | Configure SOAP web service client and server with WSSecurity | |
| sample-scp | SCP client and server interaction in Citrus | |
| sample-soap-static-response | Shows how to setup a static response generating SOAP web service server component | |
| sample-http-static-response | Shows how to setup a static response generating Http server component | |
| sample-http-basic-auth | Basic authentication on client and server components | |
| sample-soap | Shows SOAP web service support |
| MISCELLANEOUS | Description | Sources |
|---|---|---|
| sample-dictionaries | Add data dictionaries | |
| sample-message-store | Use the local message store | |
| sample-gradle | Uses Gradle build to execute tests | |
| sample-behavior | Add custom test behavior |
| QUARKUS | Description | Sources |
|---|---|---|
| camel-file-outbox | Testing Apache Camel Aggregator EIP with file output in Quarkus using Citrus | |
| camel-cxf-soap-client | Testing Apache Camel CXF SOAP client routes in Quarkus with Citrus service virtualization | |
| camel-kafka | Testing Apache Camel Kafka routes in Quarkus with Citrus and Testcontainers | |
| camel-cxf-soap | Testing Apache Camel CXF SOAP WebServices in Quarkus with Citrus SOAP client and JAXB marshalling | |
| camel-direct | Testing Apache Camel routes with direct and mock endpoints in Quarkus using Citrus | |
| camel-file-inbox | Testing Apache Camel file processing with ZIP data formats and Splitter EIP in Quarkus using Citrus | |
| camel-aws-s3-kafka | Testing Apache Camel S3-to-Kafka routes in Quarkus with Citrus, LocalStack, Kamelet property binding, and Testcontainers | |
| camel-jms | Testing Apache Camel JMS routes in Quarkus with Citrus and ActiveMQ Artemis | |
| camel-mqtt | Testing Apache Camel MQTT-to-Kafka routing with Content Based Router in Quarkus using Citrus | |
| camel-openapi-server | Testing Apache Camel OpenAPI REST services in Quarkus with specification-driven Citrus test actions | |
| camel-rest-dsl | Testing Apache Camel REST DSL endpoints in Quarkus with Citrus HTTP client | |
| camel-rest-to-soap | Testing a Camel REST-to-SOAP protocol bridge in Quarkus with Citrus HTTP client and SOAP server | |
| camel-postgresql | Testing a Camel HTTP-to-PostgreSQL route in Quarkus with Citrus HTTP client and SQL validation | |
| event-driven-jms | How Citrus helps to verify event driven JMS messaging in a Quarkus application | |
| camel-knative | Testing Apache Camel Knative eventing and CloudEvents in Quarkus using Citrus | |
| camel-knative-ssl | Testing TLS-secured Knative eventing in a Camel Quarkus application using Citrus | |
| event-driven-kafka | How Citrus helps to verify event driven Kafka messaging in a Quarkus application | |
| camel-direct-http | Testing Apache Camel routes with external HTTP dependencies using Citrus service virtualization |
| RUNTIMES | Description | Sources |
|---|---|---|
| sample-junit5 | Use JUnit5 test framework | |
| sample-dataprovider | Shows TestNG data provider usage in Citrus | |
| sample-testng | Use TestNG test framework | |
| sample-junit | Use JUnit test framework |
| VALIDATION | Description | Sources |
|---|---|---|
| sample-oxm | Shows XML object marshalling feature when sending and receiving messages | |
| sample-xml | Shows XML validation feature with schema and Xpath validation | |
| sample-hamcrest | Use Hamcrest matchers | |
| sample-xhtml | Shows XHTML validation feature | |
| sample-json | Shows Json payload validation feature with JsonPath validation | |
| sample-databind | Shows JSON object mapping feature when sending and receiving messages | |
| sample-http-form-data | Exchange form data via Http GET/POST | |
| sample-sql | Execute SQL statements in Citrus | |
| sample-binary | Shows binary message content handling in Citrus |
Pick your sample application for try out and got to the respective folder. Each sample is executable on your host. You just need Maven, Java and a git client. Refer to the detailed instructions in the sample README.
Of course, we appreciate any kind of help that you can give us in order to make things easy for Citrus users. So if you have a sample worth reading for others please let us know. Also, if you are missing a sample because you do not know how to accomplish the Citrus use case please do not hesitate to contact us. You may also open a new issue in the Citrus samples repository.