PyUnit Launcher (pyunit.jar)

The PyUnit launcher allows interfacing with PyUnit tests.
It has been tested with PyUnit 1.4.1


The pyunit.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
Test root path This must indicate where are located all the PyUnit 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:/Program Files/PyUnit/pyunit-1.4.1/examples
Python install path This must indicate the path to Python install
Default value is:C:/Python26

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%).


The tests are executed by the launcher using this syntax:

<pythonInstallPath>/python.exe <testRootPath>/<testPath>/<testName>.py

And this is executed from the working directory <testRootPath>/<testPath>

The test will be marked as passed or failed depending on the log file generated by PyUnit. The text file is parsed by the launcher. The log of the command is also attached to the testcase execution in XStudio.

Tutorial: Creating and executing PyUnit tests

In this tutorial, we will learn to run some PyUnit test scripts.


Install Python 2.6 in the folder C:\\Python26
Install PyUnit 1.4.1 in the folder C:\\pyunit-1.4.1

Create a dedicated category for PyUnit tests and create a couple of tests

  • create a category PyUnit in the test tree associated to the launcher pyunit.jar
  • under this category, create (somewhere in the tree) 2 tests with names listtests and manytests. Both must have empty canonical path.

Creating a test campaign

  • create a campaign including only the tests listtests and manytests
  • create a campaign session specifying in the configuration:
    • Test root path: C:/pyunit-1.4.1/examples
    • Python install path: C:/Python26

Run a campaign session

Run the campaign session


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


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