WebdriverIO Launcher (webdriverio.jar)

The WebdriverIO launcher allows interfacing with WebdriverIO (.js) scripts.

Configuration

The webdriverio.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 .js 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: `/home/webdriverio`
Test level	You can define at which level you make the association in between WebdriverIO and XStudio. 2 options are available: Suite: each WebdriverIO suite will be corresponding to a test in XStudio Spec: each WebdriverIO spec file (.js) will be corresponding to a test case in XStudio Default value is: `Spec`
WebdriverIO
WebdriverIO install path	This must indicate where is installed WebdriverIO on the host. The WebdriverIO runner (`wdio`) must be present in `node_modules/.bin/` starting from this folder. Default value is: `/wd`
WebdriverIO conf	This indicates which conf wil be used by the test runner. Default value is: `wdio.conf.js`
WebdriverIO options	This may include some optional arguments you want to pass to the WebdriverIO test runner. Default value is: `<empty>`
Framework	This must indicate which framework will be used by WebdriverIO test runner. 3 frameworks are available: Mocha Jasmine Cucumber Default value is: `Mocha`

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

Prerequisites

You'll need to have NodeJs installed then install WebdriverIO and the WebdriverIO JSON Reporter.

Install WebdriverIO

npm install webdriverio --save-dev

Install the WebdriverIO JSON File Reporter

You need to have the json reporter installed to:
npm install wdio-json-reporter --save-dev

Process

If you are using a configuration with Test level "Suite"

Each test in XStudio must have his dedicated suite in WebdriverIO. The name of the suite MUST be equal to the name of the test.
The webdriverio test runner is launched by the launcher using this syntax:
wdio --framework "<framework>" --reporters dot,json <webdriverioOptions> --suite "<testRootPath>/<testPath>/<testName>"
and from the working directory "<webdriverioInstallPath>/node_modules/.bin/"
The file <testRootPath>/report.json is parsed and all the results are stored as the default unique test case's steps

If you are using a configuration with Test level "Spec"

Each testcase in XStudio must have his dedicated spec in WebdriverIO. The name of the test MUST be equal to the name of the spec.
The webdriverio test runner is launched by the launcher using this syntax:
wdio --framework "<framework>" --reporters dot,json <webdriverioOptions> --spec "<testRootPath>/<testPath>/<testName>/<testcaseName>.js"
and from the working directory "<webdriverioInstallPath>/node_modules/.bin/"
The file <testRootPath>/report.json is parsed and all the results are stored as the test case's steps

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