Extrapolate.hs

-- |
-- Module      : Test.Extrapolate
-- Copyright   : (c) 2017 Rudy Matela
-- License     : 3-Clause BSD  (see the file LICENSE)
-- Maintainer  : Rudy Matela <rudy@matela.com.br>
--
-- Extrapolate is a property-based testing library capable of reporting
-- generalized counter-examples.
--
-- Consider the following faulty implementation of sort:
--
-- > sort :: Ord a => [a] -> [a]
-- > sort []      =  []
-- > sort (x:xs)  =  sort (filter (< x) xs)
-- >              ++ [x]
-- >              ++ sort (filter (> x) xs)
--
-- When tests pass, Extrapolate works like a regular property-based testing
-- library.  See:
--
-- > > check $ \xs -> sort (sort xs :: [Int]) == sort xs
-- > +++ OK, passed 360 tests.
--
-- When tests fail, Extrapolate reports a fully defined counter-example and a
-- generalization of failing inputs.  See:
--
-- > > > check $ \xs -> length (sort xs :: [Int]) == length xs
-- > *** Failed! Falsifiable (after 3 tests):
-- > [0,0]
-- >
-- > Generalization:
-- > x:x:_
--
-- The property fails for any integer @x@ and for any list @_@ at the tail.
module Test.Extrapolate
  (
-- * Checking properties
    check
  , checkResult
  , for
  , withBackground
  , withConditionSize

-- * Generalizable types
  , Generalizable (..)
  , this
  , Expr (..)
  , constant, showConstant
  , bgEq
  , bgOrd

-- * Testable properties
  , Testable

-- ** Automatically deriving Generalizable instances
  , deriveGeneralizable
  , deriveGeneralizableIfNeeded
  , deriveGeneralizableCascading

-- * Other useful modules
  , module Test.Extrapolate.TypeBinding
  , module Test.LeanCheck
  , module Test.LeanCheck.Utils.TypeBinding
  , ordering
  )
where

import Test.Extrapolate.Core
import Test.Extrapolate.Basic
import Test.Extrapolate.Derive
import Test.Extrapolate.TypeBinding
import Test.Extrapolate.IO

import Test.LeanCheck hiding
  ( Testable (..)
  , results
  , counterExamples
  , counterExample
  , productWith
  , check
  , checkFor
  , checkResult
  , checkResultFor
  )
import Test.LeanCheck.Utils.TypeBinding
-- TODO: add the following function `ordering` into LeanCheck's TypeBinding
--       module; release a new LeanCheck; remove it from here and bump version
--       requirement.
ordering :: Ordering
ordering = undefined