Test.Syd.OptParse

Documentation

getSettings :: IO Settings

data Settings

Test suite definition and run settings

Constructors

Settings

Fields

• settingSeed :: !SeedSetting

  The seed to use for deterministic randomness

• settingRandomiseExecutionOrder :: !Bool

  Randomise the execution order of the tests in the test suite

• settingThreads :: !Threads

  How parallel to run the test suite

• settingMaxSuccess :: !Int

  How many examples to run a property test with

• settingMaxSize :: !Int

  The maximum size parameter to supply to generators

• settingMaxDiscard :: !Int

  The maximum number of discarded examples per tested example

• settingMaxShrinks :: !Int

  The maximum number of tries to use while shrinking a counterexample.

• settingGoldenStart :: !Bool

  Whether to write golden tests if they do not exist yet

• settingGoldenReset :: !Bool

  Whether to overwrite golden tests instead of having them fail

• settingColour :: !(Maybe Bool)

  Whether to use colour in the output, Nothing means "detect"

• settingFilters :: ![Text]

  The filters to use to select which tests to run

• settingFailFast :: !Bool

  Whether to stop upon the first test failure

• settingIterations :: !Iterations

  How many iterations to use to look diagnose flakiness

• settingRetries :: !Word

  How many times to retry a test for flakiness diagnostics

• settingFailOnFlaky :: !Bool

  Whether to fail when any flakiness is detected in tests declared as flaky

• settingReportProgress :: !ReportProgress

  How to report progress

• settingProfile :: !Bool

  Profiling mode

Instances

Generic Settings

Defined in Test.Syd.OptParse

Associated Types

type Rep Settings :: Type -> Type

Methods

from :: Settings -> Rep Settings x

to :: Rep Settings x -> Settings

Show Settings

Defined in Test.Syd.OptParse

Methods

showsPrec :: Int -> Settings -> ShowS

show :: Settings -> String

showList :: [Settings] -> ShowS

Eq Settings

Defined in Test.Syd.OptParse

Methods

(==) :: Settings -> Settings -> Bool

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

HasParser Settings

Defined in Test.Syd.OptParse

Methods

settingsParser :: Parser Settings

type Rep Settings

Defined in Test.Syd.OptParse

type Rep Settings = D1 ('MetaData "Settings" "Test.Syd.OptParse" "sydtest-0.17.0.0-L6KbQfkPwEtDkg8pbVjSrz" 'False) (C1 ('MetaCons "Settings" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "settingSeed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SeedSetting) :*: S1 ('MetaSel ('Just "settingRandomiseExecutionOrder") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "settingThreads") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Threads) :*: S1 ('MetaSel ('Just "settingMaxSuccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "settingMaxSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "settingMaxDiscard") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "settingMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "settingGoldenStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))) :*: (((S1 ('MetaSel ('Just "settingGoldenReset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "settingColour") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "settingFilters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "settingFailFast") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "settingIterations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Iterations) :*: S1 ('MetaSel ('Just "settingRetries") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word)) :*: (S1 ('MetaSel ('Just "settingFailOnFlaky") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "settingReportProgress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ReportProgress) :*: S1 ('MetaSel ('Just "settingProfile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))))

defaultSettings :: Settings

defaultRetries :: Word

deriveTerminalCapababilities :: Settings -> IO TerminalCapabilities

detectTerminalCapabilities :: IO TerminalCapabilities

data Flags

Constructors

Flags

Fields

• flagSeed :: !SeedSetting
• flagRandomiseExecutionOrder :: !(Maybe Bool)
• flagThreads :: !(Maybe Threads)
• flagMaxSize :: !Int
• flagMaxSuccess :: !Int
• flagMaxDiscard :: !Int
• flagMaxShrinks :: !Int
• flagGoldenStart :: !Bool
• flagGoldenReset :: !Bool
• flagColour :: !(Maybe Bool)
• flagFilters :: ![Text]
• flagFailFast :: !(Maybe Bool)
• flagIterations :: !Iterations
• flagRetries :: !(Maybe Word)
• flagFailOnFlaky :: !Bool
• flagReportProgress :: !(Maybe ReportProgress)
• flagDebug :: !Bool
• flagProfile :: !Bool

Instances

Generic Flags

Defined in Test.Syd.OptParse

Associated Types

type Rep Flags :: Type -> Type

Methods

from :: Flags -> Rep Flags x

to :: Rep Flags x -> Flags

Show Flags

Defined in Test.Syd.OptParse

Methods

showsPrec :: Int -> Flags -> ShowS

show :: Flags -> String

showList :: [Flags] -> ShowS

Eq Flags

Defined in Test.Syd.OptParse

Methods

(==) :: Flags -> Flags -> Bool

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

HasParser Flags

Defined in Test.Syd.OptParse

Methods

settingsParser :: Parser Flags

type Rep Flags

Defined in Test.Syd.OptParse

type Rep Flags = D1 ('MetaData "Flags" "Test.Syd.OptParse" "sydtest-0.17.0.0-L6KbQfkPwEtDkg8pbVjSrz" 'False) (C1 ('MetaCons "Flags" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "flagSeed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SeedSetting) :*: S1 ('MetaSel ('Just "flagRandomiseExecutionOrder") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "flagThreads") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Threads)) :*: S1 ('MetaSel ('Just "flagMaxSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "flagMaxSuccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "flagMaxDiscard") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "flagMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "flagGoldenStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "flagGoldenReset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))) :*: (((S1 ('MetaSel ('Just "flagColour") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "flagFilters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text])) :*: (S1 ('MetaSel ('Just "flagFailFast") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "flagIterations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Iterations))) :*: ((S1 ('MetaSel ('Just "flagRetries") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Word)) :*: S1 ('MetaSel ('Just "flagFailOnFlaky") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "flagReportProgress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ReportProgress)) :*: (S1 ('MetaSel ('Just "flagDebug") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "flagProfile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))))

data Threads

Constructors

Synchronous

One thread

ByCapabilities

As many threads as getNumCapabilities tells you you have

Asynchronous !Word

A given number of threads

Instances

HasCodec Threads

Defined in Test.Syd.OptParse

Methods

codec :: JSONCodec Threads

listCodecForStringCompatibility :: JSONCodec [Threads]

Generic Threads

Defined in Test.Syd.OptParse

Associated Types

type Rep Threads :: Type -> Type

Methods

from :: Threads -> Rep Threads x

to :: Rep Threads x -> Threads

Read Threads

Defined in Test.Syd.OptParse

Methods

readsPrec :: Int -> ReadS Threads

readList :: ReadS [Threads]

readPrec :: ReadPrec Threads

readListPrec :: ReadPrec [Threads]

Show Threads

Defined in Test.Syd.OptParse

Methods

showsPrec :: Int -> Threads -> ShowS

show :: Threads -> String

showList :: [Threads] -> ShowS

Eq Threads

Defined in Test.Syd.OptParse

Methods

(==) :: Threads -> Threads -> Bool

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

HasParser Threads

Defined in Test.Syd.OptParse

Methods

settingsParser :: Parser Threads

type Rep Threads

Defined in Test.Syd.OptParse

type Rep Threads = D1 ('MetaData "Threads" "Test.Syd.OptParse" "sydtest-0.17.0.0-L6KbQfkPwEtDkg8pbVjSrz" 'False) (C1 ('MetaCons "Synchronous" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ByCapabilities" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Asynchronous" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word))))

data Iterations

Constructors

OneIteration

Run the test suite once, the default

Iterations !Word

Run the test suite for the given number of iterations, or until we can find flakiness

Continuous

Run the test suite over and over, until we can find some flakiness

Instances

HasCodec Iterations

Defined in Test.Syd.OptParse

Methods

codec :: JSONCodec Iterations

listCodecForStringCompatibility :: JSONCodec [Iterations]

Generic Iterations

Defined in Test.Syd.OptParse

Associated Types

type Rep Iterations :: Type -> Type

Methods

from :: Iterations -> Rep Iterations x

to :: Rep Iterations x -> Iterations

Read Iterations

Defined in Test.Syd.OptParse

Methods

readsPrec :: Int -> ReadS Iterations

readList :: ReadS [Iterations]

readPrec :: ReadPrec Iterations

readListPrec :: ReadPrec [Iterations]

Show Iterations

Defined in Test.Syd.OptParse

Methods

showsPrec :: Int -> Iterations -> ShowS

show :: Iterations -> String

showList :: [Iterations] -> ShowS

Eq Iterations

Defined in Test.Syd.OptParse

Methods

(==) :: Iterations -> Iterations -> Bool

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

HasParser Iterations

Defined in Test.Syd.OptParse

Methods

settingsParser :: Parser Iterations

type Rep Iterations

Defined in Test.Syd.OptParse

type Rep Iterations = D1 ('MetaData "Iterations" "Test.Syd.OptParse" "sydtest-0.17.0.0-L6KbQfkPwEtDkg8pbVjSrz" 'False) (C1 ('MetaCons "OneIteration" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Iterations" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word)) :+: C1 ('MetaCons "Continuous" 'PrefixI 'False) (U1 :: Type -> Type)))

data ReportProgress

Constructors

ReportNoProgress

Don't report any progress, the default

ReportProgress

Report progress

Instances

Generic ReportProgress

Defined in Test.Syd.OptParse

Associated Types

type Rep ReportProgress :: Type -> Type

Methods

from :: ReportProgress -> Rep ReportProgress x

to :: Rep ReportProgress x -> ReportProgress

Read ReportProgress

Defined in Test.Syd.OptParse

Methods

readsPrec :: Int -> ReadS ReportProgress

readList :: ReadS [ReportProgress]

readPrec :: ReadPrec ReportProgress

readListPrec :: ReadPrec [ReportProgress]

Show ReportProgress

Defined in Test.Syd.OptParse

Methods

showsPrec :: Int -> ReportProgress -> ShowS

show :: ReportProgress -> String

showList :: [ReportProgress] -> ShowS

Eq ReportProgress

Defined in Test.Syd.OptParse

Methods

(==) :: ReportProgress -> ReportProgress -> Bool

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

HasParser ReportProgress

Defined in Test.Syd.OptParse

Methods

settingsParser :: Parser ReportProgress

type Rep ReportProgress

Defined in Test.Syd.OptParse

type Rep ReportProgress = D1 ('MetaData "ReportProgress" "Test.Syd.OptParse" "sydtest-0.17.0.0-L6KbQfkPwEtDkg8pbVjSrz" 'False) (C1 ('MetaCons "ReportNoProgress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReportProgress" 'PrefixI 'False) (U1 :: Type -> Type))