report

Documentation

Index

• type Class
• type Counter
• type Group
• type Line
• type Method
• type Package
• type Report
  • func RetrieveReport(namespace string, url string) (Report, error)
• type SessionInfo
• type SourceFile

Types

type Class

type Class struct {
	Name           string    `xml:"name,attr"`
	Sourcefilename string    `xml:"sourcefilename,attr"`
	Methods        []Method  `xml:"method"`
	Counters       []Counter `xml:"counter"`
}

Class depict a Java class.

type Counter

type Counter struct {
	Type    string `xml:"type,attr"`
	Missed  int    `xml:"missed,attr"`
	Covered int    `xml:"covered,attr"`
}

Counter keeps track over misses and coverage of various the source constructs.

type Group

type Group struct {
	Name     string    `xml:"name,attr"`
	Packages []Package `xml:"package"`
	Groups   []Group   `xml:"group"`
	Counters []Counter `xml:"counter"`
}

Group allows the grouping of a set of source constucts.

type Line

type Line struct {
	Nr int `xml:"nr,attr"`
	Mi int `xml:"mi,attr"`
	Ci int `xml:"ci,attr"`
	Mb int `xml:"mb,attr"`
	Cb int `xml:"cb,attr"`
}

Line depict a line in a source file.

type Method

type Method struct {
	Name     string    `xml:"name,attr"`
	Desc     string    `xml:"desc,attr"`
	Line     int       `xml:"line,attr"`
	Counters []Counter `xml:"counter"`
}

Method depict a Java method.

type Package

type Package struct {
	Name        string       `xml:"name,attr"`
	Classes     []Class      `xml:"class"`
	SourceFiles []SourceFile `xml:"sourcefile"`
	Counters    []Counter    `xml:"counter"`
}

Package depict a Java package.

type Report

type Report struct {
	XMLName     xml.Name      `xml:"report"`
	Name        string        `xml:"name,attr"`
	SessionInfo []SessionInfo `xml:"sessioninfo"`
	Packages    []Package     `xml:"package"`
	Groups      []Group       `xml:"group"`
	Counters    []Counter     `xml:"counter"`
}

Report is the top level struct for the jacoco report

func RetrieveReport

func RetrieveReport(namespace string, url string) (Report, error)

RetrieveReport retrieves a JaCoCo report from the specified URL which can be on GitHub or a cloud storage bucket.

type SessionInfo

type SessionInfo struct {
	ID    string `xml:"id,attr"`
	Start int    `xml:"start,attr"`
	Dump  int    `xml:"dump,attr"`
}

SessionInfo identifies when the report was taken.

type SourceFile

type SourceFile struct {
	Name     string    `xml:"name,attr"`
	Lines    []Line    `xml:"line"`
	Counters []Counter `xml:"counter"`
}

SourceFile depict a Java source file.