Stability	experimental
Safe Haskell	None

Test.Hspec.Core

Contents

A type class for examples
A writer monad for constructing specs
Internal representation of a spec tree

Description

This module provides access to Hspec's internals. It is less stable than other parts of the API. For most users Test.Hspec is more suitable!

Synopsis

A type class for examples

class Example a whereSource

A type class for examples.

Methods

evaluateExample :: a -> Params -> (IO () -> IO ()) -> ProgressCallback -> IO Result Source

Instances

Example Bool
Example Property
Example Expectation
Example Result

data Params Source

Constructors

Params
Fields paramsQuickCheckArgs :: Args paramsSmallCheckDepth :: Int

Instances

Show Params

type Progress = (Int, Int)Source

type ProgressCallback = Progress -> IO ()Source

data Result Source

The result of running an example.

Constructors

Success
Pending (Maybe String)
Fail String

Instances

Eq Result
Read Result
Show Result
Typeable Result
Exception Result
Example Result

A writer monad for constructing specs

data SpecM a Source

A writer monad for SpecTree forests.

Instances

Monad SpecM
Functor SpecM
Applicative SpecM

runSpecM :: Spec -> [SpecTree]Source

Convert a Spec to a forest of SpecTrees.

fromSpecList :: [SpecTree] -> Spec Source

Create a Spec from a forest of SpecTrees.

Internal representation of a spec tree

data SpecTree Source

Internal representation of a spec.

Constructors

SpecGroup String [SpecTree]
SpecItem String Item

data Item Source

Constructors

Item
Fields itemIsParallelizable :: Bool itemExample :: Params -> (IO () -> IO ()) -> ProgressCallback -> IO Result

mapSpecItem :: (Item -> Item) -> Spec -> Spec Source

modifyParams :: (Params -> Params) -> Spec -> Spec Source

describe :: String -> [SpecTree] -> SpecTree Source

The describe function combines a list of specs into a larger spec.

it :: Example a => String -> a -> SpecTree Source

Create a spec item.