diagnose

type Catalog struct {
	Suites Suites
}

type Component interface {
	RunSuites(format string, verbose bool) ([]byte, error)
	RunSuite(suite string, format string, verbose bool) ([]byte, error)
	RunLocalSuite(suites Suites, config Config) (*Result, error)
}

type Config struct {
	Verbose bool
	Include []string
	Exclude []string
}

type Counters struct {
	Total         int `json:"total,omitempty"`
	Success       int `json:"success,omitempty"`
	Fail          int `json:"fail,omitempty"`
	Warnings      int `json:"warnings,omitempty"`
	UnexpectedErr int `json:"unexpected_error,omitempty"`
}

type Diagnoses struct {
	Name      string      `json:"suite_name"`
	Diagnoses []Diagnosis `json:"diagnoses"`
}

type Diagnosis struct {
	// --------------------------
	// required fields
	// run-time (pass, fail etc)
	Status Status `json:"result"`
	// static-time (meta typically)
	Name string `json:"name"`
	// run-time (actual diagnosis consumable by a user)
	Diagnosis string `json:"diagnosis"`

	// static-time (meta typically)
	Category string `json:"category,omitempty"`
	// static-time (meta typically, description of what being tested)
	Description string `json:"description,omitempty"`
	// run-time (what can be done of what docs need to be consulted to address the issue)
	Remediation string `json:"remediation,omitempty"`
	// run-time
	RawError string `json:"rawerror,omitempty"`
	// run-time (additional metadata)
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Result struct {
	Runs    []Diagnoses `json:"runs"`
	Summary Counters    `json:"summary"`
}

type Status int

type Suites map[string]func(Config) []Diagnosis