Launchers / Automated tests

SoapUI Launcher (soapui.jar)

The SoapUI launcher allows interfacing with SoapUI tests.
It has been tested with SoapUI 4.5.4 till 5.3.0.

Configuration

The soapui.xml file is just a template and must NOT be edited. It's used by the system to build dynamically the form that the user will be able to fill in from the GUI when creating a custom execution configuration.

Parameter Description
General
Test root path This must indicate where are located all the SoapUI tests.
This is a root path. Each test in XStudio has a canonical path that will be appended to this path.
This path MUST NOT include an ending slash.

Default value is: C:/test_repository/tests/soapui
soapUI
soapUI install path This must indicate the path to the SoapUI install.

Default value is: C:/programs/SmartBear/soapUI-pro-4.5.1
soapUI Pro This must indicate if you're using SoapUI pro or not.

Default value is: true
report path This must indicate the path where reports are generated.

Default value is: C:/testreports/soapui

These values can be changed while creating the campaign session from XStudio.
Note about file path parameters:
Any parameter referring to a file or folder path (for instance Test root path) can be provided either using \ separator (if the tests are going to be executed on a Windows agent) or / separator (if the tests are going to be executed on a linux or MacOSX agent).

On windows, if you provide a path containing an OS-localizable folder such as C:\Program Files, always prefer the English version (i.e. NOT C:\Programmes if you're using a french-localized Windows) or the corresponding native environment variable (i.e. %PROGRAMFILES%).


Process

The tests are executed by the launcher using this syntax:

With SoapUI Pro:
"<soapUIInstallPath>/bin/testrunner.bat" -r -j
-FPDF -R"TestSuite Report" -f<reportPath>
-s"<testName>" -c"<testcaseName>" -e<additionalInfo> "<testRootPath>/<testPath>/<additionalInfo>"

With SoapUI:
"<soapUIInstallPath>/bin/testrunner.bat" -r -j
-s"<testName>" -c"<testcaseName>" -e<additionalInfo> "<testRootPath>/<testPath>/<additionalInfo>"


The test's Additional Infos field must contain the project xml name (e.g. REST-Project-2-soapui-project.xml) - note that you must include thz extension (here it is .xml)
The testcase's Additional Infos field must contain the endpoint (e.g. http://192.168.10.100:8080) - note that the specified endpoint should include the protocol part (for example, https://)

And this is executed from the working directory <testRootPath>

The test will be marked as passed or failed depending on the report and traces generated by SoapUI. The report and the execution traces are also attached to the testcase execution in XStudio.

Permissions

WARNING: if you're running your tests on Windows, it may be required to run the tests as administrator.
Having an account with Administrators permissions may even not be enough in some cases (especially if you're using Windows 10) and you may need to disable completely the UAC (User Access Control) on your computer.
To do so:
  • Press the Windows + R key combination
  • Type in regedit
  • Go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
  • In the right-side pane, look for EnableLUA and set the value 0
  • Close the registry editor
  • Restart your computer

Debug

If your tests are not executed correctly or are reporting only failures, this is very likely because your configuration is incorrect or because you used a wrong naming convention for your tests and test cases.

The best way to quickly find out what's wrong is to look at the traces generated by XStudio (or XAgent).
The traces always include the detailed description of what the launcher performs (command line execution, script execution, API calling etc.) to run a test case. So, if you experiment some problems, the first thing to do is to activate the traces and look at what's happening when you run your tests.

Then, try to execute manually in a cmd box the exact same commands.
This will normally fail the same way.
At this point, you needs to figure out what has to be changed in these commands in order to have them run properly.

When you have something working, compare these commands to what's described in the Process chapter above. This will tell you exactly what you need to change.

Most of the time, this is related to:
  • some incorrect values in some parameters of your configuration,
  • the name of your tests,
  • the name of your test cases,
  • the canonical path of your tests