Test.WebDriver.Commands

This module exports basic WD actions that can be used to interact with a browser session.

Sessions

createSession :: Capabilities -> WD WDSession

Create a new session with the given Capabilities. This command resets the current session ID to that of the new session.

closeSession :: WD ()

Close the current session and the browser associated with it.

sessions :: WD [(SessionId, Capabilities)]

Retrieve a list of active sessions and their Capabilities.

getCaps :: WD Capabilities

Get the actual Capabilities of the current session.

Browser interaction

Web navigation

openPage :: String -> WD ()

Opens a new page by the given URL.

forward :: WD ()

Navigate forward in the browser history.

back :: WD ()

Navigate backward in the browser history.

refresh :: WD ()

Refresh the current page

Page info

getCurrentURL :: WD String

Gets the URL of the current page.

getSource :: WD Text

Get the current page source

getTitle :: WD Text

Get the title of the current page.

screenshot :: WD ByteString

Grab a screenshot of the current page as a PNG image

Timeouts

setImplicitWait :: Integer -> WD ()

Sets the amount of time we implicitly wait when searching for Elements.

setScriptTimeout :: Integer -> WD ()

Sets the amount of time we wait for an asynchronous script to return a result

Web elements

newtype Element

An opaque identifier for a web page element.

Constructors

Element Text

Instances

Eq Element

Ord Element

Read Element

Show Element

ToJSON Element

FromJSON Element

data Selector

Specifies element(s) within a DOM tree using various selection methods.

Constructors

ById Text

ByName Text

ByClass Text

(Note: multiple classes are not allowed. For more control, use ByCSS)

ByTag Text

ByLinkText Text

ByPartialLinkText Text

ByCSS Text

ByXPath Text

Instances

Eq Selector

Ord Selector

Show Selector

ToJSON Selector

Searching for elements

findElem :: Selector -> WD Element

Find an element on the page using the given element selector.

findElems :: Selector -> WD [Element]

Find all elements on the page matching the given selector.

findElemFrom :: Element -> Selector -> WD Element

Search for an element using the given element as root.

findElemsFrom :: Element -> Selector -> WD [Element]

Find all elements matching a selector, using the given element as root.

Interacting with elements

click :: Element -> WD ()

Click on an element.

submit :: Element -> WD ()

Submit a form element. This may be applied to descendents of a form element as well.

getText :: Element -> WD Text

Get all visible text within this element.

sendKeys :: Text -> Element -> WD ()

Send a sequence of keystrokes to an element. All modifier keys are released at the end of the function. For more information about modifier keys, see http://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value

sendRawKeys :: Text -> Element -> WD ()

Similar to sendKeys, but doesn't implicitly release modifier keys afterwards. This allows you to combine modifiers with mouse clicks.

clearInput :: Element -> WD ()

Clear a textarea or text input element's value.

Element information

attr :: Element -> Text -> WD (Maybe Text)

Retrieve the value of an element's attribute

cssProp :: Element -> Text -> WD (Maybe Text)

Retrieve the value of an element's computed CSS property

elemPos :: Element -> WD (Int, Int)

Retrieve an element's current position.

elemSize :: Element -> WD (Word, Word)

Retrieve an element's current size.

isSelected :: Element -> WD Bool

Determine if the element is selected.

isEnabled :: Element -> WD Bool

Determine if the element is enabled.

isDisplayed :: Element -> WD Bool

Determine if the element is displayed.

tagName :: Element -> WD Text

Return the tag name of the given element.

activeElem :: WD Element

Return the element that currently has focus.

elemInfo :: Element -> WD Value

Describe the element. Returns a JSON object whose meaning is currently undefined by the WebDriver protocol.

Element equality

(<==>) :: Element -> Element -> WD Bool

Determines if two element identifiers refer to the same element.

(</=>) :: Element -> Element -> WD Bool

Determines if two element identifiers refer to different elements.

Javascript

executeJS :: FromJSON a => [JSArg] -> Text -> WD a

Inject a snippet of Javascript into the page for execution in the context of the currently selected frame. The executed script is assumed to be synchronous and the result of evaluating the script is returned and converted to an instance of FromJSON.

The first parameter defines arguments to pass to the javascript function. Arguments of type Element will be converted to the corresponding DOM element. Likewise, any elements in the script result will be returned to the client as Elements.

The second parameter defines the script itself in the form of a function body. The value returned by that function will be returned to the client. The function will be invoked with the provided argument list and the values may be accessed via the arguments object in the order specified.

asyncJS :: FromJSON a => [JSArg] -> Text -> WD (Maybe a)

Executes a snippet of Javascript code asynchronously. This function works similarly to executeJS, except that the Javascript is passed a callback function as its final argument. The script should call this function to signal that it has finished executing, passing to it a value that will be returned as the result of asyncJS. A result of Nothing indicates that the Javascript function timed out (see setScriptTimeout)

data JSArg

An existential wrapper for any ToJSON instance. This allows us to pass parameters of many different types to Javascript code.

Constructors

forall a . ToJSON a => JSArg a

Instances

ToJSON JSArg

Windows

newtype WindowHandle

An opaque identifier for a browser window

Constructors

WindowHandle Text

Instances

Eq WindowHandle

Ord WindowHandle

Read WindowHandle

Show WindowHandle

ToJSON WindowHandle

FromJSON WindowHandle

currentWindow :: WindowHandle

A special WindowHandle that always refers to the currently focused window.

getCurrentWindow :: WD WindowHandle

Returns a handle to the currently focused window

focusWindow :: WindowHandle -> WD ()

Switches focus to a given window.

closeWindow :: WindowHandle -> WD ()

Closes the given window

windows :: WD [WindowHandle]

Returns a list of all windows available to the session

getWindowSize :: WindowHandle -> WD (Word, Word)

Get the dimensions of the given window.

setWindowSize :: WindowHandle -> (Word, Word) -> WD ()

Set the dimensions of the given window.

getWindowPos :: WindowHandle -> WD (Int, Int)

Get the coordinates of the given window.

setWindowPos :: WindowHandle -> (Int, Int) -> WD ()

Set the coordinates of the given window.

Cookies

data Cookie

Cookies are delicious delicacies.

Constructors

Cookie

Fields

cookName :: Text

cookValue :: Text

cookPath :: Maybe Text

cookDomain :: Maybe Text

cookSecure :: Maybe Bool

cookExpiry :: Maybe Integer

Instances

Eq Cookie

Show Cookie

ToJSON Cookie

FromJSON Cookie

cookies :: WD [Cookie]

Retrieve all cookies visible to the current page.

setCookie :: Cookie -> WD ()

Set a cookie. If the cookie path is not specified, it will default to "/". Likewise, if the domain is omitted, it will default to the current page's domain

deleteCookie :: Cookie -> WD ()

Delete a cookie. This will do nothing is the cookie isn't visible to the current page.

deleteVisibleCookies :: WD ()

Delete all visible cookies on the current page.

Alerts

getAlertText :: WD Text

Get the text of an alert dialog.

replyToAlert :: Text -> WD ()

Sends keystrokes to Javascript prompt() dialog.

acceptAlert :: WD ()

Accepts the currently displayed alert dialog.

dismissAlert :: WD ()

Dismisses the currently displayed alert dialog.

Mouse gestures

moveTo :: (Int, Int) -> WD ()

Moves the mouse to the given position relative to the active element.

moveToCenter :: Element -> WD ()

Moves the mouse to the center of a given element.

moveToFrom :: (Int, Int) -> Element -> WD ()

Moves the mouse to the given position relative to the given element.

clickWith :: MouseButton -> WD ()

Click at the current mouse position with the given mouse button.

data MouseButton

A mouse button

Constructors

LeftButton

MiddleButton

RightButton

Instances

Bounded MouseButton

Enum MouseButton

Eq MouseButton

Ord MouseButton

Show MouseButton

ToJSON MouseButton

FromJSON MouseButton

mouseDown :: WD ()

Press and hold the left mouse button down. Note that undefined behavior occurs if the next mouse command is not mouseUp.

mouseUp :: WD ()

Release the left mouse button.

withMouseDown :: WD a -> WD a

Perform the given action with the left mouse button held down. The mouse is automatically released afterwards.

doubleClick :: WD ()

Double click at the current mouse location.

Touch gestures

touchClick :: Element -> WD ()

Single tap on the touch screen at the given element's location.

touchDown :: (Int, Int) -> WD ()

Emulates pressing a finger down on the screen at the given location.

touchUp :: (Int, Int) -> WD ()

Emulates removing a finger from the screen at the given location.

touchMove :: (Int, Int) -> WD ()

Emulates moving a finger on the screen to the given location.

touchScroll :: (Int, Int) -> WD ()

Emulate finger-based touch scroll. Use this function if you don't care where the scroll begins

touchScrollFrom :: (Int, Int) -> Element -> WD ()

Emulate finger-based touch scroll, starting from the given location relative to the given element.

touchDoubleClick :: Element -> WD ()

Emulate a double click on a touch device.

touchLongClick :: Element -> WD ()

Emulate a long click on a touch device.

touchFlick :: (Int, Int) -> WD ()

Emulate a flick on the touch screen. The coordinates indicate x and y velocity, respectively. Use this function if you don't care where the flick starts.

touchFlickFrom

Arguments

:: Int

flick velocity

-> (Int, Int)

a location relative to the given element

-> Element

the given element

-> WD ()

Emulate a flick on the touch screen.

Screen orientation

data Orientation

A screen orientation

Constructors

Landscape

Portrait

Instances

Bounded Orientation

Enum Orientation

Eq Orientation

Ord Orientation

Show Orientation

ToJSON Orientation

FromJSON Orientation

getOrientation :: WD Orientation

Get the current screen orientation for rotatable display devices.

setOrientation :: Orientation -> WD ()

Set the current screen orientation for rotatable display devices.

Geo-location

getLocation :: WD (Int, Int, Int)

Get the current geographical location of the device.

setLocation :: (Int, Int, Int) -> WD ()

Set the current geographical location of the device.

IME support

availableIMEEngines :: WD [Text]

activeIMEEngine :: WD Text

checkIMEActive :: WD Bool

activateIME :: Text -> WD ()

deactivateIME :: WD ()

Server information

serverStatus :: WD Value

Get information from the server as a JSON Object. For more information about this object see http://code.google.com/p/selenium/wiki/JsonWireProtocol#/status