Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Tasty.Discover.Internal.Config

Contents

Configuration Options
Configuration Parser
Configuration Defaults

Description

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.

Synopsis

data Config = Config {
- modules :: Maybe GlobPattern
- moduleSuffix :: Maybe String
- searchDir :: FilePath
- generatedModuleName :: Maybe String
- ignores :: Maybe GlobPattern
- ignoredModules :: [FilePath]
- tastyIngredients :: [Ingredient]
- tastyOptions :: [String]
- inPlace :: Bool
- noModuleSuffix :: Bool
- debug :: Bool
- treeDisplay :: Bool
- noMain :: Bool
}
type GlobPattern = String
newtype SkipTest = SkipTest Bool
newtype OnPlatform = OnPlatform (String -> Bool)
checkPlatform :: OnPlatform -> Bool
onLinux :: OnPlatform
onDarwin :: OnPlatform
onWindows :: OnPlatform
onUnix :: OnPlatform
parseConfig :: FilePath -> String -> [String] -> Either String Config
defaultConfig :: FilePath -> Config

Configuration Options

data Config Source #

The discovery and runner configuration.

Constructors

Config

Fields

modules :: Maybe GlobPattern
Glob pattern for matching modules during test discovery.
moduleSuffix :: Maybe String
>: 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]
>: 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
>: 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.

Instances

Instances details

Generic Config Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Associated Types

type Rep Config
Instance details Defined in Test.Tasty.Discover.Internal.Config type Rep Config

Methods

from :: Config -> Rep Config x #

to :: Rep Config x -> Config #

Show Config Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Methods

showsPrec :: Int -> Config -> ShowS #

show :: Config -> String #

showList :: [Config] -> ShowS #

type Rep Config Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

type Rep Config

type GlobPattern = String Source #

A glob pattern.

newtype SkipTest Source #

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

Instances

Instances details

Generic SkipTest Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Associated Types

type Rep SkipTest
Instance details Defined in Test.Tasty.Discover.Internal.Config type Rep SkipTest = D1 ('MetaData "SkipTest" "Test.Tasty.Discover.Internal.Config" "tasty-discover-5.2.0-6BjWLNiFeo66Uowhh0b9lW" 'True) (C1 ('MetaCons "SkipTest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Methods

from :: SkipTest -> Rep SkipTest x #

to :: Rep SkipTest x -> SkipTest #

Show SkipTest Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Methods

showsPrec :: Int -> SkipTest -> ShowS #

show :: SkipTest -> String #

showList :: [SkipTest] -> ShowS #

Eq SkipTest Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Methods

(==) :: SkipTest -> SkipTest -> Bool #

(/=) :: SkipTest -> SkipTest -> Bool #

IsOption SkipTest Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

Methods

defaultValue :: SkipTest #

parseValue :: String -> Maybe SkipTest #

optionName :: Tagged SkipTest String #

optionHelp :: Tagged SkipTest String #

showDefaultValue :: SkipTest -> Maybe String #

optionCLParser :: Parser SkipTest #

type Rep SkipTest Source #

Instance details

Defined in Test.Tasty.Discover.Internal.Config

type Rep SkipTest = D1 ('MetaData "SkipTest" "Test.Tasty.Discover.Internal.Config" "tasty-discover-5.2.0-6BjWLNiFeo66Uowhh0b9lW" 'True) (C1 ('MetaCons "SkipTest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

newtype OnPlatform Source #

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)

Instances

Instances details

IsOption OnPlatform Source #
Instance details Defined in Test.Tasty.Discover.Internal.Config Methods defaultValue :: OnPlatform # parseValue :: String -> Maybe OnPlatform # optionName :: Tagged OnPlatform String # optionHelp :: Tagged OnPlatform String # showDefaultValue :: OnPlatform -> Maybe String # optionCLParser :: Parser OnPlatform #

checkPlatform :: OnPlatform -> Bool Source #

Check if the current platform matches the OnPlatform criteria

onLinux :: OnPlatform Source #

Helper function: only run on Linux

onDarwin :: OnPlatform Source #

Helper function: only run on macOS

onWindows :: OnPlatform Source #

Helper function: only run on Windows (mingw32)

onUnix :: OnPlatform Source #

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

Configuration Parser

parseConfig :: FilePath -> String -> [String] -> Either String Config Source #

Configuration options parser.

Configuration Defaults

defaultConfig :: FilePath -> Config Source #

The default configuration