BPELUnit is a unit testing framework for WS-BPEL compositions. It provides facilities for deploying, invoking and undeploying a composition running in a WS-BPEL engine. External services can be replaced with mockups and replies can be delayed at will. Additionally, BPELUnit can derive test cases by reading rows from an external data source and combining it with Apache Velocity templates.

More documentation is available in the directory net.bpelunit.dist/src/main/resources/doc. The rest of this document is dedicated to explaining the build infrastructure available.

On a high level, BPELUnit is divided into:

• A core library with all the "real" testing logic: net.bpelunit.framework.
• A set of interfaces to access the core logic:
  • From the command line: net.bpelunit.framework.client.command.
  • From Ant: net.bpelunit.framework.client.ant.
  • From Maven: net.bpelunit.framework.client.maven.
• A set of external data source types for various file formats (the core library only has support for Apache Velocity .vm files):
  • CSV: net.bpelunit.framework.control.datasource.csv.
  • XLS and XLSX: net.bpelunit.framework.control.datasource.excel.
  • HTML tables: net.bpelunit.framework.control.datasource.html.
  • ooCalc: net.bpelunit.framework.control.datasource.ods.
• A small utility for inlining a data source into a BPELUnit test specification file: net.bpelunit.utils.datasourceinliner.

These are regular Java projects. However, the core library and the data source types are also available as OSGi bundles. These are used by the Eclipse plugins, feature and update site defined under the tycho folder. Some of these plugins require external libraries: we have repackaged some of them as OSGi bundles in the eclipse-deps folder, so you can import them while working from Eclipse.

In order to build the code with Maven 3.0 or higher (needed for the Tycho-based projects), you only need to run ./build-all.sh. It will build and install into your local Maven repository everything: core projects, Eclipse plugins, the Eclipse feature and update site, and the standalone distribution.

Please note that due to a limitation in Tycho, the core projects and the Eclipse plugins have been split into separate reactors. Also, you must install the core projects into your Maven repository before you can build the Tycho-based projects or the net.bpelunit.dist project.

Note for the maintainer: if you want to deploy a release to the Sonatype OSS server, please use the sonatype-deploy profile, and make sure you have a GPG keypair which has been published to pgp.mit.edu. You can run the profile like this:

mvn -P sonatype-deploy

If you experience a StackOverflowException most likely you will need to increase the per thread stack size. To do so use the following command

set MAVEN_OPTS="-Xss12m" (Windows)
export MAVEN_OPTS="-Xss12m" (Linux)

If you want, you can also work on the BPELUnit code straight from the Eclipse Plug-in Development Environment. To do so, you will still need Maven to bootstrap the environment. Just run ./prepare-eclipse-projects.shfrom this directory. It will ensure that the dependencies will be available in the target/dependency directory in each core project, and that the required code and MANIFEST.MF files are automatically generated.

You should now import the core, tycho and eclipse-deps projects into your Eclipse workspace. You may need to define the M2_REPO variable in the "Java Build Path" section of one of the projects if you have not done so yet. It needs to point to your local Maven repository: on most UNIX-based systems, it should be $HOME/.m2/repository. Please consult the Maven documentation for more details.

To test them out, right-click on any of the projects and select "Run As > Eclipse Application". This will open a nested Eclipse instance with the BPELUnit plugins running inside it.