Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.xb2f3bfd2026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · b2f3bfd · 2026-10-11

ModuleCabal-3.16.0.0Haskell2010

Distribution.TestSuite

This module defines the detailed test suite interface which makes it possible to expose individual tests to Cabal or other test agents.

7 types
1 value

PackageCabal-3.16.0.0
Exports8
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTestSuite.hs

datadata TestInstance

Constructors

TestInstance
- run :: IO Progress
  Perform the test.
- name :: String
  A name for the test, unique within a test suite.
- tags :: [String]
  Users can select groups of tests by their tags.
- options :: [OptionDescr]
  Descriptions of the options recognized by this test.
- setOption :: String -> String -> Either String TestInstance
  Try to set the named option to the given value. Returns an error message if the option is not supported or the value could not be correctly parsed; otherwise, a TestInstance with the option set to the given value is returned.

datadata OptionDescr

Constructors

OptionDescr
- optionName :: String
- optionDescription :: String
  A human-readable description of the option to guide the user setting it.
- optionType :: OptionType
- optionDefault :: Maybe String

Instances3Eq, Read, Show

Eq OptionDescrDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Read OptionDescrDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Show OptionDescrDefined in Cabal-3.16.0.0 · Distribution.TestSuite

datadata OptionType

Constructors

OptionFile
- optionFileMustExist :: Bool
- optionFileIsDir :: Bool
- optionFileExtensions :: [String]
OptionString
- optionStringMultiline :: Bool
OptionNumber
- optionNumberIsInt :: Bool
- optionNumberBounds :: (Maybe String, Maybe String)
OptionBool
OptionEnum [String]
OptionSet [String]
OptionRngSeed

Instances3Eq, Read, Show

Eq OptionTypeDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Read OptionTypeDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Show OptionTypeDefined in Cabal-3.16.0.0 · Distribution.TestSuite

datadata Test

Constructors

Test TestInstance
Group
- groupName :: String
- concurrently :: Bool
  If true, then children of this group may be run in parallel. Note that this setting is not inherited by children. In particular, consider a group F with "concurrently = False" that has some children, including a group T with "concurrently = True". The children of group T may be run concurrently with each other, as long as none are run at the same time as any of the direct children of group F.
- groupTests :: [Test]
ExtraOptions [OptionDescr] Test

typetype Options = [(String, String)]

datadata Progress

Constructors

Finished Result
Progress String (IO Progress)

datadata Result

Constructors

Instances3Eq, Read, Show

Eq ResultDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Read ResultDefined in Cabal-3.16.0.0 · Distribution.TestSuite
Show ResultDefined in Cabal-3.16.0.0 · Distribution.TestSuite

valuetestGroup :: String -> [Test] -> Test

Create a named group of tests, which are assumed to be safe to run in parallel.