Constructors
TDeftestDefVal :: valuetestDefCallStack :: CallStack
Modulesydtest-0.33.0.0Haskell2010
Test.Syd.SpecDef
This module defines all the functions you will use to define your test suite.
- 13 types
- 14 values
- Packagesydtest-0.33.0.0
- Exports27
- LanguageHaskell2010
- LicenceLicenseRef-OtherLicense
- SourceSpecDef.hs
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 ofaroundAll.)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 ofaround.)result: The result (TestDefMis 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 :: Text -> TDef (ProgressReporter -> ((HList outers -> inner -> IO ()) -> IO ()) -> IO TestRunResult) -> extra -> SpecDefTree outers inner extraDefine a test
DefPendingNode :: Text -> Maybe Text -> SpecDefTree outers inner extraDefine a pending test
DefDescribeNode :: Text -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraGroup tests using a description
DefSetupNode :: IO () -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefBeforeAllNode :: IO outer -> SpecDefForest (outer ': outers) inner extra -> SpecDefTree outers inner extraDefBeforeAllWithNode :: (oldOuter -> IO newOuter) -> SpecDefForest (newOuter ': oldOuter ': otherOuters) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extraDefWrapNode :: (IO () -> IO ()) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefAroundAllNode :: ((outer -> IO ()) -> IO ()) -> SpecDefForest (outer ': outers) inner extra -> SpecDefTree outers inner extraDefAroundAllWithNode :: ((newOuter -> IO ()) -> HList (oldOuter ': otherOuters) -> IO ()) -> SpecDefForest (newOuter ': oldOuter ': otherOuters) inner extra -> SpecDefTree (oldOuter ': otherOuters) inner extraDefAfterAllNode :: (HList outers -> IO ()) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefParallelismNode :: Parallelism -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraControl the level of parallelism for a given group of tests
DefRandomisationNode :: ExecutionOrderRandomisation -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraControl the execution order randomisation for a given group of tests
DefTimeoutNode :: (Timeout -> Timeout) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefRetriesNode :: (Word -> Word) -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefFlakinessNode :: FlakinessMode -> SpecDefForest outers inner extra -> SpecDefTree outers inner extraDefExpectationNode :: ExpectationMode -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
Instances4Functor, Foldable, Traversable, MonadWriter
Functor (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDefFoldable (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDefTraversable (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDefMonadWriter (TestForest outers inner) (TestDefM outers inner)Defined in sydtest-0.33.0.0 · Test.Syd.Def.TestDefM
Constructors
ParallelAs many at once as there are threads to run them.
ParallelWith !WordAt most this many at once, however many threads there are.
For tests that contend for something the test suite does not own, like one database server behind a database per test. Running fewer of those at once can be faster than running all of them, and is the smaller instrument where Sequential would do.
SequentialOne at a time.
Instances4Eq, Show, Generic, Rep
Eq ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefShow ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefGeneric ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDeftype Rep Parallelism = D1 ('MetaDataDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef"Parallelism"
"Test.Syd.SpecDef"
"sydtest-0.33.0.0-8Om3cukmSySA1tijKodD6i"
'False) (C1 ('MetaCons"Parallel"
'PrefixI 'False) U1 :+: (C1 ('MetaCons"ParallelWith"
'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word)) :+: C1 ('MetaCons"Sequential"
'PrefixI 'False) U1))
Instances4Eq, Show, Generic, Rep
Eq ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefShow ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefGeneric ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDeftype Rep ExecutionOrderRandomisation = D1 ('MetaDataDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef"ExecutionOrderRandomisation"
"Test.Syd.SpecDef"
"sydtest-0.33.0.0-8Om3cukmSySA1tijKodD6i"
'False) (C1 ('MetaCons"RandomiseExecutionOrder"
'PrefixI 'False) U1 :+: C1 ('MetaCons"DoNotRandomiseExecutionOrder"
'PrefixI 'False) U1)
Constructors
Instances4Eq, Show, Generic, Rep
Eq FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefShow FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefGeneric FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDeftype Rep FlakinessMode = D1 ('MetaDataDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef"FlakinessMode"
"Test.Syd.SpecDef"
"sydtest-0.33.0.0-8Om3cukmSySA1tijKodD6i"
'False) (C1 ('MetaCons"MayNotBeFlaky"
'PrefixI 'False) U1 :+: C1 ('MetaCons"MayBeFlaky"
'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String))))
Instances4Eq, Show, Generic, Rep
Eq ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefShow ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefGeneric ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDeftype Rep ExpectationMode = D1 ('MetaDataDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef"ExpectationMode"
"Test.Syd.SpecDef"
"sydtest-0.33.0.0-8Om3cukmSySA1tijKodD6i"
'False) (C1 ('MetaCons"ExpectPassing"
'PrefixI 'False) U1 :+: C1 ('MetaCons"ExpectFailing"
'PrefixI 'False) U1)
Constructors
Instances4Eq, Show, Semigroup, Monoid
Eq TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefShow TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefSemigroup TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefMonoid TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Constructors
TestRunReporttestRunReportExpectationMode :: !ExpectationModetestRunReportRawResults :: !NonEmpty TestRunResultRaw results, including retries, in order
testRunReportFlakinessMode :: !FlakinessMode
Instances3Show, Generic, Rep
Show TestRunReportDefined in sydtest-0.33.0.0 · Test.Syd.SpecDefGeneric TestRunReportDefined in sydtest-0.33.0.0 · Test.Syd.SpecDeftype Rep TestRunReport = D1 ('MetaDataDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef"TestRunReport"
"Test.Syd.SpecDef"
"sydtest-0.33.0.0-8Om3cukmSySA1tijKodD6i"
'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))))