PyTest Launcher (pytest.jar)

The PyTest launcher allows interfacing with PyTest tests.

Configuration

The pytest.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 .py scripts.
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_python_scripts
Asynchronous timeout (in seconds) This must indicates the maximum time the system will wait for the test to complete.

Default value is: 600
Python
Python install path This must indicate where is installed Python on the host.

Default value is: C:/Python33


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

1) Each test in XStudio must have his dedicated .py script. The name of the script MUST be equal to the name of the test.


2) The .py script may be able to execute one specific testcase if necessary.
The interpreter is executed by the launcher using this syntax:

If no testcase has been created in XStudio:
<pythonInstallPath>/python.exe -m pytest <testRootPath>/<testPath>/<testName>.py


If some testcases have been manually created (with a name different from "default":
<pythonInstallPath>/python.exe -m pytest <testRootPath>/<testPath>/<testName>.py::<testcaseName>


And the output is redirected to <testName>_<testcaseIndex>.txt.


Optionally:
  • The environment variable PYTHONPATH is appended with <testRootPath>
  • If <pythonInstallPath> is a path to an executable and not a folder, "/python.exe" is not appended in the above command line
  • If a testcase has a parameter named cmdline_parameter, the value of this param is passed to the command line
  • If a testcase has a parameter named environment, the value of this param (that is on the form key=value) is added dynamically as an environment variable
  • If a test has an attribute named cmdline_parameter, the value of this attribute is passed to the command line
  • If a test has an attribute named environment, the value of this attribute (that is on the form key=value) is added dynamically as an environment variable


3) When the .py has executed all its actions, within the limit of <Asynchronous timeout (in seconds)> seconds, then the file <testName>_<testcaseIndex>.txt is parsed by the launcher and all the information will be passed/stored automatically in the XStudio database.





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