Modulewebdriver-0.12.0.1Haskell2010

Test.WebDriver.Session

6 types
1 class
9 values

Packagewebdriver-0.12.0.1
Exports16
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSession.hs

WDSessionState class

5 declarations

classclass (Monad m, Applicative m) => WDSessionState (m :: Type -> Type) 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

Instances11WDSessionState, …

WDSessionState WDDefined in webdriver-0.12.0.1 · Test.WebDriver.Monad
WDSessionState m => WDSessionState (MaybeT m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
WDSessionState m => WDSessionState (ExceptT r m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
WDSessionState m => WDSessionState (IdentityT m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
WDSessionState m => WDSessionState (ReaderT r m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
WDSessionState m => WDSessionState (StateT s m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
WDSessionState m => WDSessionState (StateT s m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
(Monoid w, WDSessionState m) => WDSessionState (WriterT w m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
(Monoid w, WDSessionState m) => WDSessionState (WriterT w m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
(Monoid w, WDSessionState m) => WDSessionState (RWST r w s m)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session
(Monoid w, WDSessionState wd) => WDSessionState (RWST r w s wd)Defined in webdriver-0.12.0.1 · Test.WebDriver.Session

typetype WDSessionStateIO (s :: Type -> Type) = (WDSessionState s, MonadBase IO s)

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

typetype WDSessionStateControl (s :: Type -> Type) = (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.

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

valuewithSession :: 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

datadata WDSession

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

Constructors

WDSession
- 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 Test.WebDriver.createSession, or created automatically with Test.WebDriver.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.

valuemostRecentHistory :: WDSession -> Maybe SessionHistory

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

valuemostRecentHTTPRequest :: WDSession -> Maybe Request

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

newtypenewtype 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

Instances6Eq, Ord, Read, Show, FromJSON, ToJSON

Eq SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Ord SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Read SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
Show SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
FromJSON SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session
ToJSON SessionIdDefined in webdriver-0.12.0.1 · Test.WebDriver.Session

datadata SessionHistory

Constructors

SessionHistory
- histRequest :: Request
- histResponse :: Either SomeException (Response ByteString)
- histRetryCount :: Int

Instances1Show

Show SessionHistoryDefined in webdriver-0.12.0.1 · Test.WebDriver.Session.History

SessionHistoryConfig options

4 declarations

typetype SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory]

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

valuenoHistory :: SessionHistoryConfig

No session history is saved.

valueunlimitedHistory :: SessionHistoryConfig

Keep unlimited history

valueonlyMostRecentHistory :: SessionHistoryConfig

Saves only the most recent history

Using custom HTTP request headers

2 declarations

valuewithRequestHeaders

:: 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.

valuewithAuthHeaders :: 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.