Web.Api.WebDriver.Assert

In this module we define assertions as first class objects and some helper functions for creating and manipulating them.

Assertions

data Assertion

An Assertion consists of the following:

• A human-readable statement being asserted, which may be either true or false.
• A result (either success or failure).
• A comment, representing why the assertion was made, to assist in debugging.

To construct assertions outside this module, use success and failure.

Instances

Eq Assertion

Methods

(==) :: Assertion -> Assertion -> Bool

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

Show Assertion

Methods

showsPrec :: Int -> Assertion -> ShowS

show :: Assertion -> String

showList :: [Assertion] -> ShowS

success

Arguments

:: AssertionStatement

Statement being asserted (the what)

-> AssertionComment

An additional comment (the why)

-> Assertion

Construct a successful assertion.

failure

Arguments

:: AssertionStatement

Statement being asserted (the what)

-> AssertionComment

An additional comment (the why)

-> Assertion

Construct a failed assertion.

newtype AssertionStatement

Human-readable statement which may be true or false.

Constructors

AssertionStatement

Fields

• theAssertionStatement :: String

Instances

Eq AssertionStatement

Methods

(==) :: AssertionStatement -> AssertionStatement -> Bool

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

Show AssertionStatement

Methods

showsPrec :: Int -> AssertionStatement -> ShowS

show :: AssertionStatement -> String

showList :: [AssertionStatement] -> ShowS

IsString AssertionStatement

Methods

fromString :: String -> AssertionStatement

Arbitrary AssertionStatement

Methods

arbitrary :: Gen AssertionStatement

shrink :: AssertionStatement -> [AssertionStatement]

newtype AssertionComment

Human-readable explanation for why an assertion is made.

Constructors

AssertionComment

Fields

• theAssertionComment :: String

Instances

Eq AssertionComment

Methods

(==) :: AssertionComment -> AssertionComment -> Bool

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

Show AssertionComment

Methods

showsPrec :: Int -> AssertionComment -> ShowS

show :: AssertionComment -> String

showList :: [AssertionComment] -> ShowS

IsString AssertionComment

Methods

fromString :: String -> AssertionComment

Arbitrary AssertionComment

Methods

arbitrary :: Gen AssertionComment

shrink :: AssertionComment -> [AssertionComment]

data AssertionResult

Type representing the result (success or failure) of an evaluated assertion.

Instances

Eq AssertionResult

Methods

(==) :: AssertionResult -> AssertionResult -> Bool

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

Show AssertionResult

Methods

showsPrec :: Int -> AssertionResult -> ShowS

show :: AssertionResult -> String

showList :: [AssertionResult] -> ShowS

Arbitrary AssertionResult

Methods

arbitrary :: Gen AssertionResult

shrink :: AssertionResult -> [AssertionResult]

isSuccess :: Assertion -> Bool

Detects successful assertions.

printAssertion :: Assertion -> String

Basic string representation of an assertion.

The Assert Class

class Assert m where

Assertions are made and evaluated inside some context, represented by the Assert class.

Minimal complete definition

assert

Methods

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

Instances

Assert (WebDriverT m)

Methods

assert :: Assertion -> WebDriverT m ()

Assertion Summaries

data AssertionSummary

Assertions are the most granular kind of "test" this library deals with. Typically we'll be interested in sets of many assertions. A single test case will include one or more assertions, which for reporting purposes we'd like to summarize. The summary for a list of assertions will include the number of successes, the number of failures, and the actual failures. Modeled this way assertion summaries form a monoid, which is handy.

Constructors

AssertionSummary

Fields

• numSuccesses :: Integer
• numFailures :: Integer
• failures :: [Assertion]
• successes :: [Assertion]

Instances

Eq AssertionSummary

Methods

(==) :: AssertionSummary -> AssertionSummary -> Bool

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

Show AssertionSummary

Methods

showsPrec :: Int -> AssertionSummary -> ShowS

show :: AssertionSummary -> String

showList :: [AssertionSummary] -> ShowS

Monoid AssertionSummary

Methods

mempty :: AssertionSummary

mappend :: AssertionSummary -> AssertionSummary -> AssertionSummary

mconcat :: [AssertionSummary] -> AssertionSummary

summarize :: [Assertion] -> AssertionSummary

Summarize a list of Assertions.

summarizeAll :: [AssertionSummary] -> AssertionSummary

Summarize a list of AssertionSummarys.

printSummary :: AssertionSummary -> IO ()

Very basic string representation of an AssertionSummary.

Basic Assertions

assertSuccessIf

Arguments

:: (Monad m, Assert m)

=> Bool

-> AssertionStatement

Statement being asserted (the what)

-> AssertionComment

An additional comment (the why)

-> m ()

Generic boolean assertion; asserts success if Bool is true and failure otherwise.

assertSuccess

Arguments

:: (Monad m, Assert m)

=> AssertionComment

An additional comment (the why)

-> m ()

Assertion that always succeeds.

assertFailure

Arguments

:: (Monad m, Assert m)

=> AssertionComment

An additional comment (the why)

-> m ()

Assertion that always fails.

assertTrue

Arguments

:: (Monad m, Assert m)

=> Bool

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if Bool is True.

assertFalse

Arguments

:: (Monad m, Assert m)

=> Bool

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if Bool is False.

assertEqual

Arguments

:: (Monad m, Assert m, Eq t, Show t)

=> t

-> t

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the given ts are equal according to their Eq instance.

assertNotEqual

Arguments

:: (Monad m, Assert m, Eq t, Show t)

=> t

-> t

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the given ts are not equal according to their Eq instance.

assertIsSubstring

Arguments

:: (Monad m, Assert m, Eq a, Show a)

=> [a]

-> [a]

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the first list is an infix of the second, according to their Eq instance.

assertIsNotSubstring

Arguments

:: (Monad m, Assert m, Eq a, Show a)

=> [a]

-> [a]

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the first list is not an infix of the second, according to their Eq instance.

assertIsNamedSubstring

Arguments

:: (Monad m, Assert m, Eq a, Show a)

=> [a]

-> ([a], String)

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the first list is an infix of the second, named list, according to their Eq instance. This is similar to assertIsSubstring, except that the "name" of the second list argument is used in reporting failures. Handy if the second list is very large -- say the source of a webpage.

assertIsNotNamedSubstring

Arguments

:: (Monad m, Assert m, Eq a, Show a)

=> [a]

-> ([a], String)

-> AssertionComment

An additional comment (the why)

-> m ()

Succeeds if the first list is not an infix of the second, named list, according to their Eq instance. This is similar to assertIsNotSubstring, except that the "name" of the second list argument is used in reporting failures. Handy if the second list is very large -- say the source of a webpage.