Test.Hspec.Core.Runner

Running a spec

hspec :: Spec -> IO ()

Run a given spec and write a report to stdout. Exit with exitFailure if at least one spec item fails.

Note: hspec handles command-line options and reads config files. This is not always desired. Use runSpec if you need more control over these aspects.

runSpec :: Spec -> Config -> IO Summary

runSpec is the most basic primitive to run a spec. hspec is defined in terms of runSpec:

hspec spec =
      getArgs
  >>= readConfig defaultConfig
  >>= withArgs [] . runSpec spec
  >>= evaluateSummary

Config

data Config

Constructors

Config

Fields

• configIgnoreConfigFile :: Bool
• configDryRun :: Bool
• configFocusedOnly :: Bool
• configFailOnFocused :: Bool
• configPrintSlowItems :: Maybe Int
• configPrintCpuTime :: Bool
• configFailFast :: Bool
• configRandomize :: Bool
• configFailureReport :: Maybe FilePath
• configRerun :: Bool
• configRerunAllOnSuccess :: Bool
• configFilterPredicate :: Maybe (Path -> Bool)

  A predicate that is used to filter the spec before it is run. Only examples that satisfy the predicate are run.

• configSkipPredicate :: Maybe (Path -> Bool)
• configQuickCheckSeed :: Maybe Integer
• configQuickCheckMaxSuccess :: Maybe Int
• configQuickCheckMaxDiscardRatio :: Maybe Int
• configQuickCheckMaxSize :: Maybe Int
• configQuickCheckMaxShrinks :: Maybe Int
• configSmallCheckDepth :: Int
• configColorMode :: ColorMode
• configUnicodeMode :: UnicodeMode
• configDiff :: Bool
• configPrettyPrint :: Bool
• configTimes :: Bool
• configAvailableFormatters :: [(String, FormatConfig -> IO Format)]
• configFormat :: Maybe (FormatConfig -> IO Format)
• configFormatter :: Maybe Formatter

  deprecated, use configFormat instead

• configHtmlOutput :: Bool
• configConcurrentJobs :: Maybe Int

data ColorMode

Constructors

ColorAuto

ColorNever

ColorAlways

Instances

Eq ColorMode

Defined in Test.Hspec.Core.Config.Definition

Methods

(==) :: ColorMode -> ColorMode -> Bool

(/=) :: ColorMode -> ColorMode -> Bool

Show ColorMode

Defined in Test.Hspec.Core.Config.Definition

Methods

showsPrec :: Int -> ColorMode -> ShowS

show :: ColorMode -> String

showList :: [ColorMode] -> ShowS

data UnicodeMode

Constructors

UnicodeAuto

UnicodeNever

UnicodeAlways

Instances

Eq UnicodeMode

Defined in Test.Hspec.Core.Config.Definition

Methods

(==) :: UnicodeMode -> UnicodeMode -> Bool

(/=) :: UnicodeMode -> UnicodeMode -> Bool

Show UnicodeMode

Defined in Test.Hspec.Core.Config.Definition

Methods

showsPrec :: Int -> UnicodeMode -> ShowS

show :: UnicodeMode -> String

showList :: [UnicodeMode] -> ShowS

type Path = ([String], String)

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

defaultConfig :: Config

configAddFilter :: (Path -> Bool) -> Config -> Config

Add a filter predicate to config. If there is already a filter predicate, then combine them with ||.

readConfig :: Config -> [String] -> IO Config

readConfig parses config options from several sources and constructs a Config value. It takes options from:

1. ~/.hspec (a config file in the user's home directory)
2. .hspec (a config file in the current working directory)
3. the environment variable HSPEC_OPTIONS
4. the provided list of command-line options (the second argument to readConfig)

(precedence from low to high)

When parsing fails then readConfig writes an error message to stderr and exits with exitFailure.

When --help is provided as a command-line option then readConfig writes a help message to stdout and exits with exitSuccess.

A common way to use readConfig is:

getArgs >>= readConfig defaultConfig

Summary

data Summary

Summary of a test run.

Constructors

Summary

Fields

• summaryExamples :: Int
• summaryFailures :: Int

Instances

Eq Summary

Defined in Test.Hspec.Core.Runner

Methods

(==) :: Summary -> Summary -> Bool

(/=) :: Summary -> Summary -> Bool

Show Summary

Defined in Test.Hspec.Core.Runner

Methods

showsPrec :: Int -> Summary -> ShowS

show :: Summary -> String

showList :: [Summary] -> ShowS

Semigroup Summary

Defined in Test.Hspec.Core.Runner

Methods

(<>) :: Summary -> Summary -> Summary

sconcat :: NonEmpty Summary -> Summary

stimes :: Integral b => b -> Summary -> Summary

Monoid Summary

Defined in Test.Hspec.Core.Runner

Methods

mempty :: Summary

mappend :: Summary -> Summary -> Summary

mconcat :: [Summary] -> Summary

isSuccess :: Summary -> Bool

True if the given Summary indicates that there were no failures, False otherwise.

evaluateSummary :: Summary -> IO ()

Exit with exitFailure if the given Summary indicates that there was at least one failure.

Legacy

The following primitives are deprecated. Use runSpec instead.

hspecWith :: Config -> Spec -> IO ()

Run given spec with custom options. This is similar to hspec, but more flexible.

hspecResult :: Spec -> IO Summary

Run given spec and returns a summary of the test run.

Note: hspecResult does not exit with exitFailure on failing spec items. If you need this, you have to check the Summary yourself and act accordingly.

hspecWithResult :: Config -> Spec -> IO Summary

Run given spec with custom options and returns a summary of the test run.

Note: hspecWithResult does not exit with exitFailure on failing spec items. If you need this, you have to check the Summary yourself and act accordingly.