Safe Haskell	None
Language	Haskell98

Test.WebDriver.Capabilities

Synopsis

Documentation

class GetCapabilities t where Source

A typeclass for readable Capabilities

Methods

getCaps :: t -> Capabilities Source

Instances

GetCapabilities Capabilities Source
GetCapabilities WDConfig Source

class SetCapabilities t where Source

A typeclass for writable Capabilities

Methods

setCaps :: Capabilities -> t -> t Source

Instances

SetCapabilities WDConfig Source

type HasCapabilities t = (GetCapabilities t, SetCapabilities t) Source

Read/write Capabilities

modifyCaps :: HasCapabilities t => (Capabilities -> Capabilities) -> t -> t Source

Modifies the wdCapabilities field of a WDConfig by applying the given function. Overloaded to work with any HasCapabilities instance.

useBrowser :: HasCapabilities t => Browser -> t -> t Source

A helper function for setting the browser capability of a HasCapabilities instance

useVersion :: HasCapabilities t => String -> t -> t Source

A helper function for setting the version capability of a HasCapabilities instance

usePlatform :: HasCapabilities t => Platform -> t -> t Source

A helper function for setting the platform capability of a HasCapabilities instance

useProxy :: HasCapabilities t => ProxyType -> t -> t Source

A helper function for setting the useProxy capability of a HasCapabilities instance

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 run.
proxy :: ProxyType: Proxy configuration settings.
javascriptEnabled :: Maybe Bool: Whether the session supports executing JavaScript via executeJS and asyncJS.
takesScreenshot :: Maybe Bool: Whether the session supports taking screenshots of the current page with the screenshot command
handlesAlerts :: Maybe Bool: Whether the session can interact with modal popups, such as window.alert and window.confirm via acceptAlerts, dismissAlerts, etc.
databaseEnabled :: Maybe Bool: Whether the session can interact with database storage.
locationContextEnabled :: Maybe Bool: Whether the session can set and query the browser's location context with setLocation and getLocation.
applicationCacheEnabled :: Maybe Bool: Whether the session can interact with the application cache .
browserConnectionEnabled :: Maybe Bool: Whether the session can query for the browser's connectivity and disable it if desired
cssSelectorsEnabled :: Maybe Bool: Whether the session supports CSS selectors when searching for elements.
webStorageEnabled :: Maybe Bool: Whether Web Storage (getKey, setKey, etc) support is enabled
rotatable :: Maybe Bool: Whether the session can rotate the current page's current layout between Portrait and Landscape orientations.
acceptSSLCerts :: Maybe Bool: Whether the session should accept all SSL certs by default
nativeEvents :: Maybe Bool: Whether the session is capable of generating native OS events when simulating user input.
unexpectedAlertBehavior :: Maybe UnexpectedAlertBehavior: How the session should handle unexpected alerts.
additionalCaps :: [Pair]: A list of (Text, Value) pairs specifying additional non-standard capabilities.

Instances

Eq Capabilities Source
Show Capabilities Source
ToJSON Capabilities Source
FromJSON Capabilities Source
Default Capabilities Source
GetCapabilities Capabilities Source

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 capabilities are set to Nothing (no preference).

allCaps :: Capabilities Source

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

data Browser Source

This constructor simultaneously specifies which browser the session will use, while also providing browser-specific configuration. Default configuration is provided for each browser by firefox, chrome, opera, ie, etc.

This library uses firefox as its Default browser configuration, when no browser choice is specified.

Constructors

Firefox
Fields ffProfile :: Maybe (PreparedProfile Firefox) The firefox profile to use. If Nothing, a default temporary profile is automatically created and used. ffLogPref :: LogLevel Firefox logging preference ffBinary :: Maybe FilePath Server-side 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 Server-side 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 ieIgnoreProtectedModeSettings :: Bool Whether to skip the protected mode check. If set, tests may become flaky, unresponsive, or browsers may hang. If not set, and protected mode settings are not the same for all zones, an exception will be thrown on driver construction. ieIgnoreZoomSetting :: Bool Indicates whether to skip the check that the browser's zoom level is set to 100%. Value is set to false by default. ieInitialBrowserUrl :: Maybe Text Allows the user to specify the initial URL loaded when IE starts. Intended to be used with ignoreProtectedModeSettings to allow the user to initialize IE in the proper Protected Mode zone. Using this capability may cause browser instability or flaky and unresponsive code. Only "best effort" support is provided when using this capability. ieElementScrollBehavior :: IEElementScrollBehavior Allows the user to specify whether elements are scrolled into the viewport for interaction to align with the top or bottom of the viewport. The default value is to align with the top of the viewport. ieEnablePersistentHover :: Bool Determines whether persistent hovering is enabled (true by default). Persistent hovering is achieved by continuously firing mouse over events at the last location the mouse cursor has been moved to. ieEnableElementCacheCleanup :: Bool Determines whether the driver should attempt to remove obsolete elements from the element cache on page navigation (true by default). This is to help manage the IE driver's memory footprint , removing references to invalid elements. ieRequireWindowFocus :: Bool Determines whether to require that the IE window have focus before performing any user interaction operations (mouse or keyboard events). This capability is false by default, but delivers much more accurate native events interactions. ieBrowserAttachTimeout :: Integer The timeout, in milliseconds, that the driver will attempt to locate and attach to a newly opened instance of Internet Explorer . The default is zero, which indicates waiting indefinitely. ieLogFile :: Maybe FilePath The path to file where server should write log messages to. By default it writes to stdout. ieLogLevel :: IELogLevel The log level used by the server. Defaults to `IELogFatal` ieHost :: Maybe Text The address of the host adapter on which the server will listen for commands. ieExtractPath :: Maybe Text The path to the directory used to extract supporting files used by the server. Defaults to the TEMP directory if not specified. ieSilent :: Bool Suppresses diagnostic output when the server is started. ieForceCreateProcess :: Bool Forces launching Internet Explorer using the CreateProcess API. If this option is not specified, IE is launched using the IELaunchURL, if it is available. For IE 8 and above, this option requires the TabProcGrowth registry value to be set to 0. ieSwitches :: Maybe Text Specifies command-line switches with which to launch Internet Explorer. This is only valid when used with the forceCreateProcess.
Opera
Fields operaBinary :: Maybe FilePath Server-side path to the Opera binary operaProduct :: Maybe String Which Opera product we're using, e.g. "desktop", "core" operaDetach :: Bool Whether the Opera instance should stay open after we close the session. If false, closing the session closes the browser. operaAutoStart :: Bool Whether to auto-start the Opera binary. If false, OperaDriver will wait for a connection from the browser. By default this is True. operaIdle :: Bool Whether to use Opera's alternative implicit wait implementation. It will use an in-browser heuristic to guess when a page has finished loading. This feature is experimental, and disabled by default. operaDisplay :: Maybe Int (*nix only) which X display to use. operaLauncher :: Maybe FilePath Path to the launcher binary to use. The launcher is a gateway between OperaDriver and the Opera browser. If Nothing, OperaDriver will use the launcher supplied with the package. operaPort :: Maybe Word16 The port we should use to connect to Opera. If Just 0 , use a random port. If Nothing, use the default Opera port. The default `opera` constructor uses Just 0, since Nothing is likely to cause "address already in use" errors. operaHost :: Maybe String The host Opera should connect to. Unless you're starting Opera manually you won't need this. operaOptions :: Maybe String Command-line arguments to pass to Opera. operaLogFile :: Maybe FilePath Where to send the log output. If Nothing, logging is disabled. operaLogPref :: LogLevel Log level preference. Defaults to `LogInfo`
HTMLUnit
IPhone
IPad
Android
Browser Text	some other browser, specified by a string name

Instances

Eq Browser Source
Show Browser Source
ToJSON Browser Source
FromJSON Browser Source
Default Browser Source

firefox :: Browser Source

Default Firefox settings. All Maybe fields are set to Nothing. ffLogPref is set to LogInfo.

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. See the IE constructor for more details on individual defaults

opera :: Browser Source

Default Opera settings. See the Opera constructor for more details on individual defaults.

htmlUnit :: Browser Source

iPhone :: Browser Source

iPad :: Browser Source

android :: Browser Source

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 Source
Enum Platform Source
Eq Platform Source
Ord Platform Source
Show Platform Source
ToJSON Platform Source
FromJSON Platform Source

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 Source
Show ProxyType Source
ToJSON ProxyType Source
FromJSON ProxyType Source

data LogLevel Source

Indicates a log verbosity level. Used in Firefox and Opera configuration.

Constructors

LogOff
LogSevere
LogWarning
LogInfo
LogConfig
LogFine
LogFiner
LogFinest
LogAll

data IELogLevel Source

Logging levels for Internet Explorer

Constructors

IELogTrace
IELogDebug
IELogInfo
IELogWarn
IELogError
IELogFatal

data IEElementScrollBehavior Source

Specifies how elements scroll into the viewport. (see ieElementScrollBehavior)

Constructors

AlignTop
AlignBottom

Bounded UnexpectedAlertBehavior Source
Enum UnexpectedAlertBehavior Source
Eq UnexpectedAlertBehavior Source
Ord UnexpectedAlertBehavior Source
Read UnexpectedAlertBehavior Source
Show UnexpectedAlertBehavior Source
ToJSON UnexpectedAlertBehavior Source
FromJSON UnexpectedAlertBehavior Source

Bounded LogLevel Source
Enum LogLevel Source
Eq LogLevel Source
Ord LogLevel Source
Read LogLevel Source
Show LogLevel Source
ToJSON LogLevel Source
FromJSON LogLevel Source
Default LogLevel Source

Bounded IELogLevel Source
Enum IELogLevel Source
Eq IELogLevel Source
Ord IELogLevel Source
Read IELogLevel Source
Show IELogLevel Source
ToJSON IELogLevel Source
FromJSON IELogLevel Source
Default IELogLevel Source

Bounded IEElementScrollBehavior Source
Enum IEElementScrollBehavior Source
Eq IEElementScrollBehavior Source
Ord IEElementScrollBehavior Source
Read IEElementScrollBehavior Source
Show IEElementScrollBehavior Source
ToJSON IEElementScrollBehavior Source
FromJSON IEElementScrollBehavior Source
Default IEElementScrollBehavior Source