Quickstart Setting up project sources
This quickstart gets the Citrus project sources running in a few minutes, starting with initial git repository clone and ending with a built Citrus project ready for coding.
- Git Client http://git-scm.com/
This can be either a command line client or some graphical UI. For simplicity, we assume you have the command line client installed.
- Java 1.6 (or higher version)
You can verify the Java installation via command line with
> java -version java version "1.6.0_17" Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0_17) Java HotSpot(TM) Client VM (build 1.6.0_17, mixed mode, sharing)
- Maven 3.0.x (or higher version)
Download maven and install Maven on your machine. Please verify correct version and MAVEN_HOME setup using following command
> mvn -version Maven version: 3.0.4 Java version: 1.6.0_17 Default locale: en_US, platform encoding: MacRoman OS name: "mac os x" version: "10.7.5" arch: "x86_64" Family: "mac"
- In case you want to use the Citrus TIBCO module in order to connect to TIBCO EMS or TIBCO Collaborator you will need a TIBCO Active Matrix BusinessWorks installation on your local machine. For more information about TIBCO see official website.
Initial git clone
First of all we get the Citrus sources from the repository on GitHub (http://www.github.com/). You can use the following command to do this
git clone git://github.com/christophd/citrus.git
This will clone the Citrus project to the target directory citrus. In the following this project directory is referred to as PROJECT_HOME. For detailed instructions about the version control system git, please consult the official website http://git-scm.com/.
Build the Citrus artifacts
Now everything is setup properly and you can use Maven for all the rest. Call
This command runs the full Maven build lifecycle with compilation, testing, packaging and installation of all artifacts. You will find the freshly built Citrus JAR files in your local Maven repository. Using this new own Citrus version is quite simple. Just add the SNAPSHot dependency to your projects POM like this
<dependency> <groupId>com.consol.citrus</groupId> <artifactId>citrus-core</artifactId> <version>1.3.1</version> <scope>test</scope> </dependency>
Create IDE project files
You can easily create the project files for your favorite IDE. For IntelliJ IDEA, in PROJECT_HOME call
for Eclipse, call
for Netbeans call
The project files are now ready for import in your IDE. This is the preferred way for creating IDE project files in Maven. Please do not create IDE projects manually. Maven takes care of the whole project classpath construction.
Make sure that you have set the M2_REPO classpath variable set in Eclipse (or Netbeans). The variable value points to your local Maven repository (typically found in C:\Documents and Settings\username\.m2\repo or ~/.m2/repo).
Maven ofers a suitable command to do this automatically:
mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
Have fun with Citrus!