https://github.com/citrusframework/citrus

Framework for automated integration tests with focus on messaging integration
https://github.com/citrusframework/citrus

integration-testing messaging microservices

Last synced: about 2 months ago
JSON representation

Framework for automated integration tests with focus on messaging integration

• Host: GitHub
• URL: https://github.com/citrusframework/citrus
• Owner: citrusframework
• License: apache-2.0
• Created: 2010-02-03T15:32:30.000Z (about 15 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T09:01:18.000Z (6 months ago)
• Last Synced: 2024-10-29T10:56:28.802Z (6 months ago)
• Topics: integration-testing, messaging, microservices
• Language: Java
• Homepage: https://citrusframework.org
• Size: 84 MB
• Stars: 459
• Watchers: 42
• Forks: 136
• Open Issues: 182
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-java - Citrus

README

        
Citrus Integration Testing ![Logo][1]

==============

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.citrusframework/citrus/badge.svg?style=flat-square)](https://central.sonatype.com/search?q=g%253Aorg.citrusframework)

[![build](https://github.com/citrusframework/citrus/workflows/build/badge.svg?branch=main)](https://github.com/citrusframework/citrus/actions) 

[![Javadocs](http://javadoc.io/badge/org.citrusframework/citrus-core.svg)](http://javadoc.io/doc/org.citrusframework/citrus-core)

[![Licensed under Apache License version 2.0](https://img.shields.io/github/license/openshift/origin.svg?maxAge=2592000)](https://www.apache.org/licenses/LICENSE-2.0")

[![Chat on Zulip](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://citrusframework.zulipchat.com)

Welcome to Citrus

---------

Citrus is a test framework written in Java that is able to create

fully automated end-to-end use case tests for enterprise SOA

applications. Citrus simulates surrounding interface partners

supporting a huge set of different transports and protocols like

Http, JMS, TCP/IP, FTP, SOAP, XML and JSON.

Visit our official website at 'https://citrusframework.org'

for more information and a detailed documentation.

Preconditions

---------

You need following software on your machine in order to use the

Citrus framework:

* Java 17+

Installed JDK plus JAVA_HOME environment variable set

up and pointing to your Java installation directory. Used to compile and build the Citrus code.

* Maven 3.9.8+

Citrus projects will fit best with [Maven](https://maven.apache.org).

However, it is not required to use Maven. You can also run tests using [Gradle](https://gradle.org/) for instance.

* Java IDE (optional)

A Java IDE will help you to manage your Citrus project (e.g. creating

and executing test cases). You can use the Java IDE that you like best like Eclipse or IntelliJ IDEA.

 

Installation

---------

* Download the latest Citrus release archive

* Extract the archive into an appropriate location on your local storage

* Read the Maven tutorial to find out how to integrate the Citrus tests

into the Maven build lifecycle

Release Notes

---------

Each release comes with a complete reference documentation. At the beginning of

the reference you will find a section about the changes and notes for this release. For detailed 

description of changed packages and classes do also consult the provided javadoc.

Resources

---------

* Citrus's source repository is hosted on github.com. You can clone the

repository with git://github.com/citrusframework/citrus.git as URL

* Find our blog and more interesting articles around Citrus on

[https://citrusframework.org/news](https://citrusframework.org/news) and checkout the various post categories for

selecting a specific topic.

* [https://citrusframework.org](https://citrusframework.org) offers tutorials and more information about

Citrus framework.

Samples

---------

Our sample section is still growing. You can find several sample

projects in the separate repository [https://github.com/citrusframework/citrus-samples](https://github.com/citrusframework/citrus-samples). 

Licensing

---------

Copyright 2006-2024 the original author or authors.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

  

Consulting

---------

Just in case you need professional support for Citrus have a look at

[https://citrusframework.org/contact.html](https://citrusframework.org/contact.html).

Contact `citrus-dev@googlegroups.com` directly for any request or questions

Bugs

---------

Please report any bugs and/or feature requests directly to

[https://github.com/citrusframework/citrus/issues](https://github.com/citrusframework/citrus/issues)

Information

---------

For more information on Citrus see [citrusframework.org][2], including

a complete [reference manual][3].

 [1]: https://citrusframework.org/img/brand-logo.png "Citrus"

 [2]: https://citrusframework.org

 [3]: https://citrusframework.org/citrus/reference/html/index.html