Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.Tasty.Streaming.TMSummary

Synopsis

data ThreatModelSummary = ThreatModelSummary {
- tmsName :: !Text
- tmsTested :: !Int
- tmsTotal :: !Int
- tmsPassed :: !Int
- tmsFailed :: !Int
- tmsSkipped :: !Int
- tmsErrors :: !Int
}
data TMStore
newtype TMRecorder = TMRecorder {
- tmRecord :: String -> ThreatModelSummary -> IO ()
}
newtype TMStoreOption = TMStoreOption (Maybe TMStore)
data TraceRecorder = TraceRecorder {
- trEnabled :: IO Bool
- recordIteration :: String -> String -> Value -> IO ()
}
newTMStore :: IO TMStore
storeRecorder :: TMStore -> TMRecorder
lookupThreatModelSummary :: TMStore -> String -> IO (Maybe ThreatModelSummary)

Documentation

data ThreatModelSummary Source #

Structured summary of a threat-model test case.

Constructors

ThreatModelSummary
Fields tmsName :: !Text tmsTested :: !Int tmsTotal :: !Int tmsPassed :: !Int tmsFailed :: !Int tmsSkipped :: !Int tmsErrors :: !Int

Instances

Instances details

FromJSON ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods parseJSON :: Value -> Parser ThreatModelSummary Source # parseJSONList :: Value -> Parser [ThreatModelSummary] Source # omittedField :: Maybe ThreatModelSummary Source #
ToJSON ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods toJSON :: ThreatModelSummary -> Value Source # toEncoding :: ThreatModelSummary -> Encoding Source # toJSONList :: [ThreatModelSummary] -> Value Source # toEncodingList :: [ThreatModelSummary] -> Encoding Source # omitField :: ThreatModelSummary -> Bool Source #
Generic ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Associated Types type Rep ThreatModelSummary :: Type -> Type # Methods from :: ThreatModelSummary -> Rep ThreatModelSummary x # to :: Rep ThreatModelSummary x -> ThreatModelSummary #
Show ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods showsPrec :: Int -> ThreatModelSummary -> ShowS # show :: ThreatModelSummary -> String # showList :: [ThreatModelSummary] -> ShowS #
Eq ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods (==) :: ThreatModelSummary -> ThreatModelSummary -> Bool # (/=) :: ThreatModelSummary -> ThreatModelSummary -> Bool #
type Rep ThreatModelSummary Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary type Rep ThreatModelSummary = D1 ('MetaData "ThreatModelSummary" "Convex.Tasty.Streaming.TMSummary" "convex-tasty-streaming-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ThreatModelSummary" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tmsName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "tmsTested") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "tmsTotal") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "tmsPassed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "tmsFailed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "tmsSkipped") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "tmsErrors") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)))))

data TMStore Source #

Mutable storage for threat-model summaries, owned by the reporter.

newtype TMRecorder Source #

A recorder closure passed to test bodies via Tasty's option system. The default no-op makes summaries silently dropped when the streaming reporter is not active.

Constructors

TMRecorder
Fields tmRecord :: String -> ThreatModelSummary -> IO ()

Instances

Instances details

IsOption TMRecorder Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods defaultValue :: TMRecorder Source # parseValue :: String -> Maybe TMRecorder Source # optionName :: Tagged TMRecorder String Source # optionHelp :: Tagged TMRecorder String Source # showDefaultValue :: TMRecorder -> Maybe String Source # optionCLParser :: Parser TMRecorder Source #

newtype TMStoreOption Source #

Internal option carrying the live store. Set by defaultMainStreaming alongside the recorder so the reporter can read summaries back out.

Constructors

TMStoreOption (Maybe TMStore)

Instances

Instances details

IsOption TMStoreOption Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods defaultValue :: TMStoreOption Source # parseValue :: String -> Maybe TMStoreOption Source # optionName :: Tagged TMStoreOption String Source # optionHelp :: Tagged TMStoreOption String Source # showDefaultValue :: TMStoreOption -> Maybe String Source # optionCLParser :: Parser TMStoreOption Source #

data TraceRecorder Source #

Callback for recording iteration traces as pre-serialized JSON. Arguments: group name, category ("positive"/"negative"), pre-serialized trace JSON. Default is a no-op (zero overhead when streaming is not active).

When trEnabled returns True, test bodies use the expensive traced code path (building IterationTrace values with UTxO snapshots, transaction summaries, and JSON serialisation). When it returns False (the IsOption default), the cheap runActions path is used instead, avoiding all that work.

trEnabled is an IO action so that the decision can be deferred until the streaming reporter has parsed --no-trace and written the shared IORef.

Constructors

TraceRecorder
Fields trEnabled :: IO Bool Whether test bodies should collect detailed traces. recordIteration :: String -> String -> Value -> IO () Emit a single iteration trace event.

Instances

Instances details

IsOption TraceRecorder Source #
Instance details Defined in Convex.Tasty.Streaming.TMSummary Methods defaultValue :: TraceRecorder Source # parseValue :: String -> Maybe TraceRecorder Source # optionName :: Tagged TraceRecorder String Source # optionHelp :: Tagged TraceRecorder String Source # showDefaultValue :: TraceRecorder -> Maybe String Source # optionCLParser :: Parser TraceRecorder Source #

newTMStore :: IO TMStore Source #

Allocate fresh storage. Call once per reporter run.

storeRecorder :: TMStore -> TMRecorder Source #

Build a recorder that writes into the given store.

lookupThreatModelSummary :: TMStore -> String -> IO (Maybe ThreatModelSummary) Source #

Look up a summary by key (does not delete).