Safe Haskell	None
Language	GHC2021

Skeletest.Prop.Internal

Contents

Test
Configuring properties
Coverage
Assertions
Plugin

Synopsis

type Property = PropertyM ()
data PropertyM a
runProperty :: Property -> IO TestResult
prop :: String -> Property -> Spec
forAll :: (HasCallStack, Show a) => Gen a -> PropertyM a
discard :: PropertyM a
setDiscardLimit :: Int -> Property
setShrinkLimit :: Int -> Property
setShrinkRetries :: Int -> Property
setConfidence :: Int -> Property
setVerifiedTermination :: Property
setTestLimit :: Int -> Property
classify :: HasCallStack => String -> Bool -> Property
cover :: HasCallStack => Double -> String -> Bool -> Property
label :: HasCallStack => String -> Property
collect :: (Show a, HasCallStack) => a -> Property
isoWith :: (HasCallStack, Show a, Eq b) => Gen a -> Predicate PropertyM (IsoChecker a b)
(===) :: (a -> b) -> (a -> b) -> IsoChecker a b
data Fun a b = Fun String (a -> b)
data IsoChecker a b = IsoChecker (Fun a b) (Fun a b)
propPlugin :: Plugin

Documentation

type Property = PropertyM () Source #

A property to run, with optional configuration settings specified up front.

Settings should be specified before any other Property calls; any settings specified afterwards are ignored.

data PropertyM a Source #

Instances

Instances details

MonadFail PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods fail :: String -> PropertyM a #
MonadIO PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods liftIO :: IO a -> PropertyM a #
Applicative PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods pure :: a -> PropertyM a # (<>) :: PropertyM (a -> b) -> PropertyM a -> PropertyM b # liftA2 :: (a -> b -> c) -> PropertyM a -> PropertyM b -> PropertyM c # (>) :: PropertyM a -> PropertyM b -> PropertyM b # (<*) :: PropertyM a -> PropertyM b -> PropertyM a #
Functor PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods fmap :: (a -> b) -> PropertyM a -> PropertyM b # (<$) :: a -> PropertyM b -> PropertyM a #
Monad PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods (>>=) :: PropertyM a -> (a -> PropertyM b) -> PropertyM b # (>>) :: PropertyM a -> PropertyM b -> PropertyM b # return :: a -> PropertyM a #
Testable PropertyM Source #
Instance details Defined in Skeletest.Prop.Internal Methods runTestable :: PropertyM () -> IO TestResult Source # context :: String -> PropertyM a -> PropertyM a Source # throwFailure :: AssertionFail -> PropertyM a Source #

runProperty :: Property -> IO TestResult Source #

Test

prop :: String -> Property -> Spec Source #

Define a property test.

describe "User" $ do
  prop "decode . encode === Just" $ do
    let genUser = ...
    (decode . encode) P.=== Just `shouldSatisfy` P.isoWith genUser

forAll :: (HasCallStack, Show a) => Gen a -> PropertyM a Source #

discard :: PropertyM a Source #

Configuring properties

setDiscardLimit :: Int -> Property Source #

setShrinkLimit :: Int -> Property Source #

setShrinkRetries :: Int -> Property Source #

setConfidence :: Int -> Property Source #

setVerifiedTermination :: Property Source #

setTestLimit :: Int -> Property Source #

Coverage

classify :: HasCallStack => String -> Bool -> Property Source #

Record the propotion of tests which satisfy a given condition

xs <- forAll $ Gen.list (Range.linear 0 100) $ Gen.int (Range.linear 0 100)
for_ xs $ x -> do
  classify "newborns" $ x == 0
  classify "children" $ x > 0 && x < 13
  classify "teens" $ x > 12 && x < 20

cover :: HasCallStack => Double -> String -> Bool -> Property Source #

Require a certain percentage of the tests to be covered by the classifier.

In the following example, if the condition does not have at least 30% coverage, the test will fail.

match <- forAll Gen.bool
cover 30 "true" $ match
cover 30 "false" $ not match

label :: HasCallStack => String -> Property Source #

Add a label for each test run. It produces a table showing the percentage of test runs that produced each label.

collect :: (Show a, HasCallStack) => a -> Property Source #

Like label, but uses Show to render its argument for display.

Assertions

isoWith :: (HasCallStack, Show a, Eq b) => Gen a -> Predicate PropertyM (IsoChecker a b) Source #

See (===).

(===) :: (a -> b) -> (a -> b) -> IsoChecker a b infix 2 Source #

Verify if two functions are isomorphic.

prop "reverse . reverse === id" $ do
  let genList = Gen.list (Range.linear 0 10) $ Gen.int (Range.linear 0 1000)
  (reverse . reverse) P.=== id `shouldSatisfy` P.isoWith genList

data Fun a b Source #

Constructors

Fun String (a -> b)

data IsoChecker a b Source #

Constructors

IsoChecker (Fun a b) (Fun a b)

Plugin

propPlugin :: Plugin Source #