Launchers / Automated tests

SOATest Launcher (soatest.jar)

The soatest launcher allows interfacing with Parasoft SOATest tests.

Configuration

The soatest.xml file is 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 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:\My_tests
SOATest
SOATest install path This must indicate where SOATest is installed.

Default value is: C:\Program Files\Parasoft\SOATest\9.8
SOATest workspace path This must indicate the absolute path of the Workspace to use.

Default value is: C:\Users\Bob\parasoft\worspace\my_worspace
SOATest configuration This must indicate the configuration to use.

Default value is: user://example configuration
SOATest options This must indicate the optional arguments you may want to use in the soatestclient command (i.e. -publish -router searchURI:host1.adobe.com).

Default value is:

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

A test is executed by the launcher using this syntax:

Windows:
"soatestcli.exe -data "<soaTestWorkspace>" -resource "<testPath>/<testName>.tst"
-config "<soaTestConfiguration>" <soaTestOptions>

Linux:
"soatestcli -data "<soaTestWorkspace>" -resource "<testPath>/<testName>.tst"
-config "<soaTestConfiguration>" <soaTestOptions>

Each test in XStudio must have his dedicated .tst file. The name of the test MUST be equal to the name of the test (without extension).

Attachments

The files generated during test execution are uploaded to XStudio so that you can open/read them afterwards:
  • <Temp folder>/soatest_<random>.txt
  • <soaTestInstallPath>/report.xml
  • <soaTestInstallPath>/report.html

Mapping

  • In XStudio you need to create a test for each Parasoft testsuite file (.tst)
  • Under each test in XStudio, you need to create as many test cases as you have test in the Parasoft testsuite

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