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

datadata TDef value

Constructors

TDef
- testDefVal :: value
- testDefCallStack :: CallStack

Instances3Functor, Foldable, Traversable

Functor TDefDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Foldable TDefDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Traversable TDefDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef

typetype TestForest (outers :: [Type]) inner = SpecDefForest outers inner ()

typetype TestTree (outers :: [Type]) inner = SpecDefTree outers inner ()

typetype SpecDefForest (outers :: [Type]) inner extra = [SpecDefTree outers inner extra]

datadata SpecDefTree (outers :: [Type]) inner extra where

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 :: Text -> TDef (ProgressReporter -> ((HList outers -> inner -> IO ()) -> IO ()) -> IO TestRunResult) -> extra -> SpecDefTree outers inner extra
Define a test
DefPendingNode :: Text -> Maybe Text -> SpecDefTree outers inner extra
Define a pending test
DefDescribeNode :: Text -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
Group tests using a description
DefSetupNode :: IO () -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
DefBeforeAllNode :: IO outer -> SpecDefForest (outer ': otherOuters) inner extra -> SpecDefTree outers 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 outers inner extra
DefAroundAllWithNode :: ((newOuter -> IO ()) -> HList (oldOuter ': otherOuters) -> 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
Control the level of parallelism for a given group of tests
DefRandomisationNode :: ExecutionOrderRandomisation -> SpecDefForest outers inner extra -> SpecDefTree outers inner extra
Control the execution order randomisation for a given group of tests
DefTimeoutNode :: (Timeout -> Timeout) -> 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

Instances4Functor, Foldable, Traversable, MonadWriter

Functor (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Foldable (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Traversable (SpecDefTree a c)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef
MonadWriter (TestForest outers inner) (TestDefM outers inner)Defined in sydtest-0.33.0.0 · Test.Syd.Def.TestDefM

valuefilterTestForest

:: [Text]
-> SpecDefForest outers inner result
-> SpecDefForest outers inner result

valuerandomiseTestForest

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

valuemarkSpecForestAsPending

:: Maybe Text
-> SpecDefForest outers inner result
-> SpecDefForest outers inner result

datadata Parallelism

Constructors

Parallel
As many at once as there are threads to run them.
ParallelWith !Word
At 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.
Sequential
One at a time.

Instances4Eq, Show, Generic, Rep

Eq ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Show ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Generic ParallelismDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
type Rep Parallelism = D1 ('MetaData "Parallelism" "Test.Syd.SpecDef" "sydtest-0.33.0.0-A4vYtVtkQp2DQjwds8Zw3v" '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))Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef

datadata ExecutionOrderRandomisation

RandomiseExecutionOrder DoNotRandomiseExecutionOrder

Instances4Eq, Show, Generic, Rep

Eq ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Show ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Generic ExecutionOrderRandomisationDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
type Rep ExecutionOrderRandomisation = D1 ('MetaData "ExecutionOrderRandomisation" "Test.Syd.SpecDef" "sydtest-0.33.0.0-A4vYtVtkQp2DQjwds8Zw3v" 'False) (C1 ('MetaCons "RandomiseExecutionOrder" 'PrefixI 'False) U1 :+: C1 ('MetaCons "DoNotRandomiseExecutionOrder" 'PrefixI 'False) U1)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef

datadata FlakinessMode

Constructors

MayNotBeFlaky
MayBeFlaky !(Maybe String)

Instances4Eq, Show, Generic, Rep

Eq FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Show FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Generic FlakinessModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
type Rep FlakinessMode = D1 ('MetaData "FlakinessMode" "Test.Syd.SpecDef" "sydtest-0.33.0.0-A4vYtVtkQp2DQjwds8Zw3v" 'False) (C1 ('MetaCons "MayNotBeFlaky" 'PrefixI 'False) U1 :+: C1 ('MetaCons "MayBeFlaky" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe String))))Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef

datadata ExpectationMode

ExpectPassing ExpectFailing

Instances4Eq, Show, Generic, Rep

Eq ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Show ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Generic ExpectationModeDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
type Rep ExpectationMode = D1 ('MetaData "ExpectationMode" "Test.Syd.SpecDef" "sydtest-0.33.0.0-A4vYtVtkQp2DQjwds8Zw3v" 'False) (C1 ('MetaCons "ExpectPassing" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ExpectFailing" 'PrefixI 'False) U1)Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef

typetype ResultForest = SpecForest (TDef (Timed TestRunReport))

typetype ResultTree = SpecTree (TDef (Timed TestRunReport))

valuecomputeTestSuiteStats :: Settings -> ResultForest -> TestSuiteStats

datadata TestSuiteStats

Constructors

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

Instances4Eq, Show, Semigroup, Monoid

Eq TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Show TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Semigroup TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Monoid TestSuiteStatsDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef

valueshouldExitFail :: Settings -> ResultForest -> Bool

valueanyFailedTests :: Settings -> ResultForest -> Bool

datadata TestRunReport

Constructors

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

Instances3Show, Generic, Rep

Show TestRunReportDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
Generic TestRunReportDefined in sydtest-0.33.0.0 · Test.Syd.SpecDef
type Rep TestRunReport = D1 ('MetaData "TestRunReport" "Test.Syd.SpecDef" "sydtest-0.33.0.0-A4vYtVtkQp2DQjwds8Zw3v" '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))))Defined in sydtest-0.33.0.0 · Test.Syd.SpecDef

valuetestRunReportReportedRun :: TestRunReport -> TestRunResult

valuetestRunReportFailed :: Settings -> TestRunReport -> Bool

valuetestRunReportStatus :: Settings -> TestRunReport -> TestStatus

valuetestStatusMatchesExpectationMode :: TestStatus -> ExpectationMode -> Bool

valuetestRunReportExamples :: TestRunReport -> Word

valuetestRunResultExamples :: TestRunResult -> Word

valuetestRunReportWasFlaky :: TestRunReport -> Bool

valuetestRunReportRetries :: TestRunReport -> Maybe Word