reporting

Documentation

Index

• Constants
• func VerificationReports(reports []VerificationReport, reporting Reporting, ...)
• type Info
• type Reporting
  • func NewReportingModule(wr *cli.Writer, tables map[string]*Table) Reporting
• type ReportingModule
  • func (r *ReportingModule) AppendSpecialCharater(symbol int, str string) string
  • func (r *ReportingModule) ChangeColour(fgColor int, msg string) string
  • func (r *ReportingModule) GenerateTableOutputAndPrint(tb *Table)
  • func (r *ReportingModule) GetAllTableKeys() []string
  • func (r *ReportingModule) GetAllTables() map[string]*Table
  • func (r *ReportingModule) GetTable(key string) *Table
  • func (r *ReportingModule) SetTable(key string, table *Table)
• type StatusMessage
• type SummaryInfo
• type Table
• type VerificationReport

Constants

const (
	Red = iota
	Green
	Yellow
	Grey
)

const (
	Failed = iota
	Success
	Warning
	SquareBracket
	Skipped
)

Functions

func VerificationReports

func VerificationReports(reports []VerificationReport, reporting Reporting, nodeInfoMap map[string][]Info)

Types

type Info

type Info struct {
	Hostip        string         `json:"hostip,omitempty"`
	Parameter     string         `json:"parameter,omitempty"`
	Status        string         `json:"status,omitempty"`
	StatusMessage *StatusMessage `json:"statusMessage,omitempty"`
	SummaryInfo   *SummaryInfo   `json:"summaryInfo,omitempty"`
}

type Reporting

type Reporting interface {
	GetTable(key string) *Table
	SetTable(key string, table *Table)
	GetAllTableKeys() []string
	GetAllTables() map[string]*Table
	AppendSpecialCharater(symbol int, str string) string
	ChangeColour(fgColor int, msg string) string
	GenerateTableOutputAndPrint(table *Table)
}

func NewReportingModule

func NewReportingModule(wr *cli.Writer, tables map[string]*Table) Reporting

type ReportingModule

type ReportingModule struct {
	// contains filtered or unexported fields
}

func (*ReportingModule) AppendSpecialCharater

func (r *ReportingModule) AppendSpecialCharater(symbol int, str string) string

AppendSpecialCharater returns a string. Function appends a special char at the start of the str provided in arguments and returns that string

func (*ReportingModule) ChangeColour

func (r *ReportingModule) ChangeColour(fgColor int, msg string) string

ChangeColour returns a string. Function changes the color of the msg provided in arguments to the color given

func (*ReportingModule) GenerateTableOutputAndPrint

func (r *ReportingModule) GenerateTableOutputAndPrint(tb *Table)

GenerateTableOutputAndPrint prints table provided as argument

func (*ReportingModule) GetAllTableKeys

func (r *ReportingModule) GetAllTableKeys() []string

GetAllTableKeys returns all keys present in tables map

func (*ReportingModule) GetAllTables

func (r *ReportingModule) GetAllTables() map[string]*Table

GetAllTables returns tables map

func (*ReportingModule) GetTable

func (r *ReportingModule) GetTable(key string) *Table

GetTable returns table present in tables map for given key.

func (*ReportingModule) SetTable

func (r *ReportingModule) SetTable(key string, table *Table)

SetTable sets the value of tables[key] in tables map to table provided in argument

type StatusMessage

type StatusMessage struct {
	MainMessage string   `json:"mainMessage,omitempty"`
	SubMessage  []string `json:"subMessage,omitempty"`
}

type SummaryInfo

type SummaryInfo struct {
	SuccessfulCount int      `json:"successfulCount,omitempty"`
	FailedCount     int      `json:"failedCount,omitempty"`
	ToResolve       []string `json:"toResolve,omitempty"`
}

type Table

type Table struct {
	Title     string
	Rows      []table.Row
	Header    table.Row
	Footer    table.Row
	ColConfig []table.ColumnConfig
}

type VerificationReport

type VerificationReport struct {
	TableKey string
	Report   Info
}