Maven Launcher (maven.jar)

The maven launcher allows running builds using the maven utility.
The launchers allows to:

Scan existing build pom.xml files and automatically create the corresponding test that will be executed
Manage this as a test, hence include it into a test campaign
Set a goal per test case so that you can use it with any goal you wish
Run synchronously or asynchronously

This is useful when you want to test a solution that needs to be assembled from its sources, including the tests or not.
This way you can build the solution and then test it. So you are then sure to run your tests against the latest version of your solution.

Note: this launcher does not read the result from potential tests that run as a result of surefire or failsafe

Configuration

The maven.xml file is just a template and must NOT be edited.
It's used by the system to dynamically build the form that the user will be able to fill in from the GUI when creating a custom execution configuration.

Parameter	Description
General
Project root path	This sets the location where the project resides. Default value is: `C:/My_workspace`
Synchronous execution	This must indicate if the executable is synchronous or not Default value is: `true`
Asynchronous execution (in seconds)	Default value is: `600`
Maven location	This must indicate where your maven `mvn` is located - this enables you to avoid having to first modify your environment variables. This path MUST NOT include an ending slash. Default value is: `C:/maven/apache-maven-3.2.2/bin`
Command Executor	This must indicate where is located the OS Command shell. Default value is: `cmd.exe /c` (but you probably need to keep it empty)

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

Specific test attributes

It is possible to associate attributes to individual test.
This launcher will recognize and use the following attributes:

com.xqual.maven.opts
Allows specifying options for Maven - usualy you don't need it - but in some environment and special cases this may be useful.

Specific test case parameters (params)

It is possible to associate params to individual test case.
This launcher will recognize and use the following params:

com.xqual.maven.goal
Allows specifying the goal you need for the build (e.g. 'verify:test', 'test' , 'package' )
If this param is not set, the default goal is 'verify'

com.xqual.maven.test
Allows specifying the test maven test to be passed through the -Dtest=<test name> syntax
If this param is not set, the testcase name is used

Process

1) The launcher will constitute and run the interpreter with the following templates:

<Command Executor>/<Maven location>/mvn <com.xqual.maven.opts> <com.xqual.maven.goal>

    [-Dtest=<com.xqual.maven.test> || -Dtest=<testcase name>]

2) The log file will be attached to the result
3) The launcher parses the specific <test name >.log trace file and use it to provide summarized information back to the testers

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