Protractor Launcher (protractor.jar)

The Protractor launcher allows running tests using the Protractor utility against angular UI .
The launcher allows to:

Scan existing protractor *.js scripts files
Automatically create the corresponding test cases in XStudio
Manage this as a test, hence include it into a test campaign
Automatically start, run and kill the Selenium server with Chrome and Gecko drivers
Attached the log and resulting files to the test case results
Setting the right environment variables (JAVA_HOME and path) during execution

Please refer to Protractor's home page for understanding the adequate context to use Protractor.
Note: Protractor is a nodeJs module - hence you need to have nodeJs, npm and the Protractor module already installed for the test to run
Latest test with: Windows 10-17134, Protractor R.3.2, nodeJs 8.11.2, npm 5.6.0
This version of the launcher is initial (v1.0)

Configuration

The protractor.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
Test root path	This sets the location where the Protractor `.js` scripts reside. This path MUST NOT include an ending slash. Notes: - not all `.js` files are protractor test scripts in that destination but XStudio find them - in this version of the launcher, we do not search for TypeScript files - you can adapt the launcher for it Default value is: `C:\MyProtractorTests`
Java Home	This sets the location where the java executables resides. This path MUST NOT include an ending slash. Default value is: `C:\Program Files\java\jdk1.8.0.172`
Protractor
Node.js install path	This must indicate where `nodeJs` is installed This path MUST NOT include an ending slash. Default value is: `C:\Program Files\nodejs`
Npm install path	This must indicate where `npm` is installed This path MUST NOT include an ending slash. Default value is: `C:\Users\<testuser>\AppData\Roaming\npm`
Chrome driver path	This must indicate where `Chrome` web driver is installed This path MUST NOT include an ending slash. Default value is: `C:\Users\<testuser>\AppData\Roaming\npm\node_modules\protractor\node_modules\webdriver-manager\selenium\chromedriver_2.40.exe`
gecko (for Firefox) driver path	This must indicate where `gecko` web driver is installed This path MUST NOT include an ending slash. Default value is: `C:\Users\<testuser>\AppData\Roaming\npm\node_modules\protractor\node_modules\webdriver-manager\selenium\geckodriver-v0.21.0.exe`
Selenium server path	This must indicate where `selenium` server is installed This path MUST NOT include an ending slash. Default value is: `C:\Users\<testuser>\AppData\Roaming\npm\node_modules\protractor\node_modules\webdriver-manager\selenium\selenium-server-standalone-3.12.0.jar`
Selenium address	This must indicate `selenium` server address Default value is: `localhost`
Selenium port	This must indicate `selenium` server port Default value is: `4444`
Selenium options	This may indicate `selenium` server options No default value

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

<JAVA_HOME> is set to the Java Home
<path> is set to by adding Node.js install path to the current path

Process

1) The launcher first start the selenium server

<javaHome>/bin/java  -Dwebdriver.chrome.driver=<chromeDriverPath> -Dwebdriver.gecko.driver=<geckoDriverPath>

		-jar <seleniumServerPath>  -port <seleniumPort>  <seleniumOptions>

2)The launcher will constitute and run the interpreter with the following templates:
<npm install path>/protractor.bat or /protractor <test name>.js
--troubleshoot --logLevel DEBUG --resultJsonOutputFile jsonReport.json <test name>
--seleniumAddress http://<selenium address>:<selenium port>/wd/hub
3) The log file XStudioLogFile.txt and the jsonReport.json will be attached to the result
4) The launcher parses the specific XstudioLogFile.txt trace file and uses it to provide summarized information back to the testers
5) The launcher parses the specific jsonReport.json trace file and uses it to provide detailed information back to the testers
6) When the session ends, XStudio terminates the selenium server it started

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