Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Syd.SpecDef

Description

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

Synopsis

data TDef value = TDef {
- testDefVal :: value
- testDefCallStack :: CallStack
}
type TestForest outers inner = SpecDefForest outers inner ()
type TestTree outers inner = SpecDefTree outers inner ()
type SpecDefForest (outers :: [Type]) inner extra = [SpecDefTree outers inner extra]
data SpecDefTree (outers :: [Type]) inner extra where
- DefSpecifyNode :: Text -> TDef (ProgressReporter -> ((HList outers -> inner -> IO ()) -> IO ()) -> IO TestRunResult) -> extra -> SpecDefTree outers inner extra
- DefPendingNode :: Text -> Maybe Text -> SpecDefTree outers inner extra
- DefDescribeNode :: Text -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefSetupNode :: IO () -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefBeforeAllNode :: IO outer -> SpecDefForest (outer ': otherOuters) inner extra -> SpecDefTree otherOuters inner extra
- DefBeforeAllWithNode :: (oldOuter -> IO newOuter) -> SpecDefForest (newOuter ': (oldOuter ': otherOuters)) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extra
- DefWrapNode :: (IO () -> IO ()) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefAroundAllNode :: ((outer -> IO ()) -> IO ()) -> SpecDefForest (outer ': otherOuters) inner extra -> SpecDefTree otherOuters inner extra
- DefAroundAllWithNode :: ((newOuter -> IO ()) -> oldOuter -> IO ()) -> SpecDefForest (newOuter ': (oldOuter ': otherOuters)) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extra
- DefAfterAllNode :: (HList outers -> IO ()) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefParallelismNode :: Parallelism -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefRandomisationNode :: ExecutionOrderRandomisation -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefRetriesNode :: (Word -> Word) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefFlakinessNode :: FlakinessMode -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
- DefExpectationNode :: ExpectationMode -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
filterTestForest :: [Text] -> SpecDefForest outers inner result -> SpecDefForest outers inner result
randomiseTestForest :: MonadRandom m => SpecDefForest outers inner result -> m (SpecDefForest outers inner result)
markSpecForestAsPending :: Maybe Text -> SpecDefForest outers inner result -> SpecDefForest outers inner result
data Parallelism
- = Parallel
- | Sequential
data ExecutionOrderRandomisation
- = RandomiseExecutionOrder
- | DoNotRandomiseExecutionOrder
data FlakinessMode
- = MayNotBeFlaky
- | MayBeFlaky !(Maybe String)
data ExpectationMode
- = ExpectPassing
- | ExpectFailing
type ResultForest = SpecForest (TDef (Timed TestRunReport))
type ResultTree = SpecTree (TDef (Timed TestRunReport))
computeTestSuiteStats :: Settings -> ResultForest -> TestSuiteStats
data TestSuiteStats = TestSuiteStats {
- testSuiteStatSuccesses :: !Word
- testSuiteStatExamples :: !Word
- testSuiteStatFailures :: !Word
- testSuiteStatFlakyTests :: !Word
- testSuiteStatPending :: !Word
- testSuiteStatSumTime :: !Word64
}
shouldExitFail :: Settings -> ResultForest -> Bool
data TestRunReport = TestRunReport {
- testRunReportExpectationMode :: !ExpectationMode
- testRunReportRawResults :: !(NonEmpty TestRunResult)
- testRunReportFlakinessMode :: !FlakinessMode
}
testRunReportReportedRun :: TestRunReport -> TestRunResult
testRunReportFailed :: Settings -> TestRunReport -> Bool
testRunReportStatus :: Settings -> TestRunReport -> TestStatus
testStatusMatchesExpectationMode :: TestStatus -> ExpectationMode -> Bool
testRunReportExamples :: TestRunReport -> Word
testRunResultExamples :: TestRunResult -> Word
testRunReportWasFlaky :: TestRunReport -> Bool
testRunReportRetries :: TestRunReport -> Maybe Word

Documentation

data TDef value Source #

Constructors

TDef
Fields testDefVal :: value testDefCallStack :: CallStack

Instances

Instances details

Foldable TDef Source #
Instance details 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 Source #
Instance details 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) #
Functor TDef Source #
Instance details Defined in Test.Syd.SpecDef Methods fmap :: (a -> b) -> TDef a -> TDef b # (<$) :: a -> TDef b -> TDef a #

type TestForest outers inner = SpecDefForest outers inner () Source #

type TestTree outers inner = SpecDefTree outers inner () Source #

type SpecDefForest (outers :: [Type]) inner extra = [SpecDefTree outers inner extra] Source #

data SpecDefTree (outers :: [Type]) inner extra where Source #

A tree of tests

This type has three parameters:

outers: A type-level list of the outer resources. These are resources that are prived once, around a group of tests. (This is the type of the results of aroundAll.)
inner: The inner resource. This is a resource that is set up around every test, and even every example of a property test. (This is the type of the result of around.)
result: The result (TestDefM is a monad.)

In practice, all of these three parameters should be () at the top level.

When you're just using sydtest and not writing a library for sydtest, you probably don't even want to concern yourself with this type.

Constructors

DefSpecifyNode	Define a test
Fields :: Text The description of the test -> TDef (ProgressReporter -> ((HList outers -> inner -> IO ()) -> IO ()) -> IO TestRunResult) How the test can be run given a function that provides the resources -> extra -> SpecDefTree outers inner extra
DefPendingNode	Define a pending test
Fields :: Text The description of the test -> Maybe Text The reason why the test is pending -> SpecDefTree outers inner extra
DefDescribeNode	Group tests using a description
Fields :: Text The description -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefSetupNode
Fields :: IO () The function that runs before the test -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefBeforeAllNode
Fields :: IO outer The function to run (once), beforehand, to produce the outer resource. -> SpecDefForest (outer ': otherOuters) inner extra -> SpecDefTree otherOuters inner extra
DefBeforeAllWithNode
Fields :: (oldOuter -> IO newOuter) The function to run (once), beforehand, to produce the outer resource. -> SpecDefForest (newOuter ': (oldOuter ': otherOuters)) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extra
DefWrapNode
Fields :: (IO () -> IO ()) The function that wraps running the tests. -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefAroundAllNode
Fields :: ((outer -> IO ()) -> IO ()) The function that provides the outer resource (once), around the tests. -> SpecDefForest (outer ': otherOuters) inner extra -> SpecDefTree otherOuters inner extra
DefAroundAllWithNode
Fields :: ((newOuter -> IO ()) -> oldOuter -> IO ()) The function that provides the new outer resource (once), using the old outer resource. -> SpecDefForest (newOuter ': (oldOuter ': otherOuters)) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extra
DefAfterAllNode
Fields :: (HList outers -> IO ()) The function to run (once), afterwards, using all outer resources. -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefParallelismNode	Control the level of parallelism for a given group of tests
Fields :: Parallelism The level of parallelism -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefRandomisationNode	Control the execution order randomisation for a given group of tests
Fields :: ExecutionOrderRandomisation The execution order randomisation -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefRetriesNode
Fields :: (Word -> Word) Modify the number of retries -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefFlakinessNode
Fields :: FlakinessMode Whether to allow flakiness -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefExpectationNode
Fields :: ExpectationMode Whether to expect passing or failing -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra

Instances

Instances details

Foldable (SpecDefTree a c) Source #
Instance details 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) Source #
Instance details 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) #
Functor (SpecDefTree a c) Source #
Instance details 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 #
MonadWriter (TestForest outers inner) (TestDefM outers inner) Source #
Instance details Defined in Test.Syd.Def.TestDefM Methods writer :: (a, TestForest outers inner) -> TestDefM outers inner a # tell :: TestForest outers inner -> TestDefM outers inner () # listen :: TestDefM outers inner a -> TestDefM outers inner (a, TestForest outers inner) # pass :: TestDefM outers inner (a, TestForest outers inner -> TestForest outers inner) -> TestDefM outers inner a #

filterTestForest :: [Text] -> SpecDefForest outers inner result -> SpecDefForest outers inner result Source #

randomiseTestForest :: MonadRandom m => SpecDefForest outers inner result -> m (SpecDefForest outers inner result) Source #

markSpecForestAsPending :: Maybe Text -> SpecDefForest outers inner result -> SpecDefForest outers inner result Source #

data Parallelism Source #

Constructors

Parallel
Sequential

Instances

Instances details

Generic Parallelism Source #
Instance details Defined in Test.Syd.SpecDef Associated Types type Rep Parallelism :: Type -> Type # Methods from :: Parallelism -> Rep Parallelism x # to :: Rep Parallelism x -> Parallelism #
Show Parallelism Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> Parallelism -> ShowS # show :: Parallelism -> String # showList :: [Parallelism] -> ShowS #
Eq Parallelism Source #
Instance details Defined in Test.Syd.SpecDef Methods (==) :: Parallelism -> Parallelism -> Bool # (/=) :: Parallelism -> Parallelism -> Bool #
type Rep Parallelism Source #
Instance details Defined in Test.Syd.SpecDef type Rep Parallelism = D1 ('MetaData "Parallelism" "Test.Syd.SpecDef" "sydtest-0.15.1.1-CZvd3rDS4m47TQqIsce9VY" 'False) (C1 ('MetaCons "Parallel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sequential" 'PrefixI 'False) (U1 :: Type -> Type))

data ExecutionOrderRandomisation Source #

Constructors

RandomiseExecutionOrder
DoNotRandomiseExecutionOrder

Instances

Instances details

Generic ExecutionOrderRandomisation Source #
Instance details Defined in Test.Syd.SpecDef Associated Types type Rep ExecutionOrderRandomisation :: Type -> Type # Methods from :: ExecutionOrderRandomisation -> Rep ExecutionOrderRandomisation x # to :: Rep ExecutionOrderRandomisation x -> ExecutionOrderRandomisation #
Show ExecutionOrderRandomisation Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> ExecutionOrderRandomisation -> ShowS # show :: ExecutionOrderRandomisation -> String # showList :: [ExecutionOrderRandomisation] -> ShowS #
Eq ExecutionOrderRandomisation Source #
Instance details Defined in Test.Syd.SpecDef Methods (==) :: ExecutionOrderRandomisation -> ExecutionOrderRandomisation -> Bool # (/=) :: ExecutionOrderRandomisation -> ExecutionOrderRandomisation -> Bool #
type Rep ExecutionOrderRandomisation Source #
Instance details Defined in Test.Syd.SpecDef type Rep ExecutionOrderRandomisation = D1 ('MetaData "ExecutionOrderRandomisation" "Test.Syd.SpecDef" "sydtest-0.15.1.1-CZvd3rDS4m47TQqIsce9VY" 'False) (C1 ('MetaCons "RandomiseExecutionOrder" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoNotRandomiseExecutionOrder" 'PrefixI 'False) (U1 :: Type -> Type))

data FlakinessMode Source #

Constructors

MayNotBeFlaky
MayBeFlaky !(Maybe String)

Instances

Instances details

Generic FlakinessMode Source #
Instance details Defined in Test.Syd.SpecDef Associated Types type Rep FlakinessMode :: Type -> Type # Methods from :: FlakinessMode -> Rep FlakinessMode x # to :: Rep FlakinessMode x -> FlakinessMode #
Show FlakinessMode Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> FlakinessMode -> ShowS # show :: FlakinessMode -> String # showList :: [FlakinessMode] -> ShowS #
Eq FlakinessMode Source #
Instance details Defined in Test.Syd.SpecDef Methods (==) :: FlakinessMode -> FlakinessMode -> Bool # (/=) :: FlakinessMode -> FlakinessMode -> Bool #
type Rep FlakinessMode Source #
Instance details Defined in Test.Syd.SpecDef type Rep FlakinessMode = D1 ('MetaData "FlakinessMode" "Test.Syd.SpecDef" "sydtest-0.15.1.1-CZvd3rDS4m47TQqIsce9VY" 'False) (C1 ('MetaCons "MayNotBeFlaky" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MayBeFlaky" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String))))

data ExpectationMode Source #

Constructors

ExpectPassing
ExpectFailing

Instances

Instances details

Generic ExpectationMode Source #
Instance details Defined in Test.Syd.SpecDef Associated Types type Rep ExpectationMode :: Type -> Type # Methods from :: ExpectationMode -> Rep ExpectationMode x # to :: Rep ExpectationMode x -> ExpectationMode #
Show ExpectationMode Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> ExpectationMode -> ShowS # show :: ExpectationMode -> String # showList :: [ExpectationMode] -> ShowS #
Eq ExpectationMode Source #
Instance details Defined in Test.Syd.SpecDef Methods (==) :: ExpectationMode -> ExpectationMode -> Bool # (/=) :: ExpectationMode -> ExpectationMode -> Bool #
type Rep ExpectationMode Source #
Instance details Defined in Test.Syd.SpecDef type Rep ExpectationMode = D1 ('MetaData "ExpectationMode" "Test.Syd.SpecDef" "sydtest-0.15.1.1-CZvd3rDS4m47TQqIsce9VY" 'False) (C1 ('MetaCons "ExpectPassing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExpectFailing" 'PrefixI 'False) (U1 :: Type -> Type))

type ResultForest = SpecForest (TDef (Timed TestRunReport)) Source #

type ResultTree = SpecTree (TDef (Timed TestRunReport)) Source #

computeTestSuiteStats :: Settings -> ResultForest -> TestSuiteStats Source #

data TestSuiteStats Source #

Constructors

TestSuiteStats
Fields testSuiteStatSuccesses :: !Word testSuiteStatExamples :: !Word testSuiteStatFailures :: !Word testSuiteStatFlakyTests :: !Word testSuiteStatPending :: !Word testSuiteStatSumTime :: !Word64

Instances

Instances details

Monoid TestSuiteStats Source #
Instance details Defined in Test.Syd.SpecDef Methods mempty :: TestSuiteStats # mappend :: TestSuiteStats -> TestSuiteStats -> TestSuiteStats # mconcat :: [TestSuiteStats] -> TestSuiteStats #
Semigroup TestSuiteStats Source #
Instance details Defined in Test.Syd.SpecDef Methods (<>) :: TestSuiteStats -> TestSuiteStats -> TestSuiteStats # sconcat :: NonEmpty TestSuiteStats -> TestSuiteStats # stimes :: Integral b => b -> TestSuiteStats -> TestSuiteStats #
Show TestSuiteStats Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> TestSuiteStats -> ShowS # show :: TestSuiteStats -> String # showList :: [TestSuiteStats] -> ShowS #
Eq TestSuiteStats Source #
Instance details Defined in Test.Syd.SpecDef Methods (==) :: TestSuiteStats -> TestSuiteStats -> Bool # (/=) :: TestSuiteStats -> TestSuiteStats -> Bool #

shouldExitFail :: Settings -> ResultForest -> Bool Source #

data TestRunReport Source #

Constructors

TestRunReport
Fields testRunReportExpectationMode :: !ExpectationMode testRunReportRawResults :: !(NonEmpty TestRunResult) Raw results, including retries, in order testRunReportFlakinessMode :: !FlakinessMode

Instances

Instances details

Generic TestRunReport Source #
Instance details Defined in Test.Syd.SpecDef Associated Types type Rep TestRunReport :: Type -> Type # Methods from :: TestRunReport -> Rep TestRunReport x # to :: Rep TestRunReport x -> TestRunReport #
Show TestRunReport Source #
Instance details Defined in Test.Syd.SpecDef Methods showsPrec :: Int -> TestRunReport -> ShowS # show :: TestRunReport -> String # showList :: [TestRunReport] -> ShowS #
type Rep TestRunReport Source #
Instance details Defined in Test.Syd.SpecDef type Rep TestRunReport = D1 ('MetaData "TestRunReport" "Test.Syd.SpecDef" "sydtest-0.15.1.1-CZvd3rDS4m47TQqIsce9VY" 'False) (C1 ('MetaCons "TestRunReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "testRunReportExpectationMode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ExpectationMode) :: (S1 ('MetaSel ('Just "testRunReportRawResults") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty TestRunResult)) :: S1 ('MetaSel ('Just "testRunReportFlakinessMode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FlakinessMode))))

testRunReportReportedRun :: TestRunReport -> TestRunResult Source #

testRunReportFailed :: Settings -> TestRunReport -> Bool Source #

testRunReportStatus :: Settings -> TestRunReport -> TestStatus Source #

testStatusMatchesExpectationMode :: TestStatus -> ExpectationMode -> Bool Source #

testRunReportExamples :: TestRunReport -> Word Source #

testRunResultExamples :: TestRunResult -> Word Source #

testRunReportWasFlaky :: TestRunReport -> Bool Source #

testRunReportRetries :: TestRunReport -> Maybe Word Source #