Test.Hspec.Core

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

Documentation

data Result

The result of running an example.

Constructors

Success

Pending String

Fail String

Instances

Eq Result

Example Result

type UnevaluatedSpec = Spec AnyExample

type EvaluatedSpec = Spec Result

data Spec a

Constructors

SpecGroup String [Spec a]

SpecExample String a

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

descriptions :: [Spec a] -> [Spec a]

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

safeEvaluateExample :: AnyExample -> IO Result

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

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)
   ]

class Example a where

Methods

evaluateExample :: a -> IO Result

Instances

Example Bool

Example Test

Example Property

Example AnyExample

Example Result

Example (IO ())

data AnyExample

An existentially quantified Example. This way they can be mixed within the same set of Specs

Constructors

forall a . Example a => AnyExample a

Instances

Example AnyExample

pending

Arguments

:: String

An explanation for why this behavior is pending.

-> Result

Declare an example as not successful or failing but pending some other work. 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 "waiting for clarification from the designers")
   ]

failedCount :: [EvaluatedSpec] -> Int

failure :: [EvaluatedSpec] -> Bool

success :: [EvaluatedSpec] -> Bool

isFailure :: Result -> Bool

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

Create a more readable display of a quantity of something.