Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.WebDriver.Session

Contents

WDSessionState class
- WebDriver sessions
SessionHistoryConfig options
Using custom HTTP request headers

Synopsis

class (Monad m, Applicative m) => WDSessionState m where
- getSession :: m WDSession
- putSession :: WDSession -> m ()
type WDSessionStateIO s = (WDSessionState s, MonadBase IO s)
type WDSessionStateControl s = (WDSessionState s, MonadBaseControl IO s)
modifySession :: WDSessionState s => (WDSession -> WDSession) -> s ()
withSession :: WDSessionStateControl m => WDSession -> m a -> m a
data WDSession = WDSession {
- wdSessHost :: ByteString
- wdSessPort :: Int
- wdSessBasePath :: ByteString
- wdSessId :: Maybe SessionId
- wdSessHist :: [SessionHistory]
- wdSessHistUpdate :: SessionHistoryConfig
- wdSessHTTPManager :: Manager
- wdSessHTTPRetryCount :: Int
- wdSessRequestHeaders :: RequestHeaders
- wdSessAuthHeaders :: RequestHeaders
}
mostRecentHistory :: WDSession -> Maybe SessionHistory
mostRecentHTTPRequest :: WDSession -> Maybe Request
newtype SessionId = SessionId Text
data SessionHistory = SessionHistory {
- histRequest :: Request
- histResponse :: Either SomeException (Response ByteString)
- histRetryCount :: Int
}
type SessionHistoryConfig = SessionHistory -> [SessionHistory] -> [SessionHistory]
noHistory :: SessionHistoryConfig
unlimitedHistory :: SessionHistoryConfig
onlyMostRecentHistory :: SessionHistoryConfig
withRequestHeaders :: WDSessionStateControl m => RequestHeaders -> m a -> m a
withAuthHeaders :: WDSessionStateControl m => m a -> m a

WDSessionState class

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

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 Source #

Retrieves the current session state of the monad

putSession :: WDSession -> m () Source #

Sets a new session state for the monad

Instances

Instances details

WDSessionState WD Source #
Instance details Defined in Test.WebDriver.Monad Methods getSession :: WD WDSession Source # putSession :: WDSession -> WD () Source #
WDSessionState m => WDSessionState (MaybeT m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: MaybeT m WDSession Source # putSession :: WDSession -> MaybeT m () Source #
WDSessionState m => WDSessionState (ExceptT r m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: ExceptT r m WDSession Source # putSession :: WDSession -> ExceptT r m () Source #
WDSessionState m => WDSessionState (IdentityT m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: IdentityT m WDSession Source # putSession :: WDSession -> IdentityT m () Source #
WDSessionState m => WDSessionState (ReaderT r m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: ReaderT r m WDSession Source # putSession :: WDSession -> ReaderT r m () Source #
WDSessionState m => WDSessionState (StateT s m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: StateT s m WDSession Source # putSession :: WDSession -> StateT s m () Source #
WDSessionState m => WDSessionState (StateT s m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: StateT s m WDSession Source # putSession :: WDSession -> StateT s m () Source #
(Monoid w, WDSessionState m) => WDSessionState (WriterT w m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: WriterT w m WDSession Source # putSession :: WDSession -> WriterT w m () Source #
(Monoid w, WDSessionState m) => WDSessionState (WriterT w m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: WriterT w m WDSession Source # putSession :: WDSession -> WriterT w m () Source #
(Monoid w, WDSessionState wd) => WDSessionState (RWST r w s wd) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: RWST r w s wd WDSession Source # putSession :: WDSession -> RWST r w s wd () Source #
(Monoid w, WDSessionState m) => WDSessionState (RWST r w s m) Source #
Instance details Defined in Test.WebDriver.Session Methods getSession :: RWST r w s m WDSession Source # putSession :: WDSession -> RWST r w s m () Source #

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

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

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

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 () Source #

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

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 Source #

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 Source #

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

mostRecentHTTPRequest :: WDSession -> Maybe Request Source #

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

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

Instances details

FromJSON SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] #
ToJSON SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding #
Read SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods readsPrec :: Int -> ReadS SessionId # readList :: ReadS [SessionId] # readPrec :: ReadPrec SessionId # readListPrec :: ReadPrec [SessionId] #
Show SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
Eq SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Ord SessionId Source #
Instance details Defined in Test.WebDriver.Session Methods compare :: SessionId -> SessionId -> Ordering # (<) :: SessionId -> SessionId -> Bool # (<=) :: SessionId -> SessionId -> Bool # (>) :: SessionId -> SessionId -> Bool # (>=) :: SessionId -> SessionId -> Bool # max :: SessionId -> SessionId -> SessionId # min :: SessionId -> SessionId -> SessionId #

data SessionHistory Source #

Constructors

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

Instances

Instances details

Show SessionHistory Source #
Instance details Defined in Test.WebDriver.Session.History Methods showsPrec :: Int -> SessionHistory -> ShowS # show :: SessionHistory -> String # showList :: [SessionHistory] -> ShowS #

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

Using custom HTTP request headers

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

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 Source #

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.