Safe Haskell	None
Language	Haskell98

Hedgehog.Internal.Report

Contents

Report

Synopsis

Report

data Summary Source #

A summary of all the properties executed.

Constructors

Summary
Fields summaryWaiting :: !PropertyCount summaryRunning :: !PropertyCount summaryFailed :: !PropertyCount summaryGaveUp :: !PropertyCount summaryOK :: !PropertyCount

Instances

Show Summary Source #
Methods showsPrec :: Int -> Summary -> ShowS # show :: Summary -> String # showList :: [Summary] -> ShowS #
Semigroup Summary Source #
Methods (<>) :: Summary -> Summary -> Summary # sconcat :: NonEmpty Summary -> Summary # stimes :: Integral b => b -> Summary -> Summary #
Monoid Summary Source #
Methods mempty :: Summary # mappend :: Summary -> Summary -> Summary # mconcat :: [Summary] -> Summary #

data Report a Source #

A report on a running or completed property test.

Constructors

Report
Fields reportTests :: !TestCount reportDiscards :: !DiscardCount reportStatus :: !a

Instances

Functor Report Source #
Methods fmap :: (a -> b) -> Report a -> Report b # (<$) :: a -> Report b -> Report a #
Foldable Report Source #
Methods fold :: Monoid m => Report m -> m # foldMap :: Monoid m => (a -> m) -> Report a -> m # foldr :: (a -> b -> b) -> b -> Report a -> b # foldr' :: (a -> b -> b) -> b -> Report a -> b # foldl :: (b -> a -> b) -> b -> Report a -> b # foldl' :: (b -> a -> b) -> b -> Report a -> b # foldr1 :: (a -> a -> a) -> Report a -> a # foldl1 :: (a -> a -> a) -> Report a -> a # toList :: Report a -> [a] # null :: Report a -> Bool # length :: Report a -> Int # elem :: Eq a => a -> Report a -> Bool # maximum :: Ord a => Report a -> a # minimum :: Ord a => Report a -> a # sum :: Num a => Report a -> a # product :: Num a => Report a -> a #
Traversable Report Source #
Methods traverse :: Applicative f => (a -> f b) -> Report a -> f (Report b) # sequenceA :: Applicative f => Report (f a) -> f (Report a) # mapM :: Monad m => (a -> m b) -> Report a -> m (Report b) # sequence :: Monad m => Report (m a) -> m (Report a) #
Show a => Show (Report a) Source #
Methods showsPrec :: Int -> Report a -> ShowS # show :: Report a -> String # showList :: [Report a] -> ShowS #

data Progress Source #

The status of a running property test.

Constructors

Running
Shrinking !FailureReport

Instances

Eq Progress Source #
Methods (==) :: Progress -> Progress -> Bool # (/=) :: Progress -> Progress -> Bool #
Show Progress Source #
Methods showsPrec :: Int -> Progress -> ShowS # show :: Progress -> String # showList :: [Progress] -> ShowS #

data Result Source #

The status of a completed property test.

In the case of a failure it provides the seed used for the test, the number of shrinks, and the execution log.

Constructors

Failed !FailureReport
GaveUp
OK

Instances

Eq Result Source #
Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Show Result Source #
Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #

data FailureReport Source #

Constructors

FailureReport
Fields failureSize :: !Size failureSeed :: !Seed failureShrinks :: !ShrinkCount failureAnnotations :: ![FailedAnnotation] failureLocation :: !(Maybe Span) failureMessage :: !String failureDiff :: !(Maybe Diff) failureFootnotes :: ![String]

Instances

Eq FailureReport Source #
Methods (==) :: FailureReport -> FailureReport -> Bool # (/=) :: FailureReport -> FailureReport -> Bool #
Show FailureReport Source #
Methods showsPrec :: Int -> FailureReport -> ShowS # show :: FailureReport -> String # showList :: [FailureReport] -> ShowS #

data FailedAnnotation Source #

Constructors

FailedAnnotation
Fields failedSpan :: !(Maybe Span) failedValue :: !String

Instances

Eq FailedAnnotation Source #
Methods (==) :: FailedAnnotation -> FailedAnnotation -> Bool # (/=) :: FailedAnnotation -> FailedAnnotation -> Bool #
Show FailedAnnotation Source #
Methods showsPrec :: Int -> FailedAnnotation -> ShowS # show :: FailedAnnotation -> String # showList :: [FailedAnnotation] -> ShowS #

newtype ShrinkCount Source #

The numbers of times a property was able to shrink after a failing test.

Constructors

ShrinkCount Int

Instances

Enum ShrinkCount Source #
Methods succ :: ShrinkCount -> ShrinkCount # pred :: ShrinkCount -> ShrinkCount # toEnum :: Int -> ShrinkCount # fromEnum :: ShrinkCount -> Int # enumFrom :: ShrinkCount -> [ShrinkCount] # enumFromThen :: ShrinkCount -> ShrinkCount -> [ShrinkCount] # enumFromTo :: ShrinkCount -> ShrinkCount -> [ShrinkCount] # enumFromThenTo :: ShrinkCount -> ShrinkCount -> ShrinkCount -> [ShrinkCount] #
Eq ShrinkCount Source #
Methods (==) :: ShrinkCount -> ShrinkCount -> Bool # (/=) :: ShrinkCount -> ShrinkCount -> Bool #
Integral ShrinkCount Source #
Methods quot :: ShrinkCount -> ShrinkCount -> ShrinkCount # rem :: ShrinkCount -> ShrinkCount -> ShrinkCount # div :: ShrinkCount -> ShrinkCount -> ShrinkCount # mod :: ShrinkCount -> ShrinkCount -> ShrinkCount # quotRem :: ShrinkCount -> ShrinkCount -> (ShrinkCount, ShrinkCount) # divMod :: ShrinkCount -> ShrinkCount -> (ShrinkCount, ShrinkCount) # toInteger :: ShrinkCount -> Integer #
Num ShrinkCount Source #
Methods (+) :: ShrinkCount -> ShrinkCount -> ShrinkCount # (-) :: ShrinkCount -> ShrinkCount -> ShrinkCount # (*) :: ShrinkCount -> ShrinkCount -> ShrinkCount # negate :: ShrinkCount -> ShrinkCount # abs :: ShrinkCount -> ShrinkCount # signum :: ShrinkCount -> ShrinkCount # fromInteger :: Integer -> ShrinkCount #
Ord ShrinkCount Source #
Methods compare :: ShrinkCount -> ShrinkCount -> Ordering # (<) :: ShrinkCount -> ShrinkCount -> Bool # (<=) :: ShrinkCount -> ShrinkCount -> Bool # (>) :: ShrinkCount -> ShrinkCount -> Bool # (>=) :: ShrinkCount -> ShrinkCount -> Bool # max :: ShrinkCount -> ShrinkCount -> ShrinkCount # min :: ShrinkCount -> ShrinkCount -> ShrinkCount #
Real ShrinkCount Source #
Methods toRational :: ShrinkCount -> Rational #
Show ShrinkCount Source #
Methods showsPrec :: Int -> ShrinkCount -> ShowS # show :: ShrinkCount -> String # showList :: [ShrinkCount] -> ShowS #

newtype TestCount Source #

The number of tests a property ran successfully.

Constructors

TestCount Int

Instances

Enum TestCount Source #
Methods succ :: TestCount -> TestCount # pred :: TestCount -> TestCount # toEnum :: Int -> TestCount # fromEnum :: TestCount -> Int # enumFrom :: TestCount -> [TestCount] # enumFromThen :: TestCount -> TestCount -> [TestCount] # enumFromTo :: TestCount -> TestCount -> [TestCount] # enumFromThenTo :: TestCount -> TestCount -> TestCount -> [TestCount] #
Eq TestCount Source #
Methods (==) :: TestCount -> TestCount -> Bool # (/=) :: TestCount -> TestCount -> Bool #
Integral TestCount Source #
Methods quot :: TestCount -> TestCount -> TestCount # rem :: TestCount -> TestCount -> TestCount # div :: TestCount -> TestCount -> TestCount # mod :: TestCount -> TestCount -> TestCount # quotRem :: TestCount -> TestCount -> (TestCount, TestCount) # divMod :: TestCount -> TestCount -> (TestCount, TestCount) # toInteger :: TestCount -> Integer #
Num TestCount Source #
Methods (+) :: TestCount -> TestCount -> TestCount # (-) :: TestCount -> TestCount -> TestCount # (*) :: TestCount -> TestCount -> TestCount # negate :: TestCount -> TestCount # abs :: TestCount -> TestCount # signum :: TestCount -> TestCount # fromInteger :: Integer -> TestCount #
Ord TestCount Source #
Methods compare :: TestCount -> TestCount -> Ordering # (<) :: TestCount -> TestCount -> Bool # (<=) :: TestCount -> TestCount -> Bool # (>) :: TestCount -> TestCount -> Bool # (>=) :: TestCount -> TestCount -> Bool # max :: TestCount -> TestCount -> TestCount # min :: TestCount -> TestCount -> TestCount #
Real TestCount Source #
Methods toRational :: TestCount -> Rational #
Show TestCount Source #
Methods showsPrec :: Int -> TestCount -> ShowS # show :: TestCount -> String # showList :: [TestCount] -> ShowS #

newtype DiscardCount Source #

The number of tests a property had to discard.

Constructors

DiscardCount Int

Instances

Enum DiscardCount Source #
Methods succ :: DiscardCount -> DiscardCount # pred :: DiscardCount -> DiscardCount # toEnum :: Int -> DiscardCount # fromEnum :: DiscardCount -> Int # enumFrom :: DiscardCount -> [DiscardCount] # enumFromThen :: DiscardCount -> DiscardCount -> [DiscardCount] # enumFromTo :: DiscardCount -> DiscardCount -> [DiscardCount] # enumFromThenTo :: DiscardCount -> DiscardCount -> DiscardCount -> [DiscardCount] #
Eq DiscardCount Source #
Methods (==) :: DiscardCount -> DiscardCount -> Bool # (/=) :: DiscardCount -> DiscardCount -> Bool #
Integral DiscardCount Source #
Methods quot :: DiscardCount -> DiscardCount -> DiscardCount # rem :: DiscardCount -> DiscardCount -> DiscardCount # div :: DiscardCount -> DiscardCount -> DiscardCount # mod :: DiscardCount -> DiscardCount -> DiscardCount # quotRem :: DiscardCount -> DiscardCount -> (DiscardCount, DiscardCount) # divMod :: DiscardCount -> DiscardCount -> (DiscardCount, DiscardCount) # toInteger :: DiscardCount -> Integer #
Num DiscardCount Source #
Methods (+) :: DiscardCount -> DiscardCount -> DiscardCount # (-) :: DiscardCount -> DiscardCount -> DiscardCount # (*) :: DiscardCount -> DiscardCount -> DiscardCount # negate :: DiscardCount -> DiscardCount # abs :: DiscardCount -> DiscardCount # signum :: DiscardCount -> DiscardCount # fromInteger :: Integer -> DiscardCount #
Ord DiscardCount Source #
Methods compare :: DiscardCount -> DiscardCount -> Ordering # (<) :: DiscardCount -> DiscardCount -> Bool # (<=) :: DiscardCount -> DiscardCount -> Bool # (>) :: DiscardCount -> DiscardCount -> Bool # (>=) :: DiscardCount -> DiscardCount -> Bool # max :: DiscardCount -> DiscardCount -> DiscardCount # min :: DiscardCount -> DiscardCount -> DiscardCount #
Real DiscardCount Source #
Methods toRational :: DiscardCount -> Rational #
Show DiscardCount Source #
Methods showsPrec :: Int -> DiscardCount -> ShowS # show :: DiscardCount -> String # showList :: [DiscardCount] -> ShowS #

newtype PropertyCount Source #

The number of properties in a group.

Constructors

PropertyCount Int

Instances

Enum PropertyCount Source #
Methods succ :: PropertyCount -> PropertyCount # pred :: PropertyCount -> PropertyCount # toEnum :: Int -> PropertyCount # fromEnum :: PropertyCount -> Int # enumFrom :: PropertyCount -> [PropertyCount] # enumFromThen :: PropertyCount -> PropertyCount -> [PropertyCount] # enumFromTo :: PropertyCount -> PropertyCount -> [PropertyCount] # enumFromThenTo :: PropertyCount -> PropertyCount -> PropertyCount -> [PropertyCount] #
Eq PropertyCount Source #
Methods (==) :: PropertyCount -> PropertyCount -> Bool # (/=) :: PropertyCount -> PropertyCount -> Bool #
Integral PropertyCount Source #
Methods quot :: PropertyCount -> PropertyCount -> PropertyCount # rem :: PropertyCount -> PropertyCount -> PropertyCount # div :: PropertyCount -> PropertyCount -> PropertyCount # mod :: PropertyCount -> PropertyCount -> PropertyCount # quotRem :: PropertyCount -> PropertyCount -> (PropertyCount, PropertyCount) # divMod :: PropertyCount -> PropertyCount -> (PropertyCount, PropertyCount) # toInteger :: PropertyCount -> Integer #
Num PropertyCount Source #
Methods (+) :: PropertyCount -> PropertyCount -> PropertyCount # (-) :: PropertyCount -> PropertyCount -> PropertyCount # (*) :: PropertyCount -> PropertyCount -> PropertyCount # negate :: PropertyCount -> PropertyCount # abs :: PropertyCount -> PropertyCount # signum :: PropertyCount -> PropertyCount # fromInteger :: Integer -> PropertyCount #
Ord PropertyCount Source #
Methods compare :: PropertyCount -> PropertyCount -> Ordering # (<) :: PropertyCount -> PropertyCount -> Bool # (<=) :: PropertyCount -> PropertyCount -> Bool # (>) :: PropertyCount -> PropertyCount -> Bool # (>=) :: PropertyCount -> PropertyCount -> Bool # max :: PropertyCount -> PropertyCount -> PropertyCount # min :: PropertyCount -> PropertyCount -> PropertyCount #
Real PropertyCount Source #
Methods toRational :: PropertyCount -> Rational #
Show PropertyCount Source #
Methods showsPrec :: Int -> PropertyCount -> ShowS # show :: PropertyCount -> String # showList :: [PropertyCount] -> ShowS #

data Style Source #

Constructors

StyleDefault
StyleAnnotation
StyleFailure

Instances

Eq Style Source #
Methods (==) :: Style -> Style -> Bool # (/=) :: Style -> Style -> Bool #
Ord Style Source #
Methods compare :: Style -> Style -> Ordering # (<) :: Style -> Style -> Bool # (<=) :: Style -> Style -> Bool # (>) :: Style -> Style -> Bool # (>=) :: Style -> Style -> Bool # max :: Style -> Style -> Style # min :: Style -> Style -> Style #
Show Style Source #
Methods showsPrec :: Int -> Style -> ShowS # show :: Style -> String # showList :: [Style] -> ShowS #
Semigroup Style Source #
Methods (<>) :: Style -> Style -> Style # sconcat :: NonEmpty Style -> Style # stimes :: Integral b => b -> Style -> Style #

data Markup Source #

Instances

Eq Markup Source #
Methods (==) :: Markup -> Markup -> Bool # (/=) :: Markup -> Markup -> Bool #
Ord Markup Source #
Methods compare :: Markup -> Markup -> Ordering # (<) :: Markup -> Markup -> Bool # (<=) :: Markup -> Markup -> Bool # (>) :: Markup -> Markup -> Bool # (>=) :: Markup -> Markup -> Bool # max :: Markup -> Markup -> Markup # min :: Markup -> Markup -> Markup #
Show Markup Source #
Methods showsPrec :: Int -> Markup -> ShowS # show :: Markup -> String # showList :: [Markup] -> ShowS #

renderProgress :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Progress -> m String Source #

renderResult :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Result -> m String Source #

renderSummary :: MonadIO m => Maybe UseColor -> Summary -> m String Source #

renderDoc :: MonadIO m => Maybe UseColor -> Doc Markup -> m String Source #

ppProgress :: MonadIO m => Maybe PropertyName -> Report Progress -> m (Doc Markup) Source #

ppResult :: MonadIO m => Maybe PropertyName -> Report Result -> m (Doc Markup) Source #

ppSummary :: MonadIO m => Summary -> m (Doc Markup) Source #

fromResult :: Result -> Summary Source #

Construct a summary from a single result.

mkFailure :: Size -> Seed -> ShrinkCount -> Maybe Span -> String -> Maybe Diff -> [Log] -> FailureReport Source #

WaitingIcon
WaitingHeader
RunningIcon
RunningHeader
ShrinkingIcon
ShrinkingHeader
FailedIcon
FailedHeader
GaveUpIcon
GaveUpHeader
SuccessIcon
SuccessHeader
DeclarationLocation
StyledLineNo !Style
StyledBorder !Style
StyledSource !Style
AnnotationGutter
AnnotationValue
FailureArrows
FailureGutter
FailureMessage
DiffPrefix
DiffInfix
DiffSuffix
DiffSame
DiffRemoved
DiffAdded
ReproduceHeader
ReproduceGutter
ReproduceSource