Safe Haskell	Safe-Infered

Test.WebDriver

Contents

WebDriver sessions
Running WebDriver tests
Capabilities and configuration
- Browser-specific configuration
WebDriver commands
Exceptions

Description

This module serves as the top-level interface to the Haskell WebDriver bindings, providing most of the functionality you're likely to want.

Synopsis

WebDriver sessions

newtype WD a Source

A monadic interface to the WebDriver server. This monad is a simple, strict layer over IO, threading session information between sequential commands

Constructors

WD (StateT WDSession IO a)

Instances

Monad WD
Functor WD
Applicative WD
MonadIO WD
MonadBase IO WD
MonadBaseControl IO WD
MonadState WDSession WD

data WDSession Source

Information about a WebDriver session. This structure is passed implicitly through all WD computations, and is also used to configure the WD monad before execution.

Constructors

WDSession

Fields

wdHost :: String: Host name of the WebDriver server for this session
wdPort :: Word16: Port number of the server
wdSessId :: Maybe SessionId: An opaque reference identifying the session to use with WD commands. A value of Nothing indicates that a session hasn't been created yet. Sessions can be created within WD via the createSession, or created and closed automatically with runSession

Instances

Eq WDSession
Show WDSession
Default WDSession
MonadState WDSession WD

defaultSession :: WDSession Source

A default session connects to localhost on port 4444, and hasn't been created yet. This value is the same as def but with a more specific type.

newtype SessionId Source

An opaque identifier for a WebDriver session. These handles are produced by the server on session creation, and act to identify a session in progress.

Constructors

SessionId Text

Instances

Eq SessionId
Ord SessionId
Read SessionId
Show SessionId
ToJSON SessionId
FromJSON SessionId

Running WebDriver tests

runWD :: WDSession -> WD a -> IO aSource

Executes a WD computation within the IO monad, using the given WDSession.

runSession :: WDSession -> Capabilities -> WD a -> IO aSource

Like runWD, but automatically creates a session beforehand and closes it afterwards. This is a very common use case.

withSession :: WDSession -> WD a -> WD aSource

Locally sets a WDSession for use within the given WD action. The state of the outer action is unaffected by this function. This function is useful if you need to work with multiple sessions at once.

finallyClose :: WD a -> WD aSource

A finalizer ensuring that the session is always closed at the end of the given WD action, regardless of any exceptions.

closeOnException :: WD a -> WD aSource

A variant of finallyClose that only closes the session when an asynchronous exception is thrown, but otherwise leaves the session open if the action was successful.

Capabilities and configuration

data Capabilities Source

A structure describing the capabilities of a session. This record serves dual roles.

It's used to specify the desired capabilities for a session before it's created. In this usage, fields that are set to Nothing indicate that we have no preference for that capability.
When received from the server , it's used to describe the actual capabilities given to us by the WebDriver server. Here a value of Nothing indicates that the server doesn't support the capability. Thus, for Maybe Bool fields, both Nothing and Just False indicate a lack of support for the desired capability.

Constructors

Capabilities

Fields

browser :: Browser: Browser choice and browser specific settings.
version :: Maybe String: Browser version to use.
platform :: Platform: Platform on which the browser should/will run.
proxy :: ProxyType: Proxy configuration.
javascriptEnabled :: Maybe Bool
takesScreenshot :: Maybe Bool
handlesAlerts :: Maybe Bool
databaseEnabled :: Maybe Bool
locationContextEnabled :: Maybe Bool
applicationCacheEnabled :: Maybe Bool
browserConnectionEnabled :: Maybe Bool
cssSelectorsEnabled :: Maybe Bool
webStorageEnabled :: Maybe Bool
rotatable :: Maybe Bool
acceptSSLCerts :: Maybe Bool
nativeEvents :: Maybe Bool

Instances

Eq Capabilities
Show Capabilities
ToJSON Capabilities
FromJSON Capabilities
Default Capabilities

defaultCaps :: Capabilities Source

Default capabilities. This is the same as the Default instance, but with less polymorphism. By default, we use firefox of an unspecified version with default system-wide proxy settings on whatever platform is available. All Maybe Bool capabilities are set to Nothing (no preference).

allCaps :: Capabilities Source

Same as defaultCaps, but with all Maybe Bool capabilities set to Just True.

data Platform Source

Represents platform options supported by WebDriver. The value Any represents no preference.

Constructors

Windows
XP
Vista
Mac
Linux
Unix
Any

Instances

Bounded Platform
Enum Platform
Eq Platform
Ord Platform
Show Platform
ToJSON Platform
FromJSON Platform

data ProxyType Source

Available settings for the proxy Capabilities field

Constructors

NoProxy
UseSystemSettings
AutoDetect
PAC	Use a proxy auto-config file specified by URL
Fields autoConfigUrl :: String
Manual	Manually specify proxy hosts as hostname:port strings. Note that behavior is undefined for empty strings.
Fields ftpProxy :: String sslProxy :: String httpProxy :: String

Instances

Eq ProxyType
Show ProxyType
ToJSON ProxyType
FromJSON ProxyType

Browser-specific configuration

data Browser Source

Browser setting and browser-specific capabilities.

Constructors

Firefox
Fields ffProfile :: Maybe PreparedFirefoxProfile The firefox profile to use. If Nothing, a default temporary profile is automatically created and used. ffLogPref :: Maybe FFLogPref Firefox logging preference ffBinary :: Maybe FilePath Path to Firefox binary. If Nothing, use a sensible system-based default.
Chrome
Fields chromeDriverVersion :: Maybe String Version of the Chrome Webdriver server server to use. for more information on chromedriver see http://code.google.com/p/selenium/wiki/ChromeDriver chromeBinary :: Maybe FilePath Path to Chrome binary. If Nothing, use a sensible system-based default. chromeOptions :: [String] A list of command-line options to pass to the Chrome binary. chromeExtensions :: [ChromeExtension] A list of extensions to use.
IE
Fields ignoreProtectedModeSettings :: Bool
Opera	(Opera-specific configuration coming soon!)
HTMLUnit
IPhone
IPad
Android

Instances

Eq Browser
Show Browser
ToJSON Browser
FromJSON Browser

firefox :: Browser Source

Default Firefox settings. All fields are set to Nothing.

chrome :: Browser Source

Default Chrome settings. All Maybe fields are set to Nothing, no options are specified, and no extensions are used.

ie :: Browser Source

Default IE settings. ignoreProtectedModeSettings is set to True.

opera :: Browser Source

iPhone :: Browser Source

iPad :: Browser Source

android :: Browser Source

WebDriver commands

module Test.WebDriver.Commands

Exceptions

newtype InvalidURL Source

An invalid URL was given

Constructors

InvalidURL String

Instances

Eq InvalidURL
Show InvalidURL
Typeable InvalidURL
Exception InvalidURL

newtype NoSessionId Source

A command requiring a session ID was attempted when no session ID was available.

Constructors

NoSessionId String

Instances

Eq NoSessionId
Show NoSessionId
Typeable NoSessionId
Exception NoSessionId

newtype BadJSON Source

An error occured when parsing a JSON value.

Constructors

BadJSON String

Instances

Eq BadJSON
Show BadJSON
Typeable BadJSON
Exception BadJSON

data HTTPStatusUnknown Source

An unexpected HTTP status was sent by the server.

Constructors

HTTPStatusUnknown (Int, Int, Int) String

Instances

Eq HTTPStatusUnknown
Show HTTPStatusUnknown
Typeable HTTPStatusUnknown
Exception HTTPStatusUnknown

newtype HTTPConnError Source

HTTP connection errors.

Constructors

HTTPConnError ConnError

Instances

Eq HTTPConnError
Show HTTPConnError
Typeable HTTPConnError
Exception HTTPConnError

newtype UnknownCommand Source

A command was sent to the WebDriver server that it didn't recognize.

Constructors

UnknownCommand String

Instances

Eq UnknownCommand
Show UnknownCommand
Typeable UnknownCommand
Exception UnknownCommand

newtype ServerError Source

A server-side exception occured

Constructors

ServerError String

Instances

Eq ServerError
Show ServerError
Typeable ServerError
Exception ServerError

data FailedCommand Source

This exception encapsulates a broad variety of exceptions that can occur when a command fails.

Constructors

FailedCommand FailedCommandType FailedCommandInfo

Instances

Eq FailedCommand
Show FailedCommand
Typeable FailedCommand
Exception FailedCommand

data FailedCommandInfo Source

Detailed information about the failed command provided by the server.

Constructors

FailedCommandInfo
Fields errMsg :: String The error message. errSess :: WDSession The session associated with the exception. errScreen :: Maybe ByteString A screen shot of the focused window when the exception occured, if provided. errClass :: Maybe String The class in which the exception was raised, if provided. errStack :: [StackFrame] A stack trace of the exception.

Instances

Eq FailedCommandInfo
Show FailedCommandInfo
FromJSON FailedCommandInfo

data StackFrame Source

An individual stack frame from the stack trace provided by the server during a FailedCommand.

Constructors

StackFrame
Fields sfFileName :: String sfClassName :: String sfMethodName :: String sfLineNumber :: Word

Instances

Eq StackFrame
Show StackFrame
FromJSON StackFrame

mkFailedCommandInfo :: String -> WD FailedCommandInfo Source

Constructs a FailedCommandInfo from only an error message.

failedCommand :: FailedCommandType -> String -> WD aSource

Convenience function to throw a FailedCommand locally with no server-side info present.

NoSuchElement
NoSuchFrame
UnknownFrame
StaleElementReference
ElementNotVisible
InvalidElementState
UnknownError
ElementIsNotSelectable
JavascriptError
XPathLookupError
Timeout
NoSuchWindow
InvalidCookieDomain
UnableToSetCookie
UnexpectedAlertOpen
NoAlertOpen
ScriptTimeout
InvalidElementCoordinates
IMENotAvailable
IMEEngineActivationFailed
InvalidSelector
MoveTargetOutOfBounds
InvalidXPathSelector
InvalidXPathSelectorReturnType
MethodNotAllowed

Bounded FailedCommandType
Enum FailedCommandType
Eq FailedCommandType
Ord FailedCommandType
Show FailedCommandType