com.github.bordertech.wcomponents.test.selenium

Class SeleniumWComponentsUtil

java.lang.Object

com.github.bordertech.wcomponents.test.selenium.SeleniumWComponentsUtil

public final class SeleniumWComponentsUtil
extends Object

Utility class containing convenience methods for testing WComponents with Selenium.

Logic has been extracted into this utility class for any consumers who cannot extend WComponentSeleniumTestCase due to a different test class hierarchy.

Since:

1.2.0

Author:

Joshua Barclay, Mark Reeves, Jonathan Austin

Method Summary

Modifier and Type	Method and Description
static void	configureDriver(org.openqa.selenium.WebDriver driver) Configure the WebDriver with the standard WComponents configuration.
static void	configureImmediateImplicitWait(org.openqa.selenium.WebDriver driver) Configure the WebDriver implicit wait for immediate find.
static void	configureImplicitWait(org.openqa.selenium.WebDriver driver) Configure the WebDriver implicit wait.
static void	configureImplicitWait(org.openqa.selenium.WebDriver driver, long time, TimeUnit unit) Configure the WebDriver implicit wait.
static org.openqa.selenium.WebElement	findElementImmediateForDriver(org.openqa.selenium.WebDriver driver, org.openqa.selenium.By by) Find immediately the first element via the driver using the given method.
static org.openqa.selenium.WebElement	findElementImmediateForElement(org.openqa.selenium.WebElement element, org.openqa.selenium.By by) Find immediately the first element via the passed in element and given method.
static List<org.openqa.selenium.WebElement>	findElementsImmediateForDriver(org.openqa.selenium.WebDriver driver, org.openqa.selenium.By by) Find immediately the elements via the driver using the given method.
static List<org.openqa.selenium.WebElement>	findElementsImmediateForElement(org.openqa.selenium.WebElement element, org.openqa.selenium.By by) Find immediately the elements via the passed in element and given method.
static SeleniumWDialogWebElement	getDialog(org.openqa.selenium.WebDriver driver) Get the screen's dialog, whether it is open or not.
static org.openqa.selenium.support.ui.ExpectedCondition<Boolean>	getPageReadyCondition() Get the ExpectedCondition for waiting for the WComponents page to be ready.
static boolean	isOpenDialog(org.openqa.selenium.WebDriver driver) Is there an open dialog on the screen?
static void	waitForPageReady(org.openqa.selenium.WebDriver driver) Wait for the page to have loaded, including all AJAX and JavaScript.
static void	waitForPageReady(org.openqa.selenium.WebDriver driver, int timeoutSeconds, long pollingMilliseconds) Wait for the page to have loaded, including all AJAX and JavaScript.
static SeleniumWComponentInputWebElement	wrapInputElementWithTypedWebElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element) Analyze the input element and attempt to wrap it in the appropriate component-specific subclass.

Methods inherited from class java.lang.Object

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

Method Detail

configureDriver

public static void configureDriver(org.openqa.selenium.WebDriver driver)

Configure the WebDriver with the standard WComponents configuration.

Parameters:

driver - the WebDriver to configure.

configureImplicitWait

public static void configureImplicitWait(org.openqa.selenium.WebDriver driver)

Configure the WebDriver implicit wait.

Parameters:

driver - the WebDriver to configure.

configureImmediateImplicitWait

public static void configureImmediateImplicitWait(org.openqa.selenium.WebDriver driver)

Configure the WebDriver implicit wait for immediate find.

Parameters:

driver - the WebDriver to configure.

configureImplicitWait

public static void configureImplicitWait(org.openqa.selenium.WebDriver driver,
                                         long time,
                                         TimeUnit unit)

Configure the WebDriver implicit wait.

Parameters:

driver - the WebDriver to configure.

time - the amount of time to wait.

unit - the unit of measure for time.

waitForPageReady

public static void waitForPageReady(org.openqa.selenium.WebDriver driver)

Wait for the page to have loaded, including all AJAX and JavaScript. Uses default values for timeout and polling interval.

Parameters:

driver - the WebDriver.

waitForPageReady

public static void waitForPageReady(org.openqa.selenium.WebDriver driver,
                                    int timeoutSeconds,
                                    long pollingMilliseconds)

Wait for the page to have loaded, including all AJAX and JavaScript.

Parameters:

driver - the WebDriver.

timeoutSeconds - - the number of seconds after which the 'wait' will time out.

pollingMilliseconds - - the number of milliseconds to wait between each poll attempt.

isOpenDialog

public static boolean isOpenDialog(org.openqa.selenium.WebDriver driver)

Is there an open dialog on the screen?

Parameters:

driver - the WebDriver.

Returns:

true if an open dialog exists, else false.

getDialog

public static SeleniumWDialogWebElement getDialog(org.openqa.selenium.WebDriver driver)

Get the screen's dialog, whether it is open or not.

Parameters:

driver - the WebDriver.

Returns:

a WDialogWebElement for the dialog.

getPageReadyCondition

public static org.openqa.selenium.support.ui.ExpectedCondition<Boolean> getPageReadyCondition()

Get the ExpectedCondition for waiting for the WComponents page to be ready.

Returns:

the WaitCondition for page ready.

wrapInputElementWithTypedWebElement

public static SeleniumWComponentInputWebElement wrapInputElementWithTypedWebElement(org.openqa.selenium.WebDriver driver,
                                                                                    org.openqa.selenium.WebElement element)

Analyze the input element and attempt to wrap it in the appropriate component-specific subclass. If not component specific subclass can be identified then the element will be wrapped in a SeleniumWComponentWebElement.

Parameters:

driver - the WebDriver.

element - the default Selenium WebElement.

Returns:

a subtype of SeleniumWComponentWebElement specific to the element type.

findElementImmediateForDriver

public static org.openqa.selenium.WebElement findElementImmediateForDriver(org.openqa.selenium.WebDriver driver,
                                                                           org.openqa.selenium.By by)

Find immediately the first element via the driver using the given method.

Parameters:

driver - the web driver

by - the by condition

Returns:

the web element

findElementsImmediateForDriver

public static List<org.openqa.selenium.WebElement> findElementsImmediateForDriver(org.openqa.selenium.WebDriver driver,
                                                                                  org.openqa.selenium.By by)

Find immediately the elements via the driver using the given method.

Parameters:

driver - the web driver

by - the by condition

Returns:

the web element

findElementImmediateForElement

public static org.openqa.selenium.WebElement findElementImmediateForElement(org.openqa.selenium.WebElement element,
                                                                            org.openqa.selenium.By by)

Find immediately the first element via the passed in element and given method.

Parameters:

element - the web driver

by - the by condition

Returns:

the web element

findElementsImmediateForElement

public static List<org.openqa.selenium.WebElement> findElementsImmediateForElement(org.openqa.selenium.WebElement element,
                                                                                   org.openqa.selenium.By by)

Find immediately the elements via the passed in element and given method.

Parameters:

element - the web driver

by - the by condition

Returns:

the web element