This project provides two Gradle plugins to run XML Calbash. Simply include the dependencies in the buildscript:

And then create tasks of the appropriate type:

• com.xmlcalabash.XMLCalabashExec is modeled after the standard JavaExec task. You can specify the classpath, heap size, and other VM parameters using the same properties as the JavaExec task. The XML Calabash options and parameters are specified using explicit properties. You cannot set the main class name or call the args() method.

• com.xmlcalabash.XMLCalabashTask runs XML Calabash in the same JVM that gradle is using. Consequently, you can’t change any of the JVM parameters.

The following properties are supported:

pipeline

Filename of the pipeline to run (string, required).

debugPipeline

Enable debug mode (boolean)

safeMode

Enable safe mode (boolean)

profilePipeline

Name of the file to use for writing profile information (string)

saxonEdition

Saxon edition (string: “he”, “pe”, or “ee”; defaults to “he”)

schemaAware

Schema aware processing (boolean, requires “he” or “pe” edition)

entityResolver

Name of entity resolver class (string)

uriResolver

Name of URI resolver class (string)

configFile

Filename of the XML Calabash configuration file (string; defaults to $HOME/.calabash)

saxonConfigFile

Filename of the Saxon Configuration file (string)

library

Library to load (string)

step

Step to run (QName)

calabashExtensions

Extenions to enable (list of strings: “general-values”, “xpointer-on-text”, “transparent-json”, “json-flavor-???”, “allow-text-results”, “use-xslt-1.0”, “html-serializer”)

In addition, the following methods may be called:

namespaceBinding(String prefix, String uri)

Establish the namespace binding between prefix and uri for evaluating QNames specified in other properties and methods.

input(String port, String filename)

Send the XML document identified by filename to the port named port.

dataInput(String port, String filename)

Send the non-XML document identified by filename to the port named port.

dataInput(String port, String filename, String contentType)

Send the non-XML document identified by filename to the port named port with the explicit content type specified in contentType.

output(String port, String filename)

Send the output from the port named port to the filename identified by filename.

param(String qname, String value)

Send the qname parameter with the value value to the primary parameter input port on the pipeline.

param(String qname, String value, String port)

Send the qname parameter with the value value to the port parameter input port on the pipeline.

option(String qname, String value)

Send the option qname to the pipeline with the value value.

Using the XMLCalabashExec task type:

Or running in the same VM:

Note that in the XMLCalabashTask case, you must put the XML Calabash dependencies in the compile configuration or they won’t be available to the task (which runs in the same VM).

(I don’t know why you have to fully qualify the types, in theory just XMLCalabashExec or XMLCalabashTask should work. But they don’t at the moment.)