Test.Daytripper

Documentation

class MonadFail m => MonadExpect m where

Interface for asserting and performing IO in tests. TODO Migrate to MonadIO superclass when Falsify supports it.

Minimal complete definition

expectLiftIO, expectAssertEq, expectAssertFailure

Methods

expectLiftIO :: IO a -> m a

expectAssertEq :: (Eq a, Show a) => a -> a -> m ()

expectAssertFailure :: String -> m ()

expectAssertBool :: String -> Bool -> m ()

Instances

MonadExpect Property

Defined in Test.Daytripper

Methods

expectLiftIO :: IO a -> Property a

expectAssertEq :: (Eq a, Show a) => a -> a -> Property ()

expectAssertFailure :: String -> Property ()

expectAssertBool :: String -> Bool -> Property ()

MonadExpect IO

Defined in Test.Daytripper

Methods

expectLiftIO :: IO a -> IO a

expectAssertEq :: (Eq a, Show a) => a -> a -> IO ()

expectAssertFailure :: String -> IO ()

expectAssertBool :: String -> Bool -> IO ()

type Expect m a b c = Either b a -> m (b, m c)

A general type of test expectation. Captures two stages of processing an input, first encoding, then decoding. The monad is typically something implementing MonadExpect, with assertions performed before returning values for further processing. The input is possibly missing, in which case we test decoding only.

expectBefore :: Monad m => (Maybe a -> m ()) -> Expect m a b c -> Expect m a b c

Assert something before processing (before encoding and before decoding)

expectDuring :: Monad m => (Maybe a -> b -> m ()) -> Expect m a b c -> Expect m a b c

Assert something during processing (after encoding and before decoding)

expectAfter :: Monad m => (Maybe a -> b -> c -> m ()) -> Expect m a b c -> Expect m a b c

Asserting something after processing (after encoding and after decoding)

mkExpect :: MonadExpect m => (a -> m b) -> (b -> m c) -> (Maybe a -> c -> m ()) -> Expect m a b c

A way of definining expectations from a pair of encode/decode functions and a comparison function.

runExpect :: Monad m => Expect m a b c -> a -> m c

Simple way to run an expectation, ignoring the intermediate value.

data RT

mkPropRT :: Show a => TestName -> Expect Property a b c -> Gen a -> RT

Create a property-based roundtrip test

mkFileRT :: TestName -> Expect IO a ByteString c -> FilePath -> Maybe a -> RT

Create a file-based ("golden") roundtrip test

mkUnitRT :: TestName -> Expect IO a b c -> a -> RT

Create a unit roundtrip test

testRT :: RT -> TestTree

Run a roundtrip test

newtype DaytripperWriteMissing

By passing the appropriate arguments to Tasty (`--daytripper-write-missing` or `TASTY_DAYTRIPPER_WRITE_MISSING=True`) we can fill in the contents of missing files with the results of running tests.

Constructors

DaytripperWriteMissing

Fields

• unDaytripperWriteMissing :: Bool

Instances

Show DaytripperWriteMissing

Defined in Test.Daytripper

Methods

showsPrec :: Int -> DaytripperWriteMissing -> ShowS

show :: DaytripperWriteMissing -> String

showList :: [DaytripperWriteMissing] -> ShowS

Eq DaytripperWriteMissing

Defined in Test.Daytripper

Methods

(==) :: DaytripperWriteMissing -> DaytripperWriteMissing -> Bool

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

Ord DaytripperWriteMissing

Defined in Test.Daytripper

Methods

compare :: DaytripperWriteMissing -> DaytripperWriteMissing -> Ordering

(<) :: DaytripperWriteMissing -> DaytripperWriteMissing -> Bool

(<=) :: DaytripperWriteMissing -> DaytripperWriteMissing -> Bool

(>) :: DaytripperWriteMissing -> DaytripperWriteMissing -> Bool

(>=) :: DaytripperWriteMissing -> DaytripperWriteMissing -> Bool

max :: DaytripperWriteMissing -> DaytripperWriteMissing -> DaytripperWriteMissing

min :: DaytripperWriteMissing -> DaytripperWriteMissing -> DaytripperWriteMissing

IsOption DaytripperWriteMissing

Defined in Test.Daytripper

Methods

defaultValue :: DaytripperWriteMissing

parseValue :: String -> Maybe DaytripperWriteMissing

optionName :: Tagged DaytripperWriteMissing String

optionHelp :: Tagged DaytripperWriteMissing String

showDefaultValue :: DaytripperWriteMissing -> Maybe String

optionCLParser :: Parser DaytripperWriteMissing

daytripperIngredients :: [Ingredient]

Tasty ingredients with write-missing support

daytripperMain :: TestTree -> IO ()

Tasty main with write-missing support