Gatling Launcher (gatling.jar)

The Gatling launcher allows running performance tests using the Gatling utility.
The launcher allows to:

Scan existing gatling performance scala scripts files and automatically create the corresponding test cases
Manage this as a test, hence include it into a test campaign
Attached the log and resulting HTML files to the test case results
Setting the right environment variables (GATLING_HOME and NO_PAUSE)during execution

Please refer to Gatling's home page for understanding the adequate context to use Gatling.

Latest tested with: Windows 10-17134, Gatling 2.3.1
This version of the launcher is initial (v1.0)

Configuration

The gatling.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
Gatling
Test root path	This sets the location where the Gatling `*.scala` scripts reside. Default value is: `C:/my_gatlingtest`
Gatling install path	This must indicate where your gatling `gatling` shell script is located - this enables you to avoid having to first modify your GATLING_HOME environment variable. XStudio will add the `/bin/gatling.bat` or `/bin/gatling.sh` , depending on the OS you execute Gatling on This path MUST NOT include an ending slash. Default value is: `C:/gatling/g2.3.1/gatling`
OS	This must indicate on which OS platform your performance tests will be executed (Windows or Linux) Valid values are: `Windows , Linux` Default value is: `Windows`

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 does not make use of any test attributes.

Specific test case parameters (params)

It is possible to associate params to individual test case.
This launcher does not make use of any test case params.

Specific Envrionment variable set during test execution

<GATLING_HOME> is set to the Gatling install path
<NO_PAUSE> is set to the no pause

Process

1) The launcher will constitute and run the interpreter with the following templates:
<gatling execution path>/bin/gatling.bat or .sh -sf / -s <test name> -m -rd run <test name> -on <execution path>/xstudiogatling
e.g.

C:\gatling\mygatlingtests\My simulation1\simulations\computerdatabase>"C:\gatling\g2.3.1\gatling\bin\gatling.bat"

	-sf "c:\gatling\mygatlingtests\My simulation1\simulations\computerdatabase\advanced"  

	-s computerdatabase.advanced.AdvancedSimulationStep01 -m -rd "caroule" -on "c:\gatling\mygatlingtests"

2) The log file XstudioLogFile.txtwill be attached to the result
3) The launcher parses the specific XstudioLogFile.txt trace file and use it to provide summarized information back to the testers
4) The launchers attaches the HTML gatling file as index.html.zip file to the test case results. This html.zip file should be opened directly if your PC has an unzipper in its path.

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