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 functional test.
You can use the following Maven goals:
Goal | Description |
---|---|
|
Runs functional tests. For its settings, see Test goal. |
|
Runs load tests in ReadyAPI Performance. For its settings, see Load test goal. |
|
Runs security tests. For its settings, see Security test goal. |
|
Runs the specified and configured virtual services. For its settings, see Virtual API goal. |
|
Stops running virtual services. |
|
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. |
Test goal
Setting | Description | ||
---|---|---|---|
|
Required. Specifies the path to the project file to be used. |
||
|
Specifies the test suite to be run. |
||
|
Specifies the test case to be run. |
||
|
Specifies the tags of the test cases to be run.
Example: <param>TestCase tag1 && (tag2 || tag3) !tag4</param>
|
||
|
Specifies the domain to be used for the requests. |
||
|
Specifies the host to be used in the test. |
||
|
Specifies the service endpoints to be used in the test. |
||
|
Specifies the environment to be used in the test run. |
||
|
Boolean. Continues the test run even if an assertion triggers. |
||
|
Boolean. Commands the test runner to skip a test. |
||
|
Boolean. Exports all requests. |
||
|
Specifies the user name to be used in requests. |
||
|
Specifies the password to be used in requests. |
||
|
Specifies the password of an encrypted project. |
||
|
Specifies the WSS password type to be used for authentications. |
||
|
Specifies the password of an encrypted settings file. |
||
|
Specifies the settings file to be used. |
||
|
Specifies global property values for the test run. |
||
|
Specifies project property values for the test run. |
||
|
Accesses the ReadyAPI properties.
Required. Use the property to specify the ReadyAPI installation directory: <property>
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 <property> |
||
|
Boolean. Enables interactive Groovy scripts. |
||
|
Specifies the report format. |
||
|
Creates a report with the specified name. |
||
|
Boolean. Opens the created report. |
||
|
Boolean. Includes a summary report into the test log. |
||
|
Boolean. Generates a JUnit-style report. |
||
|
Boolean. Creates an HTML coverage report. |
||
|
Boolean. Specifies if a coverage report should be created. |
||
|
Boolean. If |
||
|
Specifies the directory to save the results or reports to. |
||
|
Boolean. Saves the project file after running the test. |
Security test goal
Setting | Description |
---|---|
|
Required. Specifies the path to the project file to be used. |
|
Specifies the test suite to be run. |
|
Specifies the test case to be run. |
|
Specifies the security test to be run. |
|
Specifies the domain to be used for the requests. |
|
Specifies the host to be used in the test. |
|
Specifies the service endpoints to be used in the test. |
|
Specifies the environment to be used during the test run. |
|
Boolean. Continues the test run even if an assertion triggers. |
|
Boolean. Commands the test runner to skip a test. |
|
Boolean. Exports all requests. |
|
Boolean. Enables interactive Groovy scripts. |
|
Specifies the user name to be used in all the requests. |
|
Specifies the passwords to be used in all the requests. |
|
Specifies the password of an encrypted project. |
|
Specifies the WSS password type to be used for authentication. |
|
Specifies the password of an encrypted settings file. |
|
Specifies the settings file to be used. |
|
Specifies global property values for the test run. |
|
Specifies project property values for the test run. |
|
Accesses the ReadyAPI properties. <property> |
|
Specifies the report format. |
|
Creates a report with the specified name. |
|
Boolean. Opens the created report. |
|
Boolean. Includes a summary report into the test log. |
|
Boolean. Generates a JUnit-style report. |
|
Specifies the directory to save the results or reports to. |
|
Boolean. If |
|
Boolean. Saves the project file after running the test. |
Tool goal
Setting | Description |
---|---|
|
Specifies the project file to be used. |
|
Specifies the tools to be run. |
|
Specifies the interface to generate the code for. |
|
Specifies the password of the encrypted project file. |
|
Specifies the password of the encrypted configuration file. |
|
Specifies the configuration file to be used. Contains the path to the integrated tool to be run. |
|
Accesses the ReadyAPI properties. <property> |
|
Boolean. If |
|
Specifies the directory to save results or reports to. |
Load test goal
Setting | Description |
---|---|
|
Required. Specifies the path to the project file to be used. |
|
Required. Specifies the load test to be run. |
|
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. |
|
Specifies the statistic groups to included in the report. |
|
Specifies the test run limits. |
|
Spec fies the |
|
If |
|
Boolean If |
|
Specifies the remote agents to be used. |
|
Specifies service endpoints to be used in the test. |
|
Boolean. Commands the test runner to skip a test. |
|
Boolean. Continues the test run even if an assertion triggers. |
|
Specifies a password of an encrypted project. |
|
Specifies a password of an encrypted settings file. |
|
Specifies a settings file to be used. |
|
Specifies global property values for the test run. |
|
Specifies project property values for the test run. |
|
Accesses the ReadyAPI properties. <property> |
|
Generates a report and commands to save it to the specified folder. |
|
Specifies a report format. |
|
Boolean. Generates a JUnit-style report. |
|
Specifies the directory to save results or reports to. |
|
Boolean. If |
Virtual API goal
Setting | Description |
---|---|
|
Required. Specifies the project file to be used. |
|
Specifies the to be run. If not specified, all are run. |
|
Boolean. Turns off blocking when the virtual API runner starts. |
|
Boolean. Commands the test runner to skip a test. |
|
Specifies the password of the encrypted project file. |
|
Specifies the password of the encrypted settings file. |
|
Specifies the setting file to be used. Contains the path to the integrated tool to be run. |
|
Specifies global property values for the test run. |
|
Specifies project property values for the test run. |
|
Accesses the ReadyAPI properties. <property> |
|
Boolean. If |
|
Boolean. Saves the project file after running the test. |