| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Hedgehog.Internal.Report
Contents
Synopsis
- data Summary = Summary {}
- data Report a = Report {
- reportTests :: !TestCount
- reportDiscards :: !DiscardCount
- reportStatus :: !a
- data Progress
- data Result
- = Failed !FailureReport
- | GaveUp
- | OK
- data FailureReport = FailureReport {
- failureSize :: !Size
- failureSeed :: !Seed
- failureShrinks :: !ShrinkCount
- failureAnnotations :: ![FailedAnnotation]
- failureLocation :: !(Maybe Span)
- failureMessage :: !String
- failureDiff :: !(Maybe Diff)
- failureFootnotes :: ![String]
- data FailedAnnotation = FailedAnnotation {
- failedSpan :: !(Maybe Span)
- failedValue :: !String
- newtype ShrinkCount = ShrinkCount Int
- newtype TestCount = TestCount Int
- newtype DiscardCount = DiscardCount Int
- newtype PropertyCount = PropertyCount Int
- data Style
- data Markup
- = 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
- renderProgress :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Progress -> m String
- renderResult :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Result -> m String
- renderSummary :: MonadIO m => Maybe UseColor -> Summary -> m String
- renderDoc :: MonadIO m => Maybe 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 Span -> String -> Maybe Diff -> [Log] -> FailureReport
Report
A summary of all the properties executed.
Constructors
| Summary | |
Fields | |
A report on a running or completed property test.
Constructors
| Report | |
Fields
| |
Instances
| Functor Report # | |
| Foldable Report # | |
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 # elem :: Eq a => a -> Report a -> Bool # maximum :: Ord a => Report a -> a # minimum :: Ord a => Report a -> a # | |
| Traversable Report # | |
| Show a => Show (Report a) # | |
The status of a running property test.
Constructors
| Running | |
| Shrinking !FailureReport |
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 |
data FailureReport #
Constructors
| FailureReport | |
Fields
| |
Instances
| Eq FailureReport # | |
Defined in Hedgehog.Internal.Report Methods (==) :: FailureReport -> FailureReport -> Bool # (/=) :: FailureReport -> FailureReport -> Bool # | |
| Show FailureReport # | |
Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> FailureReport -> ShowS # show :: FailureReport -> String # showList :: [FailureReport] -> ShowS # | |
data FailedAnnotation #
Constructors
| FailedAnnotation | |
Fields
| |
Instances
| Eq FailedAnnotation # | |
Defined in Hedgehog.Internal.Report Methods (==) :: FailedAnnotation -> FailedAnnotation -> Bool # (/=) :: FailedAnnotation -> FailedAnnotation -> Bool # | |
| Show FailedAnnotation # | |
Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> FailedAnnotation -> ShowS # show :: FailedAnnotation -> String # showList :: [FailedAnnotation] -> ShowS # | |
newtype ShrinkCount #
The numbers of times a property was able to shrink after a failing test.
Constructors
| ShrinkCount Int |
Instances
The number of tests a property ran successfully.
Instances
| Enum TestCount # | |
Defined in Hedgehog.Internal.Report Methods succ :: TestCount -> TestCount # pred :: TestCount -> TestCount # fromEnum :: TestCount -> Int # enumFrom :: TestCount -> [TestCount] # enumFromThen :: TestCount -> TestCount -> [TestCount] # enumFromTo :: TestCount -> TestCount -> [TestCount] # enumFromThenTo :: TestCount -> TestCount -> TestCount -> [TestCount] # | |
| Eq TestCount # | |
| Integral TestCount # | |
Defined in Hedgehog.Internal.Report 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) # | |
| Num TestCount # | |
Defined in Hedgehog.Internal.Report | |
| Ord TestCount # | |
| Real TestCount # | |
Defined in Hedgehog.Internal.Report Methods toRational :: TestCount -> Rational # | |
| Show TestCount # | |
newtype DiscardCount #
The number of tests a property had to discard.
Constructors
| DiscardCount Int |
Instances
newtype PropertyCount #
The number of properties in a group.
Constructors
| PropertyCount Int |
Instances
Constructors
| StyleDefault | |
| StyleAnnotation | |
| StyleFailure |
Constructors
renderProgress :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Progress -> m String #
renderResult :: MonadIO m => Maybe UseColor -> Maybe PropertyName -> Report Result -> m String #
ppProgress :: MonadIO m => Maybe PropertyName -> Report Progress -> m (Doc Markup) #
fromResult :: Result -> Summary #
Construct a summary from a single result.