Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.WebDriver.Config

Contents

WebDriver configuration
Capabilities helpers
SessionHistoryConfig options
Overloadable configuration

Synopsis

data WDConfig = WDConfig {
- wdHost :: String
- wdPort :: Int
- wdCapabilities :: Capabilities
- wdBasePath :: String
- wdRequestHeaders :: RequestHeaders
- wdAuthHeaders :: RequestHeaders
- wdHistoryConfig :: SessionHistoryConfig
- wdHTTPManager :: Maybe Manager
- wdHTTPRetryCount :: Int
}
defaultConfig :: WDConfig
modifyCaps :: HasCapabilities t => (Capabilities -> Capabilities) -> t -> t
useBrowser :: HasCapabilities t => Browser -> t -> t
useVersion :: HasCapabilities t => String -> t -> t
usePlatform :: HasCapabilities t => Platform -> t -> t
useProxy :: HasCapabilities t => ProxyType -> t -> t
type SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory]
noHistory :: SessionHistoryConfig
unlimitedHistory :: SessionHistoryConfig
onlyMostRecentHistory :: SessionHistoryConfig
class WebDriverConfig c where
- mkCaps :: MonadBase IO m => c -> m Capabilities
- mkSession :: MonadBase IO m => c -> m WDSession

WebDriver configuration

data WDConfig Source #

WebDriver session configuration

Constructors

WDConfig

Fields

wdHost :: String
Host name of the WebDriver server for this session (default 127.0.0.1)
wdPort :: Int
Port number of the server (default 4444)
wdCapabilities :: Capabilities
Capabilities to use for this session
wdBasePath :: String
Base path for all API requests (default "/wd/hub")
wdRequestHeaders :: RequestHeaders
Custom request headers to add to every HTTP request.
wdAuthHeaders :: RequestHeaders
Custom request headers to add *only* to session creation requests. This is usually done when a WebDriver server requires HTTP auth.
wdHistoryConfig :: SessionHistoryConfig
Specifies behavior of HTTP request/response history. By default we use unlimitedHistory.
wdHTTPManager :: Maybe Manager
Use the given http-client Manager instead of automatically creating one.
wdHTTPRetryCount :: Int
Number of times to retry a HTTP request if it times out (default 0)

Instances

Instances details

Default WDConfig Source #
Instance details Defined in Test.WebDriver.Config Methods def :: WDConfig #
GetCapabilities WDConfig Source #
Instance details Defined in Test.WebDriver.Config Methods getCaps :: WDConfig -> Capabilities Source #
SetCapabilities WDConfig Source #
Instance details Defined in Test.WebDriver.Config Methods setCaps :: Capabilities -> WDConfig -> WDConfig Source #
WebDriverConfig WDConfig Source #
Instance details Defined in Test.WebDriver.Config Methods mkCaps :: MonadBase IO m => WDConfig -> m Capabilities Source # mkSession :: MonadBase IO m => WDConfig -> m WDSession Source #

defaultConfig :: WDConfig Source #

A default session config connects to localhost on port 4444, and hasn't been initialized server-side. This value is the same as def but with a less polymorphic type.

Capabilities helpers

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

SessionHistoryConfig options

type SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory] Source #

A function used by wdHistoryConfig to append new entries to session history.

noHistory :: SessionHistoryConfig Source #

No session history is saved.

unlimitedHistory :: SessionHistoryConfig Source #

Keep unlimited history

onlyMostRecentHistory :: SessionHistoryConfig Source #

Saves only the most recent history

Overloadable configuration

class WebDriverConfig c where Source #

Class of types that can configure a WebDriver session.

Methods

mkCaps :: MonadBase IO m => c -> m Capabilities Source #

Produces a Capabilities from the given configuration.

mkSession :: MonadBase IO m => c -> m WDSession Source #

Produces a WDSession from the given configuration.

Instances

Instances details

WebDriverConfig WDConfig Source #
Instance details Defined in Test.WebDriver.Config Methods mkCaps :: MonadBase IO m => WDConfig -> m Capabilities Source # mkSession :: MonadBase IO m => WDConfig -> m WDSession Source #