net.sourceforge.jbizmo.commons.selenium.page

Class AbstractPageComponent

java.lang.Object

net.sourceforge.jbizmo.commons.selenium.page.AbstractPageComponent

Direct Known Subclasses:

AbstractPrimefacesPageComponent, AbstractVaadinPageComponent

public abstract class AbstractPageComponent
extends Object

Abstract base class for all page object components

Copyright 2017 (C) by Martin Ganserer

Version:

1.0.0

Author:

Martin Ganserer

Field Summary

Fields

Modifier and Type	Field and Description
static int	AJAX_POLLING_INTERVAL_MILLISECONDS
static String	ATTR_NAME_CLASS
static String	ATTR_NAME_SELECTED
static String	ATTR_NAME_STYLE
static String	ATTR_NAME_VALUE
protected org.openqa.selenium.WebDriver	driver
static String	HTML_LIST_ITEM
static String	ITEM_DELIMITER
protected org.slf4j.Logger	logger
static String	NEW_LINE
static int	ROW_OFFSET_X
static int	ROW_OFFSET_Y
protected SeleniumTestContext	testContext

Constructor Summary

Constructors

Constructor and Description
AbstractPageComponent(SeleniumTestContext testContext) Constructor

Method Summary

Modifier and Type	Method and Description
void	assertEquals(String message, Object expected, Object actual) Assert that two objects are equal and create a log record if the assertion test has failed
void	assertNotNull(String message, Object object) Assert that an object isn't null and create a log record if the assertion test has failed
void	assertTrue(String message, boolean condition) Assert that a condition is true and create a log record if the assertion test has failed
protected void	delayPageLoad() Delay the test after creating a page object in order to make sure that the page has been fully rendered
void	doubleClickElement(org.openqa.selenium.WebElement webElement) Perform a double-click on the given element
void	fail(String message) Throw an assertion error and log the message
void	fail(String message, Throwable t) Throw an assertion error and log the message
org.openqa.selenium.WebElement	findWebElement(String elementId) Search for an element by using the given ID
org.openqa.selenium.WebElement	findWebElement(String elementId, int explicitWaitInSeconds) Search for an element by using the given ID
org.openqa.selenium.WebElement	findWebElementByXPath(String xpathExpression) Find an element by using a XPath expression
List<org.openqa.selenium.WebElement>	findWebElementsByXPath(String xpathExpression) Find elements by using a XPath expression
org.openqa.selenium.WebDriver	getDriver()
org.slf4j.Logger	getLogger()
SeleniumTestContext	getTestContext()
void	moveToElement(org.openqa.selenium.WebElement webElement)
protected void	scrollTo(org.openqa.selenium.WebElement element) Scroll the browser window to the location of the given element
void	setInputFieldValue(PageElementTestData testData) Enter data into an input field
void	setLogger(org.slf4j.Logger logger)
void	validateInputFieldValue(PageElementTestData testData) Validate an input field by using the field's test data object
abstract void	waitForPendingAjaxRequests() Every implementation must define how to wait for pending AJAX requests!
void	waitUntilVisible(org.openqa.selenium.WebElement webElement, int secondsToWait) Wait a specific amount of time in seconds until an element should be visible

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_VALUE

public static final String ATTR_NAME_VALUE

See Also:

Constant Field Values

HTML_LIST_ITEM

public static final String HTML_LIST_ITEM

See Also:

Constant Field Values

ATTR_NAME_CLASS

public static final String ATTR_NAME_CLASS

See Also:

Constant Field Values

ATTR_NAME_STYLE

public static final String ATTR_NAME_STYLE

See Also:

Constant Field Values

ATTR_NAME_SELECTED

public static final String ATTR_NAME_SELECTED

See Also:

Constant Field Values

NEW_LINE

public static final String NEW_LINE

See Also:

Constant Field Values

ITEM_DELIMITER

public static final String ITEM_DELIMITER

See Also:

Constant Field Values

ROW_OFFSET_X

public static final int ROW_OFFSET_X

See Also:

Constant Field Values

ROW_OFFSET_Y

public static final int ROW_OFFSET_Y

See Also:

Constant Field Values

AJAX_POLLING_INTERVAL_MILLISECONDS

public static final int AJAX_POLLING_INTERVAL_MILLISECONDS

See Also:

Constant Field Values

driver

protected org.openqa.selenium.WebDriver driver

logger

protected org.slf4j.Logger logger

testContext

protected SeleniumTestContext testContext

Constructor Detail

AbstractPageComponent

public AbstractPageComponent(SeleniumTestContext testContext)

Constructor

Parameters:

testContext -

Method Detail

setLogger

public void setLogger(org.slf4j.Logger logger)

Parameters:

logger -

getLogger

public org.slf4j.Logger getLogger()

Returns:

the logger

getDriver

public org.openqa.selenium.WebDriver getDriver()

Returns:

the Selenium WebDriver

getTestContext

public SeleniumTestContext getTestContext()

Returns:

the Selenium test context

findWebElement

public org.openqa.selenium.WebElement findWebElement(String elementId,
                                                     int explicitWaitInSeconds)

Search for an element by using the given ID

Parameters:

elementId -

explicitWaitInSeconds - controls the amount of time in seconds until an element should be visible

Returns:

the web element

Throws:

AssertionError - if the element either could not be found, or the parameter elementId is null or empty

findWebElement

public org.openqa.selenium.WebElement findWebElement(String elementId)

Search for an element by using the given ID

Parameters:

elementId -

Returns:

the web element

Throws:

AssertionError - if the element either could not be found, or the parameter elementId is null or empty

findWebElementByXPath

public org.openqa.selenium.WebElement findWebElementByXPath(String xpathExpression)

Find an element by using a XPath expression

Parameters:

xpathExpression -

Returns:

the web element

Throws:

AssertionError - if the element either could not be found, or the XPath expression is null or empty

findWebElementsByXPath

public List<org.openqa.selenium.WebElement> findWebElementsByXPath(String xpathExpression)

Find elements by using a XPath expression

Parameters:

xpathExpression -

Returns:

a list containing all web elements

Throws:

AssertionError - if the XPath expression is null or empty

doubleClickElement

public void doubleClickElement(org.openqa.selenium.WebElement webElement)

Perform a double-click on the given element

Parameters:

webElement -

Throws:

AssertionError - if the parameter webElement is null

setInputFieldValue

public void setInputFieldValue(PageElementTestData testData)

Enter data into an input field

Parameters:

testData - the field's test data object that provides necessary information

validateInputFieldValue

public void validateInputFieldValue(PageElementTestData testData)

Validate an input field by using the field's test data object

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

waitUntilVisible

public void waitUntilVisible(org.openqa.selenium.WebElement webElement,
                             int secondsToWait)

Wait a specific amount of time in seconds until an element should be visible

Parameters:

webElement -

secondsToWait -

Throws:

AssertionError - if the parameter webElement is null

moveToElement

public void moveToElement(org.openqa.selenium.WebElement webElement)

Parameters:

webElement -

Throws:

AssertionError - if the parameter webElement is null

assertTrue

public void assertTrue(String message,
                       boolean condition)

Assert that a condition is true and create a log record if the assertion test has failed

Parameters:

message -

condition -

Throws:

AssertionError - if the condition is not true

assertNotNull

public void assertNotNull(String message,
                          Object object)

Assert that an object isn't null and create a log record if the assertion test has failed

Parameters:

message -

object -

Throws:

AssertionError - if the object is null

assertEquals

public void assertEquals(String message,
                         Object expected,
                         Object actual)

Assert that two objects are equal and create a log record if the assertion test has failed

Parameters:

message -

expected -

actual -

Throws:

AssertionError - if both objects are not equal

fail

public void fail(String message)

Throw an assertion error and log the message

Parameters:

message -

Throws:

AssertionError - in any case

fail

public void fail(String message,
                 Throwable t)

Throw an assertion error and log the message

Parameters:

message -

t -

Throws:

AssertionError - in any case

waitForPendingAjaxRequests

public abstract void waitForPendingAjaxRequests()

Every implementation must define how to wait for pending AJAX requests!

delayPageLoad

protected void delayPageLoad()

Delay the test after creating a page object in order to make sure that the page has been fully rendered

scrollTo

protected void scrollTo(org.openqa.selenium.WebElement element)

Scroll the browser window to the location of the given element

Parameters:

element -