tasty-1.5: Modern and extensible testing framework

Safe Haskell | Safe-Inferred
Language | Haskell2010

Test.Tasty.Options

Contents

- IsOption class
- Option sets and operations
- Utilities

Description

Extensible options. They are used for provider-specific settings, ingredient-specific settings and core settings (such as the test name pattern).

Since: 0.1

Synopsis

- class Typeable v => IsOption v where
  - defaultValue :: v
  - parseValue :: String -> Maybe v
  - optionName :: Tagged v String
  - optionHelp :: Tagged v String
  - showDefaultValue :: v -> Maybe String
  - optionCLParser :: Parser v
- data OptionSet
- setOption :: IsOption v => v -> OptionSet -> OptionSet
- changeOption :: IsOption v => (v -> v) -> OptionSet -> OptionSet
- lookupOption :: IsOption v => OptionSet -> v
- singleOption :: IsOption v => v -> OptionSet
- data OptionDescription where
  - Option :: forall v. IsOption v => Proxy v -> OptionDescription
- uniqueOptionDescriptions :: [OptionDescription] -> [OptionDescription]
- flagCLParser :: IsOption v => Maybe Char -> v -> Parser v
- mkFlagCLParser :: IsOption v => Mod FlagFields v -> v -> Parser v
- mkOptionCLParser :: IsOption v => Mod OptionFields v -> Parser v
- safeRead :: Read a => String -> Maybe a
- safeReadBool :: String -> Maybe Bool

# IsOption class

class Typeable v => IsOption v where #

An option is a data type that inhabits the `IsOption` type class.

Since: 0.1

Minimal complete definition

defaultValue, parseValue, optionName, optionHelp

Methods

defaultValue :: v #

The value to use if the option was not supplied explicitly

parseValue :: String -> Maybe v #

Try to parse an option value from a string. Consider using `safeReadBool` for boolean options and `safeRead` for numeric options.

optionName :: Tagged v String #

The option name. It is used to form the command line option name, for instance. Therefore, it had better not contain spaces or other fancy characters. It is recommended to use dashes instead of spaces.

optionHelp :: Tagged v String #

The option description or help string. This can be an arbitrary string.

showDefaultValue :: v -> Maybe String #

How a `defaultValue` should be displayed in the help string. `Nothing` (the default implementation) will result in nothing being displayed, while ``Just` def` will result in `def` being advertised as the default in the help string.

Since: 1.3

optionCLParser :: Parser v #

A command-line option parser.

It has a default implementation in terms of the other methods. You may want to override it in some cases (e.g. add a short flag) and `flagCLParser`, `mkFlagCLParser` and `mkOptionCLParser` might come in handy.

Even if you override this, you still should implement all the methods above, to allow alternative interfaces.

Do not supply a default value (e.g., with the `value` function) here for this parser! This is because if no value was provided on the command line we may lookup the option e.g. in the environment. But if the parser always succeeds, we have no way to tell whether the user really provided the option on the command line.

Similarly, do not use `showDefaultWith` here, as it will be ignored. Use the `showDefaultValue` method of `IsOption` instead.

#### Instances

Instances details

IsOption AnsiTricks # |
Instance details Defined in Test.Tasty.Ingredients.ConsoleReporter Methods defaultValue :: AnsiTricks # parseValue :: String -> Maybe AnsiTricks # optionName :: Tagged AnsiTricks String # optionHelp :: Tagged AnsiTricks String # showDefaultValue :: AnsiTricks -> Maybe String # optionCLParser :: Parser AnsiTricks #
IsOption HideSuccesses # |
Instance details Defined in Test.Tasty.Ingredients.ConsoleReporter Methods defaultValue :: HideSuccesses # parseValue :: String -> Maybe HideSuccesses # optionName :: Tagged HideSuccesses String # optionHelp :: Tagged HideSuccesses String # showDefaultValue :: HideSuccesses -> Maybe String # optionCLParser :: Parser HideSuccesses #
IsOption MinDurationToReport # |
Instance details Defined in Test.Tasty.Ingredients.ConsoleReporter Methods defaultValue :: MinDurationToReport # parseValue :: String -> Maybe MinDurationToReport # optionName :: Tagged MinDurationToReport String # optionHelp :: Tagged MinDurationToReport String # showDefaultValue :: MinDurationToReport -> Maybe String # optionCLParser :: Parser MinDurationToReport #
IsOption Quiet # |
Instance details Defined in Test.Tasty.Ingredients.ConsoleReporter Methods defaultValue :: Quiet # parseValue :: String -> Maybe Quiet # optionName :: Tagged Quiet String # optionHelp :: Tagged Quiet String # showDefaultValue :: Quiet -> Maybe String # optionCLParser :: Parser Quiet #
IsOption UseColor # | Control color output
Instance details Defined in Test.Tasty.Ingredients.ConsoleReporter Methods defaultValue :: UseColor # parseValue :: String -> Maybe UseColor # optionName :: Tagged UseColor String # optionHelp :: Tagged UseColor String # showDefaultValue :: UseColor -> Maybe String # optionCLParser :: Parser UseColor #
IsOption ListTests # |
Instance details Defined in Test.Tasty.Ingredients.ListTests Methods defaultValue :: ListTests # parseValue :: String -> Maybe ListTests # optionName :: Tagged ListTests String # optionHelp :: Tagged ListTests String # showDefaultValue :: ListTests -> Maybe String # optionCLParser :: Parser ListTests #
IsOption NumThreads # |
Instance details Defined in Test.Tasty.Options.Core Methods defaultValue :: NumThreads # parseValue :: String -> Maybe NumThreads # optionName :: Tagged NumThreads String # optionHelp :: Tagged NumThreads String # showDefaultValue :: NumThreads -> Maybe String # optionCLParser :: Parser NumThreads #
IsOption Timeout # |
Instance details Defined in Test.Tasty.Options.Core Methods defaultValue :: Timeout # parseValue :: String -> Maybe Timeout # optionName :: Tagged Timeout String # optionHelp :: Tagged Timeout String # showDefaultValue :: Timeout -> Maybe String # optionCLParser :: Parser Timeout #
IsOption TestPattern # | Since tasty-1.5, this option can be specified multiple times on the command line. Only the tests matching all given patterns will be selected.
Instance details Defined in Test.Tasty.Patterns Methods defaultValue :: TestPattern # parseValue :: String -> Maybe TestPattern # optionName :: Tagged TestPattern String # optionHelp :: Tagged TestPattern String # showDefaultValue :: TestPattern -> Maybe String # optionCLParser :: Parser TestPattern #

# Option sets and operations

data OptionSet #

A set of options. Only one option of each type can be kept.

If some option has not been explicitly set, the default value is used.

Since: 0.1

#### Instances

Instances details

Monoid OptionSet # |
Instance details Defined in Test.Tasty.Options Methods mempty :: OptionSet # mappend :: OptionSet -> OptionSet -> OptionSet # mconcat :: [OptionSet] -> OptionSet #
Semigroup OptionSet # | Later options override earlier ones. Since: 0.12.0.1
Instance details Defined in Test.Tasty.Options Methods (<>) :: OptionSet -> OptionSet -> OptionSet # sconcat :: NonEmpty OptionSet -> OptionSet # stimes :: Integral b => b -> OptionSet -> OptionSet #

setOption :: IsOption v => v -> OptionSet -> OptionSet #

Set the option value.

Since: 0.1

changeOption :: IsOption v => (v -> v) -> OptionSet -> OptionSet #

Change the option value.

Since: 0.1

lookupOption :: IsOption v => OptionSet -> v #

Query the option value.

Since: 0.1

singleOption :: IsOption v => v -> OptionSet #

Create a singleton `OptionSet`.

Since: 0.8

data OptionDescription where #

The purpose of this data type is to capture the dictionary corresponding to a particular option.

Since: 0.1

Constructors

Option :: forall v. IsOption v => Proxy v -> OptionDescription |

uniqueOptionDescriptions :: [OptionDescription] -> [OptionDescription] #

Remove duplicated `OptionDescription`, preserving existing order otherwise.

Since: 1.4.1

# Utilities

flagCLParser #

Arguments

:: IsOption v |
=> Maybe Char | optional short flag
-> v | non-default value (when the flag is supplied)
-> Parser v |

Command-line parser to use with flags.

Since: 0.8

mkFlagCLParser #

Arguments

:: IsOption v |
=> Mod FlagFields v | option modifier
-> v | non-default value (when the flag is supplied)
-> Parser v |

Command-line flag parser that takes additional option modifiers.

Since: 0.11.1

mkOptionCLParser :: IsOption v => Mod OptionFields v -> Parser v #

Command-line option parser that takes additional option modifiers.

Since: 0.11.1

safeRead :: Read a => String -> Maybe a #

Safe read function. Defined here for convenience to use for `parseValue`.

Since: 0.1

safeReadBool :: String -> Maybe Bool #

Parse a `Bool` case-insensitively.

Since: 1.0.1