Test.Hspec.Core

This module contains the core types, constructors, classes, instances, and utility functions common to hspec.

Types

data Spec

type Specs = [Spec]

class Example a where

A type class for examples.

To use an HUnit Test or an Assertion as an example you need to import Test.Hspec.HUnit.

To use a QuickCheck Property as an example you need to import Test.Hspec.QuickCheck.

Methods

evaluateExample :: a -> IO Result

Instances

Example Bool

Example Test

Example Assertion

Example Property

Example Pending

Example Result

Example (String -> Pending)

data Pending

Instances

Example Pending

Example (String -> Pending)

Defining a spec

describe :: String -> [Spec] -> Spec

it :: Example a => String -> a -> Spec

Create a set of specifications for a specific type being described. Once you know what you want specs for, use this.

 describe "abs" [
   it "returns a positive number given a negative number"
     (abs (-1) == 1)
   ]

pending :: String -> Pending

A pending example.

If you want to report on a behavior but don't have an example yet, use this.

 describe "fancyFormatter" [
   it "can format text in a way that everyone likes" $
     pending
 ]

You can give an optional reason for why it's pending.

 describe "fancyFormatter" [
   it "can format text in a way that everyone likes" $
     pending "waiting for clarification from the designers"
 ]

Running a spec

hspec :: Specs -> IO [EvaluatedSpec]

Create a document of the given specs and write it to stdout.

hspecB :: Specs -> IO Bool

Use in place of hspec to also give a Bool success indication

hspecX :: Specs -> IO a

Use in place of hspec to also exit the program with an ExitCode

hHspec :: Handle -> Specs -> IO [EvaluatedSpec]

Create a document of the given specs and write it to the given handle.

 writeReport filename specs = withFile filename WriteMode (\h -> hHspec h specs)

Internals

data SpecTree a

Internal representation of a spec.

This will be made abstract with the next release. If you still need access to any constructors, open an issue and describe your use case: https://github.com/hspec/hspec/issues

Constructors

SpecGroup String [SpecTree a]

SpecExample String a

type EvaluatedSpec = SpecTree Result

data Result

The result of running an example.

Constructors

Success

Pending (Maybe String)

Fail String

Instances

Eq Result

Show Result

Example Result

quantify :: (Show a, Num a, Eq a) => a -> String -> String

Create a more readable display of a quantity of something.

Deprecated types and functions

The following types and functions are deprecated and will be removed with the next release.

If you still need any of those, please open an issue and describe your use case: https://github.com/hspec/hspec/issues

descriptions :: Specs -> Specs

DEPRECATED: This is no longer needed (it's just an alias for id now).

type AnyExample = IO Result

safeEvaluateExample :: AnyExample -> IO Result

type UnevaluatedSpec = Spec

success :: [EvaluatedSpec] -> Bool

failure :: [EvaluatedSpec] -> Bool

isFailure :: Result -> Bool

failedCount :: [EvaluatedSpec] -> Int