SmartBear® TestExecute Launcher (testexecute_v2.jar)

The SmartBear® TestExecute launcher allows interfacing with TestExecute tests.


Configuration

The testexecute_v2.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
TestExecute
TestExecute install path This must indicate where TestExecute has been installed.
This path MUST not include an ending slash.

Default value is: C:/Program Files (x86)/SmartBear/TestExecute 11
Project suite root path This must indicate where all the project suite can be found.
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_project_suite
TestExecute log directory path Default value is: C:/Program Files (x86)/SmartBear/TestExecute 11/TestProject/Log
Run type This will specify how you designed your mapping in between XStudio and TestExecute structure:

In one case, when you will run a test case in XStudio it will execute a full project in TestExecute.
In the other, when you will run a test case in XStudio it will execute an individual test in TestExecute.


  • Full project:
    XStudio's test and test case names will be used to find the TestExecute's project and TestExecute will execute the full project.


  • Selected project and tests:
    XStudio's test name will match TestExecute's project name
    XStudio's testcase name will match TestExecute's test name.
    The Project Suite file will be found using the "Project suite root path" configuration parameter concatenated with the test's canonical path.


Default value is: Selected project and tests
Project extension (only with 'Full project') If you are going to execute full projects in TestExecute, this parameter will indicate the expected extension for the project suite file.

Indeed, XStudio's test names will be used to find the TestExecute's project suite file name but an extension will need to be added automatically.

Default value is: .mds
Optional arguments You can specify any optional argument to pass to the TestExecute command line.

Default value is: /ns /SilentMode (no splashscreen and execute TestExecute in silent mode)


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 a, 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:

In "Full project" mode:
<testExecuteInstallPath>/bin/TestExecute.exe "<suiteRootPath>/<testPath>/<testName>.<suiteExt>"
/project:"<testcaseName>" /run /exit <optionalArguments>


In "Selected project and tests" mode:
<testExecuteInstallPath>/bin/TestExecute.exe "<suiteRootPath>/<testPath>"
/project:"<testName>" /test:"<testcaseName>" /run /exit <optionalArguments>


The test will be marked as passed or failed depending on the return code of the execution.
The TestExecute xml log is 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