tasty-hedgehog-1.4.0.2: Integration for tasty and hedgehog.
Safe HaskellNone
LanguageHaskell2010

Test.Tasty.Hedgehog

Description

This package lets you test Hedgehog properties with tasty.

Typical usage would look like this:

testGroup "tasty-hedgehog tests" [
   testPropertyNamed "reverse involutive" "prop_reverse_involutive" prop_reverse_involutive
 , testPropertyNamed "sort idempotent"    "prop_sort_idempotent"    prop_sort_idempotent
 ]
Synopsis

Documentation

testProperty :: TestName -> Property -> TestTree Source #

Create a TestTree from a Hedgehog Property.

testPropertyNamed :: TestName -> PropertyName -> Property -> TestTree Source #

testPropertyNamed testName propertyName property creates a TestTree from property using testName as the displayed description for the property. The propertyName is used by Hedgehog when a failure occurs to provide instructions for how to re-run the property and should normally be set to a string representation of the property argument.

testPropertyNamed
 "reverse is involutive"
 "prop_reverse_involutive"
 prop_reverse_involutive

Since: 1.2.0.0

fromGroup :: Group -> TestTree Source #

Create a TestTree from a Hedgehog Group.

Options you can pass in via tasty

newtype HedgehogReplay Source #

The replay token to use for replaying a previous test run

Constructors

HedgehogReplay (Maybe (Skip, Seed)) 

Instances

Instances details
IsOption HedgehogReplay Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogReplay Source #

parseValue :: String -> Maybe HedgehogReplay Source #

optionName :: Tagged HedgehogReplay String Source #

optionHelp :: Tagged HedgehogReplay String Source #

showDefaultValue :: HedgehogReplay -> Maybe String Source #

optionCLParser :: Parser HedgehogReplay Source #

newtype HedgehogShowReplay Source #

If a test case fails, show a replay token for replaying tests

Constructors

HedgehogShowReplay Bool 

Instances

Instances details
IsOption HedgehogShowReplay Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogShowReplay Source #

parseValue :: String -> Maybe HedgehogShowReplay Source #

optionName :: Tagged HedgehogShowReplay String Source #

optionHelp :: Tagged HedgehogShowReplay String Source #

showDefaultValue :: HedgehogShowReplay -> Maybe String Source #

optionCLParser :: Parser HedgehogShowReplay Source #

newtype HedgehogTestLimit Source #

The number of successful test cases required before Hedgehog will pass a test

Constructors

HedgehogTestLimit (Maybe TestLimit) 

Instances

Instances details
Eq HedgehogTestLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

(==) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

(/=) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

Ord HedgehogTestLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

compare :: HedgehogTestLimit -> HedgehogTestLimit -> Ordering #

(<) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

(<=) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

(>) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

(>=) :: HedgehogTestLimit -> HedgehogTestLimit -> Bool #

max :: HedgehogTestLimit -> HedgehogTestLimit -> HedgehogTestLimit #

min :: HedgehogTestLimit -> HedgehogTestLimit -> HedgehogTestLimit #

Show HedgehogTestLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

showsPrec :: Int -> HedgehogTestLimit -> ShowS #

show :: HedgehogTestLimit -> String #

showList :: [HedgehogTestLimit] -> ShowS #

IsOption HedgehogTestLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogTestLimit Source #

parseValue :: String -> Maybe HedgehogTestLimit Source #

optionName :: Tagged HedgehogTestLimit String Source #

optionHelp :: Tagged HedgehogTestLimit String Source #

showDefaultValue :: HedgehogTestLimit -> Maybe String Source #

optionCLParser :: Parser HedgehogTestLimit Source #

newtype HedgehogDiscardLimit Source #

The number of discarded cases allowed before Hedgehog will fail a test

Constructors

HedgehogDiscardLimit (Maybe DiscardLimit) 

Instances

Instances details
Eq HedgehogDiscardLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

(==) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

(/=) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

Ord HedgehogDiscardLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

compare :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Ordering #

(<) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

(<=) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

(>) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

(>=) :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> Bool #

max :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> HedgehogDiscardLimit #

min :: HedgehogDiscardLimit -> HedgehogDiscardLimit -> HedgehogDiscardLimit #

Show HedgehogDiscardLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

showsPrec :: Int -> HedgehogDiscardLimit -> ShowS #

show :: HedgehogDiscardLimit -> String #

showList :: [HedgehogDiscardLimit] -> ShowS #

IsOption HedgehogDiscardLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogDiscardLimit Source #

parseValue :: String -> Maybe HedgehogDiscardLimit Source #

optionName :: Tagged HedgehogDiscardLimit String Source #

optionHelp :: Tagged HedgehogDiscardLimit String Source #

showDefaultValue :: HedgehogDiscardLimit -> Maybe String Source #

optionCLParser :: Parser HedgehogDiscardLimit Source #

newtype HedgehogShrinkLimit Source #

The number of shrinks allowed before Hedgehog will fail a test

Constructors

HedgehogShrinkLimit (Maybe ShrinkLimit) 

Instances

Instances details
Eq HedgehogShrinkLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

(==) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

(/=) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

Ord HedgehogShrinkLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

compare :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Ordering #

(<) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

(<=) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

(>) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

(>=) :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> Bool #

max :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> HedgehogShrinkLimit #

min :: HedgehogShrinkLimit -> HedgehogShrinkLimit -> HedgehogShrinkLimit #

Show HedgehogShrinkLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

showsPrec :: Int -> HedgehogShrinkLimit -> ShowS #

show :: HedgehogShrinkLimit -> String #

showList :: [HedgehogShrinkLimit] -> ShowS #

IsOption HedgehogShrinkLimit Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogShrinkLimit Source #

parseValue :: String -> Maybe HedgehogShrinkLimit Source #

optionName :: Tagged HedgehogShrinkLimit String Source #

optionHelp :: Tagged HedgehogShrinkLimit String Source #

showDefaultValue :: HedgehogShrinkLimit -> Maybe String Source #

optionCLParser :: Parser HedgehogShrinkLimit Source #

newtype HedgehogShrinkRetries Source #

The number of times to re-run a test during shrinking

Constructors

HedgehogShrinkRetries (Maybe ShrinkRetries) 

Instances

Instances details
Eq HedgehogShrinkRetries Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

(==) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

(/=) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

Ord HedgehogShrinkRetries Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

compare :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Ordering #

(<) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

(<=) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

(>) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

(>=) :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> Bool #

max :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> HedgehogShrinkRetries #

min :: HedgehogShrinkRetries -> HedgehogShrinkRetries -> HedgehogShrinkRetries #

Show HedgehogShrinkRetries Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

showsPrec :: Int -> HedgehogShrinkRetries -> ShowS #

show :: HedgehogShrinkRetries -> String #

showList :: [HedgehogShrinkRetries] -> ShowS #

IsOption HedgehogShrinkRetries Source # 
Instance details

Defined in Test.Tasty.Hedgehog

Methods

defaultValue :: HedgehogShrinkRetries Source #

parseValue :: String -> Maybe HedgehogShrinkRetries Source #

optionName :: Tagged HedgehogShrinkRetries String Source #

optionHelp :: Tagged HedgehogShrinkRetries String Source #

showDefaultValue :: HedgehogShrinkRetries -> Maybe String Source #

optionCLParser :: Parser HedgehogShrinkRetries Source #