Safe Haskell	Safe-Inferred
Language	Haskell2010

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)
- reportSeed :: !Seed
- reportStatus :: !a
}
data Progress
- = Running
- | Shrinking !FailureReport
data Result
- = Failed !FailureReport
- | GaveUp
- | OK
data FailureReport = FailureReport {
- failureShrinks :: !ShrinkCount
- failureShrinkPath :: !ShrinkPath
- 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
data Config = Config {
- configContext :: Context
- configPrintFailedAtLocation :: Bool
- configPrintShrinkPath :: Bool
- configPrintReproduceMessage :: Bool
- configPrintPrefixIcons :: PrintPrefixIcons
}
defaultConfig :: Config
data Context
- = FullContext
- | Context Lines
data Lines
data PrintPrefixIcons
- = DisablePrefixIcons
- | EnablePrefixIcons
renderProgress :: MonadIO m => UseColor -> Maybe PropertyName -> Report Progress -> m String
renderResult :: MonadIO m => UseColor -> Maybe PropertyName -> Report Result -> m String
renderResultWith :: MonadIO m => Config -> 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)
ppResultWith :: MonadIO m => Config -> Maybe PropertyName -> Report Result -> m (Doc Markup)
ppSummary :: MonadIO m => Summary -> m (Doc Markup)
fromResult :: Result -> Summary
mkFailure :: ShrinkCount -> ShrinkPath -> 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

Instances details

Monoid Summary Source #
Instance details Defined in Hedgehog.Internal.Report Methods mempty :: Summary # mappend :: Summary -> Summary -> Summary # mconcat :: [Summary] -> Summary #
Semigroup Summary Source #
Instance details Defined in Hedgehog.Internal.Report Methods (<>) :: Summary -> Summary -> Summary # sconcat :: NonEmpty Summary -> Summary # stimes :: Integral b => b -> Summary -> Summary #
Show Summary Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Summary -> ShowS # show :: Summary -> String # showList :: [Summary] -> ShowS #

data Report a Source #

A report on a running or completed property test.

Constructors

Report
Fields reportTests :: !TestCount reportDiscards :: !DiscardCount reportCoverage :: !(Coverage CoverCount) reportSeed :: !Seed reportStatus :: !a

Instances

Instances details

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 # 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) #
Functor Report Source #
Instance details Defined in Hedgehog.Internal.Report Methods fmap :: (a -> b) -> Report a -> Report b # (<$) :: a -> Report b -> 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

Instances details

Show Progress Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Progress -> ShowS # show :: Progress -> String # showList :: [Progress] -> ShowS #
Eq Progress Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Progress -> Progress -> Bool # (/=) :: Progress -> Progress -> Bool #

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

Instances details

Show Result Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Eq Result Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #

data FailureReport Source #

Constructors

FailureReport
Fields failureShrinks :: !ShrinkCount failureShrinkPath :: !ShrinkPath failureCoverage :: !(Maybe (Coverage CoverCount)) failureAnnotations :: ![FailedAnnotation] failureLocation :: !(Maybe Span) failureMessage :: !String failureDiff :: !(Maybe Diff) failureFootnotes :: ![String]

Instances

Instances details

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

data FailedAnnotation Source #

Constructors

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

Instances

Instances details

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

data Style Source #

Constructors

StyleDefault
StyleAnnotation
StyleFailure

Instances

Instances details

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

data Markup Source #

Instances

Instances details

Show Markup Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Markup -> ShowS # show :: Markup -> String # showList :: [Markup] -> ShowS #
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 #

data Config Source #

Constructors

Config
Fields configContext :: Context configPrintFailedAtLocation :: Bool configPrintShrinkPath :: Bool configPrintReproduceMessage :: Bool configPrintPrefixIcons :: PrintPrefixIcons

Instances

Instances details

Show Config Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #

defaultConfig :: Config Source #

data Context Source #

Constructors

FullContext
Context Lines

Instances

Instances details

Show Context Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Eq Context Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #

data Lines Source #

Instances

Instances details

Num Lines Source #
Instance details Defined in Hedgehog.Internal.Report Methods (+) :: Lines -> Lines -> Lines # (-) :: Lines -> Lines -> Lines # (*) :: Lines -> Lines -> Lines # negate :: Lines -> Lines # abs :: Lines -> Lines # signum :: Lines -> Lines # fromInteger :: Integer -> Lines #
Show Lines Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> Lines -> ShowS # show :: Lines -> String # showList :: [Lines] -> ShowS #
Eq Lines Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: Lines -> Lines -> Bool # (/=) :: Lines -> Lines -> Bool #

data PrintPrefixIcons Source #

Whether to add icons to the start of important output lines or not.

Constructors

DisablePrefixIcons	Do not add icons to the start of important output lines.
EnablePrefixIcons	Add icons to the start of important output lines.

Instances

Instances details

Show PrintPrefixIcons Source #
Instance details Defined in Hedgehog.Internal.Report Methods showsPrec :: Int -> PrintPrefixIcons -> ShowS # show :: PrintPrefixIcons -> String # showList :: [PrintPrefixIcons] -> ShowS #
Eq PrintPrefixIcons Source #
Instance details Defined in Hedgehog.Internal.Report Methods (==) :: PrintPrefixIcons -> PrintPrefixIcons -> Bool # (/=) :: PrintPrefixIcons -> PrintPrefixIcons -> Bool #

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

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

renderResultWith :: MonadIO m => Config -> 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 #

ppResultWith :: MonadIO m => Config -> 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 :: ShrinkCount -> ShrinkPath -> 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