report

Documentation

Index

• type Report
  • func NewDefaultReport(id string, rawDataDir string) (Report, error)
  • func NewReport(id string, rawDataDir string, sections []Section) (Report, error)
• type Result
• type ResultSection
• type Section

Types

type Report

type Report interface {
	ID() string
	Run() Result
}

Report contains an array of all sections and their reports

func NewDefaultReport

func NewDefaultReport(
	id string,
	rawDataDir string,
) (Report, error)

NewDefaultReport returns a report containing the standard inspection checks

func NewReport

func NewReport(
	id string,
	rawDataDir string,
	sections []Section,
) (Report, error)

NewReport instantiates a new Report struct with the expected fields (e.g. ID)

type Result

type Result struct {
	Version  string          `json:"version"`
	Sections []ResultSection `json:"sections"`
}

Result contains each sections check result

type ResultSection

type ResultSection struct {
	Title   string         `json:"title"`
	Results []check.Result `json:"results"`
}

ResultSection is the individual check and its result

type Section

type Section struct {
	Title  string        `json:"title"`
	Checks []check.Check `json:"checks"`
}

Section is the category of check