hspec-core-2.7.6: A Testing Framework for Haskell
Stabilityprovisional
Safe HaskellNone
LanguageHaskell2010

Test.Hspec.Core.Runner

Description

 
Synopsis

Running a spec

hspec :: Spec -> IO () Source #

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 Source #

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 ColorMode Source #

Instances

Instances details
Eq ColorMode Source # 
Instance details

Defined in Test.Hspec.Core.Config.Options

Show ColorMode Source # 
Instance details

Defined in Test.Hspec.Core.Config.Options

type Path = ([String], String) Source #

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.

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

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

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

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 Source #

Summary of a test run.

Constructors

Summary 

Instances

Instances details
Eq Summary Source # 
Instance details

Defined in Test.Hspec.Core.Runner

Methods

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

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

Show Summary Source # 
Instance details

Defined in Test.Hspec.Core.Runner

Semigroup Summary Source # 
Instance details

Defined in Test.Hspec.Core.Runner

Monoid Summary Source # 
Instance details

Defined in Test.Hspec.Core.Runner

isSuccess :: Summary -> Bool Source #

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

evaluateSummary :: Summary -> IO () Source #

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 () Source #

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

hspecResult :: Spec -> IO Summary Source #

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 Source #

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.