EL.Test.Testing

Basic testing utilities.

Documentation

data Config

Constructors

Config

Fields

• configTestName :: !Text

  Keep the test name so I can report it in success in failure.

Instances

Show Config

Defined in EL.Test.Testing

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

modifyTestConfig :: (Config -> Config) -> IO ()

withTestName :: Text -> IO a -> IO a

Set configTestName. This is a grody hack, but I need it because GHC call stack is off by one, so you get the caller line number, but the callee's function name: https://ghc.haskell.org/trac/ghc/ticket/11686

metadata

data ModuleMeta

Constructors

ModuleMeta

Fields

• initialize :: IO () -> IO ()

  Wrap each test with IO level setup and teardown. Sync exceptions are caught from the test function, so this should only see async exceptions.

• tags :: [Tag]

moduleMeta :: ModuleMeta

data Tag

Constructors

Large

Especially expensive to run.

Instances

Eq Tag

Defined in EL.Test.Testing

Methods

(==) :: Tag -> Tag -> Bool

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

Show Tag

Defined in EL.Test.Testing

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

assertions

check :: HasCallStack => Text -> Bool -> IO Bool

checkVal :: Show a => HasCallStack => a -> (a -> Bool) -> IO Bool

Check against a function. Use like:

checkVal (f x) $ \case -> ...

equal :: (HasCallStack, Show a, Eq a) => a -> a -> IO Bool

equalFmt :: (HasCallStack, Eq a, Show a) => (a -> Text) -> a -> a -> IO Bool

rightEqual :: (HasCallStack, Show err, Show a, Eq a) => Either err a -> a -> IO Bool

notEqual :: (HasCallStack, Show a, Eq a) => a -> a -> IO Bool

equalf :: (HasCallStack, Show a, ApproxEq a) => Double -> a -> a -> IO Bool

stringsLike :: forall txt. (HasCallStack, TextLike txt) => [txt] -> [Pattern] -> IO Bool

Strings in the first list match patterns in the second list, using patternMatches.

leftLike :: (HasCallStack, Show a, TextLike txt) => Either txt a -> Pattern -> IO Bool

It's common for Left to be an error msg, or be something that can be converted to one.

match :: (HasCallStack, TextLike txt) => txt -> Pattern -> IO Bool

type Pattern = Text

Pattern as matched by patternMatches.

exception assertions

throws :: (HasCallStack, Show a) => a -> Pattern -> IO Bool

The given pure value should throw an exception that matches the predicate.

io assertions

ioEqual :: (HasCallStack, Eq a, Show a) => IO a -> a -> IO Bool

low level

success :: HasCallStack => Text -> IO Bool

Print a msg with a special tag indicating a passing test.

failure :: HasCallStack => Text -> IO Bool

Print a msg with a special tag indicating a failing test.

extracting

expectRight :: (HasCallStack, Show a) => Either a b -> b

QuickCheck

quickcheck :: (HasCallStack, Testable prop) => prop -> IO Bool

Run a quickcheck property.

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

equal for quickcheck.

pretty printing

pprint :: Show a => a -> IO ()

filesystem

uniqueTmpDir :: String -> IO FilePath

Get a tmp dir, which will be unique for each test run.

inTmpDir :: String -> IO a -> IO a

Run the computation with cwd in a new tmp dir.

tmpBaseDir :: FilePath

All tmp files used by tests should go in this directory.

TODO instead of being hardcoded this should be configured per-project.

util

force :: NFData a => a -> IO ()