Run a list of tests

Label a test. Can be nested. A "." is placed between nested scopes, so scope "foo" . scope "bar" is equivalent to scope "foo.bar"

Explicitly skip this set of tests.

Run a unit test (same as unitTest). Example:

>>> run $ example $ 1 === 2
> ━━━ run ━━━
>   ✗ (unnamed) failed after 1 test.
>
>        ┏━━ tests/Suite.hs ━━━
>     26 ┃ main :: IO ()
>     27 ┃ main = do
>     28 ┃   run $ example $ 1 === (2 :: Int)
>        ┃   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>        ┃   │ Failed (- lhs =/= + rhs)
>        ┃   │ - 1
>        ┃   │ + 2
>
>     This failure can be reproduced by running:
>     > recheck (Size 0) (Seed 2914818620245020776 12314041441884757111) (unnamed)
>
>   ✗ 1 failed.

Run a unit test (same as example). Example:

>>> run $ unitTest $ 1 === 2
> ━━━ run ━━━
>   ✗ (unnamed) failed after 1 test.
>
>        ┏━━ tests/Suite.hs ━━━
>     26 ┃ main :: IO ()
>     27 ┃ main = do
>     28 ┃   run $ unitTest $ 1 === (2 :: Int)
>        ┃   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>        ┃   │ Failed (- lhs =/= + rhs)
>        ┃   │ - 1
>        ┃   │ + 2
>
>     This failure can be reproduced by running:
>     > recheck (Size 0) (Seed 2914818620245020776 12314041441884757111) (unnamed)
>
>   ✗ 1 failed.

Run a property test. Example:

>>> run $ scope "list reversal" $ property $ do
>..   list <- forAll $ Gen.list @_ @Int (Range.linear 0 100)
>..     (Gen.element [0..100])
>..   reverse (reverse list) === list
> ━━━ run ━━━
>   ✓ list reversal passed 100 tests.
>   ✓ 1 succeeded.

Run a property test with a custom configuration. This allows you to configure the propertyTestLimit, propertyDiscardLimit, propertyShrinkLimit, or propertyShrinkRetries. Example:

>>> run $ scope "list reversal" $ propertyWith (defaultConfig { propertyTestLimit = 500 }) $ do
>..   list <- forAll $ Gen.list @_ @Int (Range.linear 0 100)
>..     (Gen.element [0..100])
>..   reverse (reverse list) === list
> ━━━ run ━━━
>   ✓ list reversal passed 500 tests.
>   ✓ 1 succeeded.

Test whether a Prism matches. Example:

>>> main
> ━━━ run ━━━
>   ✓ (unnamed) passed 1 test.
>   ✗ (unnamed) failed after 1 test.
>
>        ┏━━ tests/Suite.hs ━━━
>     48 ┃ main :: IO ()
>     49 ┃ main = do
>     50 ┃   _ <- run $ tests
>     51 ┃     [ example $ matches _Left (Left 1   :: Either Int ())
>     52 ┃     , example $ matches _Left (Right () :: Either Int ())
>        ┃     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>     53 ┃     ]
>     54 ┃   pure ()
>
>     Prism failed to match
>
>     This failure can be reproduced by running:
>     > recheck (Size 0) (Seed 14003809197113786240 2614482618840800713) (unnamed)
>
>   ✗ 1 failed, 1 succeeded.

Use with _Just, _Nothing, _Left, _Right, or Control.Lens.Prism

Test whether a Prism doesn't match. Compare with matches.

Mark a test as pending.

Record a failure with a given message

Run all tests

Run all tests whose scope starts with the given prefix.

>>> runOnly "components.a" tests

Rerun all tests with the given seed

>>> rerun (Seed 2914818620245020776 12314041441884757111) tests

Rerun all tests with the given seed and whose scope starts with the given prefix

>>> rerunOnly "components.a" (Seed 2914818620245020776 12314041441884757111) tests

Make a test with setup and teardown steps.

A variant of bracket where the return value from the setup step is not required.

A specialised variant of bracket with just a teardown step.

Make this a cabal test suite for use with exitcode-stdio-1.0 test-suites.

This simply checks to see if any tests failed and if so exits with exitFailure.

A prism embodies one constructor of a sum type (as a lens embodies one part of a product type). See _Just, _Nothing, _Left, and _Right for examples. See Control.Lens.Prism for more explanation.

A type-restricted prism. See Control.Lens.Prism for more explanation.

Unit- or property- test.

A set of unit- and property-tests

A property test, along with some configurable limits like how many times to run the test.

The property monad transformer allows both the generation of test inputs and the assertion of expectations.

Fails the test if the two arguments provided are not equal.

Fails the test if the two arguments provided are equal.

A splittable random number generator.

A summary of all the properties executed.

Configuration for a property test.

The default configuration for a property test.