Safe Haskell | None |
---|---|

Language | Haskell2010 |

Most of the code is borrowed from a mailing list discussion. Therefor, credits go to Paul Johnson and Felix Martini.

## Synopsis

- data GenT m a
- runGenT :: GenT m a -> Gen (m a)
- class (Applicative g, Monad g) => MonadGen g where
- arbitrary' :: (Arbitrary a, MonadGen m) => m a
- oneof :: MonadGen m => [m a] -> m a
- frequency :: MonadGen m => [(Int, m a)] -> m a
- elements :: MonadGen m => [a] -> m a
- growingElements :: MonadGen m => [a] -> m a
- getSize :: MonadGen m => m Int
- scale :: MonadGen m => (Int -> Int) -> m a -> m a
- suchThat :: MonadGen m => m a -> (a -> Bool) -> m a
- suchThatMap :: MonadGen m => m a -> (a -> Maybe b) -> m b
- suchThatMaybe :: MonadGen m => m a -> (a -> Bool) -> m (Maybe a)
- applyArbitrary2 :: MonadGen m => (Arbitrary a, Arbitrary b) => (a -> b -> r) -> m r
- applyArbitrary3 :: MonadGen m => (Arbitrary a, Arbitrary b, Arbitrary c) => (a -> b -> c -> r) -> m r
- applyArbitrary4 :: MonadGen m => (Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d) => (a -> b -> c -> d -> r) -> m r
- listOf :: MonadGen m => m a -> m [a]
- listOf1 :: MonadGen m => m a -> m [a]
- vectorOf :: MonadGen m => Int -> m a -> m [a]
- vector :: (Arbitrary a, MonadGen m) => Int -> m [a]
- infiniteListOf :: MonadGen m => m a -> m [a]
- infiniteList :: (Arbitrary a, MonadGen m) => m [a]
- shuffle :: MonadGen m => [a] -> m [a]
- sublistOf :: MonadGen m => [a] -> m [a]
- orderedList :: (Ord a, Arbitrary a, MonadGen m) => m [a]
- class Arbitrary a where
- data Gen a
- oneofMay :: MonadGen m => [m a] -> m (Maybe a)
- elementsMay :: MonadGen m => [a] -> m (Maybe a)
- growingElementsMay :: MonadGen m => [a] -> m (Maybe a)

# Documentation

## Instances

MonadTrans GenT Source # | |

Defined in QuickCheck.GenT | |

Monad m => Monad (GenT m) Source # | |

Functor m => Functor (GenT m) Source # | |

(Functor m, Monad m) => Applicative (GenT m) Source # | |

MonadIO m => MonadIO (GenT m) Source # | |

Defined in QuickCheck.GenT | |

(Applicative m, Monad m) => MonadGen (GenT m) Source # | |

class (Applicative g, Monad g) => MonadGen g where Source #

liftGen :: Gen a -> g a Source #

variant :: Integral n => n -> g a -> g a Source #

sized :: (Int -> g a) -> g a Source #

# Lifted functions

arbitrary' :: (Arbitrary a, MonadGen m) => m a Source #

oneof :: MonadGen m => [m a] -> m a Source #

Randomly uses one of the given generators. The input list must be non-empty.

frequency :: MonadGen m => [(Int, m a)] -> m a Source #

Chooses one of the given generators, with a weighted random distribution. The input list must be non-empty.

elements :: MonadGen m => [a] -> m a Source #

Generates one of the given values. The input list must be non-empty.

growingElements :: MonadGen m => [a] -> m a Source #

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.

suchThat :: MonadGen m => m a -> (a -> Bool) -> m a Source #

Generates a value that satisfies a predicate.

suchThatMap :: MonadGen m => m a -> (a -> Maybe b) -> m b Source #

Generates a value for which the given function returns a `Just`

, and then
applies the function.

suchThatMaybe :: MonadGen m => m a -> (a -> Bool) -> m (Maybe a) Source #

Tries to generate a value that satisfies a predicate.

applyArbitrary3 :: MonadGen m => (Arbitrary a, Arbitrary b, Arbitrary c) => (a -> b -> c -> r) -> m r Source #

applyArbitrary4 :: MonadGen m => (Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d) => (a -> b -> c -> d -> r) -> m r Source #

listOf :: MonadGen m => m a -> m [a] Source #

Generates a list of random length. The maximum length depends on the size parameter.

listOf1 :: MonadGen m => m a -> m [a] Source #

Generates a non-empty list of random length. The maximum length depends on the size parameter.

infiniteListOf :: MonadGen m => m a -> m [a] Source #

infiniteList :: (Arbitrary a, MonadGen m) => m [a] Source #

# Re-exports

Random generation and shrinking of values.

QuickCheck provides `Arbitrary`

instances for most types in `base`

,
except those which incur extra dependencies.
For a wider range of `Arbitrary`

instances see the
quickcheck-instances
package.

A generator for values of the given type.

It is worth spending time thinking about what sort of test data
you want - good generators are often the difference between
finding bugs and not finding them. You can use `sample`

,
`label`

and `classify`

to check the quality of your test data.

There is no generic `arbitrary`

implementation included because we don't
know how to make a high-quality one. If you want one, consider using the
testing-feat or
generic-random packages.

The QuickCheck manual goes into detail on how to write good generators. Make sure to look at it, especially if your type is recursive!

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. If your data type has no special invariants, you can
enable shrinking by defining `shrink = `

, but by customising
the behaviour of `genericShrink`

`shrink`

you can often get simpler counterexamples.

Most implementations of `shrink`

should try at least three things:

- Shrink a term to any of its immediate subterms.
You can use
`subterms`

to do this. - Recursively apply
`shrink`

to all immediate subterms. You can use`recursivelyShrink`

to do this. - 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.
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

as this shrinks `shrink`

x = Nil:`genericShrink`

x`Nil`

to `Nil`

, and shrinking will go into an
infinite loop.

If all this leaves you bewildered, you might try

to begin with,
after deriving `shrink`

= `genericShrink`

`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.

## Instances

A generator for values of type `a`

.

The third-party packages
QuickCheck-GenT
and
quickcheck-transformer
provide monad transformer versions of `Gen`

.

# Safe functions

elementsMay :: MonadGen m => [a] -> m (Maybe a) Source #

Generates one of the given values.

growingElementsMay :: MonadGen m => [a] -> m (Maybe a) Source #

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.