hedgehog: Hedgehog will eat all your bugs.

[ bsd3, library, testing ] [ Propose Tags ]

Hedgehog is a modern property-based testing system, in the spirit of QuickCheck. Hedgehog uses integrated shrinking, so shrinks obey the invariants of generated values by construction.

To get started quickly, see the examples: https://github.com/hedgehogqa/haskell-hedgehog/tree/master/hedgehog-example


[Skip to Readme]
Versions 0.1, 0.2, 0.2.1, 0.2.2, 0.3, 0.4, 0.4.1, 0.5, 0.5.1, 0.5.2, 0.5.3, 0.6, 0.6.1
Change log CHANGELOG.md
Dependencies ansi-terminal (>=0.6 && <0.9), async (>=2.0 && <2.3), base (>=3 && <5), bytestring (==0.10.*), concurrent-output (>=1.7 && <1.11), containers (>=0.4 && <0.7), directory (>=1.2 && <1.4), exceptions (>=0.7 && <0.11), lifted-async (>=0.7 && <0.11), mmorph (>=1.0 && <1.2), monad-control (==1.0.*), mtl (>=2.1 && <2.3), pretty-show (>=1.6 && <1.9), primitive (==0.6.*), random (==1.1.*), resourcet (>=1.1 && <1.3), semigroups (>=0.16 && <0.19), stm (>=2.4 && <2.6), template-haskell (>=2.10 && <2.15), text (>=1.1 && <1.3), th-lift (==0.7.*), time (>=1.4 && <1.10), transformers (>=0.4 && <0.6), transformers-base (==0.4.*), unix (>=2.6 && <2.8), wl-pprint-annotated (>=0.0 && <0.2) [details]
License BSD-3-Clause
Author Jacob Stanley
Maintainer Jacob Stanley <jacob@stanley.io>
Revised Revision 1 made by GeorgeWilson at Thu Sep 27 00:03:03 UTC 2018
Category Testing
Home page https://hedgehog.qa
Bug tracker https://github.com/hedgehogqa/haskell-hedgehog/issues
Source repo head: git clone git://github.com/hedgehogqa/haskell-hedgehog.git
Uploaded by JacobStanley at Sat Sep 22 07:50:18 UTC 2018
Distributions Arch:0.6.1, LTSHaskell:0.6.1, NixOS:0.6.1, Stackage:0.6.1
Downloads 6063 total (233 in the last 30 days)
Rating 2.75 (votes: 9) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-09-22 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hedgehog-0.6.1

[back to package description]

hedgehog Hackage Travis

Hedgehog will eat all your bugs.

<img src="https://github.com/hedgehogqa/haskell-hedgehog/raw/master/img/hedgehog-logo.png" width="307" align="right"/>

Hedgehog is a modern property-based testing system, in the spirit of QuickCheck. Hedgehog uses integrated shrinking, so shrinks obey the invariants of generated values by construction.

Features

  • Integrated shrinking, shrinks obey invariants by construction.
  • Abstract state machine testing.
  • Generators allow monadic effects.
  • Range combinators for full control over the scope of generated numbers and collections.
  • Equality and roundtrip assertions show a diff instead of the two inequal values.
  • Template Haskell test runner which executes properties concurrently.

Example

The main module, Hedgehog, includes almost everything you need to get started writing property tests with Hedgehog.

It is designed to be used alongside Hedgehog.Gen and Hedgehog.Range which should be imported qualified. You also need to enable Template Haskell so the Hedgehog test runner can find your properties.

{-# LANGUAGE TemplateHaskell #-}

import           Hedgehog
import qualified Hedgehog.Gen as Gen
import qualified Hedgehog.Range as Range

Once you have your imports set up, you can write a simple property:

prop_reverse :: Property
prop_reverse =
  property $ do
    xs <- forAll $ Gen.list (Range.linear 0 100) Gen.alpha
    reverse (reverse xs) === xs

And add the Template Haskell splice which will discover your properties:

tests :: IO Bool
tests =
  checkParallel $$(discover)

If you prefer to avoid macros, you can specify the group of properties to run manually instead:

{-# LANGUAGE OverloadedStrings #-}

tests :: IO Bool
tests =
  checkParallel $ Group "Test.Example" [
      ("prop_reverse", prop_reverse)
    ]

You can then load the module in GHCi, and run it:

λ tests
━━━ Test.Example ━━━
  ✓ prop_reverse passed 100 tests.