Moduletasty-discover-5.1.0Haskell2010

Test.Tasty.Discover.Internal.Config

The test driver configuration options module.

Anything that can be passed as an argument to the test driver definition exists as a field in the Config type.

4 types
7 values

Packagetasty-discover-5.1.0
Exports11
LanguageHaskell2010
LicenceMIT
SourceConfig.hs

Configuration Options

9 declarations

datadata Config

The discovery and runner configuration.

Constructors

Config
- modules :: Maybe GlobPattern
  Glob pattern for matching modules during test discovery.
- moduleSuffix :: Maybe String
  image: <DEPRECATED>: Module suffix.
- searchDir :: FilePath
  Directory where to look for tests.
- generatedModuleName :: Maybe String
  Name of the generated main module.
- ignores :: Maybe GlobPattern
  Glob pattern for ignoring modules during test discovery.
- ignoredModules :: [FilePath]
  image: <DEPRECATED>: Ignored modules by full name.
- tastyIngredients :: [Ingredient]
  Tasty ingredients to use.
- tastyOptions :: [String]
  Options passed to tasty
- inPlace :: Bool
  Whether the source file should be modified in-place.
- noModuleSuffix :: Bool
  image: <DEPRECATED>: suffix and look in all modules.
- debug :: Bool
  Debug the generated module.
- treeDisplay :: Bool
  Tree display for the test results table.
- noMain :: Bool
  Whether to generate main function.

Instances3Show, Generic, Rep

Show ConfigDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
Generic ConfigDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
type Rep Config = D1 ('MetaData "Config" "Test.Tasty.Discover.Internal.Config" "tasty-discover-5.1.0-1xhASehqxpBDcnwoTVDx7x" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) (((S1 ('MetaSel ('Just "modules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GlobPattern)) :*: (S1 ('MetaSel ('Just "moduleSuffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "searchDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))) :*: (S1 ('MetaSel ('Just "generatedModuleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "ignores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GlobPattern)) :*: S1 ('MetaSel ('Just "ignoredModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 ('MetaSel ('Just "tastyIngredients") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Ingredient]) :*: (S1 ('MetaSel ('Just "tastyOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Just "inPlace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "noModuleSuffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "debug") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "treeDisplay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "noMain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))Defined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config

typetype GlobPattern = String

A glob pattern.

newtypenewtype SkipTest

Newtype wrapper for skip test option.

This option type integrates with Tasty's option system to control whether tests should be skipped. When set to SkipTest True, tests will show as [SKIPPED] in yellow in the test output and won't actually execute.

Used internally by the skip function and Flavored type to implement test skipping functionality.

Constructors

SkipTest Bool

Instances5Eq, Show, Generic, IsOption, Rep

Eq SkipTestDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
Show SkipTestDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
Generic SkipTestDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
IsOption SkipTestDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config
type Rep SkipTest = D1 ('MetaData "SkipTest" "Test.Tasty.Discover.Internal.Config" "tasty-discover-5.1.0-1xhASehqxpBDcnwoTVDx7x" 'True) (C1 ('MetaCons "SkipTest" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))Defined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config

newtypenewtype OnPlatform

Newtype wrapper for platform-specific test filtering.

This option type allows tests to be conditionally executed based on platform criteria. The wrapped function takes a platform string and returns whether the test should run on that platform.

Platform values correspond to System.Info.os: - "linux" for Linux systems - "darwin" for macOS - "mingw32" for Windows (GHC compiled) - "unix" matches both "linux" and "darwin"

Example usage: @ -- Only run on Linux onLinux :: OnPlatform onLinux = OnPlatform (== "linux")

- Run on Unix-like systems onUnix :: OnPlatform onUnix = OnPlatform (p -> p elem ["linux", "darwin"]) @

Constructors

OnPlatform (String -> Bool)

Instances1IsOption

IsOption OnPlatformDefined in tasty-discover-5.1.0 · Test.Tasty.Discover.Internal.Config

valuecheckPlatform :: OnPlatform -> Bool

Check if the current platform matches the OnPlatform criteria

valueonLinux :: OnPlatform

Helper function: only run on Linux

valueonDarwin :: OnPlatform

Helper function: only run on macOS

valueonWindows :: OnPlatform

Helper function: only run on Windows (mingw32)

valueonUnix :: OnPlatform

Helper function: only run on Unix-like systems (Linux or macOS)

Configuration Parser

1 declaration

valueparseConfig :: FilePath -> String -> [String] -> Either String Config

Configuration options parser.

Configuration Defaults

1 declaration

valuedefaultConfig :: FilePath -> Config

The default configuration