:: a typeCtrl KGHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05
Modulehspec-core-2.11.14Haskell2010
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 desirable. Use evalSpec and runSpecForest if you need more control over these aspects.
Run given spec with custom options. This is similar to hspec, but more flexible.
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.
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.
Summary of a test run.
Exit with exitFailure if the given Summary indicates that there was at least one failure.
To run a spec hspec performs a sequence of steps:
Read config values from the command-line, config files and the process environment
Execute each spec item of the forest and report results to stdout
Exit with exitFailure if at least on spec item fails
The four primitives evalSpec, readConfig, runSpecForest and evaluateResult each perform one of these steps respectively.
hspec is defined in terms of these primitives. Loosely speaking, a definition
for hspec is:
hspec = evalSpec defaultConfig >=> \ (config, spec) ->
getArgs
>>= readConfig config
>>= withArgs [] . runSpecForest spec
>>= evaluateResult
Loosely speaking in the sense that this definition of hspec ignores
--rerun-all-on-success.
Using these primitives individually gives you more control over how a spec is
run. However, if you need support for --rerun-all-on-success then you should
try hard to solve your use case with one of hspec, hspecWith, hspecResult
or hspecWithResult.
runSpecForest is the most basic primitive to run a spec. hspec is
defined in terms of runSpecForest:
hspec = evalSpec defaultConfig >=> \ (config, spec) ->
getArgs
>>= readConfig config
>>= withArgs [] . runSpecForest spec
>>= evaluateResult
Eq SpecResultDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultShow SpecResultDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultEq ResultItemDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultShow ResultItemDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultEq ResultItemStatusDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultShow ResultItemStatusDefined in hspec-core-2.11.14 · Test.Hspec.Core.Runner.ResultConfigconfigIgnoreConfigFile :: BoolconfigDryRun :: BoolconfigFocusedOnly :: BoolconfigFailOnEmpty :: BoolconfigFailOnFocused :: BoolconfigFailOnPending :: BoolconfigFailOnEmptyDescription :: BoolconfigPrintSlowItems :: Maybe IntconfigPrintCpuTime :: BoolconfigFailFast :: BoolconfigRandomize :: BoolconfigSeed :: Maybe IntegerconfigQuickCheckSeed :: Maybe IntegerconfigFailureReport :: Maybe FilePathconfigRerun :: BoolconfigRerunAllOnSuccess :: BoolconfigFilterPredicate :: Maybe (Path -> Bool)configSkipPredicate :: Maybe (Path -> Bool)configQuickCheckMaxSuccess :: Maybe IntconfigQuickCheckMaxDiscardRatio :: Maybe IntconfigQuickCheckMaxSize :: Maybe IntconfigQuickCheckMaxShrinks :: Maybe IntconfigSmallCheckDepth :: Maybe IntconfigColorMode :: ColorModeconfigUnicodeMode :: UnicodeModeconfigDiff :: BoolconfigDiffContext :: Maybe IntconfigExternalDiff :: Maybe (Maybe Int -> String -> String -> IO ())configPrettyPrint :: BoolconfigPrettyPrintFunction :: Bool -> String -> String -> (String, String)configFormatException :: SomeException -> StringconfigTimes :: BoolconfigExpertMode :: BoolconfigAvailableFormatters :: [(String, FormatConfig -> IO Format)]configFormat :: Maybe (FormatConfig -> IO Format)configFormatter :: Maybe FormatterconfigHtmlOutput :: BoolconfigConcurrentJobs :: Maybe IntconfigAnnotations :: AnnotationsEq UnicodeModeDefined in hspec-core-2.11.14 · Test.Hspec.Core.Config.DefinitionShow UnicodeModeDefined in hspec-core-2.11.14 · Test.Hspec.Core.Config.DefinitionA Path describes the location of a spec item within a spec tree.
It consists of a list of group descriptions and a requirement description.
Deprecated. Use registerFormatter instead.
Make a formatter available for use with --format.
Deprecated. Use useFormatter instead.
Make a formatter available for use with --format and use it by default.
Add a filter predicate to config. If there is already a filter predicate, then combine them with ||.
readConfig parses config options from several sources and constructs a Config value. It takes options from:
~/.hspec (a config file in the user's home directory)
.hspec (a config file in the current working directory)
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
Note: runSpec is deprecated. It ignores any modifications applied through modifyConfig. Use evalSpec and runSpecForest instead.
A SpecWith a represents a test or group of tests that require an a
value to run.
In the common case, a Spec is a SpecWith () which requires () and
can thus be executed with hspec.
To supply an argument to SpecWith tests to turn them into Spec, use functions from Test.Hspec.Core.Hooks such as around, before, mapSubject and similar.
Values of this type are created by it, describe and similar.