org.alfresco.webdrone

Interface WebDrone

All Known Implementing Classes:

WebDroneImpl

public interface WebDrone

WebDrone represents an unmanned web browser used for testing Alfresco Share.

Key methods are findAndWaitById(String), which is used to find elements on the page using the id as an identifier.

The other various methods similar to findAndWait(By) are also used to find elements of the page.

The executeJavaScript(String) is an added functionality to manage JavaScript encountered on the page. The primary use of the method is to inject a script to yield a user based behaviour.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAndType(org.openqa.selenium.By by, String value) Find the element the clear any text and type text into the text box.
void	closeTab() Closes the recently opened tab in the same browser.
void	closeWindow() This method closes the current window or tab.
void	createNewTab() Create new tab.
void	deleteCookie(org.openqa.selenium.Cookie cookie) Delete cookie based on given cookie.
void	deleteCookies() Function to delete the cookies in the browser
void	doubleClickOnElement(org.openqa.selenium.WebElement element) Doubleclick on an element
void	dragAndDrop(org.openqa.selenium.WebElement source, int x, int y) Drag web element by x,y coordinates
void	dragAndDrop(org.openqa.selenium.WebElement source, org.openqa.selenium.WebElement target) Drag the source element and drop into target element.
Object	executeJavaScript(String string) Actions custom javascript that needs to be injected to the current page.
Object	executeJavaScript(String js, Object... args) Execute java script in resepect of object (i.e.
org.openqa.selenium.WebElement	find(org.openqa.selenium.By by) Finds WebElement by text in html.
org.openqa.selenium.WebElement	find(int x, int y) Find WebElement by x and y coordinates.
org.openqa.selenium.WebElement	find(org.sikuli.api.Target target) Finds WebElement by using an image.
List<org.openqa.selenium.WebElement>	findAll(org.openqa.selenium.By by) Finds all possible matching WebElement.
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By by) Find WebElement by the html name attribute.
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By by, long timeLeft) Finds WebElement using By pattern with a time limit set in milliseconds.
org.openqa.selenium.WebElement	findAndWait(org.openqa.selenium.By by, long timeLeft, long interval) Finds WebElement using By pattern with a time limit and interval time set in milliseconds.
org.openqa.selenium.WebElement	findAndWaitById(String id) Finds WebElement by id, this method uses an implicit wait time which set by the WebDrone max wait time.
List<org.openqa.selenium.WebElement>	findAndWaitForElements(org.openqa.selenium.By by) Finds all possible matching WebElement with time limit.
List<org.openqa.selenium.WebElement>	findAndWaitForElements(org.openqa.selenium.By criteria, long waitTime) Finds all possible matching WebElement with time limit.
org.openqa.selenium.WebElement	findAndWaitWithRefresh(org.openqa.selenium.By by) Find WebElement by the html name attribute.
org.openqa.selenium.WebElement	findAndWaitWithRefresh(org.openqa.selenium.By by, long timeLeft) Finds WebElement using By pattern with a time limit set in milliseconds.
org.openqa.selenium.WebElement	findByKey(String key) Finds the WebElement by the given identifier.
List<org.openqa.selenium.WebElement>	findDisplayedElements(org.openqa.selenium.By selector) This function will return list of visible elements found with the specified selector
org.openqa.selenium.WebElement	findFirstDisplayedElement(org.openqa.selenium.By selector) This function will return 1st visible element found with the specified selector
org.openqa.selenium.Cookie	getCookie(String name) Get a cookie that matches the name.
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.
String	getElement(String key) Gets an element value for the given key.
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 the screen shot of the current page.
String	getSessionId() Get the JSESSIONID
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 returns the set of string values.
boolean	isElementDisplayed(org.openqa.selenium.By locator) Returns true if the element is displayed else false.
boolean	isImageVisible(org.sikuli.api.Target target) Finds the target image in the screen.
boolean	isReady()
boolean	isRenderComplete(long timeLeft) Verify if the page has completed render.
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 WebElement 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	rightClickOnElement(org.openqa.selenium.WebElement element) Rightclick on an element
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	waitFor(long waitTimeMS) Deprecated. as of 2.2, this method should not be use, since it pauses a process for a set time unconditionally, 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	waitForWindowsCount(int expectedNoOfWindows, long timeOutInSeconds) Wait until the windows count are displayed in set time in seconds.
void	waitUntilElementClickable(org.openqa.selenium.By locator, long timeOutInSeconds) Wait until the given click able element is found within the time set in 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 element is not visible in set time in 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.

Method Detail

isReady

boolean isReady()

Returns:

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

quit

void quit()

End Browser session.

navigateTo

void navigateTo(String url)

Navigate the browser to given URL.

Parameters:

url - String URL

getCurrentPage

HtmlPage getCurrentPage()

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.

Returns:

HtmlPage page object of current view

getElement

String getElement(String key)

Gets an element value for the given key.

Parameters:

key - String HTML element id

Returns:

String value of key

getCurrentUrl

String getCurrentUrl()

Get the URL displayed on the browser.

Returns:

String URL

getTitle

String getTitle()

Title of the page.

getSessionId

String getSessionId()

Get the JSESSIONID

getScreenShot

File getScreenShot()

Grabs the screen shot of the current page.

Returns:

File image of page.

find

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

Finds WebElement by text in html.

Parameters:

by - selector

Returns:

WebElement html element

isRenderComplete

boolean isRenderComplete(long timeLeft)

Verify if the page has completed render.

Parameters:

timeLeft - the maximum time allocated to do the task

Returns:

true if page has rendered.

findAndWait

org.openqa.selenium.WebElement findAndWait(org.openqa.selenium.By by)

Find WebElement by the html name attribute.

Parameters:

{@link - By}

Returns:

WebElement web element

findAndWaitById

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

Finds WebElement by id, this method uses an implicit wait time which set by the WebDrone max wait time. The method will return once the html element is found or up to max wait time has exceeded.

Parameters:

id - String identifier

Returns:

WebElement web element

findAndWaitWithRefresh

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

Find WebElement by the html name attribute.

Parameters:

{@link - By}

Returns:

WebElement web element

findByKey

org.openqa.selenium.WebElement findByKey(String key)

Finds the WebElement by the given identifier.

Parameters:

key - identifier

Returns:

WebElement html element

getValue

String getValue(String key)

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

Parameters:

key - identifier

Returns:

String value

findAndWait

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

Finds WebElement using By pattern with a time limit set in milliseconds. The method will return once the html element is found or up to time limit set has exceeded.

Parameters:

by - method to find element on page

timeLeft -

Returns:

WebElement element searched

findAndWaitWithRefresh

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

Finds WebElement using By pattern with a time limit set in milliseconds. The method will return once the html element is found or up to time limit set has exceeded.

Parameters:

by - method to find element on page

timeLeft -

Returns:

WebElement element searched

findAndWait

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

Finds WebElement using By pattern with a time limit and interval time set in milliseconds. The method will return once the html element is found or up to time limit set has exceeded. This method also allows to set the polling frequency.

Parameters:

by - method to find element on page

timeLeft -

interval -

Returns:

WebElement element searched

executeJavaScript

Object executeJavaScript(String string)

Actions custom javascript that needs to be injected to the current page.

Parameters:

string - javascript code

Returns:

Object reponse of the javascript

findAll

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

Finds all possible matching WebElement.

Parameters:

by - By criteria

Returns:

Collection of WebElements

findAndWaitForElements

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

Finds all possible matching WebElement with time limit.

Parameters:

criteria - By

waitTime - the max time to wait

Returns:

Collection of WebElements

findAndWaitForElements

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

Finds all possible matching WebElement with time limit.

Parameters:

by - By the criteria to search by.

Returns:

Collection of WebElements

refresh

void refresh()

Acts as a refresh page action similar to F5 key.

mouseOver

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

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

Parameters:

element - WebElement target

mouseOverOnElement

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

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

Use xpath selector to find element, since the over the selenium grid some css selector not working for mouse over using Actions class.

Parameters:

element - WebElement target

dragAndDrop

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

Drag the source element and drop into target element.

Parameters:

source - Source WebElement

target - Target WebElement

dragAndDrop

void dragAndDrop(org.openqa.selenium.WebElement source,
               int x,
               int y)

Drag web element by x,y coordinates

Parameters:

source - html WebElement

x - coordinate

y - coordinate

doubleClickOnElement

void doubleClickOnElement(org.openqa.selenium.WebElement element)

Doubleclick on an element

Parameters:

element - WebElement

rightClickOnElement

void rightClickOnElement(org.openqa.selenium.WebElement element)

Rightclick on an element

Parameters:

element - WebElement

waitUntilElementDisappears

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

Wait until the invisibility of given Element for given seconds.

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitForElement

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

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

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitUntilNotVisible

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

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

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitUntilVisible

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

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

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitUntilElementClickable

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

Wait until the given click able element is found within the time set in seconds.

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitFor

void waitFor(long waitTimeMS)

Deprecated. as of 2.2, this method should not be use, since it pauses a process for a set time unconditionally, 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

Parameters:

long - waitTime

waitUntilElementDeletedFromDom

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

Wait Until element successfully deleting from DOM.

Parameters:

locator - - CSS Locator

timeOutInSeconds - - Timeout In Seconds

getPreviousUrl

String getPreviousUrl()

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.

Returns:

String previous page URL

switchToFrame

void switchToFrame(String frameId)

Method to switch on to frames of content object.

Parameters:

frameId -

switchToDefaultContent

void switchToDefaultContent()

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

isElementDisplayed

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

Returns true if the element is displayed else false.

getWindowHandle

String getWindowHandle()

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

Returns:

String, current window handle value.

switchToWindow

void switchToWindow(String windowHandle)

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

Parameters:

windowHandle -

getWindowHandles

Set<String> getWindowHandles()

This method finds the all window handles and returns the set of string values.

Returns:

Set.

closeWindow

void closeWindow()

This method closes the current window or tab.

getCookie

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

Get a cookie that matches the name.

Parameters:

String - cookie identifier

Returns:

Cookie object

deleteCookies

void deleteCookies()

Function to delete the cookies in the browser

Parameters:

drone - WebDrone

deleteCookie

void deleteCookie(org.openqa.selenium.Cookie cookie)

Delete cookie based on given cookie.

Parameters:

cookie - Cookie object to be deleted.

waitForPageLoad

void waitForPageLoad(long timeOutInSeconds)

Wait document.readyState to return completed.

Parameters:

timeOutInSeconds -

createNewTab

void createNewTab()

Create new tab.

closeTab

void closeTab()

Closes the recently opened tab in the same browser.

executeJavaScript

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

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

Parameters:

string - javascript code

Returns:

Object reponse of the javascript

waitUntilElementPresent

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

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

Parameters:

locator - CSS Locator

timeOutInSeconds - Timeout In Seconds

waitUntilNotVisibleWithParitalText

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

Wait until the invisibility of given Element for given seconds.

Parameters:

locator - CSS Locator

text - - The Text to find in the Locator

timeOutInSeconds - Timeout In Seconds

waitForWindowsCount

void waitForWindowsCount(int expectedNoOfWindows,
                       long timeOutInSeconds)

Wait until the windows count are displayed in set time in seconds.

Parameters:

expectedNoOfWindows - -the expected number of windows to be displayed

timeOutInSeconds - - timeout in seconds

getProperties

WebDroneProperties getProperties()

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

Returns:

WebDroneProperties properties

maximize

void maximize()

Maximizes the current window if it is not already maximized

getDefaultWaitTime

long getDefaultWaitTime()

Get the default wait time value.

Returns:

long default wait value in milliseconds

findFirstDisplayedElement

org.openqa.selenium.WebElement findFirstDisplayedElement(org.openqa.selenium.By selector)

This function will return 1st visible element found with the specified selector

Returns:

- WebElement

findDisplayedElements

List<org.openqa.selenium.WebElement> findDisplayedElements(org.openqa.selenium.By selector)

This function will return list of visible elements found with the specified selector

Returns:

List of WebElement

isImageVisible

boolean isImageVisible(org.sikuli.api.Target target)

Finds the target image in the screen.

Parameters:

target - Target image we are looking for in the screen.

Returns:

true if image visible in the screen

find

org.openqa.selenium.WebElement find(org.sikuli.api.Target target)

Finds WebElement by using an image.

Parameters:

target - Target image to find by

Returns:

WebElement of the image.

find

org.openqa.selenium.WebElement find(int x,
                                  int y)

Find WebElement by x and y coordinates.

Parameters:

x - horizontal coordinates

y - vertical coordinates

Returns:

WebElement of coordinates.

clearAndType

void clearAndType(org.openqa.selenium.By by,
                String value)

Find the element the clear any text and type text into the text box. Type text into the element character by character. Also replaces the number with Keys number.