Test.Syd.SpecDef

This module defines all the functions you will use to define your test suite.

Documentation

data TDef v

Constructors

TDef

Fields

• testDefVal :: v
• testDefCallStack :: CallStack

Instances

Functor TDef

Defined in Test.Syd.SpecDef

Methods

fmap :: (a -> b) -> TDef a -> TDef b

(<$) :: a -> TDef b -> TDef a

Foldable TDef

Defined in Test.Syd.SpecDef

Methods

fold :: Monoid m => TDef m -> m

foldMap :: Monoid m => (a -> m) -> TDef a -> m

foldMap' :: Monoid m => (a -> m) -> TDef a -> m

foldr :: (a -> b -> b) -> b -> TDef a -> b

foldr' :: (a -> b -> b) -> b -> TDef a -> b

foldl :: (b -> a -> b) -> b -> TDef a -> b

foldl' :: (b -> a -> b) -> b -> TDef a -> b

foldr1 :: (a -> a -> a) -> TDef a -> a

foldl1 :: (a -> a -> a) -> TDef a -> a

toList :: TDef a -> [a]

null :: TDef a -> Bool

length :: TDef a -> Int

elem :: Eq a => a -> TDef a -> Bool

maximum :: Ord a => TDef a -> a

minimum :: Ord a => TDef a -> a

sum :: Num a => TDef a -> a

product :: Num a => TDef a -> a

Traversable TDef

Defined in Test.Syd.SpecDef

Methods

traverse :: Applicative f => (a -> f b) -> TDef a -> f (TDef b)

sequenceA :: Applicative f => TDef (f a) -> f (TDef a)

mapM :: Monad m => (a -> m b) -> TDef a -> m (TDef b)

sequence :: Monad m => TDef (m a) -> m (TDef a)

type TestForest a c = SpecDefForest a c ()

type TestTree a c = SpecDefTree a c ()

type SpecDefForest (a :: [Type]) c e = [SpecDefTree a c e]

data SpecDefTree (a :: [Type]) c e where

Constructors

DefSpecifyNode :: Text -> TDef (((HList a -> c -> IO ()) -> IO ()) -> IO TestRunResult) -> e -> SpecDefTree a c e

DefPendingNode :: Text -> Maybe Text -> SpecDefTree a c e

DefDescribeNode :: Text -> SpecDefForest a c e -> SpecDefTree a c e

DefWrapNode :: (IO () -> IO ()) -> SpecDefForest a c e -> SpecDefTree a c e

DefBeforeAllNode :: IO a -> SpecDefForest (a ': l) c e -> SpecDefTree l c e

DefAroundAllNode :: ((a -> IO ()) -> IO ()) -> SpecDefForest (a ': l) c e -> SpecDefTree l c e

DefAroundAllWithNode :: ((b -> IO ()) -> a -> IO ()) -> SpecDefForest (b ': (a ': l)) c e -> SpecDefTree (a ': l) c e

DefAfterAllNode :: (HList a -> IO ()) -> SpecDefForest a c e -> SpecDefTree a c e

DefParallelismNode :: Parallelism -> SpecDefForest a c e -> SpecDefTree a c e

DefRandomisationNode :: ExecutionOrderRandomisation -> SpecDefForest a c e -> SpecDefTree a c e

Instances

Functor (SpecDefTree a c)

Defined in Test.Syd.SpecDef

Methods

fmap :: (a0 -> b) -> SpecDefTree a c a0 -> SpecDefTree a c b

(<$) :: a0 -> SpecDefTree a c b -> SpecDefTree a c a0

Foldable (SpecDefTree a c)

Defined in Test.Syd.SpecDef

Methods

fold :: Monoid m => SpecDefTree a c m -> m

foldMap :: Monoid m => (a0 -> m) -> SpecDefTree a c a0 -> m

foldMap' :: Monoid m => (a0 -> m) -> SpecDefTree a c a0 -> m

foldr :: (a0 -> b -> b) -> b -> SpecDefTree a c a0 -> b

foldr' :: (a0 -> b -> b) -> b -> SpecDefTree a c a0 -> b

foldl :: (b -> a0 -> b) -> b -> SpecDefTree a c a0 -> b

foldl' :: (b -> a0 -> b) -> b -> SpecDefTree a c a0 -> b

foldr1 :: (a0 -> a0 -> a0) -> SpecDefTree a c a0 -> a0

foldl1 :: (a0 -> a0 -> a0) -> SpecDefTree a c a0 -> a0

toList :: SpecDefTree a c a0 -> [a0]

null :: SpecDefTree a c a0 -> Bool

length :: SpecDefTree a c a0 -> Int

elem :: Eq a0 => a0 -> SpecDefTree a c a0 -> Bool

maximum :: Ord a0 => SpecDefTree a c a0 -> a0

minimum :: Ord a0 => SpecDefTree a c a0 -> a0

sum :: Num a0 => SpecDefTree a c a0 -> a0

product :: Num a0 => SpecDefTree a c a0 -> a0

Traversable (SpecDefTree a c)

Defined in Test.Syd.SpecDef

Methods

traverse :: Applicative f => (a0 -> f b) -> SpecDefTree a c a0 -> f (SpecDefTree a c b)

sequenceA :: Applicative f => SpecDefTree a c (f a0) -> f (SpecDefTree a c a0)

mapM :: Monad m => (a0 -> m b) -> SpecDefTree a c a0 -> m (SpecDefTree a c b)

sequence :: Monad m => SpecDefTree a c (m a0) -> m (SpecDefTree a c a0)

MonadWriter (TestForest a b) (TestDefM a b)

Defined in Test.Syd.Def.TestDefM

Methods

writer :: (a0, TestForest a b) -> TestDefM a b a0

tell :: TestForest a b -> TestDefM a b ()

listen :: TestDefM a b a0 -> TestDefM a b (a0, TestForest a b)

pass :: TestDefM a b (a0, TestForest a b -> TestForest a b) -> TestDefM a b a0

data Parallelism

Constructors

Parallel

Sequential

data ExecutionOrderRandomisation

Constructors

RandomiseExecutionOrder

DoNotRandomiseExecutionOrder

type ResultForest = SpecForest (TDef (Timed TestRunResult))

type ResultTree = SpecTree (TDef (Timed TestRunResult))

computeTestSuiteStats :: ResultForest -> TestSuiteStats

data TestSuiteStats

Constructors

TestSuiteStats

Fields

• testSuiteStatSuccesses :: !Word
• testSuiteStatFailures :: !Word
• testSuiteStatPending :: !Word
• testSuiteStatLongestTime :: !(Maybe Word64)

Instances

Eq TestSuiteStats

Defined in Test.Syd.SpecDef

Methods

(==) :: TestSuiteStats -> TestSuiteStats -> Bool

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

Show TestSuiteStats

Defined in Test.Syd.SpecDef

Methods

showsPrec :: Int -> TestSuiteStats -> ShowS

show :: TestSuiteStats -> String

showList :: [TestSuiteStats] -> ShowS

Semigroup TestSuiteStats

Defined in Test.Syd.SpecDef

Methods

(<>) :: TestSuiteStats -> TestSuiteStats -> TestSuiteStats

sconcat :: NonEmpty TestSuiteStats -> TestSuiteStats

stimes :: Integral b => b -> TestSuiteStats -> TestSuiteStats

Monoid TestSuiteStats

Defined in Test.Syd.SpecDef

Methods

mempty :: TestSuiteStats

mappend :: TestSuiteStats -> TestSuiteStats -> TestSuiteStats

mconcat :: [TestSuiteStats] -> TestSuiteStats

shouldExitFail :: ResultForest -> Bool