Test.Tasty.Bdd

Tasty driver for Language

Documentation

(@?=) :: (ToExpr a, Eq a, Typeable a, MonadThrow m) => a -> a -> m () infixl 4

equality test which show pretty differences on fail

(@?/=) :: (ToExpr a, Eq a, Typeable a, MonadThrow m) => a -> a -> m ()

inequality test which show pretty differences on fail

(^?=) :: (ToExpr a, Eq a, Typeable a, MonadThrow m) => m a -> a -> b -> m ()

shortcut to ignore the input and run another action instead in Then matching equality

(^?/=) :: (ToExpr a, Eq a, Typeable a, MonadThrow m) => m a -> a -> b -> m ()

shortcut to ignore the input and run another action instead in Then matching inequality

acquire :: MonadIO m => IO a -> (m a -> TestTree) -> TestTree

specialize withResource to just acquire a resource

acquirePure :: IO a -> (a -> TestTree) -> TestTree

data Phase

Separating the 2 phases by type

Constructors

Preparing

Testing

data Language m t q a where

Bare hoare language

Constructors

Given :: m () -> Language m t q Preparing -> Language m t q Preparing

action to prepare the test

GivenAndAfter :: m r -> (r -> m ()) -> Language m t q Preparing -> Language m t q Preparing

action to prepare the test, and related teardown action

When :: m t -> Language m t q Testing -> Language m t q Preparing

core logic of the test (last preparing action)

Then :: (t -> m q) -> Language m t q Testing -> Language m t q Testing

action producing a test

End :: Language m t q Testing

final placeholder

testBehavior

Arguments

:: (MonadIO m, TestableMonad m, Typeable t)

=> String

test name

-> BDDPreparing m t ()

bdd test definition

-> TestTree

resulting tasty test

interpret Bdd sentence to a single TestTree

testBehaviorIO

Arguments

:: (Typeable t, MonadIO m, TestableMonad m)

=> String

test name

-> IO (BDDPreparing m t ())

bdd test definition

-> TestTree

resulting tasty test

type BDDTesting m t q = Language m t q Testing

Testing language types

type BDDPreparing m t q = Language m t q Preparing

Preparing language types

class (MonadCatch m, MonadIO m, Monad m, Typeable m) => TestableMonad m where

testable monads can map to IO a Tasty Result

Methods

runCase :: m Result -> IO Result

Instances

TestableMonad IO

Defined in Test.Tasty.Bdd

Methods

runCase :: IO Result -> IO Result

failFastIngredients :: [Ingredient]

basic ingredients fail-fast aware

failFastTester :: TestTree -> IO ()

default test runner fail-fast aware

prettyDifferences :: ToExpr a => a -> a -> String

show a coloured difference of 2 values

beforeEach :: IO () -> TestTree -> TestTree

recursively prepend an action

afterEach :: IO () -> TestTree -> TestTree

recursively append an action

before :: IO () -> TestTree -> TestTree

specialize withResource to prepend an action

after :: IO () -> TestTree -> TestTree

specialize withResource to append an action

onEach :: (TestTree -> TestTree) -> TestTree -> TestTree

recursively modify a TestTree

captureStdout :: String -> IO () -> IO Text

testBehaviorF :: (Typeable m, MonadCatch m) => (m Result -> IO Result) -> String -> FreeBDD m x -> TestTree

Orphan instances

(Typeable t, TestableMonad m) => IsTest (BDDTest m t ())

any testable monad can make a BDDTest a tasty test

Methods

run :: OptionSet -> BDDTest m t () -> (Progress -> IO ()) -> IO Result

testOptions :: Tagged (BDDTest m t ()) [OptionDescription]