Applies to ReadyAPI 3.3.1, last modified on July 28, 2020
Information below applies to LoadUI TestRunner shipped along with ReadyAPI 1.1 and earlier. ReadyAPI version 1.2 and later include an updated load test runner.

The LoadTestRunner is used to execute load tests from the command line.

General Syntax

The utility command line has the following format:

loadtestrunner.bat [optional-arguments] <test-project>

Required arguments

test-project

A fully-qualified name of a project file that contains load tests to be run. If the file name or path includes spaces, enclose the entire argument in quotes.

Optional arguments

-c<test case>

Specifies the TestCase to be run.

A load test in LoadUI comes from SoapUI, where load tests were part of TestCases. In ReadyAPI, the parent TestSuite and TestCase are shown in the Navigator panel right after the name of the load test (in format <load test> (<test suite> -> <test case>).

This argument specifies a parent TestCase.

If you do not specify this argument, the runner launches all the load tests related to the specified test suite.

-D<args>

Specifies the value of a system property for the test run. The specified 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.

Example:

-Dtest.history.disabled=true

-d<domain>

Specifies the authorization domain.

This argument overrides domains specified for test requests.

-E<environment> 

Specifies the environment to be used in a test run.

Note: To use the environment in your tests, you need a LoadUI Pro license. If you do not have it, sign up for a free trial to try the new functionality.

Example:

-ENewEnvironment

-e<endpoint>

Specifies the endpoint to be used in invoking test requests. This argument overrides endpoints specified in the project file.

Example:

-ehttp://www.soapui.org/sample

-F 

Specifies the format of exported reports.

Usage: -F<FormatName>. Supported formats include: PDF, XLS, HTML, RTF, CSV, TXT and XML. To export results in several formats, separate them with commas. For example, -FPDF,XML,CSV.

The argument works with the -R argument that commands to generate a report.

Note: To export reports in different formats, you need a LoadUI Pro license. If you do not have it, sign up for a free trial to try the new functionality.

-f<directory>

Specifies the root directory to which test results should be exported.

Example:

-fC:\Work\ReadyAPI-test-results

-G<args>

Specifies the value of a global property for a test run. The specified 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.

Example:

-Gglobal.property=true

-h<host:port>

Specifies the host and port to be used in test requests.

Usage: -h<host>:<port>. You can specify the host by using its IP address or name.

This argument overrides endpoints specified in the project file.

Example:

-h127.46.44.12:80

-l<load-test-name>

Specifies the load test to be run (usage -l<test-name>). If the test name includes spaces, enclose the entire parameter in quotes. If this parameter is not specified, the runner will execute all load tests in your project.

Example:

-nLoadTest1

-m<limit>

Specifies the limit value for the load test. This argument overrides limits specified in the project.

-n<threads>

Specifies the number of threads for the test run. This argument overrides the number of threads specified in the project.

-o 

Commands the runner to open the generated report in a default browser.

-P<args>

Specifies the value of a project property for a test run. The specified value will override the variable value during the run.

Usage: -P<variable>=<value>. If the value includes spaces, enclose the entire argument in quotes. To override several variable values, specify the -P argument several times.

Example:

-Pproject.property=true

-p<password>

Specifies the password to be used in any test request authorization.

This argument overrides passwords specified in the project.

-R<args> 

Specifies the name of the report to be generated. Usage: -R<Report type>, where the Report type is one of the following:

Use -F and -f arguments to specify the desired report format and the directory where it should be saved.

Note: To use reports in your tests, you need a LoadUI Pro license. If you do not have it, sign up for a free trial to try the new functionality.

Example:

"-RJUnit-Style HTML Report"

-r

Commands the runner to print a small summary report to the test log.

-S

Commands the runner to save the project when the test run finishes. It may be useful when you store data during the test within the project.

-s<test suite>

Specifies the TestSuite to be run.

Load testing comes from SoapUI, where load tests were part of TestCases. In ReadyAPI, the parent TestSuite and TestCase are shown in the Navigator panel right after the name of the load test (in format <load test> (<test suite> -> <test case>).

If you do not specify this argument, the runner launches all the security tests in the specified project.

Example:

"-sTestSuite 1"

-t<settings file>

Specifies the ReadyAPI settings file to use during the test run. These settings are stored in soapui-settings.xml that resides in your user directory. This argument allows you to specify other XML setting files. It may be useful to use different proxy, SSL, HTTP and other without changing them within ReadyAPI.

-u<username>

Specifies the username to be used in any test request authorization.

This argument overrides passwords specified in the project.

-v<password>

Specifies the password for your XML setting file.

-w<args>

Specifies the WSS password type.

Usage: -w<password type>, where <password type> is:

  • Text– corresponds to the PasswordText WSS password type.

  • Digest– corresponds to the PasswordDigest WSS password type.

-x<password>

Specifies the project password if the project is encrypted.

Examples

  • The following command runs all the load tests from the specified project:

    loadtestrunner.bat C:\projects\my-project.xml
  • The following command runs all the load tests from the specified project against the specified service endpoint:

    loadtestrunner.bat -ehttp://localhost:8080/services/MyService c:\projects\my-project.xml

See Also

Command-Line Arguments
About LoadUI TestRunner
LoadUI TestRunner Exit Codes

Highlight search results