Modulefoundation-0.0.30Haskell2010

Foundation.Check

An implementation of a test framework and property expression & testing

Contents

Property
Check Plan

Synopsis

newtype Gen
class Arbitrary
value oneof
value elements
value frequency
value between
data Test
value testName
data PropertyCheck
data Property
class IsProperty
value ===
value propertyCompare
value propertyCompareWith
value propertyAnd
value propertyFail
value forAll
newtype Check
value validate
value pick
value iterateProperty

Packagefoundation-0.0.30
Exports21
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCheck.hs

newtypenewtype Gen a

Source#

Generator monad

Instances3Monad, Functor, Applicative

Monad GenDefined in foundation-0.0.30 · Foundation.Check.Gen
Functor GenDefined in foundation-0.0.30 · Foundation.Check.Gen
Applicative GenDefined in foundation-0.0.30 · Foundation.Check.Gen

classclass Arbitrary a where

Source#

How to generate an arbitrary value for a

Methods

arbitrary :: Gen a

Instances34Arbitrary, …

Arbitrary AsciiStringDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Char7Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word128Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word256Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary StringDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary FieldDefined in foundation-0.0.30 · Foundation.Format.CSV.Types
Arbitrary IntegerDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary NaturalDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Int16Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Int32Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Int64Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Int8Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary BoolDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary CharDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary DoubleDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary FloatDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary IntDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary WordDefined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word16Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word32Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word64Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary Word8Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary (CountOf ty)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary a => Arbitrary (Maybe a)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
Arbitrary a => Arbitrary [a]Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
KnownNat n => Arbitrary (Zn n)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(NatWithinBound Word64 n, KnownNat n) => Arbitrary (Zn64 n)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, Arbitrary b) => Arbitrary (a, b)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, KnownNat n, NatWithinBound Int n) => Arbitrary (ListN n a)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary l, Arbitrary r) => Arbitrary (Either l r)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, Arbitrary b, Arbitrary c) => Arbitrary (a, b, c)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d) => Arbitrary (a, b, c, d)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d, Arbitrary e) => Arbitrary (a, b, c, d, e)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary
(Arbitrary a, Arbitrary b, Arbitrary c, Arbitrary d, Arbitrary e, Arbitrary f) => Arbitrary (a, b, c, d, e, f)Defined in foundation-0.0.30 · Foundation.Check.Arbitrary

valueoneof :: NonEmpty [Gen a] -> Gen a

valueelements :: NonEmpty [a] -> Gen a

valuefrequency :: NonEmpty [(Word, Gen a)] -> Gen a

Source#

Call one of the generator weighted

valuebetween :: (Word, Word) -> Gen Word

datadata Test where

Source#

different type of tests supported

Constructors

Unit :: String -> IO () -> Test
Property :: IsProperty prop => String -> prop -> Test
Group :: String -> [Test] -> Test
CheckPlan :: String -> Check () -> Test

valuetestName :: Test -> String

Source#

Name of a test

Property

datadata PropertyCheck

Source#

The type of check this test did for a property

Instances1IsProperty

IsProperty PropertyCheckDefined in foundation-0.0.30 · Foundation.Check.Property

datadata Property

Constructors

Prop
- unProp :: Gen PropertyTestArg

Instances1IsProperty

IsProperty PropertyDefined in foundation-0.0.30 · Foundation.Check.Property

classclass IsProperty p where

Methods

property :: p -> Property

Instances5IsProperty

IsProperty PropertyDefined in foundation-0.0.30 · Foundation.Check.Property
IsProperty PropertyCheckDefined in foundation-0.0.30 · Foundation.Check.Property
IsProperty BoolDefined in foundation-0.0.30 · Foundation.Check.Property
IsProperty (String, Bool)Defined in foundation-0.0.30 · Foundation.Check.Property
(Show a, Arbitrary a, IsProperty prop) => IsProperty (a -> prop)Defined in foundation-0.0.30 · Foundation.Check.Property

value(===) :: (Show a, Eq a, Typeable a) => a -> a -> PropertyCheck

Source#

A property that check for equality of its 2 members.

valuepropertyCompare

:: (Show a, Typeable a)
=> String
name of the function used for comparaison, e.g. (<)
-> (a -> a -> Bool)
function used for value comparaison
-> a
value left of the operator
-> a
value right of the operator
-> PropertyCheck

Source#

A property that check for a specific comparaison of its 2 members.

This is equivalent to === but with compare

valuepropertyCompareWith

:: String
name of the function used for comparaison, e.g. (<)
-> (a -> a -> Bool)
function used for value comparaison
-> (a -> String)
function used to pretty print the values
-> a
value left of the operator
-> a
value right of the operator
-> PropertyCheck

Source#

A property that check for a specific comparaison of its 2 members.

This is equivalent to === but with compare and a given method to pretty print the values.

valuepropertyAnd :: PropertyCheck -> PropertyCheck -> PropertyCheck

Source#

A conjuctive property composed of 2 properties that need to pass

valuepropertyFail :: String -> PropertyCheck

valueforAll :: (Show a, IsProperty prop) => Gen a -> (a -> prop) -> Property

Source#

Running a generator for a specific type under a property

Check Plan

newtypenewtype Check a

Instances5Monad, Functor, Applicative, MonadState, State

Monad CheckDefined in foundation-0.0.30 · Foundation.Check.Types
Functor CheckDefined in foundation-0.0.30 · Foundation.Check.Types
Applicative CheckDefined in foundation-0.0.30 · Foundation.Check.Types
MonadState CheckDefined in foundation-0.0.30 · Foundation.Check.Types
type State Check = PlanStateDefined in foundation-0.0.30 · Foundation.Check.Types

valuevalidate :: IsProperty prop => String -> prop -> Check ()

valuepick :: String -> IO a -> Check a

valueiterateProperty

:: CountOf TestResult
-> GenParams
-> Word64 -> GenRng
-> Property
-> IO (PropertyResult, CountOf TestResult)