TestNG Launcher (testng.jar)

The TestNG launcher allows interfacing with TestNG tests.
It has been tested with TestNG 5.10


The testng.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 TestNG 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/testng-5.10/examples/src
Additional classpath This must indicate potential additional jar classpath necessary to run the tests.
This can contain several path separated by ‘;’ each pointing to either a .jar file or a directory containing .class files.

Default value is: <empty> but could be similar to C:/tests/librairies/lib1.jar;C:/tests/librairies/lib2.jar;C:/tests/classes
Java install path This must indicate the path to the java install.

Default value is: C:/Program Files/Java/jdk1.6.0_06
TestNG jar path This must indicate the path to the TestNG library.

Default value is: C:/Program Files/testng-5.10/testng-5.10-jdk15.jar
TestNG test type This must indicate the type of tests you defined in XStudio:
  • TestNG suite (.xml)
  • TestNG test (.class)
  • TestNG test and method (.class)

Default value is: TestNG test (.class)

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 differently depending on the TestNG test type you selected:

If you selected TestNG suite (.xml):
<javaInstallPath>/bin/java.exe –classpath <testNGJarPath>;<additionalClassPath> org.testng.TestNG

If you selected TestNG test (.class):
<javaInstallPath>/bin/java.exe –classpath <testNGJarPath>;<additionalClassPath>;<testRootPath> org.testng.TestNG
–testclass <testPath>.<testName>

If you selected TestNG test and method (.class):
<javaInstallPath>/bin/java.exe –classpath <testNGJarPath>;<additionalClassPath>;<testRootPath> org.testng.TestNG
–methods <testPath>.<testName>.<testcaseName>

In both cases the command line is executed from the working directory <testRootPath>

The test will be marked as passed or failed depending on the xml log file generated by TestNG. The xml file is parsed by the launcher. The logs, HTML reports and the execution trace of the command are also attached to the testcase execution in XStudio.

Tutorial: Creating and executing TestNG tests

In this tutorial, we will learn to run some TestNG tests. We will use TestNG 5.10 but this can be applied to any version of TestNG. As an example, we will execute a sample test provided with TestNG 5.10: Test1


Install TestNG 5.10 in the folder C:\\Program Files\\testng-5.10
The sample test is provided as source file only, so we need to compile it first. To do so run the following commands:

cd C:/Program Files/testing-5-10/examples
"C:/Program Files/Java/jdk1.6.0_02/bin/javac.exe" -classpath "C:/Program Files/testing-5-10/testng-5.10-jdk15.jar” src/example1/Test1.java

This will compile and create the file:
C:/Program Files/testing-5-10/examples/src/example1/Test1.class

Create a dedicated category for TestNG tests and create a test

  • create a category TestNG associated to the launcher testng.jar
  • under this category, create (somewhere in the tree) the test with the name Test1, and a canonical path set to example1.

Creating a test campaign

  • create a campaign including the test Test1.
  • create a campaign session with the default configuration settings.

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