Applies to ReadyAPI 3.0, last modified on November 15, 2019

You can configure the Maven plugin by using test goals and settings related to these goals.

Maven plugin goals

A Maven goal item commands Maven to run a test in a specific ReadyAPI tool. For example, the test goal commands Maven to run a SoapUI test.

You can use the following Maven goals:

Goal Description

test

Runs SoapUI functional tests. For its settings, see Test goal.

loadtest

Runs load tests in LoadUI. For its settings, see Load test goal.

security-test

Runs SoapUI security tests. For its settings, see Security test goal.

startVirts

Runs the specified and configured virtual services. For its settings, see Virtual API goal.

stopVirts

Stops running virtual services.

tool

Runs the specified and configured code-generation tool. For its settings, see Tool goal.

Goal Configurations

Use the following settings to configure Maven goal items:

Note: Changing the settings that are not Required will override the corresponding settings in the specified project for the current test run. If left unspecified, they will be applied as configured in the project.
Setting Description

projectFile

Required. Specifies the path to the project file to be used.

testSuite

Specifies the test suite to be run.

testCase

Specifies the test case to be run.

tags

Specifies the tags of the test cases to be run.

Note: Use the '&&', '||', and '!' operators to apply the AND, OR and NOT conditions to tags respectively, or list tags separated by commas to apply the AND condition. To change the order of operations, use parentheses.

Example:

<param>TestCase tag1 &amp;&amp; (tag2 || tag3) !tag4</param>

domain

Specifies the domain to be used for the requests.

host

Specifies the host to be used in the test.

endpoint

Specifies the service endpoints to be used in the test.

environment

Specifies the environment to be used in the test run.

testFailIgnore

Boolean. Continues the test run even if an assertion triggers.
Possible values: true, false.

skip

Boolean. Commands the test runner to skip a test.

exportAll

Boolean. Exports all requests.

username

Specifies the user name to be used in requests.

password

Specifies the password to be used in requests.

projectPassword

Specifies the password of an encrypted project.

wssPasswordType

Specifies the WSS password type to be used for authentications.
Possible values: Text, Digest.

settingsPassword

Specifies the password of an encrypted settings file.

settingsFile

Specifies the settings file to be used.

globalProperties

Specifies global property values for the test run.
Use the following syntax:
<value>Sample Project Property=My sample value</value>

projectProperties

Specifies project property values for the test run.
Use the following syntax :
<value>Some Property=My sample value</value>

readyApiProperties

Accesses the ReadyAPI properties.

soapui.home

Required. Use the property to specify the ReadyAPI installation directory:

<property>
  <name>soapui.home</name>
  <value>C:/Program Files/SmartBear/ReadyAPI-3.0/bin</value>
</property>

test.history.disabled

Optional. Use the property to control whether the test runs launched from Maven are saved to the test history. By default, the property is not set, and the history is not collected. Set the property to false if you want to save the test history:

<property>
  <name>test.history.disabled</name>
  <value>false</value>
</property>

interactive

Boolean. Enables interactive Groovy scripts.

reportFormat

Specifies the report format.
Possible values: PDF, XLS, HTML, RTF, CSV, TXT, XML.

reportName

Creates a report with the specified name.

openReport

Boolean. Opens the created report.

printReport

Boolean. Creates a printed report.

junitReport

Boolean. Generates a JUnit-style report.

coverage

Boolean. Creates an HTML coverage report.

coverageBuilder

Boolean. Specifies if a coverage report should be created.

optOutUsageStatistics

Boolean. If true, ReadyAPI disables sending usage statistics.

outputFolder

Specifies the directory to save the results or reports to.

saveAfterRun

Boolean. Saves the project file after running the test.

Setting Description

projectFile

Required. Specifies the path to the project file to be used.

testSuite

Specifies the test suite to be run.

testCase

Specifies the test case to be run.

securityTest

Specifies the security test to be run.

domain

Specifies the domain to be used for the requests.

host

Specifies the host to be used in the test.

endpoint

Specifies the service endpoints to be used in the test.

environment

Specifies the environment to be used during the test run.

testFailIgnore

Boolean. Continues the test run even if an assertion triggers.

skip

Boolean. Commands the test runner to skip a test.

exportAll

Boolean. Exports all requests.

interactive

Boolean. Enables interactive Groovy scripts.

username

Specifies the user name to be used in all the requests.

password

Specifies the passwords to be used in all the requests.

projectPassword

Specifies the password of an encrypted project.

wssPasswordType

Specifies the WSS password type to be used for authentication.
Possible values: Text, Digest.

settingsPassword

Specifies the password of an encrypted settings file.

settingsFile

Specifies the settings file to be used.

globalProperties

Specifies global property values for the test run.
Use the following syntax:
<value>Sample Project Property=My sample value</value>

projectProperties

Specifies project property values for the test run.
Use the following syntax:
<value>Some Property=My sample value</value>

readyApiProperties

Accesses the ReadyAPI properties.
Use the following syntax to specify a property name and the ReadyAPI installation directory to access it:

<property>
  <name>soapui.home</name>
  <value>C:/Program Files/SmartBear/ReadyAPI-3.0/bin</value>
</property>

reportFormat

Specifies the report format.
Possible values: PDF, XLS, HTML, RTF, CSV, TXT, XML.

reportName

Creates a report with the specified name.

openReport

Boolean. Opens the created report.

printReport

Boolean. Creates a printed report.

junitReport

Boolean. Generates a JUnit-style report.

outputFolder

Specifies the directory to save the results or reports to.

optOutUsageStatistics

Boolean. If true, ReadyAPI disables sending usage statistics.

saveAfterRun

Boolean. Saves the project file after running the test.

Setting Description

projectFile

Specifies the project file to be used.
Default value: ${pom.artifactId}-project.xml.

tool

Specifies the tools to be run.
A comma-separated list of axis1, axis2, dotnet, gsoap, jaxb, wstools, wsconsume, ora, wscompile, wsi, wsimport, xfire or xmlbeans.

iface

Specifies the interface to generate the code for.

projectPassword

Specifies the password of the encrypted project file.

settingsPassword

Specifies the password of the encrypted SoapUI file.

settingsFile

Specifies the SoapUI file to be used. Contains the path to the integrated tool to be run.

readyApiProperties

Accesses the ReadyAPI properties.
Use the following syntax to specify a property name and the ReadyAPI installation directory to access it:

<property>
  <name>soapui.home</name>
  <value>C:/Program Files/SmartBear/ReadyAPI-3.0/bin</value>
</property>

optOutUsageStatistics

Boolean. If true, ReadyAPI disables sending usage statistics.

outputFolder

Specifies the directory to save results or reports to.

Setting Description

projectFile

Required. Specifies the path to the project file to be used.

loadTest

Required. Specifies the load test to be run.

users

Specifies the number of virtual users to be simulated in the test run. This setting will not affect the test, if you have virtual users allocated to several scenarios.

statistics

Specifies the statistic groups to included in the report.

limits

Specifies the test run limits.
Use the following syntax:
<Secionds>:<Targets>:<Failures>
(for example, 60:0:200)

export

Spec fies the .csv file to export a statistics group to.
Use the following syntax:
<FileName>=<StatisticsGroupName>

abort

If true, cancels ongoing requests, else the test finishes when all the requests are completed.

local

Boolean If true, the test runs on the local computer, else the configured agents are used.

agents

Specifies the remote agents to be used.
Use the following syntax:
-a<ip>[:<port>]=<scenario>

environment

Specifies service endpoints to be used in the test.

skip

Boolean. Commands the test runner to skip a test.

testFailIgnore

Boolean. Continues the test run even if an assertion triggers.

projectPassword

Specifies a password of an encrypted project.

settingsPassword

Specifies a password of an encrypted settings file.

settingsFile

Specifies a settings file to be used.

globalProperties

Specifies global property values for the test run.
Use the following syntax:
<value>Sample Project Property=My sample value</value>

projectProperties

Specifies project property values for the test run.
Use the following syntax:
<value>Some Property=My sample value</value>

readyApiProperties

Accesses the ReadyAPI properties.
Use the following syntax to specify a property name and the ReadyAPI installation directory to access it:

<property>
  <name>soapui.home</name>
  <value>C:/Program Files/SmartBear/ReadyAPI-3.0/bin</value>
</property>

reports

Generates a report and commands to save it to the specified folder.

reportFormat

Specifies a report format.
Possible values: PDF, XLS, HTML, RTF, CSV, TXT, XML.

junitReport

Boolean. Generates a JUnit-style report.

outputFolder

Specifies the directory to save results or reports to.

optOutUsageStatistics

Boolean. If true, ReadyAPI disables sending usage statistics.

Setting Description

projectFile

Required. Specifies the project file to be used.
Default value: ${pom.artifactId}-project.xml.

virtNames

Specifies the to be run. If not specified, all are run.
Use the following syntax:
[virtName[:port[:path]]+,]

noBlock

Boolean. Turns off blocking when the virtual API runner starts.

skip

Boolean. Commands the test runner to skip a test.

projectPassword

Specifies the password of the encrypted project file.

settingsPassword

Specifies the password of the encrypted settings file.

settingsFile

Specifies the setting file to be used. Contains the path to the integrated tool to be run.

globalProperties

Specifies global property values for the test run.
Use the following syntax:
<value>Sample Project Property=My sample value</value>

projectProperties

Specifies project property values for the test run.
Use the following syntax:
<value>Some Property=My sample value</value>

readyApiProperties

Accesses the ReadyAPI properties.
Use the following syntax to specify a property name and the ReadyAPI installation directory to access it:

<property>
  <name>soapui.home</name>
  <value>C:/Program Files/SmartBear/ReadyAPI-3.0/bin</value>
</property>

optOutUsageStatistics

Boolean. If true, ReadyAPI disables sending usage statistics.

saveAfterRun

Boolean. Saves the project file after running the test.

See Also

SoapUI Testing With Maven - Example

Highlight search results