com.testoptimal.plugin.selenium

Class WebDriverAssist

java.lang.Object

com.testoptimal.plugin.selenium.WebDriverAssist

Direct Known Subclasses:

SeleniumAssist

public class WebDriverAssist
extends Object

Collection of a set of assistance functions to handle some complex UI actions. These functions should only be called after WinAppDriver has started.

Author:

yxl01

Constructor Summary

Constructors

Constructor and Description
WebDriverAssist(org.openqa.selenium.WebDriver webDriver_p, MbtScriptExecutor scriptExec_p)

Method Summary

Modifier and Type	Method and Description
org.openqa.selenium.WebElement	click(org.openqa.selenium.By loc_p) simulate click on the first element found.
org.openqa.selenium.WebElement	click(org.openqa.selenium.By loc_p, int coordX_p, int coordY_p) simulate click on the first element found.
org.openqa.selenium.WebElement	click(org.openqa.selenium.By loc_p, String shiftCtrlAlt_p) simulate click on the first element found with option of holding down shift, ctrl or alt key.
org.openqa.selenium.WebElement	doubleClick(org.openqa.selenium.By locator_p) double click on the first element found.
org.openqa.selenium.WebElement	dragAndDrop(org.openqa.selenium.By fromLocator_p, org.openqa.selenium.By toLocator_p) drag an element and drop it onto another element.
org.openqa.selenium.WebElement	mouseDown(org.openqa.selenium.By locator_p) trigger mouse down event on the first element found with locator_p.
org.openqa.selenium.WebElement	mouseOver(org.openqa.selenium.By locator_p) trigger mouse over event on the first element found with locator_p.
org.openqa.selenium.WebElement	mouseUp(org.openqa.selenium.By locator_p) trigger mouse up event on the first element found locator_p.
org.openqa.selenium.WebElement	rightClick(org.openqa.selenium.By locator_p) rightClick on the first element found with locator_p.
org.openqa.selenium.WebDriver.Timeouts	setImplicitWait(long millis_p) sets implicit wait in milliseconds.
String	snapScreen() Take a snapshot of current AUT window.
org.openqa.selenium.WebElement	waitForElement(org.openqa.selenium.By locator_p, long timeoutMillis_p) waits for an element to be visible up to the specified timeout in milliseconds.
org.openqa.selenium.WebElement	waitForElementAttr(org.openqa.selenium.By locator_p, String attrName_p, String attrValue_p, long timeoutMillis_p) waits for an attribute to contain the specified value on the element.
org.openqa.selenium.WebElement	waitForElementEnabled(org.openqa.selenium.By locator_p, long timeoutMillis_p) waits for the specified element to be enabled.
org.openqa.selenium.WebElement	waitForElementText(org.openqa.selenium.By locator_p, String text_p, long timeoutMillis_p) waits for the element up to contain the expected text.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDriverAssist

public WebDriverAssist(org.openqa.selenium.WebDriver webDriver_p,
                       MbtScriptExecutor scriptExec_p)

Method Detail

snapScreen

public String snapScreen()
                  throws Exception

Take a snapshot of current AUT window.

Typical use of this method is to call it in MBT_FAIL or MBT_ERROR triggers to take a snapshot of the screen of the error.

The screen shot will be marked with the first exception (if multiple exceptions) triggered by current mScript and thus available from the exception popup.

Returns:

file path of the screen shot file

Throws:

Exception

mouseDown

public org.openqa.selenium.WebElement mouseDown(org.openqa.selenium.By locator_p)

trigger mouse down event on the first element found with locator_p.

Example:

<action code="$mouseDown('id=F1')"/> 

Parameters:

locator_p -

Returns:

target element

mouseOver

public org.openqa.selenium.WebElement mouseOver(org.openqa.selenium.By locator_p)

trigger mouse over event on the first element found with locator_p.

Example:

<action code="$mouseOver('id=F1')"/> 

Returns:

target element

rightClick

public org.openqa.selenium.WebElement rightClick(org.openqa.selenium.By locator_p)

rightClick on the first element found with locator_p.

Example:

<action code="$rightClick('id=F1')"/> 

Returns:

target element

click

public org.openqa.selenium.WebElement click(org.openqa.selenium.By loc_p)
                                     throws Exception

simulate click on the first element found.

Example:

$WEBDRIVER.assist().click(By.id('F1')); 

Parameters:

loc_p -

Throws:

Exception

click

public org.openqa.selenium.WebElement click(org.openqa.selenium.By loc_p,
                                            String shiftCtrlAlt_p)
                                     throws Exception

simulate click on the first element found with option of holding down shift, ctrl or alt key.

Not available for remote testing using selenium/appium/saucelabs servers.

Example:

<action code="$click('id=F1','S')"/> 

Parameters:

shiftCtrlAlt_p - S for shift, C for ctrl, A for alt, for example "SA" for holding down Shift and Alt key.

loc_p -

shiftCtrlAlt_p -

Returns:

target element

Throws:

Exception - on any error

click

public org.openqa.selenium.WebElement click(org.openqa.selenium.By loc_p,
                                            int coordX_p,
                                            int coordY_p)

simulate click on the first element found. Element must supports coordinates, for example an image.

Example:

<action code="$click('id=F1','100','200')"/> 

Notice that even though coordX_p and coordY_p are integer parameters, they must be enclosed by a set of single quote.

Parameters:

loc_p -

coordX_p -

coordY_p -

Returns:

target element

doubleClick

public org.openqa.selenium.WebElement doubleClick(org.openqa.selenium.By locator_p)

double click on the first element found.

Example:

<action code="$doubleClick('id=F1')"/>

Returns:

target element

dragAndDrop

public org.openqa.selenium.WebElement dragAndDrop(org.openqa.selenium.By fromLocator_p,
                                                  org.openqa.selenium.By toLocator_p)

drag an element and drop it onto another element. Only the first element found for both drag source and drop source locators are acted on.

Example:

<action code="$dragAndDrop('id=F1','id=f2')"/> 

The above MScript drags element F1 and drops it on the element f2.

Parameters:

fromLocator_p - element locator

toLocator_p - element locator

Returns:

target/drop element

mouseUp

public org.openqa.selenium.WebElement mouseUp(org.openqa.selenium.By locator_p)

trigger mouse up event on the first element found locator_p.

Example:

<action code="$mouseUp('id=F1')"/>

Parameters:

locator_p -

Returns:

target element

setImplicitWait

public org.openqa.selenium.WebDriver.Timeouts setImplicitWait(long millis_p)

sets implicit wait in milliseconds. This function must call after web driver has started.

Parameters:

millis_p -

Returns:

timeout object for more timeout related actions

waitForElement

public org.openqa.selenium.WebElement waitForElement(org.openqa.selenium.By locator_p,
                                                     long timeoutMillis_p)

waits for an element to be visible up to the specified timeout in milliseconds. Returns true if the element is found, false it times out.

Parameters:

locator_p -

timeoutMillis_p -

Returns:

true if element is found

waitForElementText

public org.openqa.selenium.WebElement waitForElementText(org.openqa.selenium.By locator_p,
                                                         String text_p,
                                                         long timeoutMillis_p)

waits for the element up to contain the expected text. Returns true if the condition becomes true, false if it times out.

Parameters:

locator_p -

text_p - text to be expected

timeoutMillis_p -

Returns:

true if condition is found to be true within timeout duration, else return false.

waitForElementEnabled

public org.openqa.selenium.WebElement waitForElementEnabled(org.openqa.selenium.By locator_p,
                                                            long timeoutMillis_p)

waits for the specified element to be enabled. Returns true if the condition becomes true, false if it times out.

Parameters:

locator_p -

timeoutMillis_p -

Returns:

element or null if timed out

waitForElementAttr

public org.openqa.selenium.WebElement waitForElementAttr(org.openqa.selenium.By locator_p,
                                                         String attrName_p,
                                                         String attrValue_p,
                                                         long timeoutMillis_p)

waits for an attribute to contain the specified value on the element. Returns true if the condition becomes true, false if it times out.

Parameters:

locator_p -

attrName_p - attribute name

attrValue_p - expected value

timeoutMillis_p -

Returns:

element, null if timed out