Test.Syd.Modify

This module defines functions for declaring different test settings

Declaring different test settings

modifyMaxSuccess :: (Int -> Int) -> TestDefM a b c -> TestDefM a b c

modifyMaxDiscardRatio :: (Int -> Int) -> TestDefM a b c -> TestDefM a b c

modifyMaxSize :: (Int -> Int) -> TestDefM a b c -> TestDefM a b c

modifyMaxShrinks :: (Int -> Int) -> TestDefM a b c -> TestDefM a b c

modifyRunSettings :: (TestRunSettings -> TestRunSettings) -> TestDefM a b c -> TestDefM a b c

data TestRunSettings

Constructors

TestRunSettings

Fields

• testRunSettingSeed :: !SeedSetting
• testRunSettingMaxSuccess :: !Int
• testRunSettingMaxSize :: !Int
• testRunSettingMaxDiscardRatio :: !Int
• testRunSettingMaxShrinks :: !Int
• testRunSettingGoldenStart :: !Bool
• testRunSettingGoldenReset :: !Bool

Instances

Generic TestRunSettings

Defined in Test.Syd.Run

Associated Types

type Rep TestRunSettings :: Type -> Type

Methods

from :: TestRunSettings -> Rep TestRunSettings x

to :: Rep TestRunSettings x -> TestRunSettings

Show TestRunSettings

Defined in Test.Syd.Run

Methods

showsPrec :: Int -> TestRunSettings -> ShowS

show :: TestRunSettings -> String

showList :: [TestRunSettings] -> ShowS

Eq TestRunSettings

Defined in Test.Syd.Run

Methods

(==) :: TestRunSettings -> TestRunSettings -> Bool

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

type Rep TestRunSettings

Defined in Test.Syd.Run

type Rep TestRunSettings = D1 ('MetaData "TestRunSettings" "Test.Syd.Run" "sydtest-0.13.0.1-55Gc5hcyKHH3AZQfAi7Nha" 'False) (C1 ('MetaCons "TestRunSettings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "testRunSettingSeed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SeedSetting) :*: (S1 ('MetaSel ('Just "testRunSettingMaxSuccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "testRunSettingMaxSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "testRunSettingMaxDiscardRatio") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "testRunSettingMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "testRunSettingGoldenStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "testRunSettingGoldenReset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))

Declaring parallelism

sequential :: TestDefM a b c -> TestDefM a b c

Declare that all tests below must be run sequentially

parallel :: TestDefM a b c -> TestDefM a b c

Declare that all tests below may be run in parallel. (This is the default.)

withParallelism :: Parallelism -> TestDefM a b c -> TestDefM a b c

Annotate a test group with Parallelism.

data Parallelism

Constructors

Parallel

Sequential

Instances

Generic Parallelism

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

Defined in Test.Syd.SpecDef

Methods

showsPrec :: Int -> Parallelism -> ShowS

show :: Parallelism -> String

showList :: [Parallelism] -> ShowS

Eq Parallelism

Defined in Test.Syd.SpecDef

Methods

(==) :: Parallelism -> Parallelism -> Bool

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

type Rep Parallelism

Defined in Test.Syd.SpecDef

type Rep Parallelism = D1 ('MetaData "Parallelism" "Test.Syd.SpecDef" "sydtest-0.13.0.1-55Gc5hcyKHH3AZQfAi7Nha" 'False) (C1 ('MetaCons "Parallel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sequential" 'PrefixI 'False) (U1 :: Type -> Type))

Declaring randomisation order

randomiseExecutionOrder :: TestDefM a b c -> TestDefM a b c

Declare that the order of execution of all tests below may be randomised.

doNotRandomiseExecutionOrder :: TestDefM a b c -> TestDefM a b c

Declare that the order of execution of all tests below must not be randomised.

withExecutionOrderRandomisation :: ExecutionOrderRandomisation -> TestDefM a b c -> TestDefM a b c

Annotate a test group with ExecutionOrderRandomisation.

data ExecutionOrderRandomisation

Constructors

RandomiseExecutionOrder

DoNotRandomiseExecutionOrder

Instances

Generic ExecutionOrderRandomisation

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

Defined in Test.Syd.SpecDef

Methods

showsPrec :: Int -> ExecutionOrderRandomisation -> ShowS

show :: ExecutionOrderRandomisation -> String

showList :: [ExecutionOrderRandomisation] -> ShowS

Eq ExecutionOrderRandomisation

Defined in Test.Syd.SpecDef

Methods

(==) :: ExecutionOrderRandomisation -> ExecutionOrderRandomisation -> Bool

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

type Rep ExecutionOrderRandomisation

Defined in Test.Syd.SpecDef

type Rep ExecutionOrderRandomisation = D1 ('MetaData "ExecutionOrderRandomisation" "Test.Syd.SpecDef" "sydtest-0.13.0.1-55Gc5hcyKHH3AZQfAi7Nha" 'False) (C1 ('MetaCons "RandomiseExecutionOrder" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoNotRandomiseExecutionOrder" 'PrefixI 'False) (U1 :: Type -> Type))

Modifying the number of retries

modifyRetries :: (Word -> Word) -> TestDefM a b c -> TestDefM a b c

Modify the number of retries to use in flakiness diagnostics.

withoutRetries :: TestDefM a b c -> TestDefM a b c

Turn off retries

withRetries :: Word -> TestDefM a b c -> TestDefM a b c

Make the number of retries this constant

Declaring flakiness

flaky :: Word -> TestDefM a b c -> TestDefM a b c

Mark a test suite as "potentially flaky" with a given number of retries.

This will retry any test in the given test group up to the given number of tries, and pass a test if it passes once. The test output will show which tests were flaky.

WARNING: This is only a valid approach to dealing with test flakiness if it is true that tests never pass accidentally. In other words: tests using flaky must be guaranteed to fail every time if an error is introduced in the code, it should only be added to deal with accidental failures, never accidental passes.

flakyWith :: Word -> String -> TestDefM a b c -> TestDefM a b c

Like flaky, but also shows the given message to the user whenever the test is flaky.

You could use it like this:

>>> flakyWith 3 "Something sometimes goes wrong with the database, see issue 6346" ourTestSuite

notFlaky :: TestDefM a b c -> TestDefM a b c

Mark a test suite as "must not be flaky".

This is useful to have a subgroup of a group marked as flaky that must not be flaky afteral.

potentiallyFlaky :: TestDefM a b c -> TestDefM a b c

Mark a test suite as 'potentially flaky', such that it will not fail if it is flaky but passes at least once.

potentiallyFlakyWith :: String -> TestDefM a b c -> TestDefM a b c

Like potentiallyFlaky, but with a message.

withFlakiness :: FlakinessMode -> TestDefM a b c -> TestDefM a b c

Annotate a test group with FlakinessMode.

data FlakinessMode

Constructors

MayNotBeFlaky

MayBeFlaky !(Maybe String)

Instances

Generic FlakinessMode

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

Defined in Test.Syd.SpecDef

Methods

showsPrec :: Int -> FlakinessMode -> ShowS

show :: FlakinessMode -> String

showList :: [FlakinessMode] -> ShowS

Eq FlakinessMode

Defined in Test.Syd.SpecDef

Methods

(==) :: FlakinessMode -> FlakinessMode -> Bool

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

type Rep FlakinessMode

Defined in Test.Syd.SpecDef

type Rep FlakinessMode = D1 ('MetaData "FlakinessMode" "Test.Syd.SpecDef" "sydtest-0.13.0.1-55Gc5hcyKHH3AZQfAi7Nha" '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))))

Declaring expectations

expectPassing :: TestDefM a b c -> TestDefM a b c

Mark a test suite as 'should pass'

expectFailing :: TestDefM a b c -> TestDefM a b c

Mark a test suite as 'should fail'

withExpectationMode :: ExpectationMode -> TestDefM a b c -> TestDefM a b c

Annotate a test suite with ExpectationMode

data ExpectationMode

Constructors

ExpectPassing

ExpectFailing

Instances

Generic ExpectationMode

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

Defined in Test.Syd.SpecDef

Methods

showsPrec :: Int -> ExpectationMode -> ShowS

show :: ExpectationMode -> String

showList :: [ExpectationMode] -> ShowS

Eq ExpectationMode

Defined in Test.Syd.SpecDef

Methods

(==) :: ExpectationMode -> ExpectationMode -> Bool

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

type Rep ExpectationMode

Defined in Test.Syd.SpecDef

type Rep ExpectationMode = D1 ('MetaData "ExpectationMode" "Test.Syd.SpecDef" "sydtest-0.13.0.1-55Gc5hcyKHH3AZQfAi7Nha" 'False) (C1 ('MetaCons "ExpectPassing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExpectFailing" 'PrefixI 'False) (U1 :: Type -> Type))