Test.WebDriver.Session

WDSessionState class

class (Monad m, Applicative m) => WDSessionState m where

A class for monads that carry a WebDriver session with them. The MonadBaseControl superclass is used for exception handling through the lifted-base package.

Methods

getSession :: m WDSession

Retrieves the current session state of the monad

putSession :: WDSession -> m ()

Sets a new session state for the monad

Instances

WDSessionState WD

WDSessionState m => WDSessionState (ListT m)

WDSessionState m => WDSessionState (MaybeT m)

WDSessionState m => WDSessionState (IdentityT m)

WDSessionState m => WDSessionState (ReaderT r m)

WDSessionState m => WDSessionState (StateT s m)

WDSessionState m => WDSessionState (StateT s m)

(Error e, WDSessionState m) => WDSessionState (ErrorT e m)

(Monoid w, WDSessionState m) => WDSessionState (WriterT w m)

(Monoid w, WDSessionState m) => WDSessionState (WriterT w m)

(Monoid w, WDSessionState wd) => WDSessionState (RWST r w s wd)

(Monoid w, WDSessionState m) => WDSessionState (RWST r w s m)

type WDSessionStateIO s = (WDSessionState s, MonadBase IO s)

Constraint synonym for the common pairing of WDSessionState and MonadBase IO.

type WDSessionStateControl s = (WDSessionState s, MonadBaseControl IO s)

Constraint synonym for another common pairing of WDSessionState and MonadBaseControl IO. This is commonly used in library types to indicate use of lifted exception handling.

modifySession :: WDSessionState s => (WDSession -> WDSession) -> s ()

withSession :: WDSessionStateControl m => WDSession -> m a -> m a

Locally sets a session state for use within the given action. The state of any outside action is unaffected by this function. This function is useful if you need to work with multiple sessions simultaneously.

WebDriver sessions

data WDSession

The local state of a WebDriver session. This structure is passed implicitly through all WD computations

Constructors

WDSession

Fields

wdSessHost :: ByteString

wdSessPort :: Int

wdSessBasePath :: ByteString

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 createSession, or created automatically with runSession

wdSessHist :: [SessionHistory]

The complete history of HTTP requests and responses, most recent first.

wdSessHistUpdate :: SessionHistoryConfig

Update function used to append new entries to session history

wdSessHTTPManager :: Manager

HTTP Manager used for connection pooling by the http-client library.

wdSessHTTPRetryCount :: Int

Number of times to retry a HTTP request if it times out

wdSessRequestHeaders :: RequestHeaders

Custom request headers to add to every HTTP request.

wdSessAuthHeaders :: RequestHeaders

Custom request headers to add *only* to session creation requests. This is usually done when a WebDriver server requires HTTP auth.

mostRecentHistory :: WDSession -> Maybe SessionHistory

The most recent SessionHistory entry recorded by this session, if any.

mostRecentHTTPRequest :: WDSession -> Maybe Request

The most recent HTTP request issued by this session, if any.

newtype SessionId

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

data SessionHistory

Constructors

SessionHistory

Fields

histRequest :: Request

histResponse :: Either SomeException (Response ByteString)

histRetryCount :: Int

Instances

Show SessionHistory

SessionHistoryConfig options

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

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

noHistory :: SessionHistoryConfig

No session history is saved.

unlimitedHistory :: SessionHistoryConfig

Keep unlimited history

onlyMostRecentHistory :: SessionHistoryConfig

Saves only the most recent history

Using custom HTTP request headers

withRequestHeaders :: WDSessionStateControl m => RequestHeaders -> m a -> m a

Set a temporary list of custom RequestHeaders to use within the given action. All previous custom headers are temporarily removed, and then restored at the end.

withAuthHeaders :: WDSessionStateControl m => m a -> m a

Makes all webdriver HTTP requests in the given action use the session's auth headers, typically configured by setting the wdAuthHeaders config. This is useful if you want to temporarily use the same auth headers you used for session creation with other HTTP requests.