Package com.facilita.fc.selenium

Class SeleniumVirtualUser

java.lang.Object

com.facilita.fc.runtime.VirtualUser

com.facilita.fc.selenium.SeleniumVirtualUser

All Implemented Interfaces:

com.facilita.fc.runtime.Commands, DataDictionary, com.facilita.fc.runtime.IMonitoredVU, SeleniumVirtualUserInterface, java.lang.Runnable

public class SeleniumVirtualUser
extends VirtualUser
implements SeleniumVirtualUserInterface

A Selenium Virtual User.

Each Selenium Virtual User provides access to a single WebDriver instance. The WebDriver instance could drive a real browser (e.g. Firefox, Internet Explorer, Chrome), or the headless HtmlUnit browser.

The user can set the type of WebDriver by calling initialiseWebDriver(WebDriverType)

Field Summary

Fields inherited from interface com.facilita.fc.runtime.Commands

ABORT_CMD, cmds, END_CMD, NULL_CMD, RESUME_CMD, SUSPEND_CMD, TERMINATE_CMD

Constructor Summary

Constructors

Constructor	Description
SeleniumVirtualUser()

Method Summary

Modifier and Type	Method	Description
JavascriptExecutor	getJavascriptExecutor()	Get a JavascriptExecutor for this SeleniumVirtualUser
WebDriver	getUnderlyingWebDriver()	Get the underlying WebDriver instance for this SeleniumVirtualUser.
WebDriver	getWebDriver()	Get the WebDriver instance for this SeleniumVirtualUser.
void	initialiseChromeDriver(java.lang.String pathToChromeDriver)	Create a new ChromeDriver instance for this SeleniumVirtualUser.
void	initialiseFirefoxDriver()	Create a new FirefoxDriver instance for this SeleniumVirtualUser.
void	initialiseHtmlUnitDriver()	Create a new HtmlUnitDriver instance for this SeleniumVirtualUser.
void	initialiseHtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion browserVersion)	Create a new HtmlUnitDriver instance for this SeleniumVirtualUser, impersonating the BrowserVersion specified.
void	initialiseInternetExplorerDriver(java.lang.String pathToIEDriverServer)	Create a new InternetExplorerDriver instance for this SeleniumVirtualUser.
void	initialisePhantomJSDriver(java.lang.String pathToPhantomJSExe)	Create a new PhantomJSDriver instance for this SeleniumVirtualUser.
void	initialiseWebDriver(WebDriverType driverType)	Create a new WebDriver instance for this SeleniumVirtualUser.
void	initialiseWebDriver(WebDriver driver)	Create a new WebDriver instance for this SeleniumVirtualUser.
protected void	post()	This method is called after all scripts have finished executing.
void	pre()	This method is called before any scripts are executed.

Methods inherited from class com.facilita.fc.runtime.VirtualUser

add, atEndOfIteration, atStartOfIteration, attachLogMessageSender, clearProgressPoint, createBackgroundScript, createMonitorSnapshot, endRequest, endRequest, endRequest, endTiming, endTiming, endTiming, endTransaction, endTransaction, endTransaction, endTransaction, error, error, error, error, error, executeCommand, executeCommand, exitVU, exitVU, exitVU, fail, failAction, failTiming, failTiming, failTransaction, failTransaction, failTransaction, finalSequence, finishIterating, finishIteratingRequested, flushEventLog, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, formatDateTime, get, get, getBackgroundScriptIDs, getBackgroundScriptStatus, getBoolean, getBoolean, getContextState, getCurrentIteration, getCurrentScript, getCurrentTimeInXml, getCurrentTransaction, getDataDictionary, getDataDictionary, getDataPath, getDataTable, getDouble, getDouble, getElapsedTime, getFilesDataPath, getFloat, getFloat, getGroupSize, getGroupSize, getGroupSizes, getIndex, getIndexForEngineGroup, getInitialDelay, getInjectorFamilyName, getInjectorName, getInt, getInt, getInteger, getInteger, getIteration, getIterationDelay, getIterationForTime, getJmeterTestPlanName, getLastError, getLastTransaction, getList, getList, getLong, getLong, getMap, getMaxFailures, getMillisecondsSinceEpoch, getMillisecondsSinceEpoch, getName, getNumberOfErrors, getNumberOfFailures, getNumberOfIterations, getNumberOfWarmupIterations, getNumberOfWarnings, getPauseFactor, getProgressPoint, getRunPath, getSandboxPath, getSecondsSinceEpoch, getSecondsSinceEpoch, getService, getServices, getStartTime, getStartTimeSeconds, getString, getString, getTimingElapsedTime, getTimingElapsedTime, getTransactionData, getTransactionElapsedTime, getTransactionElapsedTime, getTransactionElapsedTime, getTransactionLoggingOn, getUniqueID, getUniqueID, getVUName, hasKey, isDebugMode, isFinalScript, isFirstScript, isInitialScript, isIteratedScript, isLastIteration, isPacing, isReadOnly, keys, lastIterationDelay, logCurrentDataValues, nextIteration, nextScript, nextSequence, nowSeconds, onDataDictionaryChanged, onEndTiming, onEndTransaction, onError, onException, onExitVU, onRaiseAlert, onResumeTransaction, onSetProgressPoint, onStartFinalSection, onStartInitialSection, onStartTiming, onStartTransaction, onSuspendTransaction, onWarn, onWriteMessage, openEventLog, pause, pause, pause, pause, raiseAlert, recordMetric, recordMetric, recordMetrics, recordMetrics, recordTransaction, recordTransaction, recordTransaction, recordTransaction, recordTransaction, recordTransaction, requestToStopBackgroundScript, resumeBackgroundScript, resumeTransaction, resumeTransaction, resumeTransaction, run, runAsBackgroundThread, selectRandomEntryFromList, set, setBoolean, setDebugMode, setDouble, setFloat, setInt, setInteger, setList, setLong, setName, setNumberOfWarmupIterations, setPauseFactor, setProgressPoint, setProgressPoint, setProgressPoint, setProgressPoint, setString, setSynchronizationPoint, setTransactionLoggingOn, setup, startBackgroundScript, startCustomVUWatcher, startRequest, startRequest, startTiming, startTransaction, startTransaction, startTransaction, stopBackgroundScriptImmediately, stopCustomVUWatcher, suspendBackgroundScript, suspendTransaction, suspendTransaction, suspendTransaction, timeToPause, toString, unsetSynchronizationPoint, verify, verifyEQ, verifyEQ, verifyEQ, verifyEQ, verifyLE, verifyLE, verifyLE, verifyLE, verifyLT, verifyLT, verifyLT, verifyLT, waitFor, waitForBackgroundScriptToFinish, waitForBoolean, waitForDouble, waitForFloat, waitForInt, waitForList, waitForLong, waitForString, waitForSynchronizationPoint, warn, warn, warn, warn, writeMessage, writeMessage, writeMessage, writeMessage, writeSystemLog, writeSystemLog

Methods inherited from class java.lang.Object

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

Constructor Detail

SeleniumVirtualUser

public SeleniumVirtualUser()

Method Detail

pre

public void pre()
         throws java.lang.Exception

Description copied from class: VirtualUser

This method is called before any scripts are executed.

Override this method in your custom Virtual User if you have code which should be run only once, before any scripts are executed.

This method initialises logging systems. If you override this method in a custom Virtual User, then a call to super.pre() must be made and must occur before any code that may cause an exception or write to a log.

Overrides:

pre in class VirtualUser

Throws:

java.lang.Exception - An error occurred

post

protected void post()
             throws java.lang.Exception

Description copied from class: VirtualUser

This method is called after all scripts have finished executing.

Override this method in your custom Virtual User if you have code which should be run only once, after all scripts have finished executing.

This method shuts down logging systems. If you override this method in a custom Virtual User, then a call to super.post() must be made at the end of the method. All exceptions thrown during the execution of this method must be caught and handled.

Overrides:

post in class VirtualUser

Throws:

java.lang.Exception - An error occurred

initialiseHtmlUnitDriver

public void initialiseHtmlUnitDriver()
                              throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new HtmlUnitDriver instance for this SeleniumVirtualUser.

The HtmlUnitDriver will be set to use the default BrowserVersion. If you need to impersonate a different BrowserVersion then you can call SeleniumVirtualUserInterface.initialiseHtmlUnitDriver(BrowserVersion) instead.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialiseHtmlUnitDriver in interface SeleniumVirtualUserInterface

Throws:

java.lang.Exception - An error occurred

initialiseHtmlUnitDriver

public void initialiseHtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion browserVersion)
                              throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new HtmlUnitDriver instance for this SeleniumVirtualUser, impersonating the BrowserVersion specified.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialiseHtmlUnitDriver in interface SeleniumVirtualUserInterface

Parameters:

browserVersion - The BrowserVersion to impersonate.

Throws:

java.lang.Exception - An error occurred

initialiseFirefoxDriver

public void initialiseFirefoxDriver()
                             throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new FirefoxDriver instance for this SeleniumVirtualUser.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialiseFirefoxDriver in interface SeleniumVirtualUserInterface

Throws:

java.lang.Exception - An error occurred

initialiseInternetExplorerDriver

public void initialiseInternetExplorerDriver(java.lang.String pathToIEDriverServer)
                                      throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new InternetExplorerDriver instance for this SeleniumVirtualUser.

In order to use the InternetExplorerDriver, you need to install the IE driver server (IEDriverServer.exe) on each injector in your test. You must then pass the full path of the driver server to this method, e.g:

 initialiseInternetExplorerDriver("C:/tools/SeleniumDrivers/IEDriverServer.exe");
 

For more information on setting up the IE driver server, please refer to the documentation on the selenium website.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialiseInternetExplorerDriver in interface SeleniumVirtualUserInterface

Parameters:

pathToIEDriverServer - The full path to the IE driver server on the injector.

Throws:

java.lang.Exception - An error occurred

initialiseChromeDriver

public void initialiseChromeDriver(java.lang.String pathToChromeDriver)
                            throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new ChromeDriver instance for this SeleniumVirtualUser.

In order to use the ChromeDriver, you need to install the chrome driver server (chromedriver.exe) on each injector in your test. You must then pass the full path of the driver server to this method, e.g:

 initialiseChromeDriver("C:/tools/SeleniumDrivers/chromedriver.exe");
 

For more information on setting up the chrome driver server, please refer to the documentation on the selenium website.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialiseChromeDriver in interface SeleniumVirtualUserInterface

Parameters:

pathToChromeDriver - The full path to the chrome driver server on the injector.

Throws:

java.lang.Exception - An error occurred

initialisePhantomJSDriver

public void initialisePhantomJSDriver(java.lang.String pathToPhantomJSExe)
                               throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new PhantomJSDriver instance for this SeleniumVirtualUser.

In order to use the PhantomJSDriver, you need to install the PhantomJS on each injector in your test. You must then pass the full path of phantomjs.exe to this method, e.g:

 initialisePhantomJSDriver("C:/tools/phantomjs-1.9.7-windows/phantomjs.exe");
 

For more information on PhantomJS, please refer to the PhantomJS website.

Typically, this method is called from the VirtualUser.pre() method.

Specified by:

initialisePhantomJSDriver in interface SeleniumVirtualUserInterface

Parameters:

pathToPhantomJSExe - The full path of phantomjs.exe

Throws:

java.lang.Exception - An error occurred

initialiseWebDriver

public void initialiseWebDriver(WebDriver driver)
                         throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new WebDriver instance for this SeleniumVirtualUser.

This method provides a way to alter the type of WebDriver for this Virtual User.

Specified by:

initialiseWebDriver in interface SeleniumVirtualUserInterface

Parameters:

driver - The type of WebDriver to be used by this Virtual User

Throws:

java.lang.Exception - An error occurred

initialiseWebDriver

public void initialiseWebDriver(WebDriverType driverType)
                         throws java.lang.Exception

Description copied from interface: SeleniumVirtualUserInterface

Create a new WebDriver instance for this SeleniumVirtualUser.

This method provides a way to alter the type of WebDriver for this Virtual User. Valid driver types are as follows:

• HtmlUnit
• FireFox
• Chrome
• InternetExplorer
• PhantomJS

e.g.

 // Create a new FirefoxDriver for this Virtual User 
 initialiseWebDriver(WebDriverType.FireFox);
 

Specified by:

initialiseWebDriver in interface SeleniumVirtualUserInterface

Parameters:

driverType - The web driver type to create

Throws:

java.lang.Exception - An error occurred

getWebDriver

public WebDriver getWebDriver()

Description copied from interface: SeleniumVirtualUserInterface

Get the WebDriver instance for this SeleniumVirtualUser.

Specified by:

getWebDriver in interface SeleniumVirtualUserInterface

Returns:

The WebDriver instance for this SeleniumVirtualUser.

getJavascriptExecutor

public JavascriptExecutor getJavascriptExecutor()

Description copied from interface: SeleniumVirtualUserInterface

Get a JavascriptExecutor for this SeleniumVirtualUser

Specified by:

getJavascriptExecutor in interface SeleniumVirtualUserInterface

Returns:

A JavascriptExecutor for this SeleniumVirtualUser

getUnderlyingWebDriver

public WebDriver getUnderlyingWebDriver()

Description copied from interface: SeleniumVirtualUserInterface

Get the underlying WebDriver instance for this SeleniumVirtualUser.

This is useful if you need to call a method that is specific to the WebDriver type that you are using. For example, if you are using the HtmlUnitDriver, you could use this method to call the setJavascriptEnabled method:

 HtmlUnitDriver htmlUnitDriver = (HtmlUnitDriver)getUnderlyingWebDriver();
 htmlUnitDriver.setJavascriptEnabled(false);
 

Specified by:

getUnderlyingWebDriver in interface SeleniumVirtualUserInterface

Returns:

The underlying WebDriver instance for this SeleniumVirtualUser.