The quickcheck-with-counterexamples package

[Tags:bsd3, library]

When QuickCheck finds a counterexample, it prints it out but doesn't save it so that the programmer can access it. This can be annoying when debugging.

This library provides a small extension to QuickCheck that returns counterexamples as normal Haskell values. To use it, just import Test.QuickCheck.Counterexamples instead of Test.QuickCheck. The library is largely compatible with normal QuickCheck, but the return types of quickCheck and related functions are changed to include a counterexample.

For usage information, see the Test.QuickCheck.Counterexamples module.


[Skip to Readme]

Properties

Versions 1.0
Dependencies base (==4.*), QuickCheck, template-haskell [details]
License BSD3
Author Nick Smallbone
Maintainer nick@smallbone.se
Stability Unknown
Category Testing
Home page http://www.github.com/nick8325/quickcheck-with-counterexamples
Source repository head: git clone https://github.com/nick8325/quickcheck-with-counterexamples
this: git clone https://github.com/nick8325/quickcheck-with-counterexamples(tag 1.0)
Uploaded Sun Jan 15 21:10:26 UTC 2017 by NickSmallbone
Updated Mon Jan 16 01:05:23 UTC 2017 by NickSmallbone to revision 3
Distributions NixOS:1.0
Downloads 24 total (5 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2017-01-15 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for quickcheck-with-counterexamples

Readme for quickcheck-with-counterexamples-1.0

When QuickCheck finds a counterexample, it prints it out but
doesn't save it so that the programmer can access it. This can be
annoying when debugging.

This library provides a small extension to QuickCheck that returns
counterexamples as normal Haskell values. To use it, just import
Test.QuickCheck.Counterexamples instead of Test.QuickCheck.
The library is largely compatible with normal QuickCheck, but the
return types of quickCheck and related functions are changed to
include a counterexample.

Here is an example of getting counterexamples.
Suppose we have the following property:

prop_reverse_append :: [Int] -> [Int] -> Property
prop_reverse_append xs ys =
  reverse (xs++ys) === reverse xs ++ reverse ys

If we look at the type of quickCheck, we see that it will return a
counterexample:

> :t quickCheck prop_reverse_append
quickCheck prop_reverse_append :: IO (Maybe ([Int] :&: [Int] :&: ()))

The Maybe is there because we get Nothing if the property succeeds;
":&:" is a datatype of pairs.

If we run QuickCheck, we can get the counterexample as a normal
Haskell value:

> Just (xs :&: ys :&: ()) <- quickCheck prop_reverse_append
*** Failed! Falsifiable (after 5 tests and 4 shrinks):    
[0]
[1]
[1,0] /= [0,1]

> :t xs
xs :: [Int]

> xs
[0]

> ys
[1]