jazielinc / soapui

SoapUI is a free and open source cross-platform functional testing solution for APIs and web services.

The SoapUI project

Structure and submodules

• soapui - The core module that creates the SoapUI jar
• soapui-system-test - Integration and system tests for SoapUI
• soapui-installer - Creates the SoapUI distributions, such as installers and archives
• soapui-maven-plugin – Maven plugin used for running SoapUI in a Continuous integration environment (such as Jenkins).
• soapui-maven-plugin-tester - Small test pom.xml used for testing the soapui-maven-plugin.

Building and running

Prerequisite

• JDK (version 1.6 or higher)
  • If you're using Java 1.6 you have download the standalone Java FX runtime and set the javafx.runtime.lib.jar property in the root pom.xml file to the path of the jfxrt.jar file
• Maven (version 3.0.0 or higher)
• Git (version 1.8 or higher)

Getting the source code for the first time

To get the source code run git clone https://github.com/SmartBear/soapui.git where you want to the root folder of the SoapUI project.

Building

• To build the SoapUI project run mvn clean install in the root folder.
• To build a individual submodule run mvn clean install the root folder of the submodule you want to build.

Running

To run SoapUI after it has been built, execute mvn exec:java in the root folder of the soapui submodule.

Getting the latest changes

To get the latest source code changes clone the project by running git pull in the root directory of the SoapUI project or the root directory of the submodule you want to update.

Contributing

When you have decided that you want to take a more active part in improving SoapUI then there are a few things you have to do before you can get started. Go to http://www.soapui.org/Developers-Corner/contribute-to-soapui.html for more information.

IDE support

As SoapUI is using a standard Maven 3 setup, building and running SoapUI from an IDE is usually very straight forward, as long as the IDE has good Maven support.

Getting started using Intellij IDEA (version 13)

• Clone the project
• In the main menu select File -> Open...
• Enter the path to the root folder of the SoapUI project
• Run mvn compile in order to auto generate necessary source files
• After you have created the IDEA project sucessfully, navigate to the main class com.eviware.soapui.SoapUI right click and select Run.
• To get the latest changes right click on the root folder in the Project view and select Git -> Repository -> Pull...
• To get the same code style settings as the SoapUI team select File -> Import Settings... and import the file intellij-codestyle.jar located in the root folder of the SoapUI project

Getting started using Eclipse (version 4 / Juno)

• Clone the project
• In the main menu select File -> Import -> Maven -> Existing Maven projects and at Root directory enter the path to the root folder of the SoapUI project and then finish the wizard.
• After you have created the Eclipse project sucessfully, navigate to the main class com.eviware.soapui.SoapUI right click and select Run as -> Java application
• To get the latest changes right click on the root folder in the Package explorer view and select Team -> Pull

Documentation

To generate documentation (JavaDoc) run mvn javadoc:javadoc in the root folder of the submodule you want documentation for. The documentation will be located in the target/site/javadoc folder after the Maven command has terminated successfully.

You can also get the latest JavaDoc for SoapUI here.

Additional resources

• SoapUI Groovy examples - This is a collection of SoapUI projects and Groovy Scripts used to demonstrate the Groovy scripting capabilities in SoapUI.
• Extending SoapUI
• Custom factories
• Integrating with SoapUI