1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
|
{-# LANGUAGE CPP #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE NoImplicitPrelude #-}
#if __GLASGOW_HASKELL__ >= 704
{-# LANGUAGE Safe #-}
#endif
module Test.SmallCheck.Property.Result
( PropertySuccess(..)
, PropertyFailure(..)
, ppFailure
, Reason
, Argument
) where
import Data.Bool (Bool (False, True))
import Data.Eq (Eq)
import Data.Function (($), (.))
import Data.Int (Int)
import Data.List (map)
import Data.Maybe (Maybe (Nothing, Just))
import Prelude (String)
import Text.PrettyPrint (Doc, empty, hsep, nest, render, text, (<+>), ($+$), ($$))
import Text.Show (Show)
-- | @since 1.0
type Argument = String
-- | An explanation for the test outcome.
--
-- @since 1.1
type Reason = String
-- | @since 1.0
data PropertySuccess
= Exist [Argument] PropertySuccess
| ExistUnique [Argument] PropertySuccess
| PropertyTrue (Maybe Reason) -- ^ @since 1.1
| Vacuously PropertyFailure
deriving (Eq, Show)
-- | @since 1.0
data PropertyFailure
= NotExist
| AtLeastTwo [Argument] PropertySuccess [Argument] PropertySuccess
| CounterExample [Argument] PropertyFailure
| PropertyFalse (Maybe Reason) -- ^ @since 1.1
deriving (Eq, Show)
class Pretty a where
pretty :: a -> Doc
instance Pretty PropertyFailure where
pretty NotExist = text "argument does not exist"
pretty (AtLeastTwo args1 s1 args2 s2) =
text "there are at least two" <+>
plural args1 empty (text "sets of") <+>
text "arguments satisfying the property:" $$
formatExample args1 s1 $$ formatExample args2 s2
where
formatExample args s = nest ind $ text "for" <+> prettyArgs args </> pretty s
pretty (CounterExample args f) =
text "there" <+>
text (plural args "exists" "exist") <+>
prettyArgs args <+>
text "such that"
</> pretty f
pretty (PropertyFalse Nothing) = text "condition is false"
pretty (PropertyFalse (Just s)) = text s
instance Pretty PropertySuccess where
pretty (PropertyTrue Nothing) = text "condition is true"
pretty (PropertyTrue (Just s)) = text s
pretty (Exist args s) = existsMsg False args s
pretty (ExistUnique args s) = existsMsg True args s
pretty (Vacuously s) = text "property is vacuously true because" </> pretty s
ind :: Int
ind = 2
infixl 5 </>
(</>) :: Doc -> Doc -> Doc
a </> b = a $+$ nest ind b
prettyArgs :: [Argument] -> Doc
prettyArgs = hsep . map text
existsMsg :: Pretty a => Bool -> [Argument] -> a -> Doc
existsMsg unique args s =
text "there" <+> text (plural args "exists" "exist") <+>
(if unique then text "unique" else empty) <+>
prettyArgs args <+>
text "such that" </>
pretty s
plural :: [a] -> b -> b -> b
plural lst sing pl =
case lst of
_:_:_ -> pl
_ -> sing
-- | @since 1.0
ppFailure :: PropertyFailure -> String
ppFailure = render . pretty
|