The Citrus samples 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.
This repository uses the Java DSL and configuration in Citrus. In case you are not a Java developer you can also use the plain XML DSL and configuration notation. The samples using XML can be found in samples-xml.
The Citrus samples section contains many small projects that each represents a separate system under test and some Citrus test cases.
Each sample folder demonstrates a special aspect of how to use Citrus. Most of the samples use a simple todo-list application as system under test. Please find following list of samples and their primary objective:
| Sample | Objective |
|---|---|
| sample-reporting | Shows how to add a custom reporter |
| sample-test-jar | Creates an executable test JAR to run all integration tests |
| sample-test-war | Creates a deployable test WAR to run all integration tests as part of a web deployment |
| sample-docker | Shows how to use Citrus within Docker infrastructure |
| sample-kubernetes | Shows how to use Citrus within Kubernetes infrastructure |
| sample-gradle | Uses Gradle build to execute tests |
| sample-annotation-config | Uses annotation based endpoint configuration |
| sample-javaconfig | Uses pure Java POJOs for configuration |
| sample-behaviors | Shows how to reuse test actions in test behaviors |
| sample-dictionaries | Shows how to incorporate message manipulation using data dictionaries |
| sample-message-store | Shows how to access internal message store |
| sample-jdbc | Simulates database server with JDBC |
| sample-jdbc-callable-statements | Simulates database server communication using callable statements |
| sample-jdbc-transactions | Simulates database server with transactional JDBC |
| sample-sql | Validates stored data in relational database |
| sample-binary | Shows binary message content handling in Citrus |
| sample-json | Shows Json payload validation feature with JsonPath validation |
| sample-hamcrest | Shows Hamcrest matcher support in validation and conditions |
| sample-xml | Shows XML validation feature with schema and Xpath validation |
| sample-oxm | Shows XML object marshalling feature when sending and receiving messages |
| sample-mail | Shows mail server activities in Citrus |
| sample-databind | Shows JSON object mapping feature when sending and receiving messages |
| sample-dataprovider | Shows TestNG data provider usage in Citrus |
| sample-dynamic-endpoints | Shows dynamic endpoint component usage |
| sample-testng | Shows TestNG framework support |
| sample-junit | Shows JUnit4 framework support |
| sample-junit5 | Shows JUnit5 framework support |
| sample-jms | Shows JMS queue connectivity |
| sample-swagger | Auto generate tests from Swagger Open API |
| sample-http | Shows Http REST API calls as a client |
| sample-http-loadtest | Calls REST API on Http server with multiple threads for load testing |
| sample-http-static-response | Shows how to setup a static response generating Http server component |
| sample-http-basic-auth | Shows how to use basic authentication on client and server components |
| sample-https | Shows how to use SSL connectivity as a client and server |
| sample-wsdl | Auto generate tests from WSDL |
| sample-soap | Shows basic SOAP web service support |
| sample-soap-mtom | Shows how to send and receive MTOM enabled SOAP attachments |
| sample-soap-attachment | Shows how to send SOAP attachments to server |
| sample-soap-wssecurity | Shows how to configure SOAP web service client and server with WSSecurity enabled |
| sample-soap-wsaddressing | Shows how to configure SOAP web service client and server with WSAddressing enabled |
| sample-soap-ssl | Shows how to configure SOAP web service with SSL secure connectivity |
| sample-soap-static-response | Shows how to setup a static response generating SOAP web service server component |
| sample-rmi | Shows how to use RMI with Citrus as a client and server |
| sample-xhtml | Shows XHTML validation feature |
| sample-camel-context | Interact with Apache Camel context and routes |
| sample-cucumber | Shows BDD integration with Cucumber |
| sample-cucumber-spring | Shows BDD integration with Cucumber using Spring Framework injection |
Following sample projects cover message transports and technologies. Each of these samples provides a separate system under test applicaiton that demonstrates the messaging aspect.
| Transport | JMS | Http | SOAP | Channel | Camel | Arquillian | JDBC | SYNC | ASYNC |
|---|---|---|---|---|---|---|---|---|---|
| sample-bakery | X | X | X | X | |||||
| sample-flightbooking | X | X | X | X | |||||
| sample-greeting | X | X | X | X | |||||
| sample-bookstore | X | X | X | ||||||
| sample-incident | X | X | X | X | X | ||||
| sample-javaee | X | X | X | X | X | ||||
Pick your sample application for try out and got to the respective folder.
See the preconditions for using the Citrus sample applications:
-
Installed JDK 1.8 or higher plus
JAVA_HOMEenvironment variable set up and pointing to your Java installation directory -
Apache Maven 3.0.x or higher The sample projects are executable via Apache Maven (http://maven.apache.org/). You need ANT installed and running an your machine in order to use this way of executing the sample applications.
In each of the samples folders you will find the Maven (POM) pom.xml that defines all dependencies and build plugins.
You can run all the samples locally on your machine. We are using the Maven build tool for this.
All samples use some project as system under test. These sample application has to be started before executing any Citrus tests. Many samples reuse the todo-list application which is a simple web application that provides a basic REST API.
You can auto start and deploy the todo-list application within the Maven build by using the following command:
mvn clean install -Dembedded
The embedded option automatically starts an embedded Jetty Web Server Container before the integration test phase in Maven. After that the Citrus tests will be able to perform its actions in integration-test phase in Maven. After the tests are finished the embedded Jetty container is automatically stopped.
You can also start the Jetty container manually by calling:
mvn jetty:run-war
Execute this command in the respective sample folders and you will get a running Jetty Web Server Container with the system under test deployed.
Once the sample application is deployed and running you can execute the Citrus test cases in that sample folder. Open a separate command line terminal in that folder and execute the following command.
mvn verify
This executes all Citrus tests in that sample. You can also pick a single test by calling
mvn verify -Dit.test=<testname>
You should see Citrus performing several tests with lots of debugging output in both terminals (sample application server and Citrus test client). And of course green tests at the very end of the build.
Please read the instructions in each sample folder for different setup options and execution commands.
For more information on Citrus see www.citrusframework.org, including a complete reference manual.