Test.Hspec.Tables

Table-driven (by-example) HSpec tests.

Example usage:

describe "multiplication table" $
 byExample
   ("x", "y", "result")
   [ (0, 0, 0),
     (0, 1, 0),
     (0, 2, 0),
     (1, 0, 0),
     (1, 1, 1),
     (1, 2, 2),
     (2, 0, 0),
     (2, 1, 2),
     (2, 2, 4)
   ]
   (\a b expected -> a * b == expected)

describe "reverse" $
 byExample
   ("list", "reversed")
   [("abc", "cba"), ("", ""), ("0123456", "6543210")]
   (shouldBe . reverse)

Documentation

class Table r where

A type class for tables.

A table type binds together the row type r with the type of its header and the "generic" curried function forall p. r -> p

Minimal complete definition

apply

Associated Types

type Header r

type Forall r p

Methods

apply :: Forall r p -> r -> p

showHeader :: Header r -> String

default showHeader :: Show (Header r) => Header r -> String

Instances

Table (a, b)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b)

type Forall (a, b) p

Methods

apply :: Forall (a, b) p -> (a, b) -> p

showHeader :: Header (a, b) -> String

Table (a, b, c)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b, c)

type Forall (a, b, c) p

Methods

apply :: Forall (a, b, c) p -> (a, b, c) -> p

showHeader :: Header (a, b, c) -> String

Table (a, b, c, d)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b, c, d)

type Forall (a, b, c, d) p

Methods

apply :: Forall (a, b, c, d) p -> (a, b, c, d) -> p

showHeader :: Header (a, b, c, d) -> String

Table (a, b, c, d, e)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b, c, d, e)

type Forall (a, b, c, d, e) p

Methods

apply :: Forall (a, b, c, d, e) p -> (a, b, c, d, e) -> p

showHeader :: Header (a, b, c, d, e) -> String

Table (a, b, c, d, e, f)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b, c, d, e, f)

type Forall (a, b, c, d, e, f) p

Methods

apply :: Forall (a, b, c, d, e, f) p -> (a, b, c, d, e, f) -> p

showHeader :: Header (a, b, c, d, e, f) -> String

Table (a, b, c, d, e, f, g)

Defined in Test.Hspec.Tables

Associated Types

type Header (a, b, c, d, e, f, g)

type Forall (a, b, c, d, e, f, g) p

Methods

apply :: Forall (a, b, c, d, e, f, g) p -> (a, b, c, d, e, f, g) -> p

showHeader :: Header (a, b, c, d, e, f, g) -> String

byExample

Arguments

:: forall a r. (Table r, Example a, Show r)

=> Header r

header - tuple of strings (max 7 for now); used to describe this spec, its arity == number of columns

-> [r]

rows - list of tuples of examples; arity of each tuple must match the number of columns (== arity of the header)

-> Forall r a

assertion - curried function from a row to an a - if row type is (b,c,d) then it must be (Example a) => b -> c -> d -> a

-> SpecWith (Arg a)

Creates a Spec from the table consisting of:

• header
• list of examples (rows)
• assertion

The resulting spec consists of one test per each row. For example:

byExample
  ("list", "reversed")
  [("abc", "cba"), ("", ""), ("0123456", "6543210")]
 (shouldBe . reverse)

is equivalent to:

describe (show ("list", "reversed")) $ do
  specify (show ("abc", "cba")) $ reverse "abc" `shouldBe` "cba"
  specify (show ("", "")) $ reverse "" `shouldBe` ""
  specify (show ("0123456", "6543210")) $ reverse "0123456" `shouldBe` "6543210"

testTable :: forall a r. (Table r, Example a, Show r) => Header r -> [r] -> Forall r a -> SpecWith (Arg a)

Alias for byExample