Safe Haskell	Safe-Infered

Test.Hspec.Core

Contents

Deprecated types and functions

Description

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

Synopsis

Documentation

data SpecTree a Source

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

class Example a whereSource

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 Source

Instances

Example Bool
Example Test
Example Assertion
Example Property
Example Pending
Example Result
Example (String -> Pending)

data Result Source

The result of running an example.

Constructors

Success
Pending (Maybe String)
Fail String

Instances

Eq Result
Show Result
Example Result

descriptions :: Specs -> Specs Source

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

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

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

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

data Spec Source

type Specs = [Spec]Source

type UnevaluatedSpec = Spec Source

type EvaluatedSpec = SpecTree Result Source

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

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

type AnyExample = IO Result Source

safeEvaluateExample :: AnyExample -> IO Result Source

success :: [EvaluatedSpec] -> Bool Source

failure :: [EvaluatedSpec] -> Bool Source

isFailure :: Result -> Bool Source

failedCount :: [EvaluatedSpec] -> Int Source