Selenium Java Launcher (selenium_java.jar)

The Selenium Java launcher allows interfacing with Selenium Java tests.
It has been tested with Selenium 1.0.


Configuration

The selenium_java.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 Java tests (.class files).
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:/build/classes
Additional classpath This may indicate some additional classpath necessary to execute the tests.
This can contain several path separated by ‘;’ each pointing to either a .jar file or a directory containing .class files.

Default value is: <empty> but could be similar to C:/tests/librairies/lib1.jar;C:/tests/librairies/lib2.jar;C:/tests/classes
Selenium - Java
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
Server options This may indicate optional arguments to pass to the Selenium Remote Control Server.

Default value is: -singleWindow -trustAllSSLCertificates
Java client driver JAR path This must indicate the path to the Selenium Remote Control Java Client Driver jar.

Default value is: C:/Program Files/Selenium-1.0/selenium-remote-control-1.0.1/selenium-java-client-driver-1.0.1/selenium-java-client-driver.jar
Execution framework This must indicate the execution framework to run the selenium tests.
The execution framework can be JUnit3, JUnit4 or TestNG and it depends on how you wrote your tests.

Default value is: JUnit4
JUnit
JUnit jar path This must indicate the path to the JUnit library.

Default value is: C:/Program Files/junit4.7/junit-4.7.jar
TestNG
TestNG jar path This must indicate the path to the TestNG library.

Default value is: C:/Program Files/testng-5.10/testng-5.10-jdk15.jar
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 a, 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

Before any test is initiated, the launcher will start teh selenium server by executing the following command:


"<javaInstallPath>/bin/java.exe" -jar "<seleniumServerJarPath>" <seleniumServerOptions>

Depending on the execution framework selected in the coniguration, the tests are executed by the launcher using one of these syntaxes:


For JUnitv3:
"<javaInstallPath>/bin/java.exe"
–classpath "<junitJarPath>;<additionalClassPath>;<javaClientDriverJarPath>;<testRootPath>"
junit.textui.TestRunner <testPath>.<testName>


For JUnitv4:
"<javaInstallPath>/bin/java.exe"
–classpath "<junitJarPath>;<additionalClassPath>;<javaClientDriverJarPath>;<testRootPath>"
org.junit.runner.JUnitCore <testPath>.<testName>


For TestNG:
"<javaInstallPath>/bin/java.exe"
–classpath "<testNGJarPath>;<additionalClassPath>;<javaClientDriverJarPath>;<testRootPath>"
org.testng.TestNG -testclass <testPath>.<testName>


And this 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.

Tutorial: Creating and executing Selenium Java tests

In this tutorial, we will learn to run some Selenium Java test scripts.


Prerequisites

Install Selenium 1.0 in the folder C:\\Externals\\Selenium-1.0

Install JUnit 4.7 in the folder C:\\Program Files\\junit4.7

Create a file C:\\tests\\selenium\\java_junit\\example\\basic_test.java and edit it with the following content:

package test.selenium.java_junit;
import com.thoughtworks.selenium.SeleneseTestCase;

public class basic_test extends SeleneseTestCase {
   @Override
   public void setUp() throws Exception {
      //setUp("https://www.xqual.com/", "*chrome");  // Chrome
      //setUp("https://www.xqual.com/", "*firefox"); // Firefox
      setUp("https://www.xqual.com/", "*iehta");   // IE
   }

   public void basic_test_test1() throws Exception {
      selenium.open("/");
      assertTrue(selenium.isTextPresent("language/localization, rights,"));
   }

   public void basic_test_test2() throws Exception {
      selenium.open("/");
      assertTrue(selenium.isTextPresent("some text not exsiting in the page"));
   }
}

Create a dedicated category for Selenium Java tests and create a test

  • create a category Selenium Java associated to the launcher selenium_java.jar
  • under this category, create (somewhere in the tree) a test with name basic_test and with a canonical path set to example.



Creating a test campaign

  • create a campaign including only the test basic_test
  • create a campaign session specifying in the configuration:
    • Test root path: C:/tests/selenium/java_junit
    • Additional classpath: <empty>
    • Java install path: C:/Program Files/Java/jdk1.6.0_06
    • Server Jar Path:
      C:/Externals/Selenium-1.0/selenium-remote-control-1.0.1/selenium-server-1.0.1/selenium-server.jar
    • Server options:
      -singleWindow -trustAllSSLCertificates
    • Java client driver JAR path:
      C:/Program Files/Selenium-1.0/selenium-remote-control-1.0.1/selenium-java-client-driver-1.0.1/selenium-java-client-driver.jar
    • JUnit jar path:
      C:/Program Files/junit4.7/junit-4.7.jar



Run a campaign session

Run the campaign session


What about TestNG?

The process is similar for TestNG tests. The only difference is that the annotation in the source file will use TestNG directives:


package test.selenium.java_testng;
import org.testng.annotations.Test;
import com.thoughtworks.selenium.SeleneseTestBase;

public class basic_test extends SeleneseTestBase {
	@Test public void basic_test_test1() throws Exception {
		selenium.open("/");
	}
}




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