-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Automatic testing of Haskell programs
--
-- QuickCheck is a library for random testing of program properties.
--
-- The programmer provides a specification of the program, in the form of
-- properties which functions should satisfy, and QuickCheck then tests
-- that the properties hold in a large number of randomly generated
-- cases.
--
-- Specifications are expressed in Haskell, using combinators defined in
-- the QuickCheck library. QuickCheck provides combinators to define
-- properties, observe the distribution of test data, and define test
-- data generators.
--
-- You can find a (slightly out-of-date but useful) manual at
-- http://www.cse.chalmers.se/~rjmh/QuickCheck/manual.html.
@package QuickCheck
@version 2.9.1
-- | A wrapper around the system random number generator. Internal
-- QuickCheck module.
module Test.QuickCheck.Random
newTheGen :: IO TFGen
bits :: Integral a => a
mask :: Integral a => a
doneBit :: Integral a => a
chip :: Bool -> Word32 -> TFGen -> TFGen
chop :: Integer -> Integer
stop :: Integral a => a -> Bool
mkTheGen :: Int -> TFGen
-- | The "standard" QuickCheck random number generator. A wrapper around
-- either TFGen on GHC, or StdGen on other Haskell systems.
newtype QCGen
QCGen :: TFGen -> QCGen
newQCGen :: IO QCGen
mkQCGen :: Int -> QCGen
bigNatVariant :: Integer -> TFGen -> TFGen
natVariant :: Integral a => a -> TFGen -> TFGen
variantTheGen :: Integral a => a -> TFGen -> TFGen
boolVariant :: Bool -> TFGen -> TFGen
variantQCGen :: Integral a => a -> QCGen -> QCGen
instance GHC.Show.Show Test.QuickCheck.Random.QCGen
instance GHC.Read.Read Test.QuickCheck.Random.QCGen
instance System.Random.RandomGen Test.QuickCheck.Random.QCGen
-- | Throwing and catching exceptions. Internal QuickCheck module.
module Test.QuickCheck.Exception
type AnException = SomeException
tryEvaluate :: a -> IO (Either AnException a)
tryEvaluateIO :: IO a -> IO (Either AnException a)
evaluate :: a -> IO a
-- | Test if an exception was a ^C. QuickCheck won't try to shrink
-- an interrupted test case.
isInterrupt :: AnException -> Bool
-- | A special exception that makes QuickCheck discard the test case.
-- Normally you should use ==>, but if for some reason this
-- isn't possible (e.g. you are deep inside a generator), use
-- discard instead.
discard :: a
isDiscard :: AnException -> Bool
finally :: IO a -> IO b -> IO a
-- | Terminal control. Internal QuickCheck module.
module Test.QuickCheck.Text
newtype Str
MkStr :: String -> Str
ranges :: (Show a, Integral a) => a -> a -> Str
number :: Int -> String -> String
short :: Int -> String -> String
showErr :: Show a => a -> String
oneLine :: String -> String
isOneLine :: String -> Bool
bold :: String -> String
newTerminal :: (String -> IO ()) -> (String -> IO ()) -> IO Terminal
withStdioTerminal :: (Terminal -> IO a) -> IO a
withNullTerminal :: (Terminal -> IO a) -> IO a
terminalOutput :: Terminal -> IO String
handle :: Handle -> String -> IO ()
data Terminal
putTemp :: Terminal -> String -> IO ()
putPart :: Terminal -> String -> IO ()
putLine :: Terminal -> String -> IO ()
instance GHC.Show.Show Test.QuickCheck.Text.Str
-- | QuickCheck's internal state. Internal QuickCheck module.
module Test.QuickCheck.State
-- | State represents QuickCheck's internal state while testing a property.
-- The state is made visible to callback functions.
data State
MkState :: Terminal -> Int -> Int -> (Int -> Int -> Int) -> !Int -> !Int -> !Int -> !(Map String Int) -> ![Set String] -> !Bool -> !QCGen -> !Int -> !Int -> !Int -> State
-- | the current terminal
[terminal] :: State -> Terminal
-- | maximum number of successful tests needed
[maxSuccessTests] :: State -> Int
-- | maximum number of tests that can be discarded
[maxDiscardedTests] :: State -> Int
-- | how to compute the size of test cases from discarded tests
[computeSize] :: State -> Int -> Int -> Int
-- | the current number of tests that have succeeded
[numSuccessTests] :: State -> !Int
-- | the current number of discarded tests
[numDiscardedTests] :: State -> !Int
-- | the number of discarded tests since the last successful test
[numRecentlyDiscardedTests] :: State -> !Int
-- | all labels that have been defined so far
[labels] :: State -> !(Map String Int)
-- | all labels that have been collected so far
[collected] :: State -> ![Set String]
-- | indicates if the property is expected to fail
[expectedFailure] :: State -> !Bool
-- | the current random seed
[randomSeed] :: State -> !QCGen
-- | number of successful shrinking steps so far
[numSuccessShrinks] :: State -> !Int
-- | number of failed shrinking steps since the last successful shrink
[numTryShrinks] :: State -> !Int
-- | total number of failed shrinking steps
[numTotTryShrinks] :: State -> !Int
-- | Test case generation.
module Test.QuickCheck.Gen
-- | A generator for values of type a.
newtype Gen a
MkGen :: (QCGen -> Int -> a) -> Gen a
-- | Run the generator on a particular seed. If you just want to get a
-- random value out, consider using generate.
[unGen] :: Gen a -> QCGen -> Int -> a
-- | Modifies a generator using an integer seed.
variant :: Integral n => n -> Gen a -> Gen a
-- | Used to construct generators that depend on the size parameter.
sized :: (Int -> Gen a) -> Gen a
-- | Overrides the size parameter. Returns a generator which uses the given
-- size instead of the runtime-size parameter.
resize :: Int -> Gen a -> Gen a
-- | Adjust the size parameter, by transforming it with the given function.
scale :: (Int -> Int) -> Gen a -> Gen a
-- | Generates a random element in the given inclusive range.
choose :: Random a => (a, a) -> Gen a
-- | Run a generator. The size passed to the generator is always 30; if you
-- want another size then you should explicitly use resize.
generate :: Gen a -> IO a
-- | Generates some example values.
sample' :: Gen a -> IO [a]
-- | Generates some example values and prints them to stdout.
sample :: Show a => Gen a -> IO ()
-- | Generates a value that satisfies a predicate.
suchThat :: Gen a -> (a -> Bool) -> Gen a
-- | Tries to generate a value that satisfies a predicate.
suchThatMaybe :: Gen a -> (a -> Bool) -> Gen (Maybe a)
-- | Randomly uses one of the given generators. The input list must be
-- non-empty.
oneof :: [Gen a] -> Gen a
-- | Chooses one of the given generators, with a weighted random
-- distribution. The input list must be non-empty.
frequency :: [(Int, Gen a)] -> Gen a
-- | Generates one of the given values. The input list must be non-empty.
elements :: [a] -> Gen a
-- | Generates a random subsequence of the given list.
sublistOf :: [a] -> Gen [a]
-- | Generates a random permutation of the given list.
shuffle :: [a] -> Gen [a]
-- | Takes a list of elements of increasing size, and chooses among an
-- initial segment of the list. The size of this initial segment
-- increases with the size parameter. The input list must be non-empty.
growingElements :: [a] -> Gen a
-- | Generates a list of random length. The maximum length depends on the
-- size parameter.
listOf :: Gen a -> Gen [a]
-- | Generates a non-empty list of random length. The maximum length
-- depends on the size parameter.
listOf1 :: Gen a -> Gen [a]
-- | Generates a list of the given length.
vectorOf :: Int -> Gen a -> Gen [a]
-- | Generates an infinite list.
infiniteListOf :: Gen a -> Gen [a]
instance GHC.Base.Functor Test.QuickCheck.Gen.Gen
instance GHC.Base.Applicative Test.QuickCheck.Gen.Gen
instance GHC.Base.Monad Test.QuickCheck.Gen.Gen
-- | Unsafe combinators for the Gen monad.
--
-- Gen is only morally a monad: two generators that are supposed
-- to be equal will give the same probability distribution, but they
-- might be different as functions from random number seeds to values.
-- QuickCheck maintains the illusion that a Gen is a probability
-- distribution and does not allow you to distinguish two generators that
-- have the same distribution.
--
-- The functions in this module allow you to break this illusion by
-- reusing the same random number seed twice. This is unsafe because by
-- applying the same seed to two morally equal generators, you can see
-- whether they are really equal or not.
module Test.QuickCheck.Gen.Unsafe
-- | Promotes a monadic generator to a generator of monadic values.
promote :: Monad m => m (Gen a) -> Gen (m a)
-- | Randomly generates a function of type Gen a -> a,
-- which you can then use to evaluate generators. Mostly useful in
-- implementing promote.
delay :: Gen (Gen a -> a)
-- | A variant of delay that returns a polymorphic evaluation
-- function. Can be used in a pinch to generate polymorphic (rank-2)
-- values:
--
--
-- genSelector :: Gen (a -> a -> a)
-- genSelector = elements [\x y -> x, \x y -> y]
--
-- data Selector = Selector (forall a. a -> a -> a)
-- genPolySelector :: Gen Selector
-- genPolySelector = do
-- Capture eval <- capture
-- return (Selector (eval genSelector))
--
capture :: Gen Capture
newtype Capture
Capture :: (forall a. Gen a -> a) -> Capture
-- | Type classes for random generation of values.
module Test.QuickCheck.Arbitrary
-- | Random generation and shrinking of values.
class Arbitrary a where shrink _ = []
-- | A generator for values of the given type.
arbitrary :: Arbitrary a => Gen a
-- | Produces a (possibly) empty list of all the possible immediate shrinks
-- of the given value. The default implementation returns the empty list,
-- so will not try to shrink the value.
--
-- Most implementations of shrink should try at least three
-- things:
--
--
-- - Shrink a term to any of its immediate subterms.
-- - Recursively apply shrink to all immediate subterms.
-- - Type-specific shrinkings such as replacing a constructor by a
-- simpler constructor.
--
--
-- For example, suppose we have the following implementation of binary
-- trees:
--
--
-- data Tree a = Nil | Branch a (Tree a) (Tree a)
--
--
-- We can then define shrink as follows:
--
--
-- shrink Nil = []
-- shrink (Branch x l r) =
-- -- shrink Branch to Nil
-- [Nil] ++
-- -- shrink to subterms
-- [l, r] ++
-- -- recursively shrink subterms
-- [Branch x' l' r' | (x', l', r') <- shrink (x, l, r)]
--
--
-- There are a couple of subtleties here:
--
--
-- - QuickCheck tries the shrinking candidates in the order they appear
-- in the list, so we put more aggressive shrinking steps (such as
-- replacing the whole tree by Nil) before smaller ones (such as
-- recursively shrinking the subtrees).
-- - It is tempting to write the last line as [Branch x' l' r' | x'
-- <- shrink x, l' <- shrink l, r' <- shrink r] but this is
-- the wrong thing! It will force QuickCheck to shrink x,
-- l and r in tandem, and shrinking will stop once
-- one of the three is fully shrunk.
--
--
-- There is a fair bit of boilerplate in the code above. We can avoid it
-- with the help of some generic functions; note that these only work on
-- GHC 7.2 and above. The function genericShrink tries shrinking a
-- term to all of its subterms and, failing that, recursively shrinks the
-- subterms. Using it, we can define shrink as:
--
--
-- shrink x = shrinkToNil x ++ genericShrink x
-- where
-- shrinkToNil Nil = []
-- shrinkToNil (Branch _ l r) = [Nil]
--
--
-- genericShrink is a combination of subterms, which
-- shrinks a term to any of its subterms, and recursivelyShrink,
-- which shrinks all subterms of a term. These may be useful if you need
-- a bit more control over shrinking than genericShrink gives you.
--
-- A final gotcha: we cannot define shrink as simply
-- shrink x = Nil:genericShrink x as this shrinks
-- Nil to Nil, and shrinking will go into an infinite
-- loop.
--
-- If all this leaves you bewildered, you might try shrink =
-- genericShrink to begin with, after deriving
-- Generic for your type. However, if your data type has any
-- special invariants, you will need to check that genericShrink
-- can't break those invariants.
shrink :: Arbitrary a => a -> [a]
-- | Used for random generation of functions.
--
-- If you are using a recent GHC, there is a default definition of
-- coarbitrary using genericCoarbitrary, so if your type
-- has a Generic instance it's enough to say
--
--
-- instance CoArbitrary MyType
--
--
-- You should only use genericCoarbitrary for data types where
-- equality is structural, i.e. if you can't have two different
-- representations of the same value. An example where it's not safe is
-- sets implemented using binary search trees: the same set can be
-- represented as several different trees. Here you would have to
-- explicitly define coarbitrary s = coarbitrary (toList s).
class CoArbitrary a where coarbitrary = genericCoarbitrary
-- | Used to generate a function of type a -> b. The first
-- argument is a value, the second a generator. You should use
-- variant to perturb the random generator; the goal is that
-- different values for the first argument will lead to different calls
-- to variant. An example will help:
--
--
-- instance CoArbitrary a => CoArbitrary [a] where
-- coarbitrary [] = variant 0
-- coarbitrary (x:xs) = variant 1 . coarbitrary (x,xs)
--
coarbitrary :: CoArbitrary a => a -> Gen b -> Gen b
-- | Used to generate a function of type a -> b. The first
-- argument is a value, the second a generator. You should use
-- variant to perturb the random generator; the goal is that
-- different values for the first argument will lead to different calls
-- to variant. An example will help:
--
--
-- instance CoArbitrary a => CoArbitrary [a] where
-- coarbitrary [] = variant 0
-- coarbitrary (x:xs) = variant 1 . coarbitrary (x,xs)
--
coarbitrary :: (CoArbitrary a, Generic a, GCoArbitrary (Rep a)) => a -> Gen b -> Gen b
-- | Generates an integral number. The number can be positive or negative
-- and its maximum absolute value depends on the size parameter.
arbitrarySizedIntegral :: Integral a => Gen a
-- | Generates a natural number. The number's maximum value depends on the
-- size parameter.
arbitrarySizedNatural :: Integral a => Gen a
-- | Generates an integral number. The number is chosen uniformly from the
-- entire range of the type. You may want to use
-- arbitrarySizedBoundedIntegral instead.
arbitraryBoundedIntegral :: (Bounded a, Integral a) => Gen a
-- | Generates an integral number from a bounded domain. The number is
-- chosen from the entire range of the type, but small numbers are
-- generated more often than big numbers. Inspired by demands from Phil
-- Wadler.
arbitrarySizedBoundedIntegral :: (Bounded a, Integral a) => Gen a
-- | Generates a fractional number. The number can be positive or negative
-- and its maximum absolute value depends on the size parameter.
arbitrarySizedFractional :: Fractional a => Gen a
-- | Generates an element of a bounded type. The element is chosen from the
-- entire range of the type.
arbitraryBoundedRandom :: (Bounded a, Random a) => Gen a
-- | Generates an element of a bounded enumeration.
arbitraryBoundedEnum :: (Bounded a, Enum a) => Gen a
-- | Shrink a term to any of its immediate subterms, and also recursively
-- shrink all subterms.
genericShrink :: (Generic a, RecursivelyShrink (Rep a), GSubterms (Rep a) a) => a -> [a]
-- | All immediate subterms of a term.
subterms :: (Generic a, GSubterms (Rep a) a) => a -> [a]
-- | Recursively shrink all immediate subterms.
recursivelyShrink :: (Generic a, RecursivelyShrink (Rep a)) => a -> [a]
-- | Generic CoArbitrary implementation.
genericCoarbitrary :: (Generic a, GCoArbitrary (Rep a)) => a -> Gen b -> Gen b
-- | Returns no shrinking alternatives.
shrinkNothing :: a -> [a]
-- | Shrink a list of values given a shrinking function for individual
-- values.
shrinkList :: (a -> [a]) -> [a] -> [[a]]
-- | Shrink an integral number.
shrinkIntegral :: Integral a => a -> [a]
-- | Shrink a fraction.
shrinkRealFrac :: RealFrac a => a -> [a]
-- | Shrink a fraction, but only shrink to integral values.
shrinkRealFracToInteger :: RealFrac a => a -> [a]
-- | A coarbitrary implementation for integral numbers.
coarbitraryIntegral :: Integral a => a -> Gen b -> Gen b
-- | A coarbitrary implementation for real numbers.
coarbitraryReal :: Real a => a -> Gen b -> Gen b
-- | coarbitrary helper for lazy people :-).
coarbitraryShow :: Show a => a -> Gen b -> Gen b
-- | A coarbitrary implementation for enums.
coarbitraryEnum :: Enum a => a -> Gen b -> Gen b
-- | Combine two generator perturbing functions, for example the results of
-- calls to variant or coarbitrary.
-- | Deprecated: Use ordinary function composition instead
(><) :: (Gen a -> Gen a) -> (Gen a -> Gen a) -> (Gen a -> Gen a)
-- | Generates a list of a given length.
vector :: Arbitrary a => Int -> Gen [a]
-- | Generates an ordered list.
orderedList :: (Ord a, Arbitrary a) => Gen [a]
-- | Generate an infinite list.
infiniteList :: Arbitrary a => Gen [a]
instance (Test.QuickCheck.Arbitrary.RecursivelyShrink f, Test.QuickCheck.Arbitrary.RecursivelyShrink g) => Test.QuickCheck.Arbitrary.RecursivelyShrink (f GHC.Generics.:*: g)
instance (Test.QuickCheck.Arbitrary.RecursivelyShrink f, Test.QuickCheck.Arbitrary.RecursivelyShrink g) => Test.QuickCheck.Arbitrary.RecursivelyShrink (f GHC.Generics.:+: g)
instance Test.QuickCheck.Arbitrary.RecursivelyShrink f => Test.QuickCheck.Arbitrary.RecursivelyShrink (GHC.Generics.M1 i c f)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.RecursivelyShrink (GHC.Generics.K1 i a)
instance Test.QuickCheck.Arbitrary.RecursivelyShrink GHC.Generics.U1
instance Test.QuickCheck.Arbitrary.RecursivelyShrink GHC.Generics.V1
instance Test.QuickCheck.Arbitrary.GSubterms GHC.Generics.V1 a
instance Test.QuickCheck.Arbitrary.GSubterms GHC.Generics.U1 a
instance (Test.QuickCheck.Arbitrary.GSubtermsIncl f a, Test.QuickCheck.Arbitrary.GSubtermsIncl g a) => Test.QuickCheck.Arbitrary.GSubterms (f GHC.Generics.:*: g) a
instance (Test.QuickCheck.Arbitrary.GSubtermsIncl f a, Test.QuickCheck.Arbitrary.GSubtermsIncl g a) => Test.QuickCheck.Arbitrary.GSubterms (f GHC.Generics.:+: g) a
instance Test.QuickCheck.Arbitrary.GSubterms f a => Test.QuickCheck.Arbitrary.GSubterms (GHC.Generics.M1 i c f) a
instance Test.QuickCheck.Arbitrary.GSubterms (GHC.Generics.K1 i a) b
instance Test.QuickCheck.Arbitrary.GSubtermsIncl GHC.Generics.V1 a
instance Test.QuickCheck.Arbitrary.GSubtermsIncl GHC.Generics.U1 a
instance (Test.QuickCheck.Arbitrary.GSubtermsIncl f a, Test.QuickCheck.Arbitrary.GSubtermsIncl g a) => Test.QuickCheck.Arbitrary.GSubtermsIncl (f GHC.Generics.:*: g) a
instance (Test.QuickCheck.Arbitrary.GSubtermsIncl f a, Test.QuickCheck.Arbitrary.GSubtermsIncl g a) => Test.QuickCheck.Arbitrary.GSubtermsIncl (f GHC.Generics.:+: g) a
instance Test.QuickCheck.Arbitrary.GSubtermsIncl f a => Test.QuickCheck.Arbitrary.GSubtermsIncl (GHC.Generics.M1 i c f) a
instance Test.QuickCheck.Arbitrary.GSubtermsIncl (GHC.Generics.K1 i a) a
instance Test.QuickCheck.Arbitrary.GSubtermsIncl (GHC.Generics.K1 i a) b
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b) => Test.QuickCheck.Arbitrary.Arbitrary (a -> b)
instance Test.QuickCheck.Arbitrary.Arbitrary ()
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Bool
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Ordering
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (GHC.Base.Maybe a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Either.Either a b)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary [a]
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.List.NonEmpty.NonEmpty a)
instance GHC.Real.Integral a => Test.QuickCheck.Arbitrary.Arbitrary (GHC.Real.Ratio a)
instance (GHC.Float.RealFloat a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Complex.Complex a)
instance Data.Fixed.HasResolution a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Fixed.Fixed a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b) => Test.QuickCheck.Arbitrary.Arbitrary (a, b)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e, Test.QuickCheck.Arbitrary.Arbitrary f) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e, f)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e, Test.QuickCheck.Arbitrary.Arbitrary f, Test.QuickCheck.Arbitrary.Arbitrary g) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e, f, g)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e, Test.QuickCheck.Arbitrary.Arbitrary f, Test.QuickCheck.Arbitrary.Arbitrary g, Test.QuickCheck.Arbitrary.Arbitrary h) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e, f, g, h)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e, Test.QuickCheck.Arbitrary.Arbitrary f, Test.QuickCheck.Arbitrary.Arbitrary g, Test.QuickCheck.Arbitrary.Arbitrary h, Test.QuickCheck.Arbitrary.Arbitrary i) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e, f, g, h, i)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b, Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary d, Test.QuickCheck.Arbitrary.Arbitrary e, Test.QuickCheck.Arbitrary.Arbitrary f, Test.QuickCheck.Arbitrary.Arbitrary g, Test.QuickCheck.Arbitrary.Arbitrary h, Test.QuickCheck.Arbitrary.Arbitrary i, Test.QuickCheck.Arbitrary.Arbitrary j) => Test.QuickCheck.Arbitrary.Arbitrary (a, b, c, d, e, f, g, h, i, j)
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Integer.Type.Integer
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Natural.Natural
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Int
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Int.Int8
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Int.Int16
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Int.Int32
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Int.Int64
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Word
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Word.Word8
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Word.Word16
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Word.Word32
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Word.Word64
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Char
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Float
instance Test.QuickCheck.Arbitrary.Arbitrary GHC.Types.Double
instance (GHC.Classes.Ord a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Set.Base.Set a)
instance (GHC.Classes.Ord k, Test.QuickCheck.Arbitrary.Arbitrary k, Test.QuickCheck.Arbitrary.Arbitrary v) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Map.Base.Map k v)
instance Test.QuickCheck.Arbitrary.Arbitrary Data.IntSet.Base.IntSet
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.IntMap.Base.IntMap a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Sequence.Seq a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Control.Applicative.ZipList a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Functor.Identity.Identity a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Functor.Constant.Constant a b)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Functor.Const.Const a b)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Dual a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Endo a)
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Monoid.All
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Monoid.Any
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Sum a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Product a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.First a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Last a)
instance Test.QuickCheck.Arbitrary.Arbitrary (f a) => Test.QuickCheck.Arbitrary.Arbitrary (Data.Monoid.Alt f a)
instance Test.QuickCheck.Arbitrary.Arbitrary Data.Version.Version
instance Test.QuickCheck.Arbitrary.GCoArbitrary GHC.Generics.U1
instance (Test.QuickCheck.Arbitrary.GCoArbitrary f, Test.QuickCheck.Arbitrary.GCoArbitrary g) => Test.QuickCheck.Arbitrary.GCoArbitrary (f GHC.Generics.:*: g)
instance (Test.QuickCheck.Arbitrary.GCoArbitrary f, Test.QuickCheck.Arbitrary.GCoArbitrary g) => Test.QuickCheck.Arbitrary.GCoArbitrary (f GHC.Generics.:+: g)
instance Test.QuickCheck.Arbitrary.GCoArbitrary f => Test.QuickCheck.Arbitrary.GCoArbitrary (GHC.Generics.M1 i c f)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.GCoArbitrary (GHC.Generics.K1 i a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b) => Test.QuickCheck.Arbitrary.CoArbitrary (a -> b)
instance Test.QuickCheck.Arbitrary.CoArbitrary ()
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Bool
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Ordering
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (GHC.Base.Maybe a)
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b) => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Either.Either a b)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary [a]
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.List.NonEmpty.NonEmpty a)
instance (GHC.Real.Integral a, Test.QuickCheck.Arbitrary.CoArbitrary a) => Test.QuickCheck.Arbitrary.CoArbitrary (GHC.Real.Ratio a)
instance Data.Fixed.HasResolution a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Fixed.Fixed a)
instance (GHC.Float.RealFloat a, Test.QuickCheck.Arbitrary.CoArbitrary a) => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Complex.Complex a)
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b) => Test.QuickCheck.Arbitrary.CoArbitrary (a, b)
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b, Test.QuickCheck.Arbitrary.CoArbitrary c) => Test.QuickCheck.Arbitrary.CoArbitrary (a, b, c)
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b, Test.QuickCheck.Arbitrary.CoArbitrary c, Test.QuickCheck.Arbitrary.CoArbitrary d) => Test.QuickCheck.Arbitrary.CoArbitrary (a, b, c, d)
instance (Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary b, Test.QuickCheck.Arbitrary.CoArbitrary c, Test.QuickCheck.Arbitrary.CoArbitrary d, Test.QuickCheck.Arbitrary.CoArbitrary e) => Test.QuickCheck.Arbitrary.CoArbitrary (a, b, c, d, e)
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Integer.Type.Integer
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Natural.Natural
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Int
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Int.Int8
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Int.Int16
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Int.Int32
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Int.Int64
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Word
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Word.Word8
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Word.Word16
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Word.Word32
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Word.Word64
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Char
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Float
instance Test.QuickCheck.Arbitrary.CoArbitrary GHC.Types.Double
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Set.Base.Set a)
instance (Test.QuickCheck.Arbitrary.CoArbitrary k, Test.QuickCheck.Arbitrary.CoArbitrary v) => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Map.Base.Map k v)
instance Test.QuickCheck.Arbitrary.CoArbitrary Data.IntSet.Base.IntSet
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.IntMap.Base.IntMap a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Sequence.Seq a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Control.Applicative.ZipList a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Functor.Identity.Identity a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Functor.Constant.Constant a b)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Functor.Const.Const a b)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Dual a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Arbitrary.CoArbitrary a) => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Endo a)
instance Test.QuickCheck.Arbitrary.CoArbitrary Data.Monoid.All
instance Test.QuickCheck.Arbitrary.CoArbitrary Data.Monoid.Any
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Sum a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Product a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.First a)
instance Test.QuickCheck.Arbitrary.CoArbitrary a => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Last a)
instance Test.QuickCheck.Arbitrary.CoArbitrary (f a) => Test.QuickCheck.Arbitrary.CoArbitrary (Data.Monoid.Alt f a)
instance Test.QuickCheck.Arbitrary.CoArbitrary Data.Version.Version
-- | Modifiers for test data.
--
-- These types do things such as restricting the kind of test data that
-- can be generated. They can be pattern-matched on in properties as a
-- stylistic alternative to using explicit quantification.
--
-- Examples:
--
--
-- -- Functions cannot be shown (but see Test.QuickCheck.Function)
-- prop_TakeDropWhile (Blind p) (xs :: [A]) =
-- takeWhile p xs ++ dropWhile p xs == xs
--
--
--
-- prop_TakeDrop (NonNegative n) (xs :: [A]) =
-- take n xs ++ drop n xs == xs
--
--
--
-- -- cycle does not work for empty lists
-- prop_Cycle (NonNegative n) (NonEmpty (xs :: [A])) =
-- take n (cycle xs) == take n (xs ++ cycle xs)
--
--
--
-- -- Instead of forAll orderedList
-- prop_Sort (Ordered (xs :: [OrdA])) =
-- sort xs == xs
--
module Test.QuickCheck.Modifiers
-- | Blind x: as x, but x does not have to be in the Show
-- class.
newtype Blind a
Blind :: a -> Blind a
[getBlind] :: Blind a -> a
-- | Fixed x: as x, but will not be shrunk.
newtype Fixed a
Fixed :: a -> Fixed a
[getFixed] :: Fixed a -> a
-- | Ordered xs: guarantees that xs is ordered.
newtype OrderedList a
Ordered :: [a] -> OrderedList a
[getOrdered] :: OrderedList a -> [a]
-- | NonEmpty xs: guarantees that xs is non-empty.
newtype NonEmptyList a
NonEmpty :: [a] -> NonEmptyList a
[getNonEmpty] :: NonEmptyList a -> [a]
-- | Positive x: guarantees that x > 0.
newtype Positive a
Positive :: a -> Positive a
[getPositive] :: Positive a -> a
-- | NonZero x: guarantees that x /= 0.
newtype NonZero a
NonZero :: a -> NonZero a
[getNonZero] :: NonZero a -> a
-- | NonNegative x: guarantees that x >= 0.
newtype NonNegative a
NonNegative :: a -> NonNegative a
[getNonNegative] :: NonNegative a -> a
-- | Large x: by default, QuickCheck generates Ints drawn
-- from a small range. Large Int gives you values drawn from the
-- entire range instead.
newtype Large a
Large :: a -> Large a
[getLarge] :: Large a -> a
-- | Small x: generates values of x drawn from a small
-- range. The opposite of Large.
newtype Small a
Small :: a -> Small a
[getSmall] :: Small a -> a
-- | Smart _ x: tries a different order when shrinking.
data Smart a
Smart :: Int -> a -> Smart a
-- | Shrink2 x: allows 2 shrinking steps at the same time when
-- shrinking x
newtype Shrink2 a
Shrink2 :: a -> Shrink2 a
[getShrink2] :: Shrink2 a -> a
-- | Shrinking _ x: allows for maintaining a state during
-- shrinking.
data Shrinking s a
Shrinking :: s -> a -> Shrinking s a
class ShrinkState s a
shrinkInit :: ShrinkState s a => a -> s
shrinkState :: ShrinkState s a => a -> s -> [(a, s)]
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Real.Real a => GHC.Real.Real (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Real.Integral a => GHC.Real.Integral (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Num.Num a => GHC.Num.Num (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Small a)
instance GHC.Real.Real a => GHC.Real.Real (Test.QuickCheck.Modifiers.Small a)
instance GHC.Real.Integral a => GHC.Real.Integral (Test.QuickCheck.Modifiers.Small a)
instance GHC.Num.Num a => GHC.Num.Num (Test.QuickCheck.Modifiers.Small a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.Small a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Small a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Small a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Small a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Large a)
instance GHC.Real.Real a => GHC.Real.Real (Test.QuickCheck.Modifiers.Large a)
instance GHC.Real.Integral a => GHC.Real.Integral (Test.QuickCheck.Modifiers.Large a)
instance GHC.Num.Num a => GHC.Num.Num (Test.QuickCheck.Modifiers.Large a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.Large a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Large a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Large a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Large a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.NonEmptyList a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.NonEmptyList a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.NonEmptyList a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.NonEmptyList a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.OrderedList a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.OrderedList a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.OrderedList a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.OrderedList a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Real.Real a => GHC.Real.Real (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Real.Integral a => GHC.Real.Integral (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Num.Num a => GHC.Num.Num (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Read.Read a => GHC.Read.Read (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Real.Real a => GHC.Real.Real (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Real.Integral a => GHC.Real.Integral (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Num.Num a => GHC.Num.Num (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Blind
instance GHC.Show.Show (Test.QuickCheck.Modifiers.Blind a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Blind a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Fixed
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Fixed a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.OrderedList
instance (GHC.Classes.Ord a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.OrderedList a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.NonEmptyList
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.NonEmptyList a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Positive
instance (GHC.Num.Num a, GHC.Classes.Ord a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Positive a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.NonZero
instance (GHC.Num.Num a, GHC.Classes.Eq a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.NonZero a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.NonNegative
instance (GHC.Num.Num a, GHC.Classes.Ord a, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.NonNegative a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Large
instance (GHC.Real.Integral a, GHC.Enum.Bounded a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Large a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Small
instance GHC.Real.Integral a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Small a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Shrink2
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Shrink2 a)
instance GHC.Base.Functor Test.QuickCheck.Modifiers.Smart
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Smart a)
instance Test.QuickCheck.Arbitrary.Arbitrary a => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Smart a)
instance GHC.Base.Functor (Test.QuickCheck.Modifiers.Shrinking s)
instance GHC.Show.Show a => GHC.Show.Show (Test.QuickCheck.Modifiers.Shrinking s a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, Test.QuickCheck.Modifiers.ShrinkState s a) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Modifiers.Shrinking s a)
-- | Types to help with testing polymorphic properties.
--
-- Types A, B and C are newtype wrappers
-- around Integer that implement Eq, Show,
-- Arbitrary and CoArbitrary. Types OrdA,
-- OrdB and OrdC also implement Ord and Num.
--
-- See also Test.QuickCheck.All for an automatic way of testing
-- polymorphic properties.
module Test.QuickCheck.Poly
newtype A
A :: Integer -> A
[unA] :: A -> Integer
newtype B
B :: Integer -> B
[unB] :: B -> Integer
newtype C
C :: Integer -> C
[unC] :: C -> Integer
newtype OrdA
OrdA :: Integer -> OrdA
[unOrdA] :: OrdA -> Integer
newtype OrdB
OrdB :: Integer -> OrdB
[unOrdB] :: OrdB -> Integer
newtype OrdC
OrdC :: Integer -> OrdC
[unOrdC] :: OrdC -> Integer
instance GHC.Num.Num Test.QuickCheck.Poly.OrdC
instance GHC.Classes.Ord Test.QuickCheck.Poly.OrdC
instance GHC.Classes.Eq Test.QuickCheck.Poly.OrdC
instance GHC.Num.Num Test.QuickCheck.Poly.OrdB
instance GHC.Classes.Ord Test.QuickCheck.Poly.OrdB
instance GHC.Classes.Eq Test.QuickCheck.Poly.OrdB
instance GHC.Num.Num Test.QuickCheck.Poly.OrdA
instance GHC.Classes.Ord Test.QuickCheck.Poly.OrdA
instance GHC.Classes.Eq Test.QuickCheck.Poly.OrdA
instance GHC.Classes.Eq Test.QuickCheck.Poly.C
instance GHC.Classes.Eq Test.QuickCheck.Poly.B
instance GHC.Classes.Eq Test.QuickCheck.Poly.A
instance GHC.Show.Show Test.QuickCheck.Poly.A
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.A
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.A
instance GHC.Show.Show Test.QuickCheck.Poly.B
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.B
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.B
instance GHC.Show.Show Test.QuickCheck.Poly.C
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.C
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.C
instance GHC.Show.Show Test.QuickCheck.Poly.OrdA
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.OrdA
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.OrdA
instance GHC.Show.Show Test.QuickCheck.Poly.OrdB
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.OrdB
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.OrdB
instance GHC.Show.Show Test.QuickCheck.Poly.OrdC
instance Test.QuickCheck.Arbitrary.Arbitrary Test.QuickCheck.Poly.OrdC
instance Test.QuickCheck.Arbitrary.CoArbitrary Test.QuickCheck.Poly.OrdC
-- | Generation of random shrinkable, showable functions. See the paper
-- "Shrinking and showing functions" by Koen Claessen.
--
-- Example of use:
--
--
-- >>> :{
--
-- >>> let prop :: Fun String Integer -> Bool
--
-- >>> prop (Fun _ f) = f "monkey" == f "banana" || f "banana" == f "elephant"
--
-- >>> :}
--
-- >>> quickCheck prop
-- *** Failed! Falsifiable (after 3 tests and 134 shrinks):
-- {"elephant"->1, "monkey"->1, _->0}
--
--
-- To generate random values of type Fun a b, you must
-- have an instance Function a. If your type has a
-- Show instance, you can use functionShow to write the
-- instance; otherwise, use functionMap to give a bijection
-- between your type and a type that is already an instance of
-- Function. See the Function [a] instance for an
-- example of the latter.
module Test.QuickCheck.Function
data Fun a b
Fun :: (a :-> b, b, Bool) -> (a -> b) -> Fun a b
apply :: Fun a b -> (a -> b)
-- | The type of possibly partial concrete functions
data (:->) a c
class Function a where function = genericFunction
function :: Function a => (a -> b) -> (a :-> b)
function :: (Function a, Generic a, GFunction (Rep a)) => (a -> b) -> (a :-> b)
-- | The basic building block for Function instances. Provides a
-- Function instance by mapping to and from a type that already
-- has a Function instance.
functionMap :: Function b => (a -> b) -> (b -> a) -> (a -> c) -> (a :-> c)
-- | Provides a Function instance for types with Show and
-- Read.
functionShow :: (Show a, Read a) => (a -> c) -> (a :-> c)
-- | Provides a Function instance for types with Integral.
functionIntegral :: Integral a => (a -> b) -> (a :-> b)
-- | Provides a Function instance for types with RealFrac.
functionRealFrac :: RealFrac a => (a -> b) -> (a :-> b)
-- | Provides a Function instance for types with Bounded and
-- Enum. Use only for small types (i.e. not integers): creates the
-- list ['minBound'..'maxBound']!
functionBoundedEnum :: (Eq a, Bounded a, Enum a) => (a -> b) -> (a :-> b)
-- | A pattern for matching against the function only:
--
--
-- prop :: Fun String Integer -> Bool
-- prop (Fn f) = f "banana" == f "monkey"
-- || f "banana" == f "elephant"
--
instance GHC.Base.Functor ((Test.QuickCheck.Function.:->) a)
instance (GHC.Show.Show a, GHC.Show.Show b) => GHC.Show.Show (a Test.QuickCheck.Function.:-> b)
instance Test.QuickCheck.Function.Function ()
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b) => Test.QuickCheck.Function.Function (a, b)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b) => Test.QuickCheck.Function.Function (Data.Either.Either a b)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b, Test.QuickCheck.Function.Function c) => Test.QuickCheck.Function.Function (a, b, c)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b, Test.QuickCheck.Function.Function c, Test.QuickCheck.Function.Function d) => Test.QuickCheck.Function.Function (a, b, c, d)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b, Test.QuickCheck.Function.Function c, Test.QuickCheck.Function.Function d, Test.QuickCheck.Function.Function e) => Test.QuickCheck.Function.Function (a, b, c, d, e)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b, Test.QuickCheck.Function.Function c, Test.QuickCheck.Function.Function d, Test.QuickCheck.Function.Function e, Test.QuickCheck.Function.Function f) => Test.QuickCheck.Function.Function (a, b, c, d, e, f)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b, Test.QuickCheck.Function.Function c, Test.QuickCheck.Function.Function d, Test.QuickCheck.Function.Function e, Test.QuickCheck.Function.Function f, Test.QuickCheck.Function.Function g) => Test.QuickCheck.Function.Function (a, b, c, d, e, f, g)
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.Function [a]
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.Function (GHC.Base.Maybe a)
instance Test.QuickCheck.Function.Function GHC.Types.Bool
instance Test.QuickCheck.Function.Function GHC.Integer.Type.Integer
instance Test.QuickCheck.Function.Function GHC.Types.Int
instance Test.QuickCheck.Function.Function GHC.Types.Char
instance Test.QuickCheck.Function.Function GHC.Types.Float
instance Test.QuickCheck.Function.Function GHC.Types.Double
instance Test.QuickCheck.Function.Function GHC.Types.Ordering
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.Function (Data.List.NonEmpty.NonEmpty a)
instance (GHC.Real.Integral a, Test.QuickCheck.Function.Function a) => Test.QuickCheck.Function.Function (GHC.Real.Ratio a)
instance Data.Fixed.HasResolution a => Test.QuickCheck.Function.Function (Data.Fixed.Fixed a)
instance (GHC.Float.RealFloat a, Test.QuickCheck.Function.Function a) => Test.QuickCheck.Function.Function (Data.Complex.Complex a)
instance (GHC.Classes.Ord a, Test.QuickCheck.Function.Function a) => Test.QuickCheck.Function.Function (Data.Set.Base.Set a)
instance (GHC.Classes.Ord a, Test.QuickCheck.Function.Function a, Test.QuickCheck.Function.Function b) => Test.QuickCheck.Function.Function (Data.Map.Base.Map a b)
instance Test.QuickCheck.Function.Function Data.IntSet.Base.IntSet
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.Function (Data.IntMap.Base.IntMap a)
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.Function (Data.Sequence.Seq a)
instance Test.QuickCheck.Function.Function GHC.Natural.Natural
instance Test.QuickCheck.Function.Function GHC.Int.Int8
instance Test.QuickCheck.Function.Function GHC.Int.Int16
instance Test.QuickCheck.Function.Function GHC.Int.Int32
instance Test.QuickCheck.Function.Function GHC.Int.Int64
instance Test.QuickCheck.Function.Function GHC.Word.Word8
instance Test.QuickCheck.Function.Function GHC.Word.Word16
instance Test.QuickCheck.Function.Function GHC.Word.Word32
instance Test.QuickCheck.Function.Function GHC.Word.Word64
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.A
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.B
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.C
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.OrdA
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.OrdB
instance Test.QuickCheck.Function.Function Test.QuickCheck.Poly.OrdC
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b) => Test.QuickCheck.Arbitrary.Arbitrary (a Test.QuickCheck.Function.:-> b)
instance Test.QuickCheck.Function.GFunction GHC.Generics.U1
instance (Test.QuickCheck.Function.GFunction f, Test.QuickCheck.Function.GFunction g) => Test.QuickCheck.Function.GFunction (f GHC.Generics.:*: g)
instance (Test.QuickCheck.Function.GFunction f, Test.QuickCheck.Function.GFunction g) => Test.QuickCheck.Function.GFunction (f GHC.Generics.:+: g)
instance Test.QuickCheck.Function.GFunction f => Test.QuickCheck.Function.GFunction (GHC.Generics.M1 i c f)
instance Test.QuickCheck.Function.Function a => Test.QuickCheck.Function.GFunction (GHC.Generics.K1 i a)
instance (GHC.Show.Show a, GHC.Show.Show b) => GHC.Show.Show (Test.QuickCheck.Function.Fun a b)
instance (Test.QuickCheck.Function.Function a, Test.QuickCheck.Arbitrary.CoArbitrary a, Test.QuickCheck.Arbitrary.Arbitrary b) => Test.QuickCheck.Arbitrary.Arbitrary (Test.QuickCheck.Function.Fun a b)
-- | Combinators for constructing properties.
module Test.QuickCheck.Property
-- | The type of properties.
--
-- Backwards combatibility note: in older versions of QuickCheck
-- Property was a type synonym for Gen
-- Prop, so you could mix and match property combinators and
-- Gen monad operations. Code that does this will no longer
-- typecheck. However, it is easy to fix: because of the Testable
-- typeclass, any combinator that expects a Property will also
-- accept a Gen Property. If you have a
-- Property where you need a Gen a,
-- simply wrap the property combinator inside a return to get a
-- Gen Property, and all should be well.
newtype Property
MkProperty :: Gen Prop -> Property
[unProperty] :: Property -> Gen Prop
-- | The class of things which can be tested, i.e. turned into a property.
class Testable prop
-- | Convert the thing to a property.
property :: Testable prop => prop -> Property
-- | If a property returns Discard, the current test case is
-- discarded, the same as if a precondition was false.
data Discard
Discard :: Discard
-- | Do I/O inside a property. This can obviously lead to unrepeatable
-- testcases, so use with care.
-- | Deprecated: Use ioProperty instead
morallyDubiousIOProperty :: Testable prop => IO prop -> Property
-- | Do I/O inside a property. This can obviously lead to unrepeatable
-- testcases, so use with care.
--
-- For more advanced monadic testing you may want to look at
-- Test.QuickCheck.Monadic.
--
-- Note that if you use ioProperty on a property of type IO
-- Bool, or more generally a property that does no quantification,
-- the property will only be executed once. To test the property
-- repeatedly you must use the again combinator.
ioProperty :: Testable prop => IO prop -> Property
protect :: (AnException -> a) -> IO a -> IO a
newtype Prop
MkProp :: Rose Result -> Prop
[unProp] :: Prop -> Rose Result
data Rose a
MkRose :: a -> [Rose a] -> Rose a
IORose :: (IO (Rose a)) -> Rose a
ioRose :: IO (Rose Result) -> Rose Result
joinRose :: Rose (Rose a) -> Rose a
-- | Execute the IORose bits of a rose tree, returning a tree
-- constructed by MkRose.
reduceRose :: Rose Result -> IO (Rose Result)
-- | Apply a function to the outermost MkRose constructor of a rose tree.
-- The function must be total!
onRose :: (a -> [Rose a] -> Rose a) -> Rose a -> Rose a
-- | Wrap a rose tree in an exception handler.
protectRose :: IO (Rose Result) -> IO (Rose Result)
-- | Wrap all the Results in a rose tree in exception handlers.
protectResults :: Rose Result -> Rose Result
-- | Different kinds of callbacks
data Callback
-- | Called just after a test
PostTest :: CallbackKind -> (State -> Result -> IO ()) -> Callback
-- | Called with the final failing test-case
PostFinalFailure :: CallbackKind -> (State -> Result -> IO ()) -> Callback
data CallbackKind
-- | Affected by the verbose combinator
Counterexample :: CallbackKind
-- | Not affected by the verbose combinator
NotCounterexample :: CallbackKind
-- | The result of a single test.
data Result
MkResult :: Maybe Bool -> Bool -> String -> Maybe AnException -> Bool -> Map String Int -> Set String -> [Callback] -> Result
-- | result of the test case; Nothing = discard
[ok] :: Result -> Maybe Bool
-- | indicates what the expected result of the property is
[expect] :: Result -> Bool
-- | a message indicating what went wrong
[reason] :: Result -> String
-- | the exception thrown, if any
[theException] :: Result -> Maybe AnException
-- | if True, the test should not be repeated
[abort] :: Result -> Bool
-- | all labels used by this property
[labels] :: Result -> Map String Int
-- | the collected values for this test case
[stamp] :: Result -> Set String
-- | the callbacks for this test case
[callbacks] :: Result -> [Callback]
exception :: String -> AnException -> Result
formatException :: String -> AnException -> String
protectResult :: IO Result -> IO Result
succeeded :: Result
failed :: Result
rejected :: Result
liftBool :: Bool -> Result
mapResult :: Testable prop => (Result -> Result) -> prop -> Property
mapTotalResult :: Testable prop => (Result -> Result) -> prop -> Property
mapRoseResult :: Testable prop => (Rose Result -> Rose Result) -> prop -> Property
mapProp :: Testable prop => (Prop -> Prop) -> prop -> Property
-- | Changes the maximum test case size for a property.
mapSize :: Testable prop => (Int -> Int) -> prop -> Property
-- | Shrinks the argument to property if it fails. Shrinking is done
-- automatically for most types. This is only needed when you want to
-- override the default behavior.
shrinking :: Testable prop => (a -> [a]) -> a -> (a -> prop) -> Property
-- | Disables shrinking for a property altogether.
noShrinking :: Testable prop => prop -> Property
-- | Adds a callback
callback :: Testable prop => Callback -> prop -> Property
-- | Adds the given string to the counterexample.
counterexample :: Testable prop => String -> prop -> Property
-- | Adds the given string to the counterexample.
-- | Deprecated: Use counterexample instead
printTestCase :: Testable prop => String -> prop -> Property
-- | Performs an IO action after the last failure of a property.
whenFail :: Testable prop => IO () -> prop -> Property
-- | 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.
whenFail' :: Testable prop => IO () -> prop -> Property
-- | Prints out the generated testcase every time the property is tested.
-- Only variables quantified over inside the verbose are
-- printed.
verbose :: Testable prop => prop -> Property
-- | Indicates that a property is supposed to fail. QuickCheck will report
-- an error if it does not fail.
expectFailure :: Testable prop => prop -> Property
-- | Modifies a property so that it only will be tested once.
once :: Testable prop => prop -> Property
-- | Undoes the effect of once.
again :: Testable prop => prop -> Property
-- | Attaches a label to a property. This is used for reporting test case
-- distribution.
label :: Testable prop => String -> prop -> Property
-- | Labels a property with a value:
--
--
-- collect x = label (show x)
--
collect :: (Show a, Testable prop) => a -> prop -> Property
-- | Conditionally labels test case.
classify :: Testable prop => Bool -> String -> prop -> Property
-- | Checks that at least the given proportion of successful test
-- cases belong to the given class. Discarded tests (i.e. ones with a
-- false precondition) do not affect coverage.
cover :: Testable prop => Bool -> Int -> String -> prop -> Property
-- | Implication for properties: The resulting property holds if the first
-- argument is False (in which case the test case is discarded),
-- or if the given property holds.
(==>) :: Testable prop => Bool -> prop -> Property
infixr 0 ==>
-- | Considers a property failed if it does not complete within the given
-- number of microseconds.
within :: Testable prop => Int -> prop -> Property
-- | Explicit universal quantification: uses an explicitly given test case
-- generator.
forAll :: (Show a, Testable prop) => Gen a -> (a -> prop) -> Property
-- | Like forAll, but tries to shrink the argument for failing test
-- cases.
forAllShrink :: (Show a, Testable prop) => Gen a -> (a -> [a]) -> (a -> prop) -> Property
-- | Nondeterministic choice: p1 .&. p2 picks
-- randomly one of p1 and p2 to test. If you test the
-- property 100 times it makes 100 random choices.
(.&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .&.
-- | Conjunction: p1 .&&. p2 passes if
-- both p1 and p2 pass.
(.&&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .&&.
-- | Take the conjunction of several properties.
conjoin :: Testable prop => [prop] -> Property
-- | Disjunction: p1 .||. p2 passes unless
-- p1 and p2 simultaneously fail.
(.||.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .||.
-- | Take the disjunction of several properties.
disjoin :: Testable prop => [prop] -> Property
-- | Like ==, but prints a counterexample when it fails.
(===) :: (Eq a, Show a) => a -> a -> Property
infix 4 ===
instance Test.QuickCheck.Property.Testable Test.QuickCheck.Property.Discard
instance Test.QuickCheck.Property.Testable GHC.Types.Bool
instance Test.QuickCheck.Property.Testable Test.QuickCheck.Property.Result
instance Test.QuickCheck.Property.Testable Test.QuickCheck.Property.Prop
instance Test.QuickCheck.Property.Testable prop => Test.QuickCheck.Property.Testable (Test.QuickCheck.Gen.Gen prop)
instance Test.QuickCheck.Property.Testable Test.QuickCheck.Property.Property
instance (Test.QuickCheck.Arbitrary.Arbitrary a, GHC.Show.Show a, Test.QuickCheck.Property.Testable prop) => Test.QuickCheck.Property.Testable (a -> prop)
instance GHC.Base.Functor Test.QuickCheck.Property.Rose
instance GHC.Base.Applicative Test.QuickCheck.Property.Rose
instance GHC.Base.Monad Test.QuickCheck.Property.Rose
-- | The main test loop.
module Test.QuickCheck.Test
-- | Args specifies arguments to the QuickCheck driver
data Args
Args :: Maybe (QCGen, Int) -> Int -> Int -> Int -> Bool -> Args
-- | Should we replay a previous test? Note: saving a seed from one version
-- of QuickCheck and replaying it in another is not supported. If you
-- want to store a test case permanently you should save the test case
-- itself.
[replay] :: Args -> Maybe (QCGen, Int)
-- | Maximum number of successful tests before succeeding
[maxSuccess] :: Args -> Int
-- | Maximum number of discarded tests per successful test before giving up
[maxDiscardRatio] :: Args -> Int
-- | Size to use for the biggest test cases
[maxSize] :: Args -> Int
-- | Whether to print anything
[chatty] :: Args -> Bool
-- | Result represents the test result
data Result
-- | A successful test run
Success :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | Given up
GaveUp :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | A failed test run
Failure :: Int -> Int -> Int -> Int -> QCGen -> Int -> String -> Maybe AnException -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Number of successful shrinking steps performed
[numShrinks] :: Result -> Int
-- | Number of unsuccessful shrinking steps performed
[numShrinkTries] :: Result -> Int
-- | Number of unsuccessful shrinking steps performed since last successful
-- shrink
[numShrinkFinal] :: Result -> Int
-- | What seed was used
[usedSeed] :: Result -> QCGen
-- | What was the test size
[usedSize] :: Result -> Int
-- | Why did the property fail
[reason] :: Result -> String
-- | The exception the property threw, if any
[theException] :: Result -> Maybe AnException
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | A property that should have failed did not
NoExpectedFailure :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | The tests passed but a use of cover had insufficient coverage
InsufficientCoverage :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | Check if the test run result was a success
isSuccess :: Result -> Bool
-- | The default test arguments
stdArgs :: Args
-- | Tests a property and prints the results to stdout.
quickCheck :: Testable prop => prop -> IO ()
-- | Tests a property, using test arguments, and prints the results to
-- stdout.
quickCheckWith :: Testable prop => Args -> prop -> IO ()
-- | Tests a property, produces a test result, and prints the results to
-- stdout.
quickCheckResult :: Testable prop => prop -> IO Result
-- | Tests a property, using test arguments, produces a test result, and
-- prints the results to stdout.
quickCheckWithResult :: Testable prop => Args -> prop -> IO Result
-- | Tests a property and prints the results and all test cases generated
-- to stdout. This is just a convenience function that means the
-- same as quickCheck . verbose.
verboseCheck :: Testable prop => prop -> IO ()
-- | Tests a property, using test arguments, and prints the results and all
-- test cases generated to stdout. This is just a convenience
-- function that combines quickCheckWith and verbose.
verboseCheckWith :: Testable prop => Args -> prop -> IO ()
-- | Tests a property, produces a test result, and prints the results and
-- all test cases generated to stdout. This is just a
-- convenience function that combines quickCheckResult and
-- verbose.
verboseCheckResult :: Testable prop => prop -> IO Result
-- | Tests a property, using test arguments, produces a test result, and
-- prints the results and all test cases generated to stdout.
-- This is just a convenience function that combines
-- quickCheckWithResult and verbose.
verboseCheckWithResult :: Testable prop => Args -> prop -> IO Result
test :: State -> (QCGen -> Int -> Prop) -> IO Result
doneTesting :: State -> (QCGen -> Int -> Prop) -> IO Result
giveUp :: State -> (QCGen -> Int -> Prop) -> IO Result
runATest :: State -> (QCGen -> Int -> Prop) -> IO Result
summary :: State -> [(String, Int)]
success :: State -> IO ()
labelPercentage :: String -> State -> Int
insufficientCoverage :: State -> Bool
foundFailure :: State -> Result -> [Rose Result] -> IO (Int, Int, Int)
localMin :: State -> Result -> Result -> [Rose Result] -> IO (Int, Int, Int)
localMin' :: State -> Result -> [Rose Result] -> IO (Int, Int, Int)
localMinFound :: State -> Result -> IO (Int, Int, Int)
callbackPostTest :: State -> Result -> IO Result
callbackPostFinalFailure :: State -> Result -> IO ()
instance GHC.Show.Show Test.QuickCheck.Test.Result
instance GHC.Read.Read Test.QuickCheck.Test.Args
instance GHC.Show.Show Test.QuickCheck.Test.Args
-- | Test all properties in the current module, using Template Haskell. You
-- need to have a {-# LANGUAGE TemplateHaskell #-} pragma in
-- your module for any of these to work.
module Test.QuickCheck.All
-- | Test all properties in the current module. The name of the property
-- must begin with prop_. Polymorphic properties will be
-- defaulted to Integer. Returns True if all tests
-- succeeded, False otherwise.
--
-- To use quickCheckAll, add a definition to your module along the
-- lines of
--
--
-- return []
-- runTests = $quickCheckAll
--
--
-- and then execute runTests.
--
-- Note: the bizarre return [] in the example above is needed on
-- GHC 7.8; without it, quickCheckAll will not be able to find any
-- of the properties. For the curious, the return [] is a
-- Template Haskell splice that makes GHC insert the empty list of
-- declarations at that point in the program; GHC typechecks everything
-- before the return [] before it starts on the rest of the
-- module, which means that the later call to quickCheckAll can
-- see everything that was defined before the return []. Yikes!
quickCheckAll :: Q Exp
-- | Test all properties in the current module. This is just a convenience
-- function that combines quickCheckAll and verbose.
--
-- verboseCheckAll has the same issue with scoping as
-- quickCheckAll: see the note there about return [].
verboseCheckAll :: Q Exp
-- | Test all properties in the current module, using a custom
-- quickCheck function. The same caveats as with
-- quickCheckAll apply.
--
-- $forAllProperties has type (Property ->
-- IO Result) -> IO Bool. An example
-- invocation is $forAllProperties
-- quickCheckResult, which does the same thing as
-- $quickCheckAll.
--
-- forAllProperties has the same issue with scoping as
-- quickCheckAll: see the note there about return [].
forAllProperties :: Q Exp
-- | Test a polymorphic property, defaulting all type variables to
-- Integer.
--
-- Invoke as $(polyQuickCheck 'prop), where prop
-- is a property. Note that just evaluating quickCheck
-- prop in GHCi will seem to work, but will silently default all
-- type variables to ()!
--
-- $(polyQuickCheck 'prop) means the same as
-- quickCheck $(monomorphic 'prop). If you want to
-- supply custom arguments to polyQuickCheck, you will have to
-- combine quickCheckWith and monomorphic yourself.
--
-- If you want to use polyQuickCheck in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
polyQuickCheck :: Name -> ExpQ
-- | Test a polymorphic property, defaulting all type variables to
-- Integer. This is just a convenience function that combines
-- verboseCheck and monomorphic.
--
-- If you want to use polyVerboseCheck in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
polyVerboseCheck :: Name -> ExpQ
-- | Monomorphise an arbitrary property by defaulting all type variables to
-- Integer.
--
-- For example, if f has type Ord a => [a] ->
-- [a] then $(monomorphic 'f) has type
-- [Integer] -> [Integer].
--
-- If you want to use monomorphic in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
monomorphic :: Name -> ExpQ
-- | Allows testing of monadic values. Will generally follow this form:
--
--
-- prop_monadic a b = monadicIO $ do
-- a' <- run (f a)
-- b' <- run (f b)
-- -- ...
-- assert someBoolean
--
--
-- Example using the FACTOR(1) command-line utility:
--
--
-- import System.Process
-- import Test.QuickCheck
-- import Test.QuickCheck.Monadic
--
-- -- $ factor 16
-- -- 16: 2 2 2 2
-- factor :: Integer -> IO [Integer]
-- factor n = parse `fmap` readProcess "factor" [show n] "" where
--
-- parse :: String -> [Integer]
-- parse = map read . tail . words
--
-- prop_factor :: Positive Integer -> Property
-- prop_factor (Positive n) = monadicIO $ do
-- factors <- run (factor n)
--
-- assert (product factors == n)
--
--
--
-- >>> quickCheck prop_factor
-- +++ OK, passed 100 tests.
--
--
-- See the paper "Testing Monadic Code with QuickCheck".
module Test.QuickCheck.Monadic
-- | The property monad is really a monad transformer that can contain
-- monadic computations in the monad m it is parameterized by:
--
--
-- - m - the m-computations that may be performed
-- within PropertyM
--
--
-- Elements of PropertyM m a may mix property operations and
-- m-computations.
newtype PropertyM m a
MkPropertyM :: ((a -> Gen (m Property)) -> Gen (m Property)) -> PropertyM m a
[unPropertyM] :: PropertyM m a -> (a -> Gen (m Property)) -> Gen (m Property)
-- | The lifting operation of the property monad. Allows embedding
-- monadic/IO-actions in properties:
--
--
-- log :: Int -> IO ()
--
-- prop_foo n = monadicIO $ do
-- run (log n)
-- -- ...
--
run :: Monad m => m a -> PropertyM m a
-- | Allows embedding non-monadic properties into monadic ones.
assert :: Monad m => Bool -> PropertyM m ()
-- | Tests preconditions. Unlike assert this does not cause the
-- property to fail, rather it discards them just like using the
-- implication combinator ==>.
--
-- This allows representing the Hoare triple
--
--
-- {p} x ← e{q}
--
--
-- as
--
--
-- pre p
-- x <- run e
-- assert q
--
pre :: Monad m => Bool -> PropertyM m ()
-- | The weakest precondition
--
--
-- wp(x ← e, p)
--
--
-- can be expressed as in code as wp e (\x -> p).
wp :: Monad m => m a -> (a -> PropertyM m b) -> PropertyM m b
-- | Quantification in a monadic property, fits better with
-- do-notation than forAllM.
pick :: (Monad m, Show a) => Gen a -> PropertyM m a
-- | An alternative to quantification a monadic properties to pick,
-- with a notation similar to forAll.
forAllM :: (Monad m, Show a) => Gen a -> (a -> PropertyM m b) -> PropertyM m b
-- | Allows making observations about the test data:
--
--
-- monitor (collect e)
--
--
-- collects the distribution of value of e.
--
--
-- monitor (counterexample "Failure!")
--
--
-- Adds "Failure!" to the counterexamples.
monitor :: Monad m => (Property -> Property) -> PropertyM m ()
stop :: (Testable prop, Monad m) => prop -> PropertyM m a
monadic :: Monad m => (m Property -> Property) -> PropertyM m a -> Property
monadic' :: Monad m => PropertyM m a -> Gen (m Property)
-- | Runs the property monad for IO-computations.
--
--
-- prop_cat msg = monadicIO $ do
-- (exitCode, stdout, _) <- run (readProcessWithExitCode "cat" [] msg)
--
-- pre (ExitSuccess == exitCode)
--
-- assert (stdout == msg)
--
--
--
-- >>> quickCheck prop_cat
-- +++ OK, passed 100 tests.
--
monadicIO :: PropertyM IO a -> Property
-- | Runs the property monad for ST-computations.
--
--
-- -- Your mutable sorting algorithm here
-- sortST :: Ord a => [a] -> ST s (MVector s a)
-- sortST = thaw . fromList . sort
--
-- prop_sortST xs = monadicST $ do
-- sorted <- run (freeze =<< sortST xs)
-- assert (toList sorted == sort xs)
--
--
--
-- >>> quickCheck prop_sortST
-- +++ OK, passed 100 tests.
--
monadicST :: (forall s. PropertyM (ST s) a) -> Property
runSTGen :: (forall s. Gen (ST s a)) -> Gen a
instance GHC.Base.Functor (Test.QuickCheck.Monadic.PropertyM m)
instance GHC.Base.Monad m => GHC.Base.Applicative (Test.QuickCheck.Monadic.PropertyM m)
instance GHC.Base.Monad m => GHC.Base.Monad (Test.QuickCheck.Monadic.PropertyM m)
instance Control.Monad.Trans.Class.MonadTrans Test.QuickCheck.Monadic.PropertyM
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.IO.Class.MonadIO (Test.QuickCheck.Monadic.PropertyM m)
-- | For further information see the QuickCheck manual.
--
-- To use QuickCheck to check a property, first define a function
-- expressing that property (functions expressing properties under test
-- tend to be prefixed with prop_). Testing that n + m = m +
-- n holds for Integers one might write:
--
--
-- import Test.QuickCheck
--
-- prop_commutativeAdd :: Integer -> Integer -> Bool
-- prop_commutativeAdd n m = n + m == m + n
--
--
-- and testing:
--
--
-- >>> quickCheck prop_commutativeAdd
-- +++ OK, passed 100 tests.
--
--
-- which tests prop_commutativeAdd on 100 random (Integer,
-- Integer) pairs.
--
-- verboseCheck can be used to see the actual values generated:
--
--
-- >>> verboseCheck prop_commutativeAdd
-- Passed:
-- 0
-- 0
-- …98 tests omitted…
-- Passed:
-- -68
-- 6
-- +++ OK, passed 100 tests.
--
--
-- and if more than 100 tests are needed the number of tests can be
-- increased by updating the stdArgs record:
--
--
-- >>> quickCheckWith stdArgs { maxSuccess = 500 } prop_commutativeAdd
-- +++ OK, passed 500 tests.
--
--
-- To let QuickCheck generate values of your own data type an
-- Arbitrary instance must be defined:
--
--
-- data Point = MkPoint Int Int deriving Eq
--
-- instance Arbitrary Point where
-- arbitrary = do
-- x <- arbitrary
-- y <- arbitrary
-- return (MkPoint x y)
--
-- swapPoint :: Point -> Point
-- swapPoint (MkPoint x y) = MkPoint y x
--
-- -- swapPoint . swapPoint = id
-- prop_swapInvolution point = swapPoint (swapPoint point) == point
--
--
--
-- >>> quickCheck prop_swapInvolution
-- +++ OK, passed 100 tests.
--
--
-- See Test.QuickCheck.Function for generating random shrinkable,
-- showable functions used for testing higher-order functions and
-- Test.QuickCheck.Monadic for testing impure or monadic code
-- (e.g. effectful code in IO).
module Test.QuickCheck
-- | Tests a property and prints the results to stdout.
quickCheck :: Testable prop => prop -> IO ()
-- | Args specifies arguments to the QuickCheck driver
data Args
Args :: Maybe (QCGen, Int) -> Int -> Int -> Int -> Bool -> Args
-- | Should we replay a previous test? Note: saving a seed from one version
-- of QuickCheck and replaying it in another is not supported. If you
-- want to store a test case permanently you should save the test case
-- itself.
[replay] :: Args -> Maybe (QCGen, Int)
-- | Maximum number of successful tests before succeeding
[maxSuccess] :: Args -> Int
-- | Maximum number of discarded tests per successful test before giving up
[maxDiscardRatio] :: Args -> Int
-- | Size to use for the biggest test cases
[maxSize] :: Args -> Int
-- | Whether to print anything
[chatty] :: Args -> Bool
-- | Result represents the test result
data Result
-- | A successful test run
Success :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | Given up
GaveUp :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | A failed test run
Failure :: Int -> Int -> Int -> Int -> QCGen -> Int -> String -> Maybe AnException -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Number of successful shrinking steps performed
[numShrinks] :: Result -> Int
-- | Number of unsuccessful shrinking steps performed
[numShrinkTries] :: Result -> Int
-- | Number of unsuccessful shrinking steps performed since last successful
-- shrink
[numShrinkFinal] :: Result -> Int
-- | What seed was used
[usedSeed] :: Result -> QCGen
-- | What was the test size
[usedSize] :: Result -> Int
-- | Why did the property fail
[reason] :: Result -> String
-- | The exception the property threw, if any
[theException] :: Result -> Maybe AnException
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | A property that should have failed did not
NoExpectedFailure :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | The tests passed but a use of cover had insufficient coverage
InsufficientCoverage :: Int -> [(String, Int)] -> String -> Result
-- | Number of tests performed
[numTests] :: Result -> Int
-- | Labels and frequencies found during all successful tests
[labels] :: Result -> [(String, Int)]
-- | Printed output
[output] :: Result -> String
-- | The default test arguments
stdArgs :: Args
-- | Tests a property, using test arguments, and prints the results to
-- stdout.
quickCheckWith :: Testable prop => Args -> prop -> IO ()
-- | Tests a property, using test arguments, produces a test result, and
-- prints the results to stdout.
quickCheckWithResult :: Testable prop => Args -> prop -> IO Result
-- | Tests a property, produces a test result, and prints the results to
-- stdout.
quickCheckResult :: Testable prop => prop -> IO Result
-- | Tests a property and prints the results and all test cases generated
-- to stdout. This is just a convenience function that means the
-- same as quickCheck . verbose.
verboseCheck :: Testable prop => prop -> IO ()
-- | Tests a property, using test arguments, and prints the results and all
-- test cases generated to stdout. This is just a convenience
-- function that combines quickCheckWith and verbose.
verboseCheckWith :: Testable prop => Args -> prop -> IO ()
-- | Tests a property, using test arguments, produces a test result, and
-- prints the results and all test cases generated to stdout.
-- This is just a convenience function that combines
-- quickCheckWithResult and verbose.
verboseCheckWithResult :: Testable prop => Args -> prop -> IO Result
-- | Tests a property, produces a test result, and prints the results and
-- all test cases generated to stdout. This is just a
-- convenience function that combines quickCheckResult and
-- verbose.
verboseCheckResult :: Testable prop => prop -> IO Result
-- | Test all properties in the current module. The name of the property
-- must begin with prop_. Polymorphic properties will be
-- defaulted to Integer. Returns True if all tests
-- succeeded, False otherwise.
--
-- To use quickCheckAll, add a definition to your module along the
-- lines of
--
--
-- return []
-- runTests = $quickCheckAll
--
--
-- and then execute runTests.
--
-- Note: the bizarre return [] in the example above is needed on
-- GHC 7.8; without it, quickCheckAll will not be able to find any
-- of the properties. For the curious, the return [] is a
-- Template Haskell splice that makes GHC insert the empty list of
-- declarations at that point in the program; GHC typechecks everything
-- before the return [] before it starts on the rest of the
-- module, which means that the later call to quickCheckAll can
-- see everything that was defined before the return []. Yikes!
quickCheckAll :: Q Exp
-- | Test all properties in the current module. This is just a convenience
-- function that combines quickCheckAll and verbose.
--
-- verboseCheckAll has the same issue with scoping as
-- quickCheckAll: see the note there about return [].
verboseCheckAll :: Q Exp
-- | Test all properties in the current module, using a custom
-- quickCheck function. The same caveats as with
-- quickCheckAll apply.
--
-- $forAllProperties has type (Property ->
-- IO Result) -> IO Bool. An example
-- invocation is $forAllProperties
-- quickCheckResult, which does the same thing as
-- $quickCheckAll.
--
-- forAllProperties has the same issue with scoping as
-- quickCheckAll: see the note there about return [].
forAllProperties :: Q Exp
-- | Test a polymorphic property, defaulting all type variables to
-- Integer.
--
-- Invoke as $(polyQuickCheck 'prop), where prop
-- is a property. Note that just evaluating quickCheck
-- prop in GHCi will seem to work, but will silently default all
-- type variables to ()!
--
-- $(polyQuickCheck 'prop) means the same as
-- quickCheck $(monomorphic 'prop). If you want to
-- supply custom arguments to polyQuickCheck, you will have to
-- combine quickCheckWith and monomorphic yourself.
--
-- If you want to use polyQuickCheck in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
polyQuickCheck :: Name -> ExpQ
-- | Test a polymorphic property, defaulting all type variables to
-- Integer. This is just a convenience function that combines
-- verboseCheck and monomorphic.
--
-- If you want to use polyVerboseCheck in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
polyVerboseCheck :: Name -> ExpQ
-- | Monomorphise an arbitrary property by defaulting all type variables to
-- Integer.
--
-- For example, if f has type Ord a => [a] ->
-- [a] then $(monomorphic 'f) has type
-- [Integer] -> [Integer].
--
-- If you want to use monomorphic in the same file where you
-- defined the property, the same scoping problems pop up as in
-- quickCheckAll: see the note there about return [].
monomorphic :: Name -> ExpQ
-- | A generator for values of type a.
data Gen a
-- | Generates a random element in the given inclusive range.
choose :: Random a => (a, a) -> Gen a
-- | Randomly uses one of the given generators. The input list must be
-- non-empty.
oneof :: [Gen a] -> Gen a
-- | Chooses one of the given generators, with a weighted random
-- distribution. The input list must be non-empty.
frequency :: [(Int, Gen a)] -> Gen a
-- | Generates one of the given values. The input list must be non-empty.
elements :: [a] -> Gen a
-- | Takes a list of elements of increasing size, and chooses among an
-- initial segment of the list. The size of this initial segment
-- increases with the size parameter. The input list must be non-empty.
growingElements :: [a] -> Gen a
-- | Used to construct generators that depend on the size parameter.
sized :: (Int -> Gen a) -> Gen a
-- | Overrides the size parameter. Returns a generator which uses the given
-- size instead of the runtime-size parameter.
resize :: Int -> Gen a -> Gen a
-- | Adjust the size parameter, by transforming it with the given function.
scale :: (Int -> Int) -> Gen a -> Gen a
-- | Generates a value that satisfies a predicate.
suchThat :: Gen a -> (a -> Bool) -> Gen a
-- | Tries to generate a value that satisfies a predicate.
suchThatMaybe :: Gen a -> (a -> Bool) -> Gen (Maybe a)
-- | Generates a list of random length. The maximum length depends on the
-- size parameter.
listOf :: Gen a -> Gen [a]
-- | Generates a non-empty list of random length. The maximum length
-- depends on the size parameter.
listOf1 :: Gen a -> Gen [a]
-- | Generates a list of the given length.
vectorOf :: Int -> Gen a -> Gen [a]
-- | Generates an infinite list.
infiniteListOf :: Gen a -> Gen [a]
-- | Generates a random permutation of the given list.
shuffle :: [a] -> Gen [a]
-- | Generates a random subsequence of the given list.
sublistOf :: [a] -> Gen [a]
-- | Generates a list of a given length.
vector :: Arbitrary a => Int -> Gen [a]
-- | Generates an ordered list.
orderedList :: (Ord a, Arbitrary a) => Gen [a]
-- | Generate an infinite list.
infiniteList :: Arbitrary a => Gen [a]
-- | Run a generator. The size passed to the generator is always 30; if you
-- want another size then you should explicitly use resize.
generate :: Gen a -> IO a
-- | Generates some example values and prints them to stdout.
sample :: Show a => Gen a -> IO ()
-- | Generates some example values.
sample' :: Gen a -> IO [a]
-- | Random generation and shrinking of values.
class Arbitrary a where shrink _ = []
-- | A generator for values of the given type.
arbitrary :: Arbitrary a => Gen a
-- | Produces a (possibly) empty list of all the possible immediate shrinks
-- of the given value. The default implementation returns the empty list,
-- so will not try to shrink the value.
--
-- Most implementations of shrink should try at least three
-- things:
--
--
-- - Shrink a term to any of its immediate subterms.
-- - Recursively apply shrink to all immediate subterms.
-- - Type-specific shrinkings such as replacing a constructor by a
-- simpler constructor.
--
--
-- For example, suppose we have the following implementation of binary
-- trees:
--
--
-- data Tree a = Nil | Branch a (Tree a) (Tree a)
--
--
-- We can then define shrink as follows:
--
--
-- shrink Nil = []
-- shrink (Branch x l r) =
-- -- shrink Branch to Nil
-- [Nil] ++
-- -- shrink to subterms
-- [l, r] ++
-- -- recursively shrink subterms
-- [Branch x' l' r' | (x', l', r') <- shrink (x, l, r)]
--
--
-- There are a couple of subtleties here:
--
--
-- - QuickCheck tries the shrinking candidates in the order they appear
-- in the list, so we put more aggressive shrinking steps (such as
-- replacing the whole tree by Nil) before smaller ones (such as
-- recursively shrinking the subtrees).
-- - It is tempting to write the last line as [Branch x' l' r' | x'
-- <- shrink x, l' <- shrink l, r' <- shrink r] but this is
-- the wrong thing! It will force QuickCheck to shrink x,
-- l and r in tandem, and shrinking will stop once
-- one of the three is fully shrunk.
--
--
-- There is a fair bit of boilerplate in the code above. We can avoid it
-- with the help of some generic functions; note that these only work on
-- GHC 7.2 and above. The function genericShrink tries shrinking a
-- term to all of its subterms and, failing that, recursively shrinks the
-- subterms. Using it, we can define shrink as:
--
--
-- shrink x = shrinkToNil x ++ genericShrink x
-- where
-- shrinkToNil Nil = []
-- shrinkToNil (Branch _ l r) = [Nil]
--
--
-- genericShrink is a combination of subterms, which
-- shrinks a term to any of its subterms, and recursivelyShrink,
-- which shrinks all subterms of a term. These may be useful if you need
-- a bit more control over shrinking than genericShrink gives you.
--
-- A final gotcha: we cannot define shrink as simply
-- shrink x = Nil:genericShrink x as this shrinks
-- Nil to Nil, and shrinking will go into an infinite
-- loop.
--
-- If all this leaves you bewildered, you might try shrink =
-- genericShrink to begin with, after deriving
-- Generic for your type. However, if your data type has any
-- special invariants, you will need to check that genericShrink
-- can't break those invariants.
shrink :: Arbitrary a => a -> [a]
-- | Used for random generation of functions.
--
-- If you are using a recent GHC, there is a default definition of
-- coarbitrary using genericCoarbitrary, so if your type
-- has a Generic instance it's enough to say
--
--
-- instance CoArbitrary MyType
--
--
-- You should only use genericCoarbitrary for data types where
-- equality is structural, i.e. if you can't have two different
-- representations of the same value. An example where it's not safe is
-- sets implemented using binary search trees: the same set can be
-- represented as several different trees. Here you would have to
-- explicitly define coarbitrary s = coarbitrary (toList s).
class CoArbitrary a where coarbitrary = genericCoarbitrary
-- | Used to generate a function of type a -> b. The first
-- argument is a value, the second a generator. You should use
-- variant to perturb the random generator; the goal is that
-- different values for the first argument will lead to different calls
-- to variant. An example will help:
--
--
-- instance CoArbitrary a => CoArbitrary [a] where
-- coarbitrary [] = variant 0
-- coarbitrary (x:xs) = variant 1 . coarbitrary (x,xs)
--
coarbitrary :: CoArbitrary a => a -> Gen b -> Gen b
-- | Used to generate a function of type a -> b. The first
-- argument is a value, the second a generator. You should use
-- variant to perturb the random generator; the goal is that
-- different values for the first argument will lead to different calls
-- to variant. An example will help:
--
--
-- instance CoArbitrary a => CoArbitrary [a] where
-- coarbitrary [] = variant 0
-- coarbitrary (x:xs) = variant 1 . coarbitrary (x,xs)
--
coarbitrary :: (CoArbitrary a, Generic a, GCoArbitrary (Rep a)) => a -> Gen b -> Gen b
-- | Generates an integral number. The number can be positive or negative
-- and its maximum absolute value depends on the size parameter.
arbitrarySizedIntegral :: Integral a => Gen a
-- | Generates a natural number. The number's maximum value depends on the
-- size parameter.
arbitrarySizedNatural :: Integral a => Gen a
-- | Generates a fractional number. The number can be positive or negative
-- and its maximum absolute value depends on the size parameter.
arbitrarySizedFractional :: Fractional a => Gen a
-- | Generates an integral number from a bounded domain. The number is
-- chosen from the entire range of the type, but small numbers are
-- generated more often than big numbers. Inspired by demands from Phil
-- Wadler.
arbitrarySizedBoundedIntegral :: (Bounded a, Integral a) => Gen a
-- | Generates an integral number. The number is chosen uniformly from the
-- entire range of the type. You may want to use
-- arbitrarySizedBoundedIntegral instead.
arbitraryBoundedIntegral :: (Bounded a, Integral a) => Gen a
-- | Generates an element of a bounded type. The element is chosen from the
-- entire range of the type.
arbitraryBoundedRandom :: (Bounded a, Random a) => Gen a
-- | Generates an element of a bounded enumeration.
arbitraryBoundedEnum :: (Bounded a, Enum a) => Gen a
-- | Generic CoArbitrary implementation.
genericCoarbitrary :: (Generic a, GCoArbitrary (Rep a)) => a -> Gen b -> Gen b
-- | Shrink a term to any of its immediate subterms, and also recursively
-- shrink all subterms.
genericShrink :: (Generic a, RecursivelyShrink (Rep a), GSubterms (Rep a) a) => a -> [a]
-- | All immediate subterms of a term.
subterms :: (Generic a, GSubterms (Rep a) a) => a -> [a]
-- | Recursively shrink all immediate subterms.
recursivelyShrink :: (Generic a, RecursivelyShrink (Rep a)) => a -> [a]
-- | Returns no shrinking alternatives.
shrinkNothing :: a -> [a]
-- | Shrink a list of values given a shrinking function for individual
-- values.
shrinkList :: (a -> [a]) -> [a] -> [[a]]
-- | Shrink an integral number.
shrinkIntegral :: Integral a => a -> [a]
-- | Shrink a fraction.
shrinkRealFrac :: RealFrac a => a -> [a]
-- | Shrink a fraction, but only shrink to integral values.
shrinkRealFracToInteger :: RealFrac a => a -> [a]
-- | Modifies a generator using an integer seed.
variant :: Integral n => n -> Gen a -> Gen a
-- | A coarbitrary implementation for integral numbers.
coarbitraryIntegral :: Integral a => a -> Gen b -> Gen b
-- | A coarbitrary implementation for real numbers.
coarbitraryReal :: Real a => a -> Gen b -> Gen b
-- | coarbitrary helper for lazy people :-).
coarbitraryShow :: Show a => a -> Gen b -> Gen b
-- | A coarbitrary implementation for enums.
coarbitraryEnum :: Enum a => a -> Gen b -> Gen b
-- | Combine two generator perturbing functions, for example the results of
-- calls to variant or coarbitrary.
-- | Deprecated: Use ordinary function composition instead
(><) :: (Gen a -> Gen a) -> (Gen a -> Gen a) -> (Gen a -> Gen a)
-- | Blind x: as x, but x does not have to be in the Show
-- class.
newtype Blind a
Blind :: a -> Blind a
[getBlind] :: Blind a -> a
-- | Fixed x: as x, but will not be shrunk.
newtype Fixed a
Fixed :: a -> Fixed a
[getFixed] :: Fixed a -> a
-- | Ordered xs: guarantees that xs is ordered.
newtype OrderedList a
Ordered :: [a] -> OrderedList a
[getOrdered] :: OrderedList a -> [a]
-- | NonEmpty xs: guarantees that xs is non-empty.
newtype NonEmptyList a
NonEmpty :: [a] -> NonEmptyList a
[getNonEmpty] :: NonEmptyList a -> [a]
-- | Positive x: guarantees that x > 0.
newtype Positive a
Positive :: a -> Positive a
[getPositive] :: Positive a -> a
-- | NonZero x: guarantees that x /= 0.
newtype NonZero a
NonZero :: a -> NonZero a
[getNonZero] :: NonZero a -> a
-- | NonNegative x: guarantees that x >= 0.
newtype NonNegative a
NonNegative :: a -> NonNegative a
[getNonNegative] :: NonNegative a -> a
-- | Large x: by default, QuickCheck generates Ints drawn
-- from a small range. Large Int gives you values drawn from the
-- entire range instead.
newtype Large a
Large :: a -> Large a
[getLarge] :: Large a -> a
-- | Small x: generates values of x drawn from a small
-- range. The opposite of Large.
newtype Small a
Small :: a -> Small a
[getSmall] :: Small a -> a
-- | Smart _ x: tries a different order when shrinking.
data Smart a
Smart :: Int -> a -> Smart a
-- | Shrink2 x: allows 2 shrinking steps at the same time when
-- shrinking x
newtype Shrink2 a
Shrink2 :: a -> Shrink2 a
[getShrink2] :: Shrink2 a -> a
-- | Shrinking _ x: allows for maintaining a state during
-- shrinking.
data Shrinking s a
Shrinking :: s -> a -> Shrinking s a
class ShrinkState s a
shrinkInit :: ShrinkState s a => a -> s
shrinkState :: ShrinkState s a => a -> s -> [(a, s)]
-- | The type of properties.
--
-- Backwards combatibility note: in older versions of QuickCheck
-- Property was a type synonym for Gen
-- Prop, so you could mix and match property combinators and
-- Gen monad operations. Code that does this will no longer
-- typecheck. However, it is easy to fix: because of the Testable
-- typeclass, any combinator that expects a Property will also
-- accept a Gen Property. If you have a
-- Property where you need a Gen a,
-- simply wrap the property combinator inside a return to get a
-- Gen Property, and all should be well.
data Property
-- | The class of things which can be tested, i.e. turned into a property.
class Testable prop
-- | Convert the thing to a property.
property :: Testable prop => prop -> Property
-- | Explicit universal quantification: uses an explicitly given test case
-- generator.
forAll :: (Show a, Testable prop) => Gen a -> (a -> prop) -> Property
-- | Like forAll, but tries to shrink the argument for failing test
-- cases.
forAllShrink :: (Show a, Testable prop) => Gen a -> (a -> [a]) -> (a -> prop) -> Property
-- | Shrinks the argument to property if it fails. Shrinking is done
-- automatically for most types. This is only needed when you want to
-- override the default behavior.
shrinking :: Testable prop => (a -> [a]) -> a -> (a -> prop) -> Property
-- | Implication for properties: The resulting property holds if the first
-- argument is False (in which case the test case is discarded),
-- or if the given property holds.
(==>) :: Testable prop => Bool -> prop -> Property
infixr 0 ==>
-- | Like ==, but prints a counterexample when it fails.
(===) :: (Eq a, Show a) => a -> a -> Property
infix 4 ===
-- | Do I/O inside a property. This can obviously lead to unrepeatable
-- testcases, so use with care.
--
-- For more advanced monadic testing you may want to look at
-- Test.QuickCheck.Monadic.
--
-- Note that if you use ioProperty on a property of type IO
-- Bool, or more generally a property that does no quantification,
-- the property will only be executed once. To test the property
-- repeatedly you must use the again combinator.
ioProperty :: Testable prop => IO prop -> Property
-- | Prints out the generated testcase every time the property is tested.
-- Only variables quantified over inside the verbose are
-- printed.
verbose :: Testable prop => prop -> Property
-- | Modifies a property so that it only will be tested once.
once :: Testable prop => prop -> Property
-- | Undoes the effect of once.
again :: Testable prop => prop -> Property
-- | Considers a property failed if it does not complete within the given
-- number of microseconds.
within :: Testable prop => Int -> prop -> Property
-- | Disables shrinking for a property altogether.
noShrinking :: Testable prop => prop -> Property
-- | Nondeterministic choice: p1 .&. p2 picks
-- randomly one of p1 and p2 to test. If you test the
-- property 100 times it makes 100 random choices.
(.&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .&.
-- | Conjunction: p1 .&&. p2 passes if
-- both p1 and p2 pass.
(.&&.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .&&.
-- | Take the conjunction of several properties.
conjoin :: Testable prop => [prop] -> Property
-- | Disjunction: p1 .||. p2 passes unless
-- p1 and p2 simultaneously fail.
(.||.) :: (Testable prop1, Testable prop2) => prop1 -> prop2 -> Property
infixr 1 .||.
-- | Take the disjunction of several properties.
disjoin :: Testable prop => [prop] -> Property
-- | Adds the given string to the counterexample.
counterexample :: Testable prop => String -> prop -> Property
-- | Adds the given string to the counterexample.
-- | Deprecated: Use counterexample instead
printTestCase :: Testable prop => String -> prop -> Property
-- | Performs an IO action after the last failure of a property.
whenFail :: Testable prop => IO () -> prop -> Property
-- | 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.
whenFail' :: Testable prop => IO () -> prop -> Property
-- | Indicates that a property is supposed to fail. QuickCheck will report
-- an error if it does not fail.
expectFailure :: Testable prop => prop -> Property
-- | Attaches a label to a property. This is used for reporting test case
-- distribution.
label :: Testable prop => String -> prop -> Property
-- | Labels a property with a value:
--
--
-- collect x = label (show x)
--
collect :: (Show a, Testable prop) => a -> prop -> Property
-- | Conditionally labels test case.
classify :: Testable prop => Bool -> String -> prop -> Property
-- | Checks that at least the given proportion of successful test
-- cases belong to the given class. Discarded tests (i.e. ones with a
-- false precondition) do not affect coverage.
cover :: Testable prop => Bool -> Int -> String -> prop -> Property
-- | If a property returns Discard, the current test case is
-- discarded, the same as if a precondition was false.
data Discard
Discard :: Discard
-- | A special exception that makes QuickCheck discard the test case.
-- Normally you should use ==>, but if for some reason this
-- isn't possible (e.g. you are deep inside a generator), use
-- discard instead.
discard :: a
-- | Changes the maximum test case size for a property.
mapSize :: Testable prop => (Int -> Int) -> prop -> Property