Modulesydtest-0.22.0.0Haskell2010

Test.Syd.OptParse

6 types
6 values

Packagesydtest-0.22.0.0
Exports12
LanguageHaskell2010
LicenceLicenseRef-OtherLicense
SourceOptParse.hs

valuegetSettings :: IO Settings

datadata Settings

Test suite definition and run settings

Constructors

Settings
- 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
- settingTimeout :: !Timeout
  How many microseconds wait for a test to finish before considering it failed
- 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
- settingSkipPassed :: !Bool
  Whether to skip running tests that have already passed.
- settingReportFile :: !Maybe (Path Abs File)
  Where to store the report
- settingReportProgress :: !ReportProgress
  How to report progress
- settingProfile :: !Bool
  Profiling mode

Instances5Eq, Show, Generic, HasParser, Rep

Eq SettingsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show SettingsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic SettingsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser SettingsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep Settings = D1 ('MetaData "Settings" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" '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 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "settingMaxSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "settingMaxDiscard") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "settingMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (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 "settingTimeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Timeout) :*: S1 ('MetaSel ('Just "settingRetries") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word)))) :*: ((S1 ('MetaSel ('Just "settingFailOnFlaky") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "settingSkipPassed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "settingReportFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Path Abs File))) :*: (S1 ('MetaSel ('Just "settingReportProgress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ReportProgress) :*: S1 ('MetaSel ('Just "settingProfile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))))Defined in sydtest-0.22.0.0 · Test.Syd.OptParse

valuedefaultSettings :: Settings

valuedefaultTimeout :: Int

valuedefaultRetries :: Word

valuederiveTerminalCapababilities :: Settings -> IO TerminalCapabilities

valuedetectTerminalCapabilities :: IO TerminalCapabilities

datadata Flags

Constructors

Flags
- 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
- flagTimeout :: !Timeout
- flagFailOnFlaky :: !Bool
- flagSkipPassed :: !Bool
- flagReportFile :: !Maybe (Path Abs File)
- flagReportProgress :: !Maybe ReportProgress
- flagDebug :: !Bool
- flagProfile :: !Bool

Instances5Eq, Show, Generic, HasParser, Rep

Eq FlagsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show FlagsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic FlagsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser FlagsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep Flags = D1 ('MetaData "Flags" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" '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 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "flagMaxSuccess") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "flagMaxDiscard") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "flagMaxShrinks") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (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 "flagTimeout") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Timeout)))) :*: ((S1 ('MetaSel ('Just "flagFailOnFlaky") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "flagSkipPassed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "flagReportFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Path Abs File))))) :*: (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)))))))Defined in sydtest-0.22.0.0 · Test.Syd.OptParse

datadata Timeout

Instances7Eq, Read, Show, Generic, HasCodec, HasParser, …

Eq TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Read TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasCodec TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser TimeoutDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep Timeout = D1 ('MetaData "Timeout" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" 'False) (C1 ('MetaCons "DoNotTimeout" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TimeoutAfterMicros" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)))Defined in sydtest-0.22.0.0 · Test.Syd.OptParse

datadata Threads

Constructors

Synchronous
One thread
ByCapabilities
As many threads as getNumCapabilities tells you you have
Asynchronous !Word
A given number of threads

Instances7Eq, Read, Show, Generic, HasCodec, HasParser, …

Eq ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Read ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasCodec ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser ThreadsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep Threads = D1 ('MetaData "Threads" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" 'False) (C1 ('MetaCons "Synchronous" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ByCapabilities" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Asynchronous" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word))))Defined in sydtest-0.22.0.0 · Test.Syd.OptParse

datadata 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

Instances7Eq, Read, Show, Generic, HasCodec, HasParser, …

Eq IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Read IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasCodec IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser IterationsDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep Iterations = D1 ('MetaData "Iterations" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" 'False) (C1 ('MetaCons "OneIteration" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Iterations" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word)) :+: C1 ('MetaCons "Continuous" 'PrefixI 'False) U1))Defined in sydtest-0.22.0.0 · Test.Syd.OptParse

datadata ReportProgress

Constructors

ReportNoProgress
Don't report any progress, the default
ReportProgress
Report progress

Instances6Eq, Read, Show, Generic, HasParser, Rep

Eq ReportProgressDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Read ReportProgressDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Show ReportProgressDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
Generic ReportProgressDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
HasParser ReportProgressDefined in sydtest-0.22.0.0 · Test.Syd.OptParse
type Rep ReportProgress = D1 ('MetaData "ReportProgress" "Test.Syd.OptParse" "sydtest-0.22.0.0-C6WVjaL6xelIJS238V3PZE" 'False) (C1 ('MetaCons "ReportNoProgress" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ReportProgress" 'PrefixI 'False) U1)Defined in sydtest-0.22.0.0 · Test.Syd.OptParse