Tool Runner

Applies to ReadyAPI 3.5, last modified on December 29, 2020

Use ToolRunner to run any of the available code generation tools for projects and APIs you need via a command line.

Before running a tool for the first time, you need to configure it in ReadyAPI.

General Syntax

The runner command line has the following format:

toolrunner.bat <project file> <arguments>

Arguments

  • project file – The fully-qualified name of the project file to work with. If the file name or path includes spaces, enclose the entire argument in quotes.

  • -D – Specifies a value of a system property for the tool run. This value will override the variable value during the run.

    Usage: -D<variable>=<value>.

    If the value includes spaces, enclose the entire argument in quotes. To override several variable values, specify the -D argument several times.

  • -f – Specifies the root directory, where the runner will save test result files. If the directory does not exist, it will be created.

  • -G – Specifies a value of a global property for the tool run. This value will override the variable value during the run.

    Usage: -G<variable>=<value>.

    If the value includes spaces, enclose the entire argument in quotes. To override several variable values, specify the -G argument several times.

  • -i – Commands the runner to enable UI-related components. Use this command-line argument to work with the UISupport class in your tests.

  • -s – Specifies the workspace settings to be used during the virtual API run. By default, these settings are stored in soapui-settings.xml that you can find in your user directory. This argument allows you to specify another setting file for the run, which can be useful to easily switch between different proxies, SSL, HTTP, and other settings without changing them in ReadyAPI.

  • -t – A tool to run.

    Usage: -t<toolname>

    Possible values:

  • -v – Specifies your settings XML file password.

  • -x – Specifies the project password in case it is encrypted.

Sample Command

The following command runs the axis 1.X code generation tool for the my-amazon-project.xml project:

toolrunner.bat -iAWSECommerceServicePortType -taxis1 d:\test\my-amazon-project.xml

See Also

Code Generation in ReadyAPI

Highlight search results