org.safs.selenium

Class SeleniumGUIUtilities

java.lang.Object

org.safs.STAFRequester

org.safs.DDGUIUtilities

org.safs.selenium.SeleniumGUIUtilities

Direct Known Subclasses:

SPC

public class SeleniumGUIUtilities
extends DDGUIUtilities

SAFS/Selenium-specific subclass of DDGUIUtilities. The primary feature is that the SeleniumGUIUtilities uses the new SAFS RMI bridge to communicate with our own Java Proxies embedded in each JVM.

Since:

AUG 15, 2006

Author:

Carl Nagle, PHSABO

See Also:

DDGUIUtilities

Field Summary

Fields

Modifier and Type	Field and Description
DocumentParser	domParser
static java.util.regex.Pattern	FRAME_PATTERN
boolean	frameSwitched
java.lang.String	UNNAMED_WINDOW

Fields inherited from class org.safs.DDGUIUtilities

appmaps, DEBUG_MESSAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, GENERIC_MESSAGE, log, PASSED_MESSAGE, trdata, WARNING_MESSAGE, WARNING_OK_MESSAGE

Fields inherited from class org.safs.STAFRequester

staf

Constructor Summary

Constructors

Constructor and Description
SeleniumGUIUtilities() No-argument constructor.
SeleniumGUIUtilities(STAFHelper helper, LogUtilities log) Constructor providing the STAFHelper and LogUtilities needed for proper operation.
SeleniumGUIUtilities(STAFHelper helper, TestRecordData data, LogUtilities log) Constructor providing the STAFHelper, LogUtilities, and TestRecordData for proper operation.

Method Summary

Modifier and Type	Method and Description
void	clearFramesCache()
java.util.List<?>	extractListItems(java.lang.Object obj, java.lang.String countProp, java.lang.String itemProp) Extract items from a List or Array type of object property.
Tree	extractMenuBarItems(java.lang.Object obj) Extract a menu hierarchy from a MenuBar pseudo-object reference.
Tree	extractMenuItems(java.lang.Object obj) Extract a menu hierarchy from a object.
java.lang.Object	findPropertyMatchedChild(java.lang.Object obj, java.lang.String property, java.lang.String bench, boolean exactMatch) Attempt to locate a child object based on a matching property value.
java.lang.String[]	getAllWindowNames(com.thoughtworks.selenium.Selenium selenium) Wraps Selenium.getAllWindowNames to handle Selenium defect.
java.lang.String[]	getAllXPaths(java.lang.String tag, com.thoughtworks.selenium.Selenium selenium) Gets all the xpaths for a certain html tag
java.lang.String	getAttribute(com.thoughtworks.selenium.Selenium selenium, java.lang.String xpath, java.lang.String attribute) Purpose: Return the value of attribute for an element indicated by xpath Note: This method will try to DocumentParser to get the value If it can not get the value, it will try the selenium's API getAttribute.
java.util.HashMap	getAttributes(com.thoughtworks.selenium.Selenium selenium, java.lang.String xpath) Purpose: Return the attributes for an element indicated by xpath Note: This method will try to DocumentParser to get the properties
protected java.awt.Rectangle	getComponentBounds(SGuiObject o, com.thoughtworks.selenium.Selenium selenium) Returns the bounds of a component as a Rectangle object
protected java.awt.Rectangle	getComponentBounds(java.lang.String xpath, com.thoughtworks.selenium.Selenium selenium) Returns the absolute bounds of a component on the screen as a Rectangle object
DocumentParser	getDocumentParser(com.thoughtworks.selenium.Selenium selenium) Purpose: Return a HtmlDoParser, if not exist, create a new one.
protected java.lang.String	getFramePath(java.lang.String xpath)
SGuiObject	getGuiObject(java.lang.String recString, com.thoughtworks.selenium.Selenium selenium, java.lang.String windowId) Returns the xpath of the component represented by a robot recognition string
java.lang.String	getListItem(java.lang.Object obj, int i, java.lang.String itemProp) Get a single list item from a List or Array type of object property.
java.lang.String	getProperty(com.thoughtworks.selenium.Selenium selenium, java.lang.String xpath, java.lang.String attribute) Return the value of a specific attribute/property
SGuiObject	getTestObject(java.lang.String mapname, java.lang.String windowName, java.lang.String childName, boolean ignoreCache) Gets the object defined by the windowName and childName
SGuiObject	getWindowIdFromTitle(com.thoughtworks.selenium.Selenium selenium, java.lang.String winRec) Get's the window's id and returns it in the form of an SGuiObject
protected DocumentParser	initDocumentParser(com.thoughtworks.selenium.Selenium selenium) Purpose: Create a new HtmlDoParser, it will replace the older one.
static java.util.regex.Matcher	matchPattern(java.util.regex.Pattern pattern, java.lang.String xpath)
void	maximizeWindow(java.lang.String winRec) Uses ComponentFunctions.dll to maximize the window with the given recognition string.
boolean	maximizeWindow(java.lang.String windowId, com.thoughtworks.selenium.Selenium selenium) Uses Selenium to maximize the window with the given window id. Note: The window can't be resotre after it is maximized by this method.
void	minimizeWindow(java.lang.String winRec) Uses ComponentFunctions.dll to maximize the window with the given recognition string.
protected java.lang.String	navigateFrames(java.lang.String xpath, com.thoughtworks.selenium.Selenium selenium) Selects any frames that are part of the xpath and returns the last component's xpath
protected HtmlFrameComp	navigateFrames(java.lang.String url, java.lang.String xpath, com.thoughtworks.selenium.Selenium selenium) Selects any frames that are part of the xpath and returns the last Frame preceding final component xpath
protected HtmlFrameComp	navigateFrames(java.lang.String url, java.lang.String xpath, com.thoughtworks.selenium.Selenium selenium, java.awt.Rectangle boundsOut) Selects any frames that are part of the xpath and returns the last Frame preceding final component xpath
static java.lang.String	normalizeXPath(java.lang.String xPath)
void	restoreWindow(java.lang.String winRec) Uses ComponentFunctions.dll to maximize the window with the given recognition string.
void	selectTopFrame(com.thoughtworks.selenium.Selenium selenium) Selects the top frame if its not already selected
boolean	selectWindow(com.thoughtworks.selenium.Selenium selenium, java.lang.String id, long timeout) selects a window to send future commands to
int	setActiveWindow(java.lang.String appMapName, java.lang.String windowName, java.lang.String compName) Attempts to "activate" or give focus to the specified window/object via the remote AUT JVM proxies.
boolean	setWindowFocus(java.lang.String winRec) Uses ComponentFunctions.dll to focus the window with the given recognition string.
boolean	setWindowFocus(java.lang.String windowId, com.thoughtworks.selenium.Selenium selenium) Uses Selenium to focus the window with the given window id.
int	waitForObject(java.lang.String appMapName, java.lang.String windowName, java.lang.String compName, long secTimeout) Uses the Application Map caching mechanism provided by the superclass.

Methods inherited from class org.safs.DDGUIUtilities

clearAllAppMapCaches, clearAppMapCache, createAppMapInstance, getAppMap, getLogUtilities, getTestRecordData, isAppMapRegistered, openAppMap, registerAppMap, registerAppMap, setLogUtilities, setTestRecordData

Methods inherited from class org.safs.STAFRequester

getSTAFHelper, setSTAFHelper

Methods inherited from class java.lang.Object

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

Field Detail

FRAME_PATTERN

public static final java.util.regex.Pattern FRAME_PATTERN

frameSwitched

public boolean frameSwitched

UNNAMED_WINDOW

public java.lang.String UNNAMED_WINDOW

domParser

public DocumentParser domParser

Constructor Detail

SeleniumGUIUtilities

public SeleniumGUIUtilities()

No-argument constructor. Simply calls super()

See Also:

DDGUIUtilities.DDGUIUtilities()

SeleniumGUIUtilities

public SeleniumGUIUtilities(STAFHelper helper,
                            LogUtilities log)

Constructor providing the STAFHelper and LogUtilities needed for proper operation.

Parameters:

helper - The STAFHelper for performing STAF requests.

log - the LogUtilities for logging.

See Also:

STAFHelper, LogUtilities

SeleniumGUIUtilities

public SeleniumGUIUtilities(STAFHelper helper,
                            TestRecordData data,
                            LogUtilities log)

Constructor providing the STAFHelper, LogUtilities, and TestRecordData for proper operation. The SAFS/Selenium engine generally uses an instanceof STestRecordHelper for TestRecordData.

Parameters:

helper - The STAFHelper for performing STAF requests.

data - the TestRecordData generally an instanceof STestRecordHelper.

log - the LogUtilities for logging.

See Also:

STAFHelper, STestRecordHelper, LogUtilities

Method Detail

waitForObject

public int waitForObject(java.lang.String appMapName,
                         java.lang.String windowName,
                         java.lang.String compName,
                         long secTimeout)
                  throws SAFSObjectNotFoundException

Uses the Application Map caching mechanism provided by the superclass. Retrieves cached references or recognition strings from the App Map and attempts to identify the matching component via the remote AUT JVM proxies.

Specified by:

waitForObject in class DDGUIUtilities

Parameters:

appMapName - the name/ID of the App Map currently in use.

windowName - the name/ID of the window as predefined in the App Map.

compName - the name/ID of the child component of the window as predefined in the App Map.

secTimeout - the number of seconds allowed to located the object before a SAFSObjectNotFoundException is thrown.

Returns:

0 on success. throw SAFSObjectNotFoundException if not successful.

Throws:

SAFSObjectNotFoundException - if specified parent or child cannot be found.

See Also:

DDGUIUtilities.waitForObject(String,String,String,long)

getTestObject

public SGuiObject getTestObject(java.lang.String mapname,
                                java.lang.String windowName,
                                java.lang.String childName,
                                boolean ignoreCache)

Gets the object defined by the windowName and childName

Parameters:

mapName - the name/ID of the App Map currently in use.

windowName - the name/ID of the window as predefined in the App Map.

childName - the name/ID of the child component of the window as predefined in the App Map.

ignoreCache - if true, try getting the component from the appmap

Returns:

the object defined by the windowName and childName

selectWindow

public boolean selectWindow(com.thoughtworks.selenium.Selenium selenium,
                            java.lang.String id,
                            long timeout)

selects a window to send future commands to

Parameters:

selenium - Current Selenium object

id - windowId--can be null

timeout - how long to wait for the window in seconds

Returns:

whether window was found

getAllWindowNames

public java.lang.String[] getAllWindowNames(com.thoughtworks.selenium.Selenium selenium)

Wraps Selenium.getAllWindowNames to handle Selenium defect. Something buggy about later versions of Selenium. Later versions return the window names in one comma-delimited string in the first array item. This wrapper will handle this situation if present.

Returns:

String array. Empty window names are replaced with INVALID_WINDOWNAME in the array before it is returned. An array of one "null" item will be returned if no windows were found.

getWindowIdFromTitle

public SGuiObject getWindowIdFromTitle(com.thoughtworks.selenium.Selenium selenium,
                                       java.lang.String winRec)

Get's the window's id and returns it in the form of an SGuiObject

Parameters:

selenium - current selenium object

winRec - window recognition string

Returns:

object representing the window defined by the winRec

setActiveWindow

public int setActiveWindow(java.lang.String appMapName,
                           java.lang.String windowName,
                           java.lang.String compName)
                    throws SAFSObjectNotFoundException

Attempts to "activate" or give focus to the specified window/object via the remote AUT JVM proxies.

Specified by:

setActiveWindow in class DDGUIUtilities

Parameters:

appMapName - name of AppMap used to lookup component.

windowName - name of Window in AppMap.

compName - name of Window Component in AppMap. If the Window IS the desired Component, then both windowName and compName will be the same.

Returns:

0 on success.

Throws:

SAFSObjectNotFoundException - if the specified component cannot be found.

See Also:

DDGUIUtilities.setActiveWindow(String,String,String)

selectTopFrame

public void selectTopFrame(com.thoughtworks.selenium.Selenium selenium)

Selects the top frame if its not already selected

Parameters:

selenium - Current selenium object

getProperty

public java.lang.String getProperty(com.thoughtworks.selenium.Selenium selenium,
                                    java.lang.String xpath,
                                    java.lang.String attribute)

Return the value of a specific attribute/property

Parameters:

selenium - current Selenium object

xpath - Selenium XPATH to desired element

attribute - case-sensitive property name

Returns:

value of property or null

getGuiObject

public SGuiObject getGuiObject(java.lang.String recString,
                               com.thoughtworks.selenium.Selenium selenium,
                               java.lang.String windowId)

Returns the xpath of the component represented by a robot recognition string

Parameters:

recString - robot recognition string

selenium - current selenium object

windowId - window containing the object

Returns:

xpath string

normalizeXPath

public static java.lang.String normalizeXPath(java.lang.String xPath)

matchPattern

public static java.util.regex.Matcher matchPattern(java.util.regex.Pattern pattern,
                                                   java.lang.String xpath)

getFramePath

protected java.lang.String getFramePath(java.lang.String xpath)

navigateFrames

protected java.lang.String navigateFrames(java.lang.String xpath,
                                          com.thoughtworks.selenium.Selenium selenium)

Selects any frames that are part of the xpath and
returns the last component's xpath

Parameters:

xpath - xpath of the frames and component that needs to be interacted with

selenium - current selenium object

Returns:

the last component's xpath

navigateFrames

protected HtmlFrameComp navigateFrames(java.lang.String url,
                                       java.lang.String xpath,
                                       com.thoughtworks.selenium.Selenium selenium)

Selects any frames that are part of the xpath and
returns the last Frame preceding final component xpath

Parameters:

url - from where the xpath will be parsed, that is, the page indicated by url should contain the element described by xpath

xpath - xpath of the frames and component that needs to be interacted with

selenium - current selenium object

Returns:

HtmlFrameComp, it contains
src: the url (the last frame's src), where the last XPATH is located
locator: the frame's locator recognized by selenium
fullXpath: the full xpath to represent the last preceding frame
recognitionString: the recognition string of preceding frames
childXpath: last part XPATH, without preceding frame's xpath

navigateFrames

protected HtmlFrameComp navigateFrames(java.lang.String url,
                                       java.lang.String xpath,
                                       com.thoughtworks.selenium.Selenium selenium,
                                       java.awt.Rectangle boundsOut)

Selects any frames that are part of the xpath and
returns the last Frame preceding final component xpath

Parameters:

url - from where the xpath will be parsed, that is, the page indicated by url should contain the element described by xpath

xpath - xpath of the frames and component that needs to be interacted with

selenium - current selenium object

boundsOut - object that will contain the bounds of the component after its found

Returns:

HtmlFrameComp, it contains
src: the url (the last frame's src), where the last XPATH is located
locator: the frame's locator recognized by selenium
fullXpath: the full xpath to represent the last preceding frame
recognitionString: the recognition string of preceding frames
childXpath: last part XPATH, without preceding frame's xpath

getComponentBounds

protected java.awt.Rectangle getComponentBounds(SGuiObject o,
                                                com.thoughtworks.selenium.Selenium selenium)

Returns the bounds of a component as a Rectangle object

Parameters:

o - object describing the component

selenium - current selenium object

Returns:

bounds as a rectangle object

getComponentBounds

protected java.awt.Rectangle getComponentBounds(java.lang.String xpath,
                                                com.thoughtworks.selenium.Selenium selenium)

Returns the absolute bounds of a component on the screen as a Rectangle object

Parameters:

xpath - xpath string describing the component

selenium - current selenium object

Returns:

bounds as a rectangle object or null

initDocumentParser

protected DocumentParser initDocumentParser(com.thoughtworks.selenium.Selenium selenium)

Purpose: Create a new HtmlDoParser, it will replace the older one.

Parameters:

selenium -

Returns:

getDocumentParser

public DocumentParser getDocumentParser(com.thoughtworks.selenium.Selenium selenium)

Purpose: Return a HtmlDoParser, if not exist, create a new one.

Parameters:

selenium -

Returns:

getAttribute

public java.lang.String getAttribute(com.thoughtworks.selenium.Selenium selenium,
                                     java.lang.String xpath,
                                     java.lang.String attribute)

Purpose: Return the value of attribute for an element indicated by xpath Note: This method will try to DocumentParser to get the value
If it can not get the value, it will try the selenium's API getAttribute.

Parameters:

selenium - The instance of Selenium

xpath - Xpath to represent the element in html page

attribute - The name of attribute

Returns:

The value of attribute

See Also:

DocumentParser.getAttribute(String, String, String)

getAttributes

public java.util.HashMap getAttributes(com.thoughtworks.selenium.Selenium selenium,
                                       java.lang.String xpath)

Purpose: Return the attributes for an element indicated by xpath Note: This method will try to DocumentParser to get the properties

Parameters:

selenium - The instance of Selenium

xpath - Xpath to represent the element in html page

Returns:

The attributes

See Also:

DocumentParser.getAttributes(String, String)

getAllXPaths

public java.lang.String[] getAllXPaths(java.lang.String tag,
                                       com.thoughtworks.selenium.Selenium selenium)

Gets all the xpaths for a certain html tag

Parameters:

tag - html tag of the components to get the xpaths for

selenium - current selenium object

Returns:

array of all the xpath strings

extractListItems

public java.util.List<?> extractListItems(java.lang.Object obj,
                                          java.lang.String countProp,
                                          java.lang.String itemProp)
                                   throws SAFSException

Description copied from class: DDGUIUtilities

Extract items from a List or Array type of object property.

Specified by:

extractListItems in class DDGUIUtilities

Returns:

List

Throws:

SAFSException

extractMenuBarItems

public Tree extractMenuBarItems(java.lang.Object obj)
                         throws SAFSException

Description copied from class: DDGUIUtilities

Extract a menu hierarchy from a MenuBar pseudo-object reference. Often this can be served by the extracMenuItems function. This is generally for JMenuBars.

Specified by:

extractMenuBarItems in class DDGUIUtilities

Returns:

org.safs.Tree

Throws:

SAFSException

extractMenuItems

public Tree extractMenuItems(java.lang.Object obj)
                      throws SAFSException

Description copied from class: DDGUIUtilities

Extract a menu hierarchy from a object. This is generally for JPopupMenus, JMenus, and JMenuItems (JMenu is subclass of JMenuItem).

Specified by:

extractMenuItems in class DDGUIUtilities

Returns:

org.safs.Tree

Throws:

SAFSException

findPropertyMatchedChild

public java.lang.Object findPropertyMatchedChild(java.lang.Object obj,
                                                 java.lang.String property,
                                                 java.lang.String bench,
                                                 boolean exactMatch)
                                          throws SAFSObjectNotFoundException

Description copied from class: DDGUIUtilities

Attempt to locate a child object based on a matching property value. The check can require an exactMatch; or, a case-insensitive partial substring match if the exactMatch parameter is false. (Can use StringUtils.isCaseContainsMatch)

Specified by:

findPropertyMatchedChild in class DDGUIUtilities

Parameters:

obj - -- the pseudo-object reference whose children will be evaluated.

property - -- the property of each child that will be evaluated. The property is expected to be one that can successfully return a value cast as type String.

bench - -- the benchmark value for the property to be used in comparisons.

exactMatch - -- if true, an exact case-sensitive match of the bench value provided is required to signal a match.
if false, a case-insensitive partial substring match with the bench value is performed.

Returns:

Object, the first child pseudo-object whose property value matches accordingly.

Throws:

SAFSObjectNotFoundException - if no matching child object is found.

See Also:

StringUtils.isCaseContainsMatch(String,String,boolean)

getListItem

public java.lang.String getListItem(java.lang.Object obj,
                                    int i,
                                    java.lang.String itemProp)
                             throws SAFSException

Description copied from class: DDGUIUtilities

Get a single list item from a List or Array type of object property.

Specified by:

getListItem in class DDGUIUtilities

Returns:

String

Throws:

SAFSException

setWindowFocus

public boolean setWindowFocus(java.lang.String winRec)

Uses ComponentFunctions.dll to focus the window with the given recognition string.

Parameters:

winRec - window to be focused

Returns:

true if window was found, false otherwise

setWindowFocus

public boolean setWindowFocus(java.lang.String windowId,
                              com.thoughtworks.selenium.Selenium selenium)

Uses Selenium to focus the window with the given window id.

Parameters:

windowId - window's name or title

selenium - the instance of Selenium object

Returns:

true if window was found, false otherwise

maximizeWindow

public boolean maximizeWindow(java.lang.String windowId,
                              com.thoughtworks.selenium.Selenium selenium)

Uses Selenium to maximize the window with the given window id.
Note: The window can't be resotre after it is maximized by this method.

Parameters:

windowId - window's name or title

selenium - the instance of Selenium object

Returns:

true if window was maximized, false otherwise

maximizeWindow

public void maximizeWindow(java.lang.String winRec)

Uses ComponentFunctions.dll to maximize the window with the given recognition string.

Parameters:

winRec - window to be maximize

minimizeWindow

public void minimizeWindow(java.lang.String winRec)

Uses ComponentFunctions.dll to maximize the window with the given recognition string.

Parameters:

winRec - window to be maximize

restoreWindow

public void restoreWindow(java.lang.String winRec)

Uses ComponentFunctions.dll to maximize the window with the given recognition string.

Parameters:

winRec - window to be maximize

clearFramesCache

public void clearFramesCache()