Web.Api.WebDriver.Monad

A monad transformer for building WebDriver sessions.

Documentation

type WebDriverT eff a = WebDriverTT IdentityT eff a

WebDriverTT over IdentityT.

execWebDriverT :: Monad eff => WebDriverConfig eff -> WebDriverT eff a -> eff (Either (E WDError) a, S WDState, W WDError WDLog)

Execute a WebDriverT session.

debugWebDriverT :: Monad eff => WebDriverConfig eff -> WebDriverT eff a -> eff (Either Text a, AssertionSummary)

Execute a WebDriverT session, returning an assertion summary with the result.

checkWebDriverT

Arguments

:: (Monad eff, Show q)

=> WebDriverConfig eff

-> (eff (Either (E WDError) t, S WDState, W WDError WDLog) -> IO q)

Condense to IO

-> (q -> Bool)

Result check

-> WebDriverT eff t

-> Property

For testing with QuickCheck

data WebDriverTT (t :: (* -> *) -> * -> *) (eff :: * -> *) (a :: *)

Wrapper type around HttpTT; a stack of error, reader, writer, state, and prompt monad transformers.

Instances

(Monad eff, Monad (t eff), MonadTrans t) => Monad (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

(>>=) :: WebDriverTT t eff a -> (a -> WebDriverTT t eff b) -> WebDriverTT t eff b

(>>) :: WebDriverTT t eff a -> WebDriverTT t eff b -> WebDriverTT t eff b

return :: a -> WebDriverTT t eff a

(Monad eff, Monad (t eff), MonadTrans t) => Functor (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

fmap :: (a -> b) -> WebDriverTT t eff a -> WebDriverTT t eff b

(<$) :: a -> WebDriverTT t eff b -> WebDriverTT t eff a

(Monad eff, MonadTrans t, Monad (t eff), MonadFail (t eff)) => MonadFail (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

fail :: String -> WebDriverTT t eff a

(Monad eff, Monad (t eff), MonadTrans t) => Applicative (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

pure :: a -> WebDriverTT t eff a

(<*>) :: WebDriverTT t eff (a -> b) -> WebDriverTT t eff a -> WebDriverTT t eff b

liftA2 :: (a -> b -> c) -> WebDriverTT t eff a -> WebDriverTT t eff b -> WebDriverTT t eff c

(*>) :: WebDriverTT t eff a -> WebDriverTT t eff b -> WebDriverTT t eff b

(<*) :: WebDriverTT t eff a -> WebDriverTT t eff b -> WebDriverTT t eff a

(MonadIO eff, MonadIO (t eff), MonadTrans t) => MonadIO (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

liftIO :: IO a -> WebDriverTT t eff a

(Monad eff, Monad (t eff), MonadTrans t) => Assert (WebDriverTT t eff)

Defined in Web.Api.WebDriver.Monad

Methods

assert :: Assertion -> WebDriverTT t eff ()

execWebDriverTT :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverConfig eff -> WebDriverTT t eff a -> t eff (Either (E WDError) a, S WDState, W WDError WDLog)

Execute a WebDriverTT session.

debugWebDriverTT :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverConfig eff -> WebDriverTT t eff a -> t eff (Either Text a, AssertionSummary)

Execute a WebDriverTT session, returning an assertion summary with the result.

checkWebDriverTT

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t, Show q)

=> WebDriverConfig eff

-> (t eff (Either (E WDError) a, S WDState, W WDError WDLog) -> IO q)

Condense to IO

-> (q -> Bool)

Result check

-> WebDriverTT t eff a

-> Property

For testing with QuickCheck.

liftWebDriverTT :: (Monad eff, Monad (t eff), MonadTrans t) => t eff a -> WebDriverTT t eff a

Lift a value from the inner transformed monad

evalWDAct :: WDAct a -> IO a

Standard IO evaluator for WDAct.

evalIO

Arguments

:: (p a -> IO a)

Evaluator for user effects

-> P p a

-> IO a

Basic evaluator for interpreting atomic Http effects in IO.

evalWDActMockIO :: WDAct a -> MockIO u a

Standard MockIO evaluator for WDAct.

evalMockIO :: (p a -> MockIO s a) -> P p a -> MockIO s a

Basic evaluator for interpreting atomic Http effects in MockIO.

Config

data WebDriverConfig eff

Type representing configuration settings for a WebDriver session

Constructors

WDConfig

Fields

• _initialState :: S WDState
• _environment :: R WDError WDLog WDEnv
• _evaluator :: forall a. P WDAct a -> eff a

defaultWebDriverConfig :: WebDriverConfig IO

Default IO effects

defaultWebDriverState :: S WDState

defaultWebDriverEnvironment :: R WDError WDLog WDEnv

defaultWDEnv :: WDEnv

Uses default geckodriver settings

defaultWebDriverLogOptions :: LogOptions WDError WDLog

Noisy, JSON, in color, without headers.

API

fromState :: (Monad eff, Monad (t eff), MonadTrans t) => (S WDState -> a) -> WebDriverTT t eff a

Get a computed value from the state

modifyState :: (Monad eff, Monad (t eff), MonadTrans t) => (S WDState -> S WDState) -> WebDriverTT t eff ()

Mutate the state

fromEnv :: (Monad eff, Monad (t eff), MonadTrans t) => (R WDError WDLog WDEnv -> a) -> WebDriverTT t eff a

Get a computed value from the environment

comment :: (Monad eff, Monad (t eff), MonadTrans t) => Text -> WebDriverTT t eff ()

Write a comment to the log.

wait

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Int

Wait time in milliseconds

-> WebDriverTT t eff ()

Suspend the current session. Handy when waiting for pages to load.

logDebug :: (Monad eff, Monad (t eff), MonadTrans t) => WDLog -> WebDriverTT t eff ()

logNotice :: (Monad eff, Monad (t eff), MonadTrans t) => WDLog -> WebDriverTT t eff ()

throwError :: (Monad eff, Monad (t eff), MonadTrans t) => WDError -> WebDriverTT t eff a

throwJsonError :: (Monad eff, Monad (t eff), MonadTrans t) => JsonError -> WebDriverTT t eff a

throwHttpException :: (Monad eff, Monad (t eff), MonadTrans t) => HttpException -> WebDriverTT t eff a

throwIOException :: (Monad eff, Monad (t eff), MonadTrans t) => IOException -> WebDriverTT t eff a

expect :: (Monad eff, Monad (t eff), MonadTrans t, Eq a, Show a) => a -> a -> WebDriverTT t eff a

For validating responses. Throws an UnexpectedValue error if the two arguments are not equal according to their Eq instance.

expectIs

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t, Show a)

=> (a -> Bool)

-> Text

Human readable error label

-> a

-> WebDriverTT t eff a

For validating responses. Throws an UnexpectedValue error if the a argument does not satisfy the predicate.

assert :: Assert m => Assertion -> m ()

Make an assertion. Typically m is a monad, and the Assert instance handles the assertion in m by e.g. logging it, changing state, etc.

catchError :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff a -> (WDError -> WebDriverTT t eff a) -> WebDriverTT t eff a

Rethrows other error types

catchJsonError :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff a -> (JsonError -> WebDriverTT t eff a) -> WebDriverTT t eff a

Rethrows other error types

catchHttpException :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff a -> (HttpException -> WebDriverTT t eff a) -> WebDriverTT t eff a

Rethrows other error types

catchIOException :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff a -> (IOException -> WebDriverTT t eff a) -> WebDriverTT t eff a

Rethrows other error types

catchAnyError :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff a -> (WDError -> WebDriverTT t eff a) -> (HttpException -> WebDriverTT t eff a) -> (IOException -> WebDriverTT t eff a) -> (JsonError -> WebDriverTT t eff a) -> WebDriverTT t eff a

Explicitly handle any of the error types thrown in WebDriverTT

parseJson :: (Monad eff, Monad (t eff), MonadTrans t) => ByteString -> WebDriverTT t eff Value

May throw a JsonError.

lookupKeyJson :: (Monad eff, Monad (t eff), MonadTrans t) => Text -> Value -> WebDriverTT t eff Value

May throw a JsonError.

constructFromJson :: (Monad eff, Monad (t eff), MonadTrans t, FromJSON a) => Value -> WebDriverTT t eff a

May throw a JsonError.

httpGet :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff HttpResponse

Capures HttpExceptions.

httpSilentGet :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff HttpResponse

Does not write request or response info to the log, except to note that a request occurred. Capures HttpExceptions.

httpPost :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> ByteString -> WebDriverTT t eff HttpResponse

Capures HttpExceptions.

httpSilentPost :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> ByteString -> WebDriverTT t eff HttpResponse

Does not write request or response info to the log, except to note that a request occurred. Capures HttpExceptions.

httpDelete :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff HttpResponse

Capures HttpExceptions.

httpSilentDelete :: (Monad eff, Monad (t eff), MonadTrans t) => Url -> WebDriverTT t eff HttpResponse

Does not write request or response info to the log, except to note that a request occurred. Capures HttpExceptions.

hPutStrLn :: (Monad eff, Monad (t eff), MonadTrans t) => Handle -> Text -> WebDriverTT t eff ()

Capures IOExceptions.

hPutStrLnBlocking :: (Monad eff, Monad (t eff), MonadTrans t) => MVar () -> Handle -> Text -> WebDriverTT t eff ()

Capures IOExceptions.

getStrLn :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff Text

promptForString

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Text

Prompt text

-> WebDriverTT t eff Text

Prompt for input on stdin.

promptForSecret

Arguments

:: (Monad eff, Monad (t eff), MonadTrans t)

=> Text

Prompt text

-> WebDriverTT t eff Text

Prompt for input on stdin, but do not echo the typed characters back to the terminal -- handy for getting suuper secret info.

readFilePath :: (Monad eff, Monad (t eff), MonadTrans t) => FilePath -> WebDriverTT t eff ByteString

Captures IOExceptions

writeFilePath :: (Monad eff, Monad (t eff), MonadTrans t) => FilePath -> ByteString -> WebDriverTT t eff ()

Captures IOExceptions

fileExists :: (Monad eff, Monad (t eff), MonadTrans t) => FilePath -> WebDriverTT t eff Bool

Captures IOExceptions

breakpointsOn :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

breakpointsOff :: (Monad eff, Monad (t eff), MonadTrans t) => WebDriverTT t eff ()

breakpoint :: (Monad eff, Monad (t eff), MonadTrans t) => Text -> WebDriverTT t eff ()

breakpointWith :: (Monad eff, Monad (t eff), MonadTrans t) => Text -> Maybe (Text, WebDriverTT t eff ()) -> WebDriverTT t eff ()

Types

data E e

Error type.

Instances

Show e => Show (E e)

Defined in Control.Monad.Script.Http

Methods

showsPrec :: Int -> E e -> ShowS

show :: E e -> String

showList :: [E e] -> ShowS

data JsonError

Represents the kinds of errors that can occur when parsing and decoding JSON.

Constructors

JsonError Text

A generic JSON error; try not to use this.

JsonParseError ByteString

A failed parse.

JsonKeyDoesNotExist Text Value

An attempt to look up the value of a key that does not exist on an object.

JsonKeyLookupOffObject Text Value

An attempt to look up the value of a key on something other than an object.

JsonConstructError String

A failed attempt to convert a Value to some other type.

Instances

Eq JsonError

Defined in Data.Aeson.Extras

Methods

(==) :: JsonError -> JsonError -> Bool

(/=) :: JsonError -> JsonError -> Bool

Show JsonError

Defined in Data.Aeson.Extras

Methods

showsPrec :: Int -> JsonError -> ShowS

show :: JsonError -> String

showList :: [JsonError] -> ShowS

Arbitrary JsonError

Defined in Data.Aeson.Extras

Methods

arbitrary :: Gen JsonError

shrink :: JsonError -> [JsonError]

data WDError

Errors specific to WebDriver sessions.

Constructors

NoSession

ResponseError ResponseErrorCode Text Text (Maybe Value) Status

See https://w3c.github.io/webdriver/webdriver-spec.html#handling-errors

UnableToConnect

RemoteEndTimeout

UnhandledHttpException HttpException

ImageDecodeError Text

UnexpectedValue Text

UnexpectedResult Outcome Text

BreakpointHaltError

Instances

Show WDError

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> WDError -> ShowS

show :: WDError -> String

showList :: [WDError] -> ShowS

data R e w r

Generic session environment.

Constructors

R

Fields

• _logOptions :: LogOptions e w
• _logEntryPrinter :: LogOptions e w -> LogEntry e w -> Maybe Text

  Printer for log entries.

• _logHandle :: Handle

  Handle for printing logs

• _logLock :: Maybe (MVar ())

  Lock used to prevent race conditions when writing to the log.

• _uid :: Text

  Identifier string for the session; used to help match log entries emitted by the same session.

• _httpErrorInject :: HttpException -> Maybe e

  Function for elevating HttpExceptions to a client-supplied error type.

• _env :: r

  Client-supplied environment type.

data LogOptions e w

Options for tweaking the logs.

Constructors

LogOptions

Fields

• _logColor :: Bool

  Toggle color

• _logJson :: Bool

  Toggle JSON pretty printing

• _logSilent :: Bool

  Toggle to silence the logs

• _logMinSeverity :: LogSeverity

  Suppress log output below this severity

• _logHeaders :: Bool

  Toggle for printing HTTP headers

• _printUserError :: Bool -> e -> Text

  Printer for client-supplied error type. The boolean toggles JSON pretty printing.

• _printUserLog :: Bool -> w -> Text

  Printer for client-supplied log type. the boolean toggles JSON pretty printing.

data WDEnv

Read-only environment variables specific to WebDriver.

Constructors

WDEnv

Fields

• _remoteHostname :: Text

  Hostname of the remote WebDriver server

• _remotePort :: Int

  Port of the remote WebDriver server

• _remotePath :: Text

  Extra path for the remote WebDriver server

• _dataPath :: FilePath

  Path where secret data is stored

• _responseFormat :: ResponseFormat

  Flag for the format of HTTP responses from the remote end. Needed because not all remote ends are spec-compliant.

• _apiVersion :: ApiVersion

  Version of the WebDriver specification.

• _stdin :: Handle
• _stdout :: Handle

data ResponseFormat

Format flag for HTTP responses from the remote end. Chromedriver, for instance, is not spec-compliant. :)

Constructors

SpecFormat

Responses as described in the spec.

ChromeFormat

Responses as emitted by chromedriver.

Instances

Eq ResponseFormat

Defined in Web.Api.WebDriver.Monad

Methods

(==) :: ResponseFormat -> ResponseFormat -> Bool

(/=) :: ResponseFormat -> ResponseFormat -> Bool

Show ResponseFormat

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> ResponseFormat -> ShowS

show :: ResponseFormat -> String

showList :: [ResponseFormat] -> ShowS

data ApiVersion

Version of the WebDriver specification.

Constructors

CR_2018_03_04

Candidate Recommendation, March 4, 2018

Instances

Eq ApiVersion

Defined in Web.Api.WebDriver.Monad

Methods

(==) :: ApiVersion -> ApiVersion -> Bool

(/=) :: ApiVersion -> ApiVersion -> Bool

Show ApiVersion

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> ApiVersion -> ShowS

show :: ApiVersion -> String

showList :: [ApiVersion] -> ShowS

data Outcome

Type representing an abstract outcome. Do with it what you will.

Constructors

IsSuccess

IsFailure

Instances

Eq Outcome

Defined in Web.Api.WebDriver.Monad

Methods

(==) :: Outcome -> Outcome -> Bool

(/=) :: Outcome -> Outcome -> Bool

Show Outcome

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> Outcome -> ShowS

show :: Outcome -> String

showList :: [Outcome] -> ShowS

type Url = Text

To make type signatures nicer

data HttpResponse

Non-opaque HTTP response type.

Constructors

HttpResponse

Fields

• _responseStatus :: Status
• _responseVersion :: HttpVersion
• _responseHeaders :: ResponseHeaders
• _responseBody :: ByteString
• _responseCookieJar :: CookieJar

Instances

Eq HttpResponse

Defined in Network.HTTP.Client.Extras

Methods

(==) :: HttpResponse -> HttpResponse -> Bool

(/=) :: HttpResponse -> HttpResponse -> Bool

Show HttpResponse

Defined in Network.HTTP.Client.Extras

Methods

showsPrec :: Int -> HttpResponse -> ShowS

show :: HttpResponse -> String

showList :: [HttpResponse] -> ShowS

data WDLog

WebDriver specific log entries.

Constructors

LogAssertion Assertion

LogSession SessionVerb

LogUnexpectedResult Outcome Text

LogBreakpoint Text

Instances

Show WDLog

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> WDLog -> ShowS

show :: WDLog -> String

showList :: [WDLog] -> ShowS

data P (p :: Type -> Type) a where

Atomic effects

Constructors

HPutStrLn :: forall (p :: Type -> Type). Handle -> Text -> P p (Either IOException ())

HPutStrLnBlocking :: forall (p :: Type -> Type). MVar () -> Handle -> Text -> P p (Either IOException ())

GetSystemTime :: forall (p :: Type -> Type). P p UTCTime

ThreadDelay :: forall (p :: Type -> Type). Int -> P p ()

HttpGet :: forall (p :: Type -> Type). Options -> Maybe Session -> Url -> P p (Either HttpException HttpResponse)

HttpPost :: forall (p :: Type -> Type). Options -> Maybe Session -> Url -> ByteString -> P p (Either HttpException HttpResponse)

HttpDelete :: forall (p :: Type -> Type). Options -> Maybe Session -> Url -> P p (Either HttpException HttpResponse)

P :: forall (p :: Type -> Type) a. p a -> P p a

data WDAct a where

WebDriver specific effects

Constructors

ReadFilePath :: FilePath -> WDAct (Either IOException ByteString)

WriteFilePath :: FilePath -> ByteString -> WDAct (Either IOException ())

FileExists :: FilePath -> WDAct (Either IOException Bool)

HGetLine :: Handle -> WDAct (Either IOException Text)

HGetLineNoEcho :: Handle -> WDAct (Either IOException Text)

data S s

State type

Constructors

S

Fields

• _httpOptions :: Options
• _httpSession :: Maybe Session
• _userState :: s

Instances

Show s => Show (S s)

Defined in Control.Monad.Script.Http

Methods

showsPrec :: Int -> S s -> ShowS

show :: S s -> String

showList :: [S s] -> ShowS

data WDState

Includes a Maybe Text representing the current session ID, if one has been opened.

Constructors

WDState

Fields

• _sessionId :: Maybe Text
• _breakpoints :: BreakpointSetting

Instances

Show WDState

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> WDState -> ShowS

show :: WDState -> String

showList :: [WDState] -> ShowS

data BreakpointSetting

Constructors

BreakpointsOn

BreakpointsOff

Instances

Eq BreakpointSetting

Defined in Web.Api.WebDriver.Monad

Methods

(==) :: BreakpointSetting -> BreakpointSetting -> Bool

(/=) :: BreakpointSetting -> BreakpointSetting -> Bool

Show BreakpointSetting

Defined in Web.Api.WebDriver.Monad

Methods

showsPrec :: Int -> BreakpointSetting -> ShowS

show :: BreakpointSetting -> String

showList :: [BreakpointSetting] -> ShowS

Logs

getAssertions :: [WDLog] -> [Assertion]

Filter the assertions from a WebDriver log.

logEntries :: W e w -> [w]

Extract the user-defined log entries.

printHttpLogs :: Handle -> Maybe (MVar ()) -> LogOptions e w -> (LogOptions e w -> LogEntry e w -> Maybe Text) -> W e w -> IO ()

All log statements should go through logNow.

basicLogEntryPrinter :: LogOptions e w -> LogEntry e w -> Maybe Text

Simple default pretty printer for LogEntrys.