report

Documentation

Index

• type Report
  • func NewDefaultReport(debug bool) *Report
  • func (report *Report) Run() Result
• type Result
• type ResultSection
• type Section

Types

type Report

type Report struct {
	Sections []Section `json:"sections"`
}

Report contains an array of all sections and their reports

func NewDefaultReport

func NewDefaultReport(debug bool) *Report

NewDefaultReport returns a report containing the standard inspection checks

func (*Report) Run

func (report *Report) Run() Result

Run starts each check and returns a report of the results

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 []framework.CheckResult `json:"results"`
}

ResultSection is the individual check and its result

type Section

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

Section is the category of check