Idris2Doc : Hedgehog.Internal.Runner

Hedgehog.Internal.Runner

(source)

Definitions

TestRes : Type
Totality: total
Visibility: public export
checkReport : Monad m => PropertyConfig -> Maybe Size -> StdGen -> PropertyT () -> (Report Progress -> m ()) -> m (Report Result)
  The low-level runner behind `check`, returning the full `Report Result`.

Totality: total
Visibility: export
checkNamed : CanInitSeed StdGen m => HasConfig m => HasTerminal m => Monad m => PropertyName -> Property -> m Bool
  Check a property.

Totality: total
Visibility: export
check : CanInitSeed StdGen m => HasConfig m => HasTerminal m => Monad m => Property -> m Bool
  Check a property.

Totality: total
Visibility: export
recheck : HasConfig m => HasTerminal m => Monad m => Size -> StdGen -> Property -> m ()
  Check a property using a specific size and seed.

Totality: total
Visibility: export
checkGroup : CanInitSeed StdGen m => HasConfig m => HasTerminal m => Monad m => Group -> m Bool
Totality: total
Visibility: export
test : HasIO io => List Group -> io ()
  Simple test runner.

Use this in a `main` function in order to test a list of
property groups. The runner will take into account several
command line arguments in order to adjust the number of
tests to be run for each property, the maximal number of
shrinks and the confidence value to use.

```idris example
main : IO ()
main = test myGroups
```

The resulting executable can then be run as follows:

```sh
build/exec/runTests -n 1000
```

It will fail with an exit code of 1 if at least one property
fails.

Totality: total
Visibility: export