Hedgehog.Classes

This library provides sets of properties that should hold for common typeclasses.

Note: on GHC < 8.5, this library uses the higher-kinded typeclasses (Show1, Eq1, Ord1, etc.), but on GHC >= 8.5, it uses `-XQuantifiedConstraints` to express these constraints more cleanly.

Running

lawsCheck

Arguments

:: Laws

The Laws you would like to check.

-> IO Bool

True if your tests pass, False otherwise.

A convenience function for testing the properties of a typeclass. For example, in GHCi:

>>> genOrdering :: Gen Ordering; genOrdering = frequency [(1,pure EQ),(1,pure LT),(1,pure GT)]
>>> lawsCheck (monoidLaws genOrdering)
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
True

lawsCheckOne

Arguments

:: Gen a

The generator for your type.

-> [Gen a -> Laws]

Functions that take a generator and output Laws.

-> IO Bool

True if your tests pass. False otherwise.

A convenience function for testing many typeclass instances of a single type.

>>> lawsCheckOne (word8 constantBounded) [jsonLaws, showReadLaws]
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
  ✓ <interactive> passed 100 tests.
True

lawsCheckMany

Arguments

:: [(String, [Laws])]

Pairs of type names and their associated laws to test.

-> IO Bool

True if your tests pass. False otherwise.

A convenience function for checking many typeclass instances of multiple types.

import Control.Applicative (liftA2)

import Data.Map (Map)
import Data.Set (Set)

import qualified Data.List as List
import qualified Data.Set as Set
import qualified Data.Map as Map

import qualified Hedgehog.Gen as Gen
import qualified Hedgehog.Range as Range

import Hedgehog (Gen)
import Hedgehog.Classes

-- Generate a small Set Int
genSet :: Gen (Set Int)
genSet = Set.fromList $ (Gen.list (Range.linear 2 10) (Gen.int Range.constantBounded))

-- Generate a small Map String Int
genMap :: Gen (Map String Int)
genMap = Map.fromList $ (liftA2 List.zip genStrings genInts)
  where
    rng = Range.linear 2 6
    genStrings = Gen.list rng (Gen.string rng Gen.lower)
    genInts = Gen.list rng (Gen.int Range.constantBounded)

commonLaws :: (Eq a, Monoid a, Show a) => Gen a -> [Laws]
commonLaws p = [eqLaws p, monoidLaws p]

tests :: [(String, [Laws])]
tests =
  [ ("Set Int", commonLaws genSet)
  , ("Map String Int", commonLaws genMap)
  ]

Now, in GHCi:

>>> lawsCheckMany tests

Testing properties for common typeclasses...

• ------------
• - Set Int --
• ------------

✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests.

• -------------------
• - Map String Int --
• -------------------

✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests. ✓ interactive passed 100 tests.

All tests succeeded True

Properties

Ground types

bitsLaws :: (FiniteBits a, Show a) => Gen a -> Laws

Tests the following Bits laws:

Conjunction Idempotence

n .&. n ≡ n

Disjunction Idempotence

n .|. n ≡ n

Double Complement

complement . complement ≡ id

Set Bit

setBit n i ≡ n .|. bit i

Clear Bit

clearBit n i ≡ n .&. complement (bit i)

Complement Bit

complement n i ≡ xor n (bit i)

Clear Zero

clearBit zeroBits i ≡ zeroBits

Set Zero

setBit zeroBits i ≡ zeroBits

Test Zero

testBit zeroBits i ≡ False

Pop Zero

popCount zeroBits ≡ 0

Count Leading Zeros of Zero

countLeadingZeros zeroBits ≡ finiteBitSize (undefined :: a)

Count Trailing Zeros of Zero

countTrailingZeros zeroBits ≡ finiteBitSize (undefined :: a)

eqLaws :: (Eq a, Show a) => Gen a -> Laws

Tests the following Eq laws:

Reflexivity

x == x ≡ True

Symmetry

x == y ≡ y == x

Transitivity

x == y && y == z ≡ x == z

Substitutivity

x == y ≡ f x == f y

Negation

x /= y ≡ not (x == y)

integralLaws :: (Integral a, Show a) => Gen a -> Laws

Tests the following Integral laws:

Quotient Remainder

quot x y * y + (rem x y) ≡ x

Division Modulus

(div x y) * y + (mod x y) ≡ x

Integer Roundtrip

fromInteger . toInteger ≡ id

monoidLaws :: (Eq a, Monoid a, Show a) => Gen a -> Laws

Tests the following Monoid laws:

Left Identity

mappend mempty ≡ id

Right Identity

flip mappend mempty ≡ id

Associativity

mappend a (mappend b c) ≡ mappend (mappend a b) c

Concatenation

mconcat ≡ foldr mappend mempty

commutativeMonoidLaws :: (Eq a, Monoid a, Show a) => Gen a -> Laws

Tests the following Monoid laws:

Commutativity

mappend a b ≡ mappend b a

ordLaws :: forall a. (Ord a, Show a) => Gen a -> Laws

Tests the following Ord laws:

Antisymmetry

@ ≡ @

Transitivity

@ ≡ @

Reflexivity

@ ≡ @

Totality

@ ≡ @

enumLaws :: (Enum a, Eq a, Show a) => Gen a -> Laws

Tests the following Enum laws:

Succ-Pred Identity

succ . pred ≡ id

Pred-Succ Identity

pred . succ ≡ id

boundedEnumLaws :: (Bounded a, Enum a, Eq a, Show a) => Gen a -> Laws

Tests the same laws as enumLaws, but uses the Bounded constraint to ensure that succ and pred behave as though they are total. This should always be preferred if your type has a Bounded instance.

semigroupLaws :: (Eq a, Semigroup a, Show a) => Gen a -> Laws

Tests the following Semigroup laws:

Associativity

@ ≡ @

Concatenation

@ ≡ @

Times

@ ≡ @

commutativeSemigroupLaws :: (Eq a, Semigroup a, Show a) => Gen a -> Laws

Tests the following Semigroup laws:

Commutativity

@ ≡ @

exponentialSemigroupLaws :: (Eq a, Semigroup a, Show a) => Gen a -> Laws

Tests the following Semigroup laws:

Exponential

@ ≡ @

idempotentSemigroupLaws :: (Eq a, Semigroup a, Show a) => Gen a -> Laws

Tests the following Semigroup laws:

Idempotent

@ ≡ @

rectangularBandSemigroupLaws :: (Eq a, Semigroup a, Show a) => Gen a -> Laws

Tests the following Semigroup laws:

Rectangular Band

@ ≡ @

showLaws :: Show a => Gen a -> Laws

Tests the following Show laws:

@ ≡ @

@ ≡ @

@ ≡ @

showReadLaws :: (Eq a, Read a, Show a) => Gen a -> Laws

Tests the following Show / Read laws:

@ ≡ @

@ ≡ @

@ ≡ @

storableLaws :: (Eq a, Show a, Storable a) => Gen a -> Laws

Tests the following Storable laws:

@ ≡ @

@ ≡ @

@ ≡ @

genericLaws :: (Generic a, Eq a, Show a, Eq (Rep a x), Show (Rep a x)) => Gen a -> Gen (Rep a x) -> Laws

Tests the following Generic laws:

From-To Inverse

from . to ≡ id

To-From Inverse

to . from ≡ id

jsonLaws :: (FromJSON a, ToJSON a, Eq a, Show a) => Gen a -> Laws

Tests the following ToJSON / FromJSON laws:

Encoding Partial Isomorphism

decode . encode ≡ Just

Encoding Equals Value

decode . encode ≡ Just . toJSON

Unary type constructors

alternativeLaws :: (Alternative f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Alternative laws:

Left Identity

empty <|> a ≡ a

Right Identity

a <|> empty ≡ a

Associativity

a <|> (b <|> c) ≡ (a <|> b) <|> c

applicativeLaws :: (Applicative f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Applicative laws:

Identity

pure id <*> v ≡ v

Composition

pure (.) <*> u <*> v <*> w ≡ u <*> (v <*> w)

Homomorphism

pure f <*> pure x ≡ pure (f x)

Interchange

u <*> pure y ≡ pure ($ y) <*> u

LiftA2 1

liftA2 id f x ≡ f <*> x

LiftA2 2

liftA2 f x y ≡ f <$> x <*> y

contravariantLaws :: (Contravariant f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Contravariant laws:

Identity

contramap id ≡ id

Composition

contramap f . contramap g ≡ contramap (g . f)

foldableLaws :: (Foldable f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Foldable laws:

Fold

fold ≡ foldMap id

FoldMap

foldMap f ≡ foldr (mappend . f) mempty

Foldr

foldr f z t ≡ appEndo (foldMap (Endo . f) t) z

Foldr'

foldr' f z0 t ≡ foldl f' id t z0, where f' k x z = k $! f x z

Foldl

foldl f z t ≡ appEndo (getDual (foldMap (Dual . Endo . flip f) t)) z

Foldl'

foldl' f z0 xs ≡ foldr f' id xs z0, where f' x k z = k $! f z x

Foldl1

foldl1 f t ≡ let (x:xs) = toList t in foldl f x xs

Foldr1

foldr1 f t ≡ let (xs,x) = unsnoc (toList t) in foldr f x xs

ToList

toList ≡ foldr (:) []

Null

null ≡ foldr (const (const False)) True

Length

length ≡ getSum . foldMap (const (Sum 1))

functorLaws :: (Functor f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Functor laws:

Identity

fmap id ≡ id

Composition

fmap f . fmap g ≡ fmap (f . g)

Const

fmap (const x) ≡ x <$

monadLaws :: (Monad f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Monad laws:

Left Identity

return a >>= k ≡ k a

Right Identity

m >>= return ≡ m

Associativity

m >>= (\x -> k x >>= h) ≡ (m >>= k) >>= h

Return

return ≡ pure

Ap

ap f x ≡ f <*> x

monadIOLaws :: (MonadIO f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following MonadIO laws:

Return

liftIO . return ≡ return

Lift

liftIO (m >>= f) ≡ liftIO m >>= (liftIO . f)

monadPlusLaws :: (MonadPlus f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following MonadPlus laws:

Left Identity

mplus mzero ≡ id

Right Identity

flip mplus mzero ≡ id

Associativity

mplus a (mplus b c) ≡ mplus (mplus a b) c

Left Zero

mzero >>= f ≡ mzero

Right Zero

v >> mzero ≡ mzero

monadZipLaws :: (MonadZip f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following MonadZip laws:

Naturality

fmap (f *** g) (mzip ma mb) ≡ mzip (fmap f ma) (fmap g mb)

traversableLaws :: (Traversable f, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => (forall x. Gen x -> Gen (f x)) -> Laws

Tests the following Traversable laws:

Naturality

t . traverse f ≡ traverse (t . f), for every applicative transformation t

Identity

traverse Identity ≡ Identity

Composition

traverse (Compose . fmap g . f) ≡ Compose . fmap (traverse g) . traverse f

SequenceA Naturality

t . sequenceA ≡ sequenceA . fmap t, for every applicative transformation t

SequenceA Identity

sequenceA . fmap Identity ≡ Identity

SequenceA Composition

sequenceA . fmap Compose ≡ Compose . fmap sequenceA . sequenceA

FoldMap

foldMap ≡ foldMapDefault

Fmap

fmap ≡ fmapDefault

Binary type constructors

arrowLaws :: forall f. (Arrow f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Arrow laws:

Arr Identity

arr id ≡ id

Arr Composition

arr (f >>> g) ≡ arr f >>> arr g

Arr-First inverse

first (arr f) ≡ arr (first f)

First Composition

first (f >>> g) ≡ first f >>> first g

Arrow Law 5

first f >>> arr fst ≡ arr fst >>> f

Arrow Law 6

first f >>> arr (id *** g) ≡ arr (id *** g) >>> first f

Arrow Law 7

first (first f) >>> arr assoc ≡ arr assoc >>> first f, where assoc ((a,b),c) = (a,(b,c))

bifoldableLaws :: forall f. (Bifoldable f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Bifoldable laws:

Identity

bifold ≡ bifoldMap id id

FoldMap

bifoldMap f g ≡ bifoldr (mappend . f) (mappend . g) mempty

Foldr

bifoldr f g z t ≡ appEndo (bifoldMap (Endo . f) (Endo . g) t) z

bifoldableFunctorLaws :: forall f. (Bifoldable f, Bifunctor f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Bifoldable / Bifunctor laws:

Composition

bifoldMap f g ≡ bifold . bimap f g

FoldMap

bifoldMap f g . bimap h i ≡ bifoldMap (f . h) (g . i)

bifunctorLaws :: forall f. (Bifunctor f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Bifunctor laws:

Identity

bimap id id ≡ id

First Identity

first id ≡ id

Second Identity

second id ≡ id

Composition

bimap id id ≡ first id . second id

bitraversableLaws :: forall f. (Bitraversable f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Bitraversable laws:

Naturality

bitraverse (t . f) (t . g) ≡ t . bitraverse f g, for every applicative transformation t

Identity

bitraverse Identity Identity ≡ Identity

Composition

Compose . fmap (bitraverse g1 g2) . bitraverse f1 f2 ≡ bitraverse (Compose . fmap g1 . f1) (Compose . fmap g2 . f2)

categoryLaws :: forall f. (Category f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Category laws:

Left Identity

id . f ≡ f

Right Identity

f . id ≡ f

Associativity

f . (g . h) ≡ (f . g) . h

commutativeCategoryLaws :: forall f. (Category f, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => (forall x y. Gen x -> Gen y -> Gen (f x y)) -> Laws

Tests the following Category laws:

Commutativity

f . g ≡ g . f

Defining your own laws

data Laws

A Laws is the name of the typeclass and the set of named properties associated with that typeclass.

Constructors

Laws

Fields

• lawsTypeClass :: String
• lawsProperties :: [(String, Property)]

data LawContext

The context surrounding the property test of a law. Use contextualise to turn this into a Context.

Constructors

LawContext

Fields

• lawContextLawName :: String

  law name

• lawContextLawBody :: String

  law body

• lawContextTcName :: String

  typeclass name

• lawContextTcProp :: String

  how to show the specific property test

• lawContextReduced :: String

  reduced equation, eg "LHS = RHS" where neither LHS nor RHS are reducible

data Context

You can provide a Context to heqCtx,heqCtx1,heqCtx2,hneqCtx,hneqCtx1,or hneqCtx2. The Context is used to provide useful error messages in the event of a failure.

Constructors

NoContext

Context String

contextualise :: LawContext -> Context

Turn a LawContext into a Context.

Hedgehog equality tests sans source information

hLessThan :: (MonadTest m, Ord a, Show a, HasCallStack) => a -> a -> m ()

Fails the test if the right argument is less than or equal to the left. see https://github.com/hedgehogqa/haskell-hedgehog/pull/196

hGreaterThan :: (MonadTest m, Ord a, Show a, HasCallStack) => a -> a -> m ()

Fails the test if the right argument is greater than or equal to the left. see https://github.com/hedgehogqa/haskell-hedgehog/pull/196

heq :: (MonadTest m, HasCallStack, Eq a, Show a) => a -> a -> m () infix 4

Passes the test if the given arguments are equal. Otherwise fails with NoContext.

heq1 :: (MonadTest m, HasCallStack, Eq a, Show a, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => f a -> f a -> m () infix 4

Passes the test if the given arguments are equal. Otherwise fails with NoContext.

heq2 :: (MonadTest m, HasCallStack, Eq a, Eq b, Show a, Show b, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => f a b -> f a b -> m () infix 4

Passes the test if the given arguments are equal. Otherwise fails with NoContext.

heqCtx :: (MonadTest m, HasCallStack, Eq a, Show a) => a -> a -> Context -> m ()

Passes the test if the given arguments are equal. Otherwise fails with the given Context.

heqCtx1 :: (MonadTest m, HasCallStack, Eq a, Show a, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => f a -> f a -> Context -> m ()

Passes the test if the given arguments are equal. Otherwise fails with the given Context.

heqCtx2 :: (MonadTest m, HasCallStack, Eq a, Eq b, Show a, Show b, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => f a b -> f a b -> Context -> m ()

Passes the test if the given arguments are equal. Otherwise fails with the given Context.

hneq :: (MonadTest m, HasCallStack, Eq a, Show a) => a -> a -> m () infix 4

Passes the test if the given arguments are not equal. Otherwise fails with NoContext.

hneq1 :: (MonadTest m, HasCallStack, Eq a, Show a, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => f a -> f a -> m ()

Passes the test if the given arguments are not equal. Otherwise fails with NoContext.

hneq2 :: (MonadTest m, HasCallStack, Eq a, Eq b, Show a, Show b, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => f a b -> f a b -> m () infix 4

Passes the test if the given arguments are not equal. Otherwise fails with NoContext.

hneqCtx :: (MonadTest m, HasCallStack, Eq a, Show a) => a -> a -> Context -> m ()

Passes the test if the given arguments are not equal. Otherwise fails with the given Context.

hneqCtx1 :: (MonadTest m, HasCallStack, Eq a, Show a, forall x. Eq x => Eq (f x), forall x. Show x => Show (f x)) => f a -> f a -> Context -> m ()

Passes the test if the given arguments are not equal. Otherwise fails with the given Context.

hneqCtx2 :: (MonadTest m, HasCallStack, Eq a, Eq b, Show a, Show b, forall x y. (Eq x, Eq y) => Eq (f x y), forall x y. (Show x, Show y) => Show (f x y)) => f a b -> f a b -> Context -> m ()

Passes the test if the given arguments are not equal. Otherwise fails with the given Context.