Copyright	2018 Automattic Inc.
License	GPL-3
Maintainer	Nathan Bloomfield (nbloomf@gmail.com)
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Api.WebDriver.Monad

Contents

Config
API
Types
Logs

Description

A monad and monad transformer for

Synopsis

Documentation

type WebDriver eff a = WebDriverT (IdentityT eff) a Source #

WebDriverT over IdentityT.

execWebDriver :: Monad eff => WebDriverConfig eff -> WebDriver eff a -> eff (Either (E WDError) a, S WDState, W WDError WDLog) Source #

Execute a WebDriver session.

debugWebDriver :: Monad eff => WebDriverConfig eff -> WebDriver eff a -> eff (Either String a, AssertionSummary) Source #

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

checkWebDriver Source #

Arguments

:: Monad eff
=> WebDriverConfig eff
-> (eff (Either (E WDError) t, S WDState, W WDError WDLog) -> IO q)	Condense to `IO`
-> (q -> Bool)	Result check
-> WebDriver eff t
-> Property

For testing with QuickCheck

data WebDriverT m a Source #

Wrapper type around HttpT; a stack of error, reader, writer, state, and prompt monads.

Instances

Monad (WebDriverT m) Source #
Methods (>>=) :: WebDriverT m a -> (a -> WebDriverT m b) -> WebDriverT m b # (>>) :: WebDriverT m a -> WebDriverT m b -> WebDriverT m b # return :: a -> WebDriverT m a # fail :: String -> WebDriverT m a #
Functor (WebDriverT m) Source #
Methods fmap :: (a -> b) -> WebDriverT m a -> WebDriverT m b # (<$) :: a -> WebDriverT m b -> WebDriverT m a #
Applicative (WebDriverT m) Source #
Methods pure :: a -> WebDriverT m a # (<>) :: WebDriverT m (a -> b) -> WebDriverT m a -> WebDriverT m b # liftA2 :: (a -> b -> c) -> WebDriverT m a -> WebDriverT m b -> WebDriverT m c # (>) :: WebDriverT m a -> WebDriverT m b -> WebDriverT m b # (<*) :: WebDriverT m a -> WebDriverT m b -> WebDriverT m a #
Assert (WebDriverT m) Source #
Methods assert :: Assertion -> WebDriverT m () Source #

execWebDriverT Source #

Arguments

:: (Monad eff, Monad (m eff))
=> WebDriverConfig eff
-> (forall u. eff u -> m eff u)	Lift effects to the inner monad
-> WebDriverT (m eff) a
-> m eff (Either (E WDError) a, S WDState, W WDError WDLog)

Execute a WebDriverT session.

debugWebDriverT Source #

Arguments

:: (Monad eff, Monad (m eff))
=> WebDriverConfig eff
-> (forall u. eff u -> m eff u)	Lift effects to the inner monad
-> WebDriverT (m eff) a
-> m eff (Either String a, AssertionSummary)

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

checkWebDriverT Source #

Arguments

:: (Monad eff, Monad (m eff))
=> WebDriverConfig eff
-> (forall u. eff u -> m eff u)	Lift effects to the inner monad
-> (m eff (Either (E WDError) t, S WDState, W WDError WDLog) -> IO q)	Condense to `IO`
-> (q -> Bool)	Result check
-> WebDriverT (m eff) t
-> Property

For testing with QuickCheck.

liftWebDriverT :: Monad m => m a -> WebDriverT m a Source #

Lift a value from the inner monad

newtype IdentityT m a Source #

The identity monad transformer.

Constructors

IdentityT
Fields runIdentityT :: m a

Instances

Monad m => Monad (IdentityT m) Source #
Methods (>>=) :: IdentityT m a -> (a -> IdentityT m b) -> IdentityT m b # (>>) :: IdentityT m a -> IdentityT m b -> IdentityT m b # return :: a -> IdentityT m a # fail :: String -> IdentityT m a #
Functor m => Functor (IdentityT m) Source #
Methods fmap :: (a -> b) -> IdentityT m a -> IdentityT m b # (<$) :: a -> IdentityT m b -> IdentityT m a #
Monad m => Applicative (IdentityT m) Source #
Methods pure :: a -> IdentityT m a # (<>) :: IdentityT m (a -> b) -> IdentityT m a -> IdentityT m b # liftA2 :: (a -> b -> c) -> IdentityT m a -> IdentityT m b -> IdentityT m c # (>) :: IdentityT m a -> IdentityT m b -> IdentityT m b # (<*) :: IdentityT m a -> IdentityT m b -> IdentityT m a #

evalWDAct :: WDAct a -> IO a Source #

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

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

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

Default IO effects

defaultWebDriverState :: S WDState Source #

defaultWebDriverEnvironment :: R WDError WDLog WDEnv Source #

defaultWDEnv :: WDEnv Source #

Uses default geckodriver settings

defaultWebDriverLogOptions :: LogOptions WDError WDLog Source #

Noisy, JSON, in color, without headers.

API

fromState :: (S WDState -> a) -> WebDriverT m a Source #

Get a computed value from the state

modifyState :: (S WDState -> S WDState) -> WebDriverT m () Source #

Mutate the state

fromEnv :: (R WDError WDLog WDEnv -> a) -> WebDriverT m a Source #

Get a computed value from the environment

comment :: String -> WebDriverT m () Source #

Write a comment to the log.

wait :: Int -> WebDriverT m () Source #

In milliseconds

throwError :: WDError -> WebDriverT m a Source #

throwJsonError :: JsonError -> WebDriverT m a Source #

throwHttpException :: HttpException -> WebDriverT m a Source #

throwIOException :: IOException -> WebDriverT m a Source #

expect :: (Monad m, Eq a, Show a) => a -> a -> WebDriverT m a Source #

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

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

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 :: WebDriverT m a -> (WDError -> WebDriverT m a) -> WebDriverT m a Source #

Rethrows other error types

catchJsonError :: WebDriverT m a -> (JsonError -> WebDriverT m a) -> WebDriverT m a Source #

Rethrows other error types

catchHttpException :: WebDriverT m a -> (HttpException -> WebDriverT m a) -> WebDriverT m a Source #

Rethrows other error types

catchIOException :: WebDriverT m a -> (IOException -> WebDriverT m a) -> WebDriverT m a Source #

Rethrows other error types

parseJson :: ByteString -> WebDriverT m Value Source #

May throw a JsonError.

lookupKeyJson :: Text -> Value -> WebDriverT m Value Source #

May throw a JsonError.

constructFromJson :: FromJSON a => Value -> WebDriverT m a Source #

May throw a JsonError.

httpGet :: Url -> WebDriverT m HttpResponse Source #

Capures HttpExceptions.

httpSilentGet :: Url -> WebDriverT m HttpResponse Source #

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

httpPost :: Url -> ByteString -> WebDriverT m HttpResponse Source #

Capures HttpExceptions.

httpSilentPost :: Url -> ByteString -> WebDriverT m HttpResponse Source #

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

httpDelete :: Url -> WebDriverT m HttpResponse Source #

Capures HttpExceptions.

httpSilentDelete :: Url -> WebDriverT m HttpResponse Source #

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

hPutStrLn :: Handle -> String -> WebDriverT m () Source #

Capures IOExceptions.

hPutStrLnBlocking :: MVar () -> Handle -> String -> WebDriverT m () Source #

Capures IOExceptions.

readFilePath :: Monad m => FilePath -> WebDriverT m ByteString Source #

Captures IOExceptions

writeFilePath :: Monad m => FilePath -> ByteString -> WebDriverT m () Source #

Captures IOExceptions

fileExists :: Monad m => FilePath -> WebDriverT m Bool Source #

Captures IOExceptions

Types

data E e :: * -> * #

Error type.

data JsonError :: * #

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

Constructors

JsonError String	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
Methods (==) :: JsonError -> JsonError -> Bool # (/=) :: JsonError -> JsonError -> Bool #
Show JsonError
Methods showsPrec :: Int -> JsonError -> ShowS # show :: JsonError -> String # showList :: [JsonError] -> ShowS #
Arbitrary JsonError
Methods arbitrary :: Gen JsonError # shrink :: JsonError -> [JsonError] #

data WDError Source #

Errors specific to WebDriver sessions.

Instances

Show WDError Source #
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
_logHandle :: Handle
Handle for printing logs
_logLock :: Maybe (MVar ())
Lock used to prevent race conditions when writing to the log.
_uid :: String
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
_logHeaders :: Bool
Toggle for printing HTTP headers
_logEntryPrinter :: (String -> String) -> (String, String, String) -> String
Printer for log entries; first argument colorizes a string, and the tuple argument is (timestamp, uid, message).
_printUserError :: Bool -> e -> String
Printer for client-supplied error type. The boolean toggles JSON pretty printing.
_printUserLog :: Bool -> w -> String
Printer for client-supplied log type. the boolean toggles JSON pretty printing.

data WDEnv Source #

Read-only environment variables specific to WebDriver.

Constructors

WDEnv

Fields

_remoteHostname :: String
Hostname of the remote WebDriver server
_remotePort :: Int
Port of the remote WebDriver server
_remotePath :: String
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 Source #

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 Source #
Methods (==) :: ResponseFormat -> ResponseFormat -> Bool # (/=) :: ResponseFormat -> ResponseFormat -> Bool #
Show ResponseFormat Source #
Methods showsPrec :: Int -> ResponseFormat -> ShowS # show :: ResponseFormat -> String # showList :: [ResponseFormat] -> ShowS #

data ApiVersion Source #

Version of the WebDriver specification.

Constructors

CR_2018_03_04

Candidate Recommendation, March 4, 2018

Instances

Eq ApiVersion Source #
Methods (==) :: ApiVersion -> ApiVersion -> Bool # (/=) :: ApiVersion -> ApiVersion -> Bool #
Show ApiVersion Source #
Methods showsPrec :: Int -> ApiVersion -> ShowS # show :: ApiVersion -> String # showList :: [ApiVersion] -> ShowS #

data Outcome Source #

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

Constructors

IsSuccess
IsFailure

Instances

Eq Outcome Source #
Methods (==) :: Outcome -> Outcome -> Bool # (/=) :: Outcome -> Outcome -> Bool #
Show Outcome Source #
Methods showsPrec :: Int -> Outcome -> ShowS # show :: Outcome -> String # showList :: [Outcome] -> ShowS #

type Url = String #

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
Methods (==) :: HttpResponse -> HttpResponse -> Bool # (/=) :: HttpResponse -> HttpResponse -> Bool #
Show HttpResponse
Methods showsPrec :: Int -> HttpResponse -> ShowS # show :: HttpResponse -> String # showList :: [HttpResponse] -> ShowS #

data WDLog Source #

WebDriver specific log entries.

Constructors

LogAssertion Assertion
LogSession SessionVerb
LogUnexpectedResult Outcome String

Instances

Show WDLog Source #
Methods showsPrec :: Int -> WDLog -> ShowS # show :: WDLog -> String # showList :: [WDLog] -> ShowS #

data P (p :: * -> *) a :: (* -> *) -> * -> * where #

Atomic effects

Constructors

HPutStrLn :: P p (Either IOException ())
HPutStrLnBlocking :: P p (Either IOException ())
GetSystemTime :: P p UTCTime
ThreadDelay :: P p ()
HttpGet :: P p (Either HttpException HttpResponse)
HttpPost :: P p (Either HttpException HttpResponse)
HttpDelete :: P p (Either HttpException HttpResponse)
P :: P p a

data WDAct a where Source #

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 String)
HGetLineNoEcho :: Handle -> WDAct (Either IOException String)

data S s :: * -> * #

State type

Constructors

S
Fields _httpOptions :: Options _httpSession :: Maybe Session _userState :: s

newtype WDState Source #

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

Constructors

WDState
Fields _sessionId :: Maybe String

Instances

Show WDState Source #
Methods showsPrec :: Int -> WDState -> ShowS # show :: WDState -> String # showList :: [WDState] -> ShowS #

Logs

getAssertions :: [WDLog] -> [Assertion] Source #

Filter the assertions from a WebDriver log.

logEntries :: W e w -> [w] #

Extract the user-defined log entries.

NoSession
ResponseError ResponseErrorCode String String (Maybe Value) Status	See https://w3c.github.io/webdriver/webdriver-spec.html#handling-errors
UnableToConnect
RemoteEndTimeout
UnhandledHttpException HttpException
ImageDecodeError String
UnexpectedValue String
UnexpectedResult Outcome String