Copyright	(c) 2022 8c6794b6
License	BSD3
Maintainer	8c6794b6 <[email protected]>
Safe Haskell	None
Language	Haskell2010

Trace.Hpc.Codecov.Report

Contents

Types
Functions

Description

Generate Codecov report data.

Synopsis

data Report = Report {
- reportTix :: FilePath
- reportMixDirs :: [FilePath]
- reportSrcDirs :: [FilePath]
- reportExcludes :: [String]
- reportOutFile :: Maybe FilePath
- reportVerbose :: Bool
- reportFormat :: Format
- reportExprOnly :: Bool
- reportIgnoreDittos :: Bool
}
data CoverageEntry = CoverageEntry {
- ce_filename :: FilePath
- ce_hits :: LineHits
- ce_fns :: FunctionHits
- ce_branches :: BranchHits
}
data Format
- = Codecov
- | Lcov
- | Cobertura
type LineHits = [(Int, Hit)]
data Hit
- = Missed
- | Partial Int
- | Full Int
type FunctionHits = [(Int, Int, Int, String)]
type BranchHits = [(Int, Int, Bool, Int)]
genReport :: Report -> IO ()
genCoverageEntries :: Report -> IO [CoverageEntry]
emitCoverage :: Format -> Maybe FilePath -> [CoverageEntry] -> IO ()

Types

data Report Source #

Data type to hold information for generating test coverage report.

Constructors

Report

Fields

reportTix :: FilePath
Input tix file.
reportMixDirs :: [FilePath]
Directories containing mix files referred by the tix file.
reportSrcDirs :: [FilePath]
Directories containing source codes referred by the mix files.
reportExcludes :: [String]
Module name strings to exclude from coverage report.
reportOutFile :: Maybe FilePath
Output file to write report data, if given.
reportVerbose :: Bool
Flag for showing verbose message during report generation.
reportFormat :: Format
Format of the report output.
Since: 0.4.0.0
reportExprOnly :: Bool
Flag for ignoring other data than ExpBox entries in mix files.
Since: 0.6.0.0
reportIgnoreDittos :: Bool
Flag for ignoring some of the compiler generated source codes.
As of the .mix file generated by ghc 9.{4,6,8}, record field declarations, class names with more than two member functions in deriving(..) clauses, and top-level TemplateHaskell splices are known to be ignored.
Since: 0.6.0.0

Instances

Instances details

Monoid Report Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods mempty :: Report # mappend :: Report -> Report -> Report # mconcat :: [Report] -> Report #
Semigroup Report Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods (<>) :: Report -> Report -> Report # sconcat :: NonEmpty Report -> Report # stimes :: Integral b => b -> Report -> Report #
Show Report Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods showsPrec :: Int -> Report -> ShowS # show :: Report -> String # showList :: [Report] -> ShowS #
Eq Report Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods (==) :: Report -> Report -> Bool # (/=) :: Report -> Report -> Bool #

data CoverageEntry Source #

Single file entry in coverage report.

Constructors

CoverageEntry
Fields ce_filename :: FilePath Source code file name. ce_hits :: LineHits Line hits of the file. ce_fns :: FunctionHits Function hits of the file. Since: 0.4.0.0 ce_branches :: BranchHits Branch hits of the file. Since: 0.4.0.0

Instances

Instances details

Show CoverageEntry Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods showsPrec :: Int -> CoverageEntry -> ShowS # show :: CoverageEntry -> String # showList :: [CoverageEntry] -> ShowS #
Eq CoverageEntry Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods (==) :: CoverageEntry -> CoverageEntry -> Bool # (/=) :: CoverageEntry -> CoverageEntry -> Bool #

data Format Source #

Data type for generated report format.

Constructors

Codecov

Custom Codecov JSON format. See the Codecov documentation for detail.

Since: 0.1.0.0

Lcov

LCOV tracefile format. See the geninfo manpage for detail.

Since: 0.4.0.0

Cobertura

Cobertura XML file format. See the Cobertura website for detail.

Since: 0.5.0.0

Instances

Instances details

Show Format Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #
Eq Format Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods (==) :: Format -> Format -> Bool # (/=) :: Format -> Format -> Bool #

type LineHits = [(Int, Hit)] Source #

Pair of line number and hit tag.

data Hit Source #

Data type to represent coverage of source code line.

The Int value in Partial and Full are the hit count.

Constructors

Missed	The line is not covered at all.
Partial Int	The line is partially covered.
Full Int	The line is fully covered.

Instances

Instances details

Show Hit Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods showsPrec :: Int -> Hit -> ShowS # show :: Hit -> String # showList :: [Hit] -> ShowS #
Eq Hit Source #
Instance details Defined in Trace.Hpc.Codecov.Report.Entry Methods (==) :: Hit -> Hit -> Bool # (/=) :: Hit -> Hit -> Bool #

type FunctionHits = [(Int, Int, Int, String)] Source #

Type synonym for tracking function enter count. Elements are start line number, end line number, execution count, and function name.

Since: 0.4.0.0

type BranchHits = [(Int, Int, Bool, Int)] Source #

Type synonym for tracking branch information. Elements are start line number, branch block number, Bool for the taken branch, and execution count.

Since: 0.4.0.0

Functions

genReport :: Report -> IO () Source #

Generate report data from options.

genCoverageEntries :: Report -> IO [CoverageEntry] Source #

Generate test coverage entries.

emitCoverage Source #

Arguments

:: Format	Format of the report. Since: 0.4.0.0
-> Maybe FilePath	`Just` output file name, or `Nothing` for `stdout`.
-> [CoverageEntry]	Coverage entries to write.
-> IO ()

Emit simple coverage data.