Selenium3 (Webdriver) HTML Launcher (selenium3_html.jar)

The Selenium3 (WebDriver) HTML launcher allows interfacing with Selenium 3 (WebDriver) HTML tests.
It has been tested with Selenium 3.0.

Configuration

The selenium3_html.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 Selenium HTML 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:/tests/Selenium/html`
Selenium - HTML
Java install path	This must indicate the path to the java install. Default value is: `C:/Program Files/Java/jdk1.6.0_06`
Server JAR path	This must indicate the path to the Selenium Remote Control Server. Default value is: `C:/Program Files/Selenium-1.0/selenium-remote-control-1.0.1/selenium-server-1.0.1/selenium-server.jar`
Domain URL	This must indicate the URL of the web site under testing. Default value is: `https://www.xqual.com`
Browser	This must indicate which browser to use. Please refer to Selenium documentation to know which string to use (as of Today it can be `Firefox`, `Internet Explorer`, `Edge` or `Chrome`). Default value is: `Chrome`
Brower WebDriver file full path	This must indicate the browser webdriver. Default value is: `c:/webdrivers/chromedriver.exe`
Attachments
Additional attachments path	This must indicate where Selenium save its attachments (so that the launcher can upload them in XStudio too). WARNING: this folder will be automatically deleted by the launcher after each execution! It MUST contain only temporary data that you want to be automatically uploaded. DO NOT POINT TO A WORKING DIRECTORY THAT CONTAINS TESTS OR ANY OTHER DATA YOU NEED TO BE PERSISTANT! Default value is: `C:/tests/Selenium/attachments`

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

Base on the chosen driver, the launcher will use those variables:

Firefox

browserDriverProperty="webdriver.gecko.driver"
browserLogProperty="webdriver.gecko.logfile"
browserCodeName ="*firefox"

Internet Explorer

browserDriverProperty="webdriver.ie.driver"
browserLogProperty="webdriver.ie.driver.logfile"
browserCodeName ="*iexplore"

Edge

browserDriverProperty="webdriver.edge.driver"
browserLogProperty="webdriver.edge.logfile"
browserCodeName ="*MicrosoftEdge"

Chrome

browserDriverProperty="webdriver.chrome.driver"
browserLogProperty="webdriver.chrome.logfile"
browserCodeName ="*googlechrome"

For each execution, an HTML file <TestRootPath>/<testPath>/on_the_fly.htmlcode> is dynamically created and executed using this command:

"<javaInstallPath>/bin/java.exe"

		  -D<browserDriverProperty>=<browserDriverFile>

		  -D<browserLogProperty>=<TestPath>/report/selenium_server_traces.txt;

		  -jar "<seleniumServerJarPath>"
 
		  -htmlSuite "*<browserCodeName>" "<domainUrl>" "<TestRootPath>/<testPath>/on_the_fly.html"

		  "<TestRootPath>/<testPath>/report"

This command is executed from the working directory <testRootPath>

The test will be marked as passed or failed depending on the report and traces generated by Selenium. The report and the execution traces are also attached to the testcase execution in XStudio.

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