Safe Haskell	None
Language	Haskell98

Hedgehog.Internal.Report

Contents

Report

Synopsis

data Summary = Summary {
- summaryWaiting :: !PropertyCount
- summaryRunning :: !PropertyCount
- summaryFailed :: !PropertyCount
- summaryGaveUp :: !PropertyCount
- summaryOK :: !PropertyCount
}
data Report a = Report {
- reportTests :: !TestCount
- reportDiscards :: !DiscardCount
- reportCoverage :: !(Coverage CoverCount)
- reportStatus :: !a
}
data Progress
- = Running
- | Shrinking !FailureReport
data Result
- = Failed !FailureReport
- | GaveUp
- | OK
data FailureReport = FailureReport {
- failureSize :: !Size
- failureSeed :: !Seed
- failureShrinks :: !ShrinkCount
- failureCoverage :: !(Maybe (Coverage CoverCount))
- failureAnnotations :: ![FailedAnnotation]
- failureLocation :: !(Maybe Span)
- failureMessage :: !String
- failureDiff :: !(Maybe Diff)
- failureFootnotes :: ![String]
}
data FailedAnnotation = FailedAnnotation {
- failedSpan :: !(Maybe Span)
- failedValue :: !String
}
data Style
- = StyleDefault
- | StyleAnnotation
- | StyleFailure
data Markup
- = WaitingIcon
- | WaitingHeader
- | RunningIcon
- | RunningHeader
- | ShrinkingIcon
- | ShrinkingHeader
- | FailedIcon
- | FailedText
- | GaveUpIcon
- | GaveUpText
- | SuccessIcon
- | SuccessText
- | CoverageIcon
- | CoverageText
- | CoverageFill
- | DeclarationLocation
- | StyledLineNo !Style
- | StyledBorder !Style
- | StyledSource !Style
- | AnnotationGutter
- | AnnotationValue
- | FailureArrows
- | FailureGutter
- | FailureMessage
- | DiffPrefix
- | DiffInfix
- | DiffSuffix
- | DiffSame
- | DiffRemoved
- | DiffAdded
- | ReproduceHeader
- | ReproduceGutter
- | ReproduceSource
renderProgress :: MonadIO m => UseColor -> Maybe PropertyName -> Report Progress -> m String
renderResult :: MonadIO m => UseColor -> Maybe PropertyName -> Report Result -> m String
renderSummary :: MonadIO m => UseColor -> Summary -> m String
renderDoc :: MonadIO m => UseColor -> Doc Markup -> m String
ppProgress :: MonadIO m => Maybe PropertyName -> Report Progress -> m (Doc Markup)
ppResult :: MonadIO m => Maybe PropertyName -> Report Result -> m (Doc Markup)
ppSummary :: MonadIO m => Summary -> m (Doc Markup)
fromResult :: Result -> Summary
mkFailure :: Size -> Seed -> ShrinkCount -> Maybe (Coverage CoverCount) -> Maybe Span -> String -> Maybe Diff -> [Log] -> FailureReport

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 #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Summary -> ShowS # show :: Summary -> String # showList :: [Summary] -> ShowS #
Semigroup Summary Source #
Instance details Defined in Hedgehog.Internal.Report Methods (<>) :: Summary -> Summary -> Summary # sconcat :: NonEmpty Summary -> Summary # stimes :: Integral b => b -> Summary -> Summary #
Monoid Summary Source #
Instance details Defined in Hedgehog.Internal.Report 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 reportCoverage :: !(Coverage CoverCount) reportStatus :: !a

Instances

Functor Report Source #
Instance details Defined in Hedgehog.Internal.Report Methods fmap :: (a -> b) -> Report a -> Report b # (<$) :: a -> Report b -> Report a #
Foldable Report Source #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Progress -> Progress -> Bool # (/=) :: Progress -> Progress -> Bool #
Show Progress Source #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Show Result Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #

data FailureReport Source #

Constructors

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

Instances

Eq FailureReport Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: FailureReport -> FailureReport -> Bool # (/=) :: FailureReport -> FailureReport -> Bool #
Show FailureReport Source #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: FailedAnnotation -> FailedAnnotation -> Bool # (/=) :: FailedAnnotation -> FailedAnnotation -> Bool #
Show FailedAnnotation Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> FailedAnnotation -> ShowS # show :: FailedAnnotation -> String # showList :: [FailedAnnotation] -> ShowS #

data Style Source #

Constructors

StyleDefault
StyleAnnotation
StyleFailure

Instances

Eq Style Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Style -> Style -> Bool # (/=) :: Style -> Style -> Bool #
Ord Style Source #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Style -> ShowS # show :: Style -> String # showList :: [Style] -> ShowS #
Semigroup Style Source #
Instance details Defined in Hedgehog.Internal.Report Methods (<>) :: Style -> Style -> Style # sconcat :: NonEmpty Style -> Style # stimes :: Integral b => b -> Style -> Style #

data Markup Source #

Instances

Eq Markup Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Markup -> Markup -> Bool # (/=) :: Markup -> Markup -> Bool #
Ord Markup Source #
Instance details Defined in Hedgehog.Internal.Report 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 #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Markup -> ShowS # show :: Markup -> String # showList :: [Markup] -> ShowS #

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

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

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

renderDoc :: MonadIO m => 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 (Coverage CoverCount) -> Maybe Span -> String -> Maybe Diff -> [Log] -> FailureReport Source #

WaitingIcon
WaitingHeader
RunningIcon
RunningHeader
ShrinkingIcon
ShrinkingHeader
FailedIcon
FailedText
GaveUpIcon
GaveUpText
SuccessIcon
SuccessText
CoverageIcon
CoverageText
CoverageFill
DeclarationLocation
StyledLineNo !Style
StyledBorder !Style
StyledSource !Style
AnnotationGutter
AnnotationValue
FailureArrows
FailureGutter
FailureMessage
DiffPrefix
DiffInfix
DiffSuffix
DiffSame
DiffRemoved
DiffAdded
ReproduceHeader
ReproduceGutter
ReproduceSource