com.kulana.core.foundation.webdriver

Class DriverHelper

java.lang.Object

com.kulana.core.foundation.webdriver.DriverHelper

Direct Known Subclasses:

AbstractTest, AbstractUIObject, PerformanceTest

public class DriverHelper
extends java.lang.Object

Wrapper above standard Selenium WebDriver, implements additional complex methods for stable interaction with UI. Also it implements logging and screenshot capturing and crypto logic.

Author:

Alex Khursevich

Constructor Summary

Constructors

Constructor and Description
DriverHelper()
DriverHelper(org.openqa.selenium.WebDriver driver)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptAlert() Accepts alert modal.
void	assertElementPresent(ExtendedWebElement element) Asserts that element is found on UI.
void	assertElementPresent(ExtendedWebElement element, long timeout) Asserts that element is found on UI during specified timeout.
void	assertElementWithTextPresent(ExtendedWebElement element, java.lang.String text) Asserts that element with text is found on UI.
void	assertElementWithTextPresent(ExtendedWebElement element, java.lang.String text, long timeout) Asserts that element with text is found on UI during specified timeout.
void	attachFile(ExtendedWebElement element, java.lang.String filePath) Populates file path to specified file input.
void	cancelAlert() Cancels alert modal.
void	check(ExtendedWebElement checkbox) Checks check-box.
void	click(ExtendedWebElement element) Waits for element and click on it.
void	click(java.lang.String eName, org.openqa.selenium.WebElement element) Waits for element and click on it.
void	dragAndDrop(ExtendedWebElement from, ExtendedWebElement to) Drags one element and drops to another.
java.lang.String	getSelectedValue(ExtendedWebElement select) Returns selected value in select input.
java.util.List<java.lang.String>	getSelectedValues(ExtendedWebElement select) Returns selected values in multi-select input.
void	hover(ExtendedWebElement element) Hovers over element.
void	hover(java.lang.String eName, org.openqa.selenium.WebElement element) Hovers over element.
boolean	isChecked(ExtendedWebElement checkbox) Get check-box state.
boolean	isElementNotPresent(ExtendedWebElement element) Waits until element does not present on UI, max time = 'explicit_timeout' seconds.
boolean	isElementNotPresent(java.lang.String eName, org.openqa.selenium.By locator) Waits until element does not present on UI, max time = 'explicit_timeout' seconds.
boolean	isElementNotPresent(java.lang.String eName, org.openqa.selenium.WebElement element) Waits until element does not present on UI, max time = 'explicit_timeout' seconds.
boolean	isElementPresent(ExtendedWebElement element) Checks page HTML DOM model for element presence.
boolean	isElementPresent(ExtendedWebElement element, long timeout) Checks page HTML DOM model for element presence.
boolean	isElementPresent(java.lang.String eName, org.openqa.selenium.WebElement element) Checks page HTML DOM model for element presence.
boolean	isElementPresent(java.lang.String eName, org.openqa.selenium.WebElement element, long timeout) Checks page HTML DOM model for element presence.
boolean	isElementWithTextPresent(ExtendedWebElement element, java.lang.String text) Checks page HTML DOM model for element with text presence.
boolean	isElementWithTextPresent(ExtendedWebElement element, java.lang.String text, long timeout) Checks page HTML DOM model for element with text presence.
boolean	isPageOpened(AbstractPage page) Checks that page URL is opened.
boolean	isPageOpened(AbstractPage page, long timeout) Checks that page URL is opened during specified timeout.
boolean	isTitleAsExpected(java.lang.String expectedTitle) Checks that page title is as expected.
boolean	isTitleAsExpectedPattern(java.lang.String expectedPattern) Checks that page title conforms to expected regexp pattern.
boolean	isUrlAsExpected(java.lang.String expectedURL) Checks that current page URL is as expected.
void	navigateBack() Go back in browser.
void	openTab(java.lang.String url) Opens a new tab for the given URL
void	openURL(java.lang.String url) Opens URL in browser.
void	pause(long seconds) Pause for specified amount of seconds.
void	pressEnter(ExtendedWebElement element) Presses 'Enter' on specified element.
void	pressEnter(java.lang.String controlInfo, org.openqa.selenium.WebElement control) Presses 'Enter' on specified element.
void	pressTab() Presses 'Tab' button.
void	refresh() Refresh browser.
void	refresh(long timeout) Refresh browser after timeout.
void	scrollTo(ExtendedWebElement element) Scrolls to element.
boolean	select(ExtendedWebElement element, int index) Select by index in specified select input.
boolean	select(ExtendedWebElement select, java.lang.String text) Select by text in specified select input.
boolean	select(ExtendedWebElement select, java.lang.String[] values) Select multiple text values in specified select input.
void	select(java.lang.String sName, org.openqa.selenium.WebElement select, int index) Select by index in specified select input.
void	select(java.lang.String sName, org.openqa.selenium.WebElement select, java.lang.String selectText) Select by text in specified select input.
boolean	selectByMatcher(ExtendedWebElement select, org.hamcrest.BaseMatcher<java.lang.String> matcher) Select value by matcher in specified select input.
void	sendKeys(java.lang.String keys) Sends keys using Selenium Actions object.
void	setElementText(java.lang.String eName, java.lang.String text) Deprecated.
void	setElementText(java.lang.String eName, java.lang.String frame, java.lang.String id, java.lang.String text) Deprecated.
void	sielentAlert() Closes alert pop-up by JS.
void	slide(ExtendedWebElement slider, int moveX, int moveY) Moves slider by specified offset.
void	switchWindow() Switches browser window using Selenium windows handler.
java.lang.Object	trigger(java.lang.String script) Executes a script
void	trigger(java.lang.String script, org.openqa.selenium.WebElement element) Executes a script on an element
void	type(ExtendedWebElement element, java.lang.String text) Waits for element and types text into it.
void	type(java.lang.String eName, org.openqa.selenium.WebElement element, java.lang.String text) Waits for element and types text into it.
void	uncheck(ExtendedWebElement checkbox) Unchecks check-box.

Methods inherited from class java.lang.Object

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

Constructor Detail

DriverHelper

public DriverHelper()

DriverHelper

public DriverHelper(org.openqa.selenium.WebDriver driver)

Method Detail

isElementPresent

public boolean isElementPresent(ExtendedWebElement element)

Checks page HTML DOM model for element presence. It waits for element max time = 'explicit_timeout' seconds, retrying to find every 'retry_timeout' seconds.

Parameters:

element - ExtendedWebElement to find

Returns:

is element found on UI

isElementPresent

public boolean isElementPresent(java.lang.String eName,
                       org.openqa.selenium.WebElement element)

Checks page HTML DOM model for element presence. It waits for element max time = 'explicit_timeout' seconds, retrying to find every 'retry_timeout' seconds.

Parameters:

element - WebElement to find

eName - element name for better logging

Returns:

is element found on UI

isElementPresent

public boolean isElementPresent(ExtendedWebElement element,
                       long timeout)

Checks page HTML DOM model for element presence. It waits for element max time = 'maxWait' seconds (as method argument), retrying to find every 'retry_timeout' seconds.

Parameters:

element - ExtendedWebElement to find

timeout - max time to wait

Returns:

is element found on UI

isElementPresent

public boolean isElementPresent(java.lang.String eName,
                       org.openqa.selenium.WebElement element,
                       long timeout)

Checks page HTML DOM model for element presence. It waits for element max time = 'maxWait' seconds (as method argument), retrying to find every 'retry_timeout' seconds.

Parameters:

element - WebElement to find

eName - element name for better logging

timeout - max time to wait

Returns:

is element found on UI

isElementWithTextPresent

public boolean isElementWithTextPresent(ExtendedWebElement element,
                               java.lang.String text)

Checks page HTML DOM model for element with text presence. It waits for element with text max time = 'explicit_timeout' seconds, retrying to find every 'retry_timeout' seconds.

Parameters:

element - ExtendedWebElement to find

text - expected text that should contain the element

Returns:

is element found on UI

isElementWithTextPresent

public boolean isElementWithTextPresent(ExtendedWebElement element,
                               java.lang.String text,
                               long timeout)

Checks page HTML DOM model for element with text presence. It waits for element with text max time = 'maxWait' seconds (as method argument), retrying to find every 'retry_timeout' seconds.

Parameters:

element - ExtendedWebElement to find

text - expected text that should contain the element

timeout - max time to wait

Returns:

is element found on UI

isElementNotPresent

public boolean isElementNotPresent(ExtendedWebElement element)

Waits until element does not present on UI, max time = 'explicit_timeout' seconds.

Parameters:

element - ExtendedWebElement to disappear

Returns:

is element not found on UI

isElementNotPresent

public boolean isElementNotPresent(java.lang.String eName,
                          org.openqa.selenium.WebElement element)

Waits until element does not present on UI, max time = 'explicit_timeout' seconds.

Parameters:

element - WebElement to disappear

eName - element name for better logging

Returns:

is element not found on UI

isElementNotPresent

public boolean isElementNotPresent(java.lang.String eName,
                          org.openqa.selenium.By locator)

Waits until element does not present on UI, max time = 'explicit_timeout' seconds.

Parameters:

eName - element name for better logging

locator - By element locator

Returns:

is element not found on UI

type

public void type(ExtendedWebElement element,
        java.lang.String text)

Waits for element and types text into it.

Parameters:

element - ExtendedWebElement for text population

text - value to type

type

public void type(java.lang.String eName,
        org.openqa.selenium.WebElement element,
        java.lang.String text)

Waits for element and types text into it.

Parameters:

element - WebElement for text population

eName - element name for better logging

text - value to type

click

public void click(ExtendedWebElement element)

Waits for element and click on it.

Parameters:

element - ExtendedWebElement to click at

click

public void click(java.lang.String eName,
         org.openqa.selenium.WebElement element)

Waits for element and click on it.

Parameters:

eName - element name for better logging

element - WebElement to click at

pressEnter

public void pressEnter(ExtendedWebElement element)

Presses 'Enter' on specified element.

Parameters:

element - to click at

pressEnter

public void pressEnter(java.lang.String controlInfo,
              org.openqa.selenium.WebElement control)

Presses 'Enter' on specified element.

Parameters:

eName - element name for better logging

element - WebElement to click at.

check

public void check(ExtendedWebElement checkbox)

Checks check-box.

Parameters:

checkbox - ExtendedWebElement to check

uncheck

public void uncheck(ExtendedWebElement checkbox)

Unchecks check-box.

Parameters:

checkbox - ExtendedWebElement to uncheck

isChecked

public boolean isChecked(ExtendedWebElement checkbox)

Get check-box state.

Parameters:

checkbox - ExtendedWebElement to test

Returns:

current state

attachFile

public void attachFile(ExtendedWebElement element,
              java.lang.String filePath)

Populates file path to specified file input.

Parameters:

element - ExtendedWebElement file input

filePath - file path to attach

openURL

public void openURL(java.lang.String url)

Opens URL in browser.

Parameters:

url - URL to open

isUrlAsExpected

public boolean isUrlAsExpected(java.lang.String expectedURL)

Checks that current page URL is as expected.

Parameters:

expectedURL - control URL

Returns:

is URL valid

pause

public void pause(long seconds)

Pause for specified amount of seconds.

Parameters:

seconds - timeout length

isTitleAsExpected

public boolean isTitleAsExpected(java.lang.String expectedTitle)

Checks that page title is as expected.

Parameters:

expectedTitle - control title

Returns:

is title valid

isTitleAsExpectedPattern

public boolean isTitleAsExpectedPattern(java.lang.String expectedPattern)

Checks that page title conforms to expected regexp pattern.

Parameters:

expectedPattern - regexp title pattern

Returns:

is title valid

navigateBack

public void navigateBack()

Go back in browser.

refresh

public void refresh()

Refresh browser.

refresh

public void refresh(long timeout)

Refresh browser after timeout.

Parameters:

timeout - before refresh

select

public boolean select(ExtendedWebElement select,
             java.lang.String text)

Select by text in specified select input.

Parameters:

select - ExtendedWebElement select input

text - to select

Returns:

if text is selected

select

public boolean select(ExtendedWebElement select,
             java.lang.String[] values)

Select multiple text values in specified select input.

Parameters:

select - ExtendedWebElement select input

values - text values to select

Returns:

if text is selected

selectByMatcher

public boolean selectByMatcher(ExtendedWebElement select,
                      org.hamcrest.BaseMatcher<java.lang.String> matcher)

Select value by matcher in specified select input.

Parameters:

select - ExtendedWebElement select input

values - text values to select

Returns:

if text is selected

select

public void select(java.lang.String sName,
          org.openqa.selenium.WebElement select,
          java.lang.String selectText)

Select by text in specified select input.

Parameters:

sName - select name

element - WebElement select input

text - value to select

select

public boolean select(ExtendedWebElement element,
             int index)

Select by index in specified select input.

Parameters:

select - ExtendedWebElement select input

index - index to select

Returns:

if text is selected

select

public void select(java.lang.String sName,
          org.openqa.selenium.WebElement select,
          int index)

Select by index in specified select input.

Parameters:

sName - select name

element - WebElement select input

index - index to select

hover

public void hover(ExtendedWebElement element)

Hovers over element.

Parameters:

element - ExtendedWebElement to hover over

getSelectedValue

public java.lang.String getSelectedValue(ExtendedWebElement select)

Returns selected value in select input.

Parameters:

select - ExtendedWebElement select input

Returns:

selected value

getSelectedValues

public java.util.List<java.lang.String> getSelectedValues(ExtendedWebElement select)

Returns selected values in multi-select input.

Parameters:

select - ExtendedWebElement select input

Returns:

selected values

hover

public void hover(java.lang.String eName,
         org.openqa.selenium.WebElement element)

Hovers over element.

Parameters:

eName - element name for better logging

element - WebElement to hover over

scrollTo

public void scrollTo(ExtendedWebElement element)

Scrolls to element.

Parameters:

element - ExtendedWebElement to scroll to

pressTab

public void pressTab()

Presses 'Tab' button.

sendKeys

public void sendKeys(java.lang.String keys)

Sends keys using Selenium Actions object.

Parameters:

keys - string value to send

sielentAlert

public void sielentAlert()

Closes alert pop-up by JS.

acceptAlert

public void acceptAlert()

Accepts alert modal.

cancelAlert

public void cancelAlert()

Cancels alert modal.

dragAndDrop

public void dragAndDrop(ExtendedWebElement from,
               ExtendedWebElement to)

Drags one element and drops to another.

Parameters:

from - ExtendedWebElement to drag

to - ExtendedWebElement to drop to

slide

public void slide(ExtendedWebElement slider,
         int moveX,
         int moveY)

Moves slider by specified offset.

Parameters:

slider - ExtendedWebElement as slider to move

moveX - X offset

moveY - Y offset

setElementText

@Deprecated
public void setElementText(java.lang.String eName,
                             java.lang.String frame,
                             java.lang.String id,
                             java.lang.String text)

Deprecated.

setElementText

@Deprecated
public void setElementText(java.lang.String eName,
                             java.lang.String text)

Deprecated.

isPageOpened

public boolean isPageOpened(AbstractPage page)

Checks that page URL is opened.

Parameters:

page - to check

Returns:

if page URL is opened

isPageOpened

public boolean isPageOpened(AbstractPage page,
                   long timeout)

Checks that page URL is opened during specified timeout.

Parameters:

page - to check

timeout - max time to wait

Returns:

if page URL is opened

trigger

public void trigger(java.lang.String script,
           org.openqa.selenium.WebElement element)

Executes a script on an element

Parameters:

script - the script to execute

element - the target of the script, referenced as arguments[0]

trigger

public java.lang.Object trigger(java.lang.String script)

Executes a script

Parameters:

script - the script to execute

openTab

public void openTab(java.lang.String url)

Opens a new tab for the given URL

Parameters:

url - URL to open in new tab

Throws:

net.sourceforge.htmlunit.corejs.javascript.JavaScriptException - if unable to open tab

switchWindow

public void switchWindow()
                  throws org.openqa.selenium.NoSuchWindowException

Switches browser window using Selenium windows handler.

Throws:

org.openqa.selenium.NoSuchWindowException - if window is not found

assertElementPresent

public void assertElementPresent(ExtendedWebElement element)

Asserts that element is found on UI.

Parameters:

element - to find on UI

assertElementPresent

public void assertElementPresent(ExtendedWebElement element,
                        long timeout)

Asserts that element is found on UI during specified timeout.

Parameters:

element - to find on UI

timeout - max time to wait

assertElementWithTextPresent

public void assertElementWithTextPresent(ExtendedWebElement element,
                                java.lang.String text)

Asserts that element with text is found on UI.

Parameters:

element - to find on UI

text - that element should contain

assertElementWithTextPresent

public void assertElementWithTextPresent(ExtendedWebElement element,
                                java.lang.String text,
                                long timeout)

Asserts that element with text is found on UI during specified timeout.

Parameters:

element - to find on UI

text - that element should contain

timeout - max time to wait