Trace.Hpc.Codecov.Report

Generate Codecov report data.

Types

data Report

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

Instances

Monoid Report

Defined in Trace.Hpc.Codecov.Report

Methods

mempty :: Report

mappend :: Report -> Report -> Report

mconcat :: [Report] -> Report

Semigroup Report

Defined in Trace.Hpc.Codecov.Report

Methods

(<>) :: Report -> Report -> Report

sconcat :: NonEmpty Report -> Report

stimes :: Integral b => b -> Report -> Report

Show Report

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

Eq Report

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: Report -> Report -> Bool

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

data CoverageEntry

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

Show CoverageEntry

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> CoverageEntry -> ShowS

show :: CoverageEntry -> String

showList :: [CoverageEntry] -> ShowS

Eq CoverageEntry

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: CoverageEntry -> CoverageEntry -> Bool

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

data Format

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

Instances

Show Format

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Eq Format

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: Format -> Format -> Bool

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

type LineHits = [(Int, Hit)]

Pair of line number and hit tag.

data Hit

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

Show Hit

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> Hit -> ShowS

show :: Hit -> String

showList :: [Hit] -> ShowS

Eq Hit

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: Hit -> Hit -> Bool

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

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

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)]

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 ()

Generate report data from options.

genCoverageEntries :: Report -> IO [CoverageEntry]

Generate test coverage entries.

emitCoverage

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.