org.safs.selenium.webdriver.lib

Class RemoteDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.safs.selenium.webdriver.lib.RemoteDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class RemoteDriver
extends org.openqa.selenium.remote.RemoteWebDriver
implements org.openqa.selenium.TakesScreenshot

Handle the Session information (serverhost, browsername, sessionid, firefoxProfile, chrome-user-data-dir, chrome-profile-dir, chrome-preference, chromeExcludedOptions, firefoxPreference).
Handle a SeleniumRMIAgent, if enabled, to communicate with a remote SAFS Selenium RMI Server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteDriver.SessionInfo The current format of each SessionInfo when stored in file:

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.remote.RemoteWebDriver.RemoteTargetLocator, org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions, org.openqa.selenium.remote.RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPABILITY_ID "ID"
static java.lang.String	CAPABILITY_RECONNECT "RECONNECT"
static java.lang.String	CAPABILITY_REMOTESERVER "REMOTESERVER"
static java.lang.String	debugLogFile The debug log file containing debug message when calling main() to start "selenium server".
static java.lang.String	DEFAULT_CONNECTION_TEST_COMMAND "getAlertText" defines the default selenium-driver-command used to test the connection between WebDriver and BrowserDriver.
protected boolean	isGrid if this is a grid-hub server
static java.lang.String	JAVA_TMPDIR "java.io.tmpdir"
static java.lang.String	LAST_SESSION_KEY "LASTSESSION"
java.lang.String	remote_hostname parsed hostname of the remote selenium server (standalone or grid-hub) might be needed for additional Selenium RMI Server communication.
int	remote_port parsed port number of the remote selenium server (standalone or grid-hub) might be needed for get grid-node information.
java.net.URL	remote_URL The URL provided at construction time.
java.lang.String	rmi_hostname hostname of the remote grid-node.
int	rmi_registry_port
SeleniumAgent	rmiAgent A SeleniumRMIAgent, if enabled, to communicate with a remote SAFS Selenium RMI Server. This may be null if we could not initialize an agent or find a server. This may also be non-null, but not connected to an RMI server if the server is not running.
static java.lang.String	SESSION_FILE "selenium.session.tmp"

Constructor Summary

Constructors

Constructor and Description
RemoteDriver(org.openqa.selenium.remote.DesiredCapabilities capabilities) Not used by SAFS Selenium. Should not be used if retaining SAFS Selenium RMI Server capabilities.
RemoteDriver(java.net.URL selenium_server_url, org.openqa.selenium.remote.DesiredCapabilities capabilities) Connect to a remote selenium standalone server. We will also parse the URL to attempt to connect to a SAFS Selenium RMI Server on RMI-SERVER-HOST. The RMI-SERVER-HOST can be: 1.

Method Summary

Modifier and Type	Method and Description
static void	deleteSessionFile()
static void	deleteSessionIdFromFile(java.lang.String Id) Delete the session from the RemoteDriver file with the given Id.
protected org.openqa.selenium.remote.Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters)
java.lang.Object	executeScript(java.lang.String script, java.lang.Object... args)
java.lang.String	getBrowserName()
java.lang.String	getBrowserVersion()
java.lang.String	getDriverVersion()
long	getExecutionTime(java.lang.String command, int timeoutWaitForComponent)
java.lang.String	getPlatform()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> target)
static java.util.List<RemoteDriver.SessionInfo>	getSessionsFromFile() Returns a List of SessionInfo objects.
boolean	hasQuit()
boolean	isConnectionFine(java.lang.String command, long maxDuration, int timeoutWaitForComponent) Test if the connection between WebDriver and the browser-driver is good enough to satisfy user's need.
boolean	isLocalServer()
static boolean	isNewSession()
static void	main(java.lang.String[] args) This main method will start a Selenium Server (standalone, hub, or node).
protected void	parseSeleniumServerURL(java.net.URL url) Extract the needed remote_hostname and remote_port from the selenium server URL.
void	quit()
static RemoteDriver.SessionInfo	retrieveSessionInfoFromFile(java.lang.String Id) Retrieve the remote server's session information for the session with the given id.
static RemoteDriver.SessionInfo	retriveLastSessionInfoFromFile() Retrieve SessionInfo representing the "current" or "last" session
static java.lang.String	retriveSessionIdFromFile(java.lang.String Id) Retrieve the remote server's session string for the session with the given id.
static void	setLastSessionId(java.lang.String Id)
protected void	startRMIAgent(java.lang.String rmihost, int rmiport) try to start a SAFS Selenium RMI Agent if our "selenium server" is NOT on localhost or it is a "grid hub server".
void	startSession(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities) Called internally by OpenQA RemoteWebDriver during Constructor initialization.
static void	storeSessionIdToFile(java.lang.String serverHostname, java.lang.String Id, java.lang.String browserName, java.lang.String sessionid, org.openqa.selenium.Capabilities desiredCapabilities)

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

close, execute, executeAsyncScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getExecuteMethod, getFileDetector, getKeyboard, getMouse, getPageSource, getSessionId, getTitle, getW3CStandardComplianceLevel, getWindowHandle, getWindowHandles, log, manage, navigate, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startClient, startSession, stopClient, switchTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

remote_URL

public java.net.URL remote_URL

The URL provided at construction time.

remote_hostname

public java.lang.String remote_hostname

parsed hostname of the remote selenium server (standalone or grid-hub) might be needed for additional Selenium RMI Server communication.

remote_port

public int remote_port

parsed port number of the remote selenium server (standalone or grid-hub) might be needed for get grid-node information.

rmi_hostname

public java.lang.String rmi_hostname

hostname of the remote grid-node. might be needed for additional Selenium RMI Server communication.

rmi_registry_port

public int rmi_registry_port

rmiAgent

public SeleniumAgent rmiAgent

A SeleniumRMIAgent, if enabled, to communicate with a remote SAFS Selenium RMI Server.
This may be null if we could not initialize an agent or find a server.
This may also be non-null, but not connected to an RMI server if the server is not running.

See Also:

SeleniumAgent, SeleniumAgent.server, SeleniumRMIAgent, SeleniumRMIServer

LAST_SESSION_KEY

public static final java.lang.String LAST_SESSION_KEY

"LASTSESSION"

See Also:

Constant Field Values

JAVA_TMPDIR

public static final java.lang.String JAVA_TMPDIR

"java.io.tmpdir"

See Also:

Constant Field Values

SESSION_FILE

public static final java.lang.String SESSION_FILE

"selenium.session.tmp"

See Also:

Constant Field Values

CAPABILITY_ID

public static final java.lang.String CAPABILITY_ID

"ID"

See Also:

Constant Field Values

CAPABILITY_RECONNECT

public static final java.lang.String CAPABILITY_RECONNECT

"RECONNECT"

See Also:

Constant Field Values

CAPABILITY_REMOTESERVER

public static final java.lang.String CAPABILITY_REMOTESERVER

"REMOTESERVER"

See Also:

Constant Field Values

isGrid

protected boolean isGrid

if this is a grid-hub server

DEFAULT_CONNECTION_TEST_COMMAND

public static final java.lang.String DEFAULT_CONNECTION_TEST_COMMAND

"getAlertText" defines the default selenium-driver-command used to test the connection between WebDriver and BrowserDriver.

See Also:

Constant Field Values

debugLogFile

public static final java.lang.String debugLogFile

The debug log file containing debug message when calling main() to start "selenium server".

Constructor Detail

RemoteDriver

public RemoteDriver(org.openqa.selenium.remote.DesiredCapabilities capabilities)

Not used by SAFS Selenium.
Should not be used if retaining SAFS Selenium RMI Server capabilities.

Parameters:

capabilities -

See Also:

RemoteDriver(URL, DesiredCapabilities)

RemoteDriver

public RemoteDriver(java.net.URL selenium_server_url,
                    org.openqa.selenium.remote.DesiredCapabilities capabilities)

Connect to a remote selenium standalone server.
We will also parse the URL to attempt to connect to a SAFS Selenium RMI Server on RMI-SERVER-HOST.
The RMI-SERVER-HOST can be:
1. The same host as this Selenium Server (Standalone).
2. The node host assigned by this Selenium Server (grid-hub).

Parameters:

selenium_server_url - -- URL of the remote Selenium Server.

capabilities - -- to enable the possibility of SAFS Selenium RMI Server/Agent communication you must set a "capability" of REMOTESERVER to be the hostname of the remote selenium server.

Ex: capabilities.setCapability(RemoteDriver.CAPABILITY_REMOTESERVER, hostname);

This is done automatically within the SAFS Selenium code where needed. Only advanced users doing custom initialization and instantiation need set this capability.

Method Detail

getBrowserName

public java.lang.String getBrowserName()

Returns:

String, the name of the browser where test is running. Or null if something wrong happens.

getBrowserVersion

public java.lang.String getBrowserVersion()

Returns:

String, the version of the browser where test is running. Or null if something wrong happens.

getPlatform

public java.lang.String getPlatform()

Returns:

String, the name of the platform where the browser is running. Or null if something wrong happens.

getDriverVersion

public java.lang.String getDriverVersion()

Returns:

String, the version of 'selenium server' with which the test is running. Or null if something wrong happens.

startRMIAgent

protected void startRMIAgent(java.lang.String rmihost,
                             int rmiport)

try to start a SAFS Selenium RMI Agent if our "selenium server" is NOT on localhost or it is a "grid hub server".

Parameters:

rmihost - String, the host name of the RMI server

rmiport - int, the port number of the RMI server, default is 1099

isLocalServer

public boolean isLocalServer()

Returns:

true if our standalone Selenium Server is local (localhost), otherwise false.

parseSeleniumServerURL

protected void parseSeleniumServerURL(java.net.URL url)

Extract the needed remote_hostname and remote_port from the selenium server URL.

Parameters:

URL - - URL of the Selenium Server used.

quit

public void quit()

Specified by:

quit in interface org.openqa.selenium.WebDriver

Overrides:

quit in class org.openqa.selenium.remote.RemoteWebDriver

hasQuit

public boolean hasQuit()

startSession

public void startSession(org.openqa.selenium.Capabilities desiredCapabilities,
                         org.openqa.selenium.Capabilities requiredCapabilities)

Called internally by OpenQA RemoteWebDriver during Constructor initialization.

Overrides:

startSession in class org.openqa.selenium.remote.RemoteWebDriver

isConnectionFine

public boolean isConnectionFine(java.lang.String command,
                                long maxDuration,
                                int timeoutWaitForComponent)
                         throws SeleniumPlusException

Test if the connection between WebDriver and the browser-driver is good enough to satisfy user's need.

Parameters:

command - String, the selenium driver command to use to test execution time

maxDuration - long, the maximum execution duration that user can accept

timeoutWaitForComponent - int, the original timeout to wait for a GUI component

Returns:

boolean true if the connection is good enough

Throws:

SeleniumPlusException - if the parameter command is null or empty

getExecutionTime

public long getExecutionTime(java.lang.String command,
                             int timeoutWaitForComponent)
                      throws SeleniumPlusException

Parameters:

command - String, the selenium driver command to use to test execution time

timeoutWaitForComponent - int, the original timeout to wait for a GUI component

Returns:

long, the time (in milliseconds) consumed by the command execution

Throws:

SeleniumPlusException - if the parameter command is null or empty

execute

protected org.openqa.selenium.remote.Response execute(java.lang.String driverCommand,
                                                      java.util.Map<java.lang.String,?> parameters)

Overrides:

execute in class org.openqa.selenium.remote.RemoteWebDriver

isNewSession

public static boolean isNewSession()

storeSessionIdToFile

public static void storeSessionIdToFile(java.lang.String serverHostname,
                                        java.lang.String Id,
                                        java.lang.String browserName,
                                        java.lang.String sessionid,
                                        org.openqa.selenium.Capabilities desiredCapabilities)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteSessionIdFromFile

public static void deleteSessionIdFromFile(java.lang.String Id)
                                    throws java.lang.Exception

Delete the session from the RemoteDriver file with the given Id. If the Id is also set as the LAST_SESSION, then the LAST_SESSION_KEY will also be removed showing the last or "current" session is uncertain.

Parameters:

Id -

Throws:

java.lang.Exception - if there is a problem reading or deleting the session info.

retrieveSessionInfoFromFile

public static RemoteDriver.SessionInfo retrieveSessionInfoFromFile(java.lang.String Id)
                                                            throws java.lang.Exception

Retrieve the remote server's session information for the session with the given id.

Parameters:

Id -

Returns:

SessionInfo or null if not found.

Throws:

java.lang.Exception

retriveSessionIdFromFile

public static java.lang.String retriveSessionIdFromFile(java.lang.String Id)
                                                 throws java.lang.Exception

Retrieve the remote server's session string for the session with the given id.

Parameters:

Id -

Returns:

Throws:

java.lang.Exception

setLastSessionId

public static void setLastSessionId(java.lang.String Id)
                             throws java.lang.Exception

Throws:

java.lang.Exception

retriveLastSessionInfoFromFile

public static RemoteDriver.SessionInfo retriveLastSessionInfoFromFile()
                                                               throws java.lang.Exception

Retrieve SessionInfo representing the "current" or "last" session

Returns:

SessionInfo -- can be null if there is no session running or stored.

Throws:

java.lang.Exception

getSessionsFromFile

public static java.util.List<RemoteDriver.SessionInfo> getSessionsFromFile()
                                                                    throws java.lang.Exception

Returns a List of SessionInfo objects.

Returns:

List --can be empty if no sessions and no Exception is thrown.

Throws:

java.lang.Exception - if the sessions are not retrievable (do not exist).

deleteSessionFile

public static void deleteSessionFile()

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> target)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Overrides:

getScreenshotAs in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException

executeScript

public java.lang.Object executeScript(java.lang.String script,
                                      java.lang.Object... args)

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

Overrides:

executeScript in class org.openqa.selenium.remote.RemoteWebDriver

main

public static void main(java.lang.String[] args)

This main method will start a Selenium Server (standalone, hub, or node). It will automatically detect the Java to use, which file to log messages for each browser, and what driver (IE CHROME) to be used to start with Selenium Server.

Parameters:

args - String[], it accepts following arguments:
"-port N", optional, the port number for Selenium Server. If not provided, the default port will be used. For "standalone" and "hub" the default port number is 4444; While for "node", it is 5555.
"SELENIUMSERVER_JVM_OPTIONS=JVM OPTIONS", optional, the JVM Options to start the Selenium Server
"-role TheServerRole", optional, if not provided, a standalone server will be launched.
TheServerRole could be "hub", and selenium server will be launched as a hub for other node to connect.
TheServerRole could be "node", and selenium server will be launched as a node to connect a hub. **Note** Hub's information must also be provided. Ex: -role node -hub http://hub.machine:port/grid/register
"-project ProjectLocationAbsDir", optional, the absolute directory holding the project to test; If not provided, use SeleniumPlus or SAFS installation directory as default. This parameter has higher priority than JVM parameter "-Dsafs.project.root".

Example:

• Start "selenium standalone server on port 4567 with JVM option -Xms512m -Xmx2g"
  java org.safs.selenium.webdriver.lib.RemoteDriver "-port 4567" "SELENIUMSERVER_JVM_OPTIONS=-Xms512m -Xmx2g"
  
• Start "selenium hub on port 4567 with JVM option -Xms512m -Xmx2g"
  java org.safs.selenium.webdriver.lib.RemoteDriver "-role hub" "-port 4567" "SELENIUMSERVER_JVM_OPTIONS=-Xms512m -Xmx2g"
  
• Start "selenium node" on port 5555 with JVM option -Xms512m -Xmx2g", and register it to hub.machine:4567
  java org.safs.selenium.webdriver.lib.RemoteDriver "-role node -hub http://hub.machine:4567/grid/register" "-port 5678" "SELENIUMSERVER_JVM_OPTIONS=-Xms512m -Xmx2g"
  

We can also provide the following JVM parameters.

• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_OPTIONS
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_Xms
• DriverConstant.SeleniumConfigConstant.SELENIUMSERVER_JVM_Xmx
• DriverConstant.PROPERTY_SAFS_PROJECT_ROOT

Example:

• -DSELENIUMSERVER_JVM_OPTIONS="-Xms256m -Xmx1g"
• -DSELENIUMSERVER_JVM_Xmx=4g
• -DSELENIUMSERVER_JVM_Xms=512m
• -Dsafs.project.root=d:\full_path\to\test_project