org.alfresco.webdrone

Class WebDroneImpl

java.lang.Object

org.alfresco.webdrone.WebDroneImpl

All Implemented Interfaces:

WebDrone

public class WebDroneImpl
extends Object
implements WebDrone

An Alfresco web browser simulator that uses Selenium WebDriver as a base with added helper methods that are specific to Alfresco site and version.

Since:

1.0

Author:

Michael Suzuki

Constructor Summary

Constructors

Constructor and Description
WebDroneImpl(org.openqa.selenium.WebDriver driver) Constructor with default time set to 2000 milliseconds.
WebDroneImpl(org.openqa.selenium.WebDriver driver, long defaultWaitTime, long maxPageRenderWaitTime) The main constructor
WebDroneImpl(org.openqa.selenium.WebDriver driver, long defaultWaitTime, long maxPageRenderWaitTime, WebDroneProperties properties, PageFactory factoryPage) The main constructor
WebDroneImpl(org.openqa.selenium.WebDriver driver, WebDroneProperties properties)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeTab() Closes the recently opened tab in the same browser.
void	closeWindow() This method closes the current window or tab.
void	createNewTab() Opens the new tab in the same browser.
void	deleteCookies() Function to delete the cookies in the browser
void	dragAndDrop(org.openqa.selenium.WebElement source, org.openqa.selenium.WebElement target) Drag the source element and drop into target element.
Object	executeJavaScript(String js) Injects java script directly to the page to invoke a change on the page's java script
Object	executeJavaScript(String js, Object... args) Execute java script in resepect of object (i.e.
protected void	finalize() Clean up WebDrone.
org.openqa.selenium.WebElement	find(org.openqa.selenium.By by) Helper method to find a WebElement.
List<org.openqa.selenium.WebElement>	findAll(org.openqa.selenium.By by) Helper method to find all WebElement on HTML page
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By criteria) Helper method to find and return a slow loading WebElement.
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By by, long limit) Helper method to find a WebElement with a time limit in milliseconds.
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By by, long limit, long interval) Helper method to find a WebElement with a time limit in milliseconds.
org.openqa.selenium.WebElement	findAndWaitById(String id) Helper method to find and return a slow loading WebElement by id.
List<org.openqa.selenium.WebElement>	findAndWaitForElements(org.openqa.selenium.By criteria) Helper method to find and return a slow loading collection of WebElement.
List<org.openqa.selenium.WebElement>	findAndWaitForElements(org.openqa.selenium.By criteria, long waitTime) Helper method to find and return a slow loading collection of WebElement.
org.openqa.selenium.WebElement	findAndWaitWithRefresh(org.openqa.selenium.By by) Helper method to find and return a slow loading WebElement.
org.openqa.selenium.WebElement	findAndWaitWithRefresh(org.openqa.selenium.By by, long limit) Helper method to find a WebElement with a time limit in milliseconds.
org.openqa.selenium.WebElement	findByKey(String id) Helper method to find a WebElement by id using the WebDroneProperties to resolve the key value of the id.
org.openqa.selenium.Cookie	getCookie(String name) Gets the cookie from the WebDrone browser session.
Set<org.openqa.selenium.Cookie>	getCookies() Extract cookie information
HtmlPage	getCurrentPage() Gets the current page in the form of a page object based on the Alfresco site type.
String	getCurrentUrl() Get the URL displayed on the browser.
long	getDefaultWaitTime() Get the default wait time value.
org.openqa.selenium.WebDriver	getDriver()
String	getElement(String key) Gets an element value for the given key.
long	getMaxPageRenderWaitTime()
String	getPageSouce() The HTML source code of the page viewed.
String	getPreviousUrl() Gets the URL of the previously visited page.
WebDroneProperties	getProperties() Get the WebDrone property which contains additional information such as the page object library, version details or language.
File	getScreenShot() Grabs a screen shot of what the WebDriver is currently viewing.
String	getSessionId() Gets the WebDrone browser session id from a cookie.
String	getTitle() Title of the page.
String	getValue(String key) Check value of given key, such as string value of an i18n label.
String	getWindowHandle() This method finds the current window handle and return it as string.
Set<String>	getWindowHandles() This method finds the all window handles and return it as string.
boolean	isChromeBrowser() Checks to see if driver used is chrome.
boolean	isElementDisplayed(org.openqa.selenium.By locator) Returns true if the element is displayed else false
boolean	isHtmlUnit() Checks to see if driver used is HtmlUnit.
boolean	isReady()
boolean	isRenderComplete(long waitTime) Verify if loading of the page is complete using java script to validate state of the HTML DOM.
void	maximize() Maximizes the current window if it is not already maximized
void	mouseOver(org.openqa.selenium.WebElement element) Recreating the action of hovering over a particular HTML element on a page.
void	mouseOverOnElement(org.openqa.selenium.WebElement element) Recreating the action of hovering over a particular HTML element on a page based Actions class.
void	navigateTo(String url) Navigate the browser to given URL.
void	quit() End Browser session.
void	refresh() Acts as a refresh page action similar to F5 key.
void	setDefaultWaitTime(long defaultWaitTime)
void	switchToDefaultContent() Method to switch back from i-frame to default content.
void	switchToFrame(String frameId) Method to switch on to frames of content object.
void	switchToWindow(String windowHandle) This method transfers the control to the specific window as per the given window handle.
void	test()
String	toString()
void	waitFor(long waitTimeMS) Deprecated. this method should never be used, its the same as thread sleep.
void	waitForElement(org.openqa.selenium.By locator, long timeOutInSeconds) Wait until the element is visible for the specified amount of time.
void	waitForPageLoad(long timeOutInSeconds) Wait document.readyState to return completed.
void	waitUntilElementClickable(org.openqa.selenium.By locator, long timeOutInSeconds) Wait until the Clickable of given Element for given seconds.
void	waitUntilElementDeletedFromDom(org.openqa.selenium.By locator, long timeOutInSeconds) Wait Until element successfully deleting from DOM.
void	waitUntilElementDisappears(org.openqa.selenium.By locator, long timeOutInSeconds) Wait until the invisibility of given Element for given seconds.
void	waitUntilElementPresent(org.openqa.selenium.By locator, long timeOutInSeconds) Wait until the element is present in set time in seconds.
void	waitUntilNotVisible(org.openqa.selenium.By locator, String text, long timeOutInSeconds) Wait until the invisibility of given Element for given seconds.
void	waitUntilNotVisibleWithParitalText(org.openqa.selenium.By locator, String text, long timeOutInSeconds) Wait until the invisibility of given Element for given seconds.
void	waitUntilVisible(org.openqa.selenium.By locator, String text, long timeOutInSeconds) Wait until the element is visible in set time in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDroneImpl

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

Constructor with default time set to 2000 milliseconds.

Parameters:

driver - WebDriver the browser behavior

alfrescoVersion - AlfrescoVersion version

WebDroneImpl

public WebDroneImpl(org.openqa.selenium.WebDriver driver,
            WebDroneProperties properties)

WebDroneImpl

public WebDroneImpl(org.openqa.selenium.WebDriver driver,
            long defaultWaitTime,
            long maxPageRenderWaitTime)

The main constructor

Parameters:

driver - WebDriver the browser

alfrescoVersion - AlfrescoVersion version

defaultWaitTime - time to wait in milliseconds

maxPageRenderWaitTime - maximum time to wait for page to render

WebDroneImpl

public WebDroneImpl(org.openqa.selenium.WebDriver driver,
            long defaultWaitTime,
            long maxPageRenderWaitTime,
            WebDroneProperties properties,
            PageFactory factoryPage)

The main constructor

Parameters:

driver - WebDriver the browser

alfrescoVersion - AlfrescoVersion version

defaultWaitTime - time to wait in milliseconds

maxPageRenderWaitTime - maximum time to wait for page to render

Method Detail

isReady

public boolean isReady()

Specified by:

isReady in interface WebDrone

Returns:

true if the instance is ready for browser requests, otherwise false.

quit

public void quit()

Description copied from interface: WebDrone

End Browser session.

Specified by:

quit in interface WebDrone

navigateTo

public void navigateTo(String url)

Description copied from interface: WebDrone

Navigate the browser to given URL.

Specified by:

navigateTo in interface WebDrone

Parameters:

url - String URL

find

public org.openqa.selenium.WebElement find(org.openqa.selenium.By by)

Helper method to find a WebElement.

Specified by:

find in interface WebDrone

Parameters:

by - By criteria to identify HTML element

Returns:

WebElement HTML element

findByKey

public org.openqa.selenium.WebElement findByKey(String id)

Helper method to find a WebElement by id using the WebDroneProperties to resolve the key value of the id.

Specified by:

findByKey in interface WebDrone

Parameters:

id - the html element id

Returns:

WebElement HTML element

findAll

public List<org.openqa.selenium.WebElement> findAll(org.openqa.selenium.By by)

Helper method to find all WebElement on HTML page

Specified by:

findAll in interface WebDrone

Parameters:

by - By criteria to identify HTML element

Returns:

WebElement HTML element

findAndWait

public org.openqa.selenium.WebElement findAndWait(org.openqa.selenium.By by,
                                         long limit)

Helper method to find a WebElement with a time limit in milliseconds. During the wait period it will check for the element every 100 millisecond.

Specified by:

findAndWait in interface WebDrone

Parameters:

by - By criteria to search by

millisecond - time limit

Returns:

WebElement HTML element

findAndWait

public org.openqa.selenium.WebElement findAndWait(org.openqa.selenium.By by,
                                         long limit,
                                         long interval)

Helper method to find a WebElement with a time limit in milliseconds. During the wait period it will check for the element every 100 millisecond.

Specified by:

findAndWait in interface WebDrone

Parameters:

by - By criteria to search by

limit - time limit

interval - polling frequency

Returns:

WebElement HTML element

isRenderComplete

public boolean isRenderComplete(long waitTime)

Verify if loading of the page is complete using java script to validate state of the HTML DOM.

Specified by:

isRenderComplete in interface WebDrone

Parameters:

waitTime - max time to look for an element

Returns:

true if page has been loaded

findAndWaitById

public org.openqa.selenium.WebElement findAndWaitById(String id)

Helper method to find and return a slow loading WebElement by id.

Specified by:

findAndWaitById in interface WebDrone

Parameters:

id - String identifier

Returns:

WebElement HTML element

findAndWait

public org.openqa.selenium.WebElement findAndWait(org.openqa.selenium.By criteria)

Helper method to find and return a slow loading WebElement.

Specified by:

findAndWait in interface WebDrone

Parameters:

criteria - By search criteria

Returns:

WebElement HTML element

findAndWaitForElements

public List<org.openqa.selenium.WebElement> findAndWaitForElements(org.openqa.selenium.By criteria,
                                                          long waitTime)

Helper method to find and return a slow loading collection of WebElement.

Specified by:

findAndWaitForElements in interface WebDrone

Parameters:

criteria - By search criteria

waitTime - milliseconds to wait

Returns:

Collection of WebElement HTML elements

findAndWaitForElements

public List<org.openqa.selenium.WebElement> findAndWaitForElements(org.openqa.selenium.By criteria)

Helper method to find and return a slow loading collection of WebElement.

Specified by:

findAndWaitForElements in interface WebDrone

Parameters:

criteria - By search criteria

Returns:

Collection of WebElement HTML elements

setDefaultWaitTime

public void setDefaultWaitTime(long defaultWaitTime)

getDefaultWaitTime

public long getDefaultWaitTime()

Description copied from interface: WebDrone

Get the default wait time value.

Specified by:

getDefaultWaitTime in interface WebDrone

Returns:

long default wait value in milliseconds

mouseOver

public void mouseOver(org.openqa.selenium.WebElement element)

Recreating the action of hovering over a particular HTML element on a page.

Specified by:

mouseOver in interface WebDrone

Parameters:

element - WebElement target

getElement

public final String getElement(String key)

Description copied from interface: WebDrone

Gets an element value for the given key.

Specified by:

getElement in interface WebDrone

Parameters:

key - String HTML element id

Returns:

String value of key

getCurrentUrl

public String getCurrentUrl()

Description copied from interface: WebDrone

Get the URL displayed on the browser.

Specified by:

getCurrentUrl in interface WebDrone

Returns:

String URL

executeJavaScript

public Object executeJavaScript(String js)

Injects java script directly to the page to invoke a change on the page's java script

Specified by:

executeJavaScript in interface WebDrone

Parameters:

js - String script

Returns:

Object reponse of the javascript

getTitle

public String getTitle()

Description copied from interface: WebDrone

Title of the page.

Specified by:

getTitle in interface WebDrone

getPageSouce

public String getPageSouce()

The HTML source code of the page viewed.

Returns:

String of current HTML source

getScreenShot

public final File getScreenShot()

Grabs a screen shot of what the WebDriver is currently viewing. This is only possible on WebDriver that are UI based browser.

Specified by:

getScreenShot in interface WebDrone

Returns:

File screen image of the page

toString

public String toString()

Overrides:

toString in class Object

finalize

protected void finalize()
                 throws Throwable

Clean up WebDrone.

Overrides:

finalize in class Object

Throws:

Throwable

refresh

public void refresh()

Description copied from interface: WebDrone

Acts as a refresh page action similar to F5 key.

Specified by:

refresh in interface WebDrone

getMaxPageRenderWaitTime

public long getMaxPageRenderWaitTime()

getDriver

public org.openqa.selenium.WebDriver getDriver()

isChromeBrowser

public boolean isChromeBrowser()

Checks to see if driver used is chrome.

Returns:

true if chrome browser

isHtmlUnit

public boolean isHtmlUnit()

Checks to see if driver used is HtmlUnit.

Returns:

true if chrome browser

getSessionId

public String getSessionId()

Gets the WebDrone browser session id from a cookie.

Specified by:

getSessionId in interface WebDrone

Returns:

String JSESSIONID and value

getCookies

public Set<org.openqa.selenium.Cookie> getCookies()

Extract cookie information

Parameters:

drone - WebDrone

Returns:

String value of cookies

dragAndDrop

public void dragAndDrop(org.openqa.selenium.WebElement source,
               org.openqa.selenium.WebElement target)

Drag the source element and drop into target element.

Specified by:

dragAndDrop in interface WebDrone

Parameters:

source - - Source Element

target - - Target Element

waitUntilElementDisappears

public void waitUntilElementDisappears(org.openqa.selenium.By locator,
                              long timeOutInSeconds)

Wait until the invisibility of given Element for given seconds.

Specified by:

waitUntilElementDisappears in interface WebDrone

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitUntilNotVisible

public void waitUntilNotVisible(org.openqa.selenium.By locator,
                       String text,
                       long timeOutInSeconds)

Wait until the invisibility of given Element for given seconds.

Specified by:

waitUntilNotVisible in interface WebDrone

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitUntilNotVisibleWithParitalText

public void waitUntilNotVisibleWithParitalText(org.openqa.selenium.By locator,
                                      String text,
                                      long timeOutInSeconds)

Wait until the invisibility of given Element for given seconds.

Specified by:

waitUntilNotVisibleWithParitalText in interface WebDrone

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitUntilVisible

public void waitUntilVisible(org.openqa.selenium.By locator,
                    String text,
                    long timeOutInSeconds)

Description copied from interface: WebDrone

Wait until the element is visible in set time in seconds.

Specified by:

waitUntilVisible in interface WebDrone

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitUntilElementPresent

public void waitUntilElementPresent(org.openqa.selenium.By locator,
                           long timeOutInSeconds)

Description copied from interface: WebDrone

Wait until the element is present in set time in seconds.

Specified by:

waitUntilElementPresent in interface WebDrone

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

mouseOverOnElement

public void mouseOverOnElement(org.openqa.selenium.WebElement element)

Recreating the action of hovering over a particular HTML element on a page based Actions class.

Specified by:

mouseOverOnElement in interface WebDrone

Parameters:

element - WebElement target

waitForElement

public void waitForElement(org.openqa.selenium.By locator,
                  long timeOutInSeconds)

Wait until the element is visible for the specified amount of time.

Specified by:

waitForElement in interface WebDrone

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitUntilElementClickable

public void waitUntilElementClickable(org.openqa.selenium.By locator,
                             long timeOutInSeconds)

Wait until the Clickable of given Element for given seconds.

Specified by:

waitUntilElementClickable in interface WebDrone

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitFor

public void waitFor(long waitTimeMS)

Deprecated. this method should never be used, its the same as thread sleep.

Helper method to make the driver Wait / sleep until given time elapses. This is necessary in various cases within WebDrone tests + QA-Share This provides the thread safe wait for the specific driver instance

Specified by:

waitFor in interface WebDrone

Parameters:

long - waitTime in Milliseconds

waitUntilElementDeletedFromDom

public void waitUntilElementDeletedFromDom(org.openqa.selenium.By locator,
                                  long timeOutInSeconds)

Wait Until element successfully deleting from DOM.

Specified by:

waitUntilElementDeletedFromDom in interface WebDrone

Parameters:

locator - - CSS Locator

timeOutInSeconds - - Timeout In Seconds

getPreviousUrl

public String getPreviousUrl()

Description copied from interface: WebDrone

Gets the URL of the previously visited page. The previous url is only displayed once interacted with the page. If user uses drone.navigetTo it will treat it as an entry page and will not have a previous page url.

Specified by:

getPreviousUrl in interface WebDrone

Returns:

String previous page URL

switchToFrame

public void switchToFrame(String frameId)

Description copied from interface: WebDrone

Method to switch on to frames of content object.

Specified by:

switchToFrame in interface WebDrone

switchToDefaultContent

public void switchToDefaultContent()

Description copied from interface: WebDrone

Method to switch back from i-frame to default content.

Specified by:

switchToDefaultContent in interface WebDrone

isElementDisplayed

public boolean isElementDisplayed(org.openqa.selenium.By locator)

Description copied from interface: WebDrone

Returns true if the element is displayed else false

Specified by:

isElementDisplayed in interface WebDrone

getWindowHandle

public String getWindowHandle()

This method finds the current window handle and return it as string.

Specified by:

getWindowHandle in interface WebDrone

Returns:

String, current window handle value.

getWindowHandles

public Set<String> getWindowHandles()

This method finds the all window handles and return it as string.

Specified by:

getWindowHandles in interface WebDrone

Returns:

Set.

switchToWindow

public void switchToWindow(String windowHandle)

This method transfers the control to the specific window as per the given window handle.

Specified by:

switchToWindow in interface WebDrone

Parameters:

windowHandle -

closeWindow

public void closeWindow()

This method closes the current window or tab.

Specified by:

closeWindow in interface WebDrone

getCookie

public org.openqa.selenium.Cookie getCookie(String name)

Gets the cookie from the WebDrone browser session.

Specified by:

getCookie in interface WebDrone

Returns:

Cookie cookie value

Throws:

Exception - if cookie not found

deleteCookies

public void deleteCookies()

Function to delete the cookies in the browser

Specified by:

deleteCookies in interface WebDrone

Parameters:

drone - WebDrone

waitForPageLoad

public void waitForPageLoad(long timeOutInSeconds)

Wait document.readyState to return completed.

Specified by:

waitForPageLoad in interface WebDrone

Parameters:

timeOutInSeconds -

createNewTab

public void createNewTab()

Opens the new tab in the same browser.

Specified by:

createNewTab in interface WebDrone

closeTab

public void closeTab()

Closes the recently opened tab in the same browser.

Specified by:

closeTab in interface WebDrone

findAndWaitWithRefresh

public org.openqa.selenium.WebElement findAndWaitWithRefresh(org.openqa.selenium.By by,
                                                    long limit)

Helper method to find a WebElement with a time limit in milliseconds. During the wait period it will check for the element every 100 millisecond. If the element is not displayed, refresh the page.

Specified by:

findAndWaitWithRefresh in interface WebDrone

Parameters:

by - By criteria to search by

Returns:

WebElement

findAndWaitWithRefresh

public org.openqa.selenium.WebElement findAndWaitWithRefresh(org.openqa.selenium.By by)

Helper method to find and return a slow loading WebElement. If the element is not displayed, refresh the page

Specified by:

findAndWaitWithRefresh in interface WebDrone

Parameters:

criteria - By search criteria

Returns:

WebElement HTML element

executeJavaScript

public Object executeJavaScript(String js,
                       Object... args)

Execute java script in resepect of object (i.e. WebElement)

Specified by:

executeJavaScript in interface WebDrone

Parameters:

js - String script

Returns:

Object reponse of the javascript

getCurrentPage

public HtmlPage getCurrentPage()

Description copied from interface: WebDrone

Gets the current page in the form of a page object based on the Alfresco site type. If site type is of Share then the page returned will be a HtmlPage` object.

Specified by:

getCurrentPage in interface WebDrone

Returns:

HtmlPage page object of current view

getProperties

public WebDroneProperties getProperties()

Description copied from interface: WebDrone

Get the WebDrone property which contains additional information such as the page object library, version details or language.

Specified by:

getProperties in interface WebDrone

Returns:

WebDroneProperties properties

maximize

public void maximize()

Description copied from interface: WebDrone

Maximizes the current window if it is not already maximized

Specified by:

maximize in interface WebDrone

test

public void test()

getValue

public String getValue(String key)

Description copied from interface: WebDrone

Check value of given key, such as string value of an i18n label.

Specified by:

getValue in interface WebDrone

Parameters:

key - identifier

Returns:

String value