HPCThreshold

Documentation

data Threshold

Data structure for a single threshold configuration.

Constructors

Threshold

Fields

• thresholdName :: String
• thresholdRegex :: ByteString
• thresholdValue :: Double

Instances

Eq Threshold

Methods

(==) :: Threshold -> Threshold -> Bool

(/=) :: Threshold -> Threshold -> Bool

Read Threshold

Methods

readsPrec :: Int -> ReadS Threshold

readList :: ReadS [Threshold]

readPrec :: ReadPrec Threshold

readListPrec :: ReadPrec [Threshold]

Show Threshold

Methods

showsPrec :: Int -> Threshold -> ShowS

show :: Threshold -> String

showList :: [Threshold] -> ShowS

type Coverage = Double

type ThresholdEvaluationResult = (Threshold, Coverage, Bool)

The result of evaluation. The _3 indicates whether the coverage passes the threshold or not.

extractCoverage

Arguments

:: String

The input string

-> ByteString

The regex to extract the coverage. The regex should contain `(\d+)` capture otherwise the coverage is always be 0.

-> Coverage

The extracted coverage

Extract the coverage from input string using a regex string

evaluate :: String -> Threshold -> ThresholdEvaluationResult

Evaluate the given string against the given threshold, producing an evaluation result

reportThreshold :: ThresholdEvaluationResult -> String

Produce a human-friendly output of the evaluation result

evaluateAndReport

Arguments

:: String

The input string

-> [Threshold]

The list of thresholds

-> (String, Bool)

Pair of report and whether there is any coverage under thresholds

Evaluate a string against a list of thresholds configuration and produce a report