reports

Documentation

Index

• Constants
• type Report
  • func (r *Report) Init(name string, sourceNbr, conditionNbr, targetNbr int)
  • func (r *Report) String(mode string) (report string, err error)
• type Reports
  • func (r *Reports) Show() error
  • func (r *Reports) Summary() (int, int, int, error)
• type Stage
  • func (s *Stage) New(kind, result string)

Constants

const (
	// CONDITIONREPORTTEMPLATE defines
	CONDITIONREPORTTEMPLATE string = `` /* 130-byte string literal not displayed */

	// TARGETREPORTTEMPLATE ...
	TARGETREPORTTEMPLATE string = `
{{- "\t" -}}Target:
{{ range .Targets }}
{{- "\t" }}{{"\t"}}{{- .Result }}  {{ .Name -}}({{- .Kind -}}){{"\n"}}
{{- end }}
`
	// SOURCEREPORTTEMPLATE ...
	SOURCEREPORTTEMPLATE string = `
{{- "\t"}}Source:
{{ range .Sources }}
{{- "\t" }}{{"\t"}}{{- .Result }}  {{ .Name -}}({{- .Kind -}}){{"\n"}}
{{- end }}
`

	// REPORTTEMPLATE ...
	REPORTTEMPLATE string = `` /* 586-byte string literal not displayed */

)

Types

type Report

type Report struct {
	Name       string
	Err        string
	Result     string
	Sources    []Stage
	Conditions []Stage
	Targets    []Stage
}

Report contains a list of Rules

func (*Report) Init

func (r *Report) Init(name string, sourceNbr, conditionNbr, targetNbr int)

Init init a new report for a specific configuration func (config *Config) InitReport() (report *Report) {

func (*Report) String

func (r *Report) String(mode string) (report string, err error)

String return a report as a string

type Reports

type Reports []Report

Reports contains a list of report

func (*Reports) Show

func (r *Reports) Show() error

Show return a small reports of what has been changed

func (*Reports) Summary

func (r *Reports) Summary() (int, int, int, error)

Summary display a summary of

type Stage

type Stage struct {
	Name   string
	Kind   string
	Result string
}

Stage contains the information if specific stage reported a success, a change, an error

func (*Stage) New

func (s *Stage) New(kind, result string)

New init a new state object