QuickCheck-2.1.0.3: Automatic testing of Haskell programsSource codeContentsIndex
Test.QuickCheck.Property
Contents
Property and Testable types
Type Prop
type Rose
Result type
Lifting and mapping functions
Property combinators
Synopsis
type Property = Gen Prop
class Testable prop where
property :: prop -> Property
newtype Prop = MkProp {
unProp :: Rose (IO Result)
}
data Rose a = MkRose a [Rose a]
join :: Rose (Rose a) -> Rose a
protectRose :: Rose (IO Result) -> IO (Rose (IO Result))
data Callback
= PostTest (State -> Result -> IO ())
| PostFinalFailure (State -> Result -> IO ())
data Result = MkResult {
ok :: Maybe Bool
expect :: Bool
reason :: String
interrupted :: Bool
stamp :: [(String, Int)]
callbacks :: [Callback]
}
result :: Result
failed :: Result -> Result
protectResult :: IO Result -> IO Result
succeeded :: Result
rejected :: Result
liftBool :: Bool -> Property
liftResult :: Result -> Property
liftIOResult :: IO Result -> Property
liftRoseIOResult :: Rose (IO Result) -> Property
mapResult :: Testable prop => (Result -> Result) -> prop -> Property
mapIOResult :: Testable prop => (IO Result -> IO Result) -> prop -> Property
mapRoseIOResult :: Testable prop => (Rose (IO Result) -> Rose (IO Result)) -> prop -> Property
mapProp :: Testable prop => (Prop -> Prop) -> prop -> Property
mapSize :: Testable prop => (Int -> Int) -> prop -> Property
shrinking :: Testable prop => (a -> [a]) -> a -> (a -> prop) -> Property
noShrinking :: Testable prop => prop -> Property
callback :: Testable prop => Callback -> prop -> Property
whenFail :: Testable prop => IO () -> prop -> Property
whenFail' :: Testable prop => IO () -> prop -> Property
expectFailure :: Testable prop => prop -> Property
label :: Testable prop => String -> prop -> Property
collect :: (Show a, Testable prop) => a -> prop -> Property
classify :: Testable prop => Bool -> String -> prop -> Property
cover :: Testable prop => Bool -> Int -> String -> prop -> Property
(==>) :: Testable prop => Bool -> prop -> Property
within :: Testable prop => Int -> prop -> Property
forAll :: (Show a, Testable prop) => Gen a -> (a -> prop) -> Property
forAllShrink :: (Show a, Testable prop) => Gen a -> (a -> [a]) -> (a -> prop) -> Property
(.&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
Property and Testable types
type Property = Gen PropSource
class Testable prop whereSource
The class of things which can be tested, i.e. turned into a property.
Methods
property :: prop -> PropertySource
Type Prop
newtype Prop Source
Constructors
MkProp
unProp :: Rose (IO Result)
type Rose
data Rose a Source
Constructors
MkRose a [Rose a]
join :: Rose (Rose a) -> Rose aSource
protectRose :: Rose (IO Result) -> IO (Rose (IO Result))Source
Result type
data Callback Source
Different kinds of callbacks
Constructors
PostTest (State -> Result -> IO ())Called just after a test
PostFinalFailure (State -> Result -> IO ())Called with the final failing test-case
data Result Source
The result of a single test.
Constructors
MkResult
ok :: Maybe Boolresult of the test case; Nothing = discard
expect :: Boolindicates what the expected result of the property is
reason :: Stringa message indicating what went wrong
interrupted :: Boolindicates if the test case was cancelled by pressing ^C
stamp :: [(String, Int)]the collected values for this test case
callbacks :: [Callback]the callbacks for this test case
result :: ResultSource
failed :: Result -> ResultSource
protectResult :: IO Result -> IO ResultSource
succeeded :: ResultSource
rejected :: ResultSource
Lifting and mapping functions
liftBool :: Bool -> PropertySource
liftResult :: Result -> PropertySource
liftIOResult :: IO Result -> PropertySource
liftRoseIOResult :: Rose (IO Result) -> PropertySource
mapResult :: Testable prop => (Result -> Result) -> prop -> PropertySource
mapIOResult :: Testable prop => (IO Result -> IO Result) -> prop -> PropertySource
mapRoseIOResult :: Testable prop => (Rose (IO Result) -> Rose (IO Result)) -> prop -> PropertySource
mapProp :: Testable prop => (Prop -> Prop) -> prop -> PropertySource
Property combinators
mapSize :: Testable prop => (Int -> Int) -> prop -> PropertySource
Changes the maximum test case size for a property.
shrinkingSource
:: Testable prop
=> a -> [a]The original argument
-> a
-> a -> prop
-> Property
Shrinks the argument to property if it fails. Shrinking is done automatically for most types. This is only needed weh you want to override the default behavior.
noShrinking :: Testable prop => prop -> PropertySource
Disables shrinking for a property altogether.
callback :: Testable prop => Callback -> prop -> PropertySource
Adds a callback
whenFail :: Testable prop => IO () -> prop -> PropertySource
Performs an IO action after the last failure of a property.
whenFail' :: Testable prop => IO () -> prop -> PropertySource
Performs an IO action every time a property fails. Thus, if shrinking is done, this can be used to keep track of the failures along the way.
expectFailure :: Testable prop => prop -> PropertySource
Modifies a property so that it is expected to fail for some test cases.
label :: Testable prop => String -> prop -> PropertySource
Attaches a label to a property. This is used for reporting test case distribution.
collect :: (Show a, Testable prop) => a -> prop -> PropertySource

Labels a property with a value: 

 collect x = label (show x)
classifySource
:: Testable prop
=> BoolLabel.
-> String
-> prop
-> Property
Conditionally labels test case.
coverSource
:: Testable prop
=> BoolThe required percentage (0-100) of test cases.
-> IntLabel for the test case class.
-> String
-> prop
-> Property
Checks that at least the given proportion of the test cases belong to the given class.
(==>) :: Testable prop => Bool -> prop -> PropertySource
Implication for properties: The resulting property holds if the first argument is False, or if the given property holds.
within :: Testable prop => Int -> prop -> PropertySource
Considers a property failed if it does not complete within the given number of microseconds.
forAll :: (Show a, Testable prop) => Gen a -> (a -> prop) -> PropertySource
Explicit universal quantification: uses an explicitly given test case generator.
forAllShrink :: (Show a, Testable prop) => Gen a -> (a -> [a]) -> (a -> prop) -> PropertySource
Like forAll, but tries to shrink the argument for failing test cases.
(.&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> PropertySource
Produced by Haddock version 2.6.0