report

Documentation

Index

• type KeyValue
  • func (k KeyValue) Key() string
  • func (k KeyValue) Value() string
• type Report
  • func New() Report
• type Reporter
• type Result
• type Section
  • func NewSection(heading string) Section
• type Test

Types

type KeyValue

type KeyValue [2]string

func (KeyValue) Key

func (k KeyValue) Key() string

func (KeyValue) Value

func (k KeyValue) Value() string

type Report

type Report interface {
	Sections() []Section
	AddSection(Section)
	Status() Result
}

func New

func New() Report

type Reporter

type Reporter interface {
	CreateReport() (Report, error)
}

type Result

type Result uint8

const (
	Fail Result = iota
	Warning
	Pass
)

type Section

type Section interface {
	Heading() string
	KeyValues() []KeyValue
	AddKeyValue(key, value string)
	AddTest(name string, result Result, description string)
	Tests() []Test
}

func NewSection

func NewSection(heading string) Section

type Test

type Test struct {
	Name        string
	Result      Result
	Description string
}