Skip to content
This repository has been archived by the owner on Aug 27, 2021. It is now read-only.

Goals

Jump to bottom
Thomas Bouffard edited this page Mar 7, 2017 · 60 revisions

This page provides information about plugin goals (please also have a look on the Tips page)

Note on soapui logs
Please have a look on the Tips page as maven-soapui-extension-plugin fix some soapui logs bugs

Important note
By default, SoapUI goals are not bound to any lifecycle phase, so configure appropriate executions if you want to have these goals executed as part of the maven build.
See the maven plugin configuration guide for general information.

Standard goals

Standard goals are goals that are both available in maven-soapui-extension-plugin and in the SmartBear plugins. See the soapui documentation for more information.
Here are some additional information (missing from the official documentation or added by the maven-soapui-extension-plugin)

TODO: add missing doc (from SmartBear) about 'properties' parameters. Could be a link to [Tips]

loadtest

see http://www.soapui.org/Test-Automation/maven-2x.html#5-2-eviwaresoapuiloadtest-settings

mock

Mock additional parameters

Name Type Since Description
coverageReport boolean 4.6.4.1 Pro Only feature. Turns on creation of Html coverage reports. Default value: false
outputFolder String 4.6.4.1 Pro Only feature. Set which folder coverage reports are saved to.
runnerType String 4.5.1.3 The type of runner. OSS for the open source runner, PRO for the soapui-pro runner.
Default value is: PRO.

IMPORTANT NOTE ON COVERAGE

Due to the way the mock runner works, the coverage feature is currently only accurate when runnng with the noBlock parameter set to false. Otherwise, the mock runner processing ends, the coverage report generation is performed, but the mock is still available as the Jetty server is still running. So then, if you run tests against the mock, no additional coverage information is stored nor other coverage report generation is performed.

See #119 to follow the improvement status.

Mock standard parameters

TODO:

Name Description
mockService Specified the MockService to run. If not set, run all MockServices.
TODO: can we specify more than 1 service?separator (,)?
noBlock Turns off blocking when MockRunner has started.
**TODO **explain it better, why setting it to true is the common way)
path The local path to listen on, overrides the path configured for the MockService
port The local port to listen on, overrides the port configured for the MockService
projectFile Specified the name of the soapUI project file to use, default value is ${pom.artifactId}-soapui-project.xml
projectPassword Specifies password for encrypted project file (from tool command line description: Sets project password for decryption if project is encrypted)
saveAfterRun Saves project file after run.
TODO default
settingsFile Specifies soapUI settings file to use, will contain path to integrated tool to run.
TODO default
settingsFilePassword Specifies password for encrypted soapui settings file
skip undocumented, buggy in SmartBear implem - see #35, work in extension since 4.5.1.2, also skip with env variable

security-test

undocumented for 4.0.x and 4.5.x

TODO describe (see http://www.soapui.org/Test-Automation/security-tests.html)

test

Test additional parameters

Name Type Since Description
junitHtmlReport Boolean 4.5.1.4 PRO only + only releavant when the junitReport parameter is set to true.
In SmartBear implementation, additional xml and html reports are always generated. If this parameter is set false, then the 2 reports are not generated. This is particulary useful with Continuous Integration server (see #45).
Default value is: true.
runnerType String 4.5.1.1 The type of runner. OSS for the open source runner, PRO for the soapui-pro runner.
Default value is: PRO.
testSuiteProperties - 4.5.1.3 Override/create properties in all test suites. For more information, see the Tips page

Test additional features

Test standard parameters

Here are the parameters available for both oss and pro

TODO: document default values

  • domain : Overrides the domain used by any TestRequests run
  • endpoint : Overrides the service endpoint to be invoked by any TestRequests (see this post in soapui forum for usage example)
  • exportAll : Controls if all test requests should be exported (default only exports errors), (true/false)
  • globalProperties : Sets global properties. For more information, see the Tips page
  • host : Overrides the target host:port to be invoked by any TestRequests (see this post in soapui forum for usage example)
  • interactive: undocumented (to be confirm by looking on the plugin.xml file). TODO description
  • junitReport : Turns on creation of JUnit-reports, (true/false). TODO: with pro, additional reports. Default value: false
  • outputFolder : Set which folder results/reports are saved to
  • password : Overrides the password used by any TestRequests run
  • printReport : Controls if a small test report should be printed to the console (true/false)
  • projectFile : Specified the name of the soapUI project file to use, default value is ${pom.artifactId}-soapui-project.xml. To configure several projects, see this page in the wiki
  • projectPassword : Specifies password for encrypted project
  • projectProperties : Sets project properties. For more information, see the Tips page
  • testCase : Specifies the name of the TestCase to run
  • testFailIgnore : Ignore failed tests. ie won't fail the build. When using SmartBear implementation, if set to true, the "uggly" exception message is not displayed when errors occurs. See #2 for more details
  • testSuite : Specifies the name of the TestSuite to run
  • saveAfterRun : Saves project file after run
  • settingsFile : Specifies soapUI settings file to use
  • settingsFilePassword : Specifies password for encrypted settings file
  • skip: undocumented. Tests are skipped if the skip option is set to true or if the "maven.test.skip" system property is set to true. These apply to both open source and pro version of the maven plugin. TODO: add link to Integration Test + same doc in the mock goal
  • soapuiProperties : Sets Java System properties. For more information, see the Tips page
  • username : Overrides the username used by any TestRequests run
  • wssPasswordType : Specifies WSS password type

Test standard parameters for PRO only

Only available for:

  • SmartBear: soapui-pro plugin
  • maven-soapui-extension-plugin: set the runnerType parameter to PRO

Parameters

  • coverage : Sets the output to include Coverage HTML reports (true/false). Default value: false
  • environment (since 4.5 in soapui PRO): undocumented (see http://forum.soapui.org/viewtopic.php?f=2&t=14749)
  • openReport: undocumented. Open the junit html report if set to true. Default value: false
  • reportFormat : Sets formats for created report.
  • reportName : Sets which report to create.

Reporting parameters (TODO: create a dedicated page)

Details for reports from: http://www.soapui.org/Test-Automation/functional-tests.html

Important: the report generation is only performed if the soapui.home property is set, see http://community.smartbear.com/t5/SoapUI-NG/How-to-generate-Single-Page-report-when-running-TestCaseRunner/m-p/103872

R : Selects which report to generate for the test objects executed, for example if running the entire project, this could specify the name of a test-suite-level report that would be generated for each TestSuite. The report is saved as specified with the -F option to the folder specified with the -f option. (SoapUI Pro only)

F : Sets the format of the report specified with the -R option, for Printable reports this is one of PDF, XLS, HTML, RTF, CSV, TXT, and XML. For Data Export this is either XML or CSV (SoapUI Pro only)

from usage when running the command line tool

R: Report to Generate

F: Report format. Used with -R. Valid options PDF, XLS, HTML, RTF, CSV, TXT, and XML (comma-separated)

Does this work?? see http://forum.soapui.org/viewtopic.php?f=13&t=17698&p=41164

Values from doc seems to be wrong, support uses different version as answer of an user issue (http://forum.soapui.org/viewtopic.php?f=2&t=14458&p=35072&hilit=report+junit#p35034)

-R"JUnit-Style HTML Report" -F"Single Page (Print)"

tool

see http://www.soapui.org/Test-Automation/maven-2x.html#5-3-eviwaresoapuitool-settings

Additional goals

Additional goals are only available in maven-soapui-extension-plugin.

convert-project

This goal converts

  • a composite project into a standard project
  • a standard project into a composite project

Since: 4.5.1.1

convert-project case cases

Sometime, a composite project is not supported by a runner whereas the standard project is supported (running the war generated by MockAsWar=DeployAsWar?)
You may want to preprocess the project as a standard one as this user
In maven-soapui-extension-plugin, this goal has been used to create composite projects used in integration tests

convert-project required parameters

Name Type Description
inputProject File The path to the project to be converted.
outputProject File The path to the converted project.

convert-project optional parameters

Name Type Description
conversionType String The type of conversion. TO_STANDARD to convert a composite project into a standard one, TO_COMPOSITE to convert a standard project into a composite one. Default value is: TO_STANDARD.

See also this example

Note: if the conversion type is the same of the orginal project, the project is simply copied

mock-as-war

IMPORTANT NOTE: this goal is currently in beta. Thanks for trying it and providing feedbacks. New features and improvements are already planned.

Current limitation: only works with maven 3.0.x (see improvement #70). Some users have reported issue with Maven 3.0.2 (see #120), use Maven 3.0.5 instead.

Documentation in progress.

Usage: see the dedicated page
Since: 4.5.1.5

mock-as-war parameters

Name Since Type Description
enableWebUI 4.6.3.1 String If true, enable a Web UI to let you see the details of the mock service activity. See the SoapUI Mock As War documentation for more information.
Default value is: false.
explodedWarDirectory - File Required (todo: add a default value). Path to the directory where the exploded war is generated.
Default value is: ${project.build.directory}/soapui/mock-as-war/explodedWar (since 4.6.4.1).
projectFile - File Default to ${project.artifactId}-soapui-project.xml.
runnerType 4.6.3.1 String The type of runner. OSS for the open source runner, PRO for the soapui-pro runner.
Default value is: PRO.
warFile - File Path to the directory where the war file.If not set, no war file is generated.

test-multi

IMPORTANT NOTE: this goal is currently in beta. Thanks for trying it and providing feedbacks. New features and improvements are already planned.

Documentation in progress.

Usage: see the dedicated page
Since: 4.6.3.1

This goal let you run tests of several projects. It has almost the same parameters than the test goal. To see live examples, see the integration tests of this plugin

test-multi ignored parameters

Name Since Rationale
projectFile - The purpose of this goal is to run several SoapUI projects and this parameter let only set one project, so it is ignored (you can configure it, the goal will run without any error)

test-multi specific parameters

Name Since Type Description
projectFiles - - SoapUI project files to run (support both regular and composite projects). See below.
Default to empty.
useOutputFolderPerProject - boolean If set to true, the actual output folder for each project is set to a subdirectory of the configured ouputFolder (the subdirectory is based on the project name).
Default to false.

To configure the SoapUI projects you want to run, you declare a set of directories you want to scan and for each directory, what projects you want to include and/or exclude

<projectFiles>
  <scan>
    <baseDirectory>/soapui/project/service1</baseDirectory>
    <includes>
      <include>**/*.xml</include>
    </includes>
    <excludes>
      <exclude>**/*fail-*-soapui-project.xml</exclude>
      <exclude>**/composite-projects/**</exclude>
    </excludes>
  </scan>
  <scan>
    <baseDirectory>/soapui/project/service2</baseDirectory>
    <includes>
      <!-- here we only include composite projects -->
      <include>**/composite-*-soapui-project</include>
    </includes>
  </scan>
</projectFiles>

Notes:

  • in the previous example, you can replace the scan node by whatever name
  • be carrefull with composite projects, only include the root directory of the project and no xml files, otherwise the plugin will try to run the sub xml files as regular SoapUI project and then will fail to load them

test-verify

This goal checks if previous call of the test or test-multi goal has detected SoapUI failures. If so, it fails the build.
This goal has no parameters.
Since: 4.0.0.2

Important note: it only detects failures if you run the test goals with this plugin. This means that failures are not detected when running the test goal of the SmartBear plugins

test-verify use cases

It is needed when you

  • want to launch multiple projects with the test goal.
  • do not want to fail the build immediatly after the tests have been executed, for instance when you want to perform post-processing (shutting down server, ...) before failing the build.

In the latter case, you run the test goal (in integration-test phase), do you post processing (in post-integration-test phase) and then launch the test-verify goal (in post-integration-test phase).

See also this example

Clone this wiki locally