Jar Launcher (jar.jar)

The Jar launcher allows interpreting .jar files as tests.

Configuration

The jar.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
Java install path	This must indicate the path to the java install. Default value is: `C:/Program Files/Java/jdk1.6.0_17`
Test root path	This must indicate where are located all the Jar files. 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:/test_repository/tests/jar`
Jar
Generated file path	This must indicate the path to a file to be optionally uploaded to XStudios. Default value is: `generated_file.txt`

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

The tests are executed by the launcher using this syntax:

"<javaInstallPath>/bin/java.exe" -jar "<testRootPath>/<testPath>/<testName>_<testcaseName>.jar" <jarOptions>
And this is executed from the working directory <testRootPath>
<jarOptions> is added only if an attribute jar_options has been set to the test in XStudio.
The test will be marked as passed or failed depending on the error code returned by the Java interpreter.

Tutorial: Creating and executing Jar tests

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

Prerequisites

Install Java in the folder C:\\Program Files\\Java\\jdk1.6.0_17
Prepare and copy 2 JAR files named test1_tc1.jar and test1_tc1.jar in C:\\test_repository\\tests\\jar\\folder1\\. They must contains a manifest so that the main-class is known.

Create a dedicated category for Jar tests and create a test

create a category Jar associated to the launcher jar.jar
under this category, create (somewhere in the tree) a test with name Test1 and with a canonical path set to folder1.
(Opt.) create an attribute jar_option and set it with the options you want to pass to the jar.
create 2 test cases tc1 and tc2 under the test.

Creating a test campaign

create a campaign including only the test Test1
create a campaign session using a configuration having all the default values.

Run a campaign session

Run the campaign session

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

Launchers / Automated tests