com.github.andreptb.fitnesse.selenium

Class WebDriverHelper

java.lang.Object

com.github.andreptb.fitnesse.selenium.WebDriverHelper

public class WebDriverHelper
extends Object

Utility class that wraps WebDriver instances. Each connect(String, String, String) call will associate a working instance of WebDriver and will be used until quit() is used or another connect(String, String, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebDriverHelper.StopTestWithWebDriverException Exception class so test can be stopped.

Constructor Summary

Constructors

Constructor and Description
WebDriverHelper()

Method Summary

Modifier and Type	Method and Description
ByWebElement	addCachedElement(org.openqa.selenium.WebElement element)
void	clearCacheElements()
void	connect(String browser, String capabilities, String preferences) Creates a WebDriver instance with desired browser and capabilities.
boolean	doWhenAvailable(String from, BiConsumer<org.openqa.selenium.WebDriver,SeleniumLocatorParser.WebElementSelector> callback)
org.openqa.selenium.WebElement	getCachedElement(String aId)
String	getDryRunWindow()
long	getLastActionDurationInSeconds()
boolean	getStopTestOnFirstFailure()
boolean	getTakeScreenshotOnFailure()
int	getTimeoutInSeconds()
String	getWhenAvailable(String from, BiFunction<org.openqa.selenium.WebDriver,SeleniumLocatorParser.WebElementSelector,String> callback) Core function designed to provide callbacks with selenium context necessary to evaluate commands.
boolean	isBrowserAvailable()
void	quit() Quietly quits the current browser instance
void	setDryRunWindow(String dryRunWindow)
void	setStopTestOnFirstFailure(boolean stopTestOnFirstFailure)
void	setTakeScreenshotOnFailure(boolean takeScreenshotOnFailure)
void	setTimeoutInSeconds(int timeoutInSeconds)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDriverHelper

public WebDriverHelper()

Method Detail

connect

public void connect(String browser,
                    String capabilities,
                    String preferences)
             throws ReflectiveOperationException,
                    IOException

Creates a WebDriver instance with desired browser and capabilities. Capabilities should follow a key/value format

Parameters:

browser - to be initialized. Can be a remote driver URL

capabilities - string. Should follow a key/value format

preferences - string. Should follow a key/value format

Throws:

ReflectiveOperationException - if remote driver class cannot be instantiated

IOException - if IO error occurs if invalid URL is used when connecting to remote drivers

See Also:

WebDriverCapabilitiesHelper.parse(String, String, String)

quit

public void quit()

Quietly quits the current browser instance

doWhenAvailable

public boolean doWhenAvailable(String from,
                               BiConsumer<org.openqa.selenium.WebDriver,SeleniumLocatorParser.WebElementSelector> callback)

getWhenAvailable

public String getWhenAvailable(String from,
                               BiFunction<org.openqa.selenium.WebDriver,SeleniumLocatorParser.WebElementSelector,String> callback)

Core function designed to provide callbacks with selenium context necessary to evaluate commands. Applies the following rules:

• Builds the context and passes the control to the callback (see SeleniumLocatorParser.parse(String))
• If the callback is unable to find a WebElement to run commmands, or fails for any other reason, the callback will be reinvoked until a positive return happens or getTimeoutInSeconds() is reached
• If the callback returns positively and the result don't match with SeleniumLocatorParser.WebElementSelector.getExpectedValue(), the callback will be reinvoked until the value matches or getTimeoutInSeconds() is reached
• If the callback returns positively and the result match with SeleniumLocatorParser.WebElementSelector.getExpectedValue() (or SeleniumLocatorParser.WebElementSelector.getExpectedValue() is empty), the result will be returned

Parameters:

from - selenium selector received by the fixture@param from

callback - The callback to be invoked with SeleniumLocatorParser.WebElementSelector and WebDriver

Returns:

the value returned from the callback

Throws:

WebDriverHelper.StopTestWithWebDriverException - if isBrowserAvailable() returns false or if getStopTestOnFirstFailure() is true and any failure occurs

isBrowserAvailable

public boolean isBrowserAvailable()

Returns:

if browser is available and can be used

setTimeoutInSeconds

public void setTimeoutInSeconds(int timeoutInSeconds)

Parameters:

timeoutInSeconds - Timeout to wait for elements to be present. Default is 20 seconds

getTimeoutInSeconds

public int getTimeoutInSeconds()

Returns:

Timeout to wait for elements to be present. Default is 20 seconds

setStopTestOnFirstFailure

public void setStopTestOnFirstFailure(boolean stopTestOnFirstFailure)

Parameters:

stopTestOnFirstFailure - If true, if any error occurs while running selenium actions, test will be stopped.

getStopTestOnFirstFailure

public boolean getStopTestOnFirstFailure()

getLastActionDurationInSeconds

public long getLastActionDurationInSeconds()

Returns:

Seconds the last action took to complete

getTakeScreenshotOnFailure

public boolean getTakeScreenshotOnFailure()

setTakeScreenshotOnFailure

public void setTakeScreenshotOnFailure(boolean takeScreenshotOnFailure)

Parameters:

takeScreenshotOnFailure - If true, will embed exceptions with screenshot data (if available). Default is true

getDryRunWindow

public String getDryRunWindow()

setDryRunWindow

public void setDryRunWindow(String dryRunWindow)

clearCacheElements

public void clearCacheElements()

addCachedElement

public ByWebElement addCachedElement(org.openqa.selenium.WebElement element)

getCachedElement

public org.openqa.selenium.WebElement getCachedElement(String aId)