Documentation
¶
Index ¶
- Constants
- Variables
- func CounterRendererMinWidth() int
- func InferFormatFromExportFileName(filename string) (string, error)
- func MapRange(value int, valueRange RangeConstraint, desiredRange RangeConstraint) int
- func TruncateString(str string, length int) string
- type CSVFormatter
- type CSVRenderer
- type CheckExportTarget
- type ControlColorSchemaDefinition
- type ControlColorScheme
- type ControlRenderer
- type CounterGraphRenderer
- type CounterGraphRendererOptions
- type CounterRenderer
- type CounterRendererOptions
- type CsvColumnPair
- type DimensionsRenderer
- type ErrorRenderer
- type Formatter
- type FormatterMap
- type GroupHeadingRenderer
- type GroupRenderer
- type GroupTitleRenderer
- type HTMLFormatter
- type JSONFormatter
- type MarkdownFormatter
- type NullFormatter
- type RangeConstraint
- type ResultColumns
- type ResultReasonRenderer
- type ResultRenderer
- type ResultStatusRenderer
- type SeverityRenderer
- type SpacerRenderer
- type SummaryRenderer
- type SummarySeverityRenderer
- type SummarySeverityRowRenderer
- type SummaryStatusRowRenderer
- type SummaryTotalRowRenderer
- type TableRenderer
- type TextFormatter
Constants ¶
const ( OutputFormatNone = "none" OutputFormatText = "text" OutputFormatBrief = "brief" OutputFormatCSV = "csv" OutputFormatJSON = "json" OutputFormatHTML = "html" OutputFormatMarkdown = "md" )
const MaxColumns = 200
Variables ¶
var ColorSchemes = map[string]*ControlColorSchemaDefinition{ "dark": { GroupTitle: "bold-bright-white", Severity: "bold-bright-yellow", CountZeroFail: "gray1", CountZeroFailDivider: "gray1", CountDivider: "gray2", CountFail: "bold-bright-red", CountTotal: "bright-white", CountTotalAllPassed: "bold-bright-green", CountGraphFail: "bright-red", CountGraphPass: "bright-green", CountGraphAlarm: "bright-red", CountGraphError: "bright-red", CountGraphInfo: "bright-cyan", CountGraphOK: "bright-green", CountGraphSkip: "gray3", CountGraphBracket: "gray2", StatusAlarm: "bold-bright-red", StatusError: "bold-bright-red", StatusSkip: "gray3", StatusInfo: "bright-cyan", StatusOK: "bright-green", StatusColon: "gray1", ReasonAlarm: "bright-red", ReasonError: "bright-red", ReasonSkip: "gray3", ReasonInfo: "bright-cyan", ReasonOK: "gray4", Spacer: "gray1", Indent: "gray1", UseColor: true, }, "light": { GroupTitle: "bold-bright-black", Severity: "bold-bright-yellow", CountZeroFail: "gray5", CountZeroFailDivider: "gray5", CountDivider: "gray4", CountFail: "bold-bright-red", CountTotal: "bright-black", CountTotalAllPassed: "bold-bright-green", CountGraphFail: "bright-red", CountGraphPass: "bright-green", CountGraphAlarm: "bright-red", CountGraphError: "bright-red", CountGraphInfo: "bright-cyan", CountGraphOK: "bright-green", CountGraphSkip: "gray3", CountGraphBracket: "gray4", StatusAlarm: "bold-bright-red", StatusError: "bold-bright-red", StatusSkip: "gray3", StatusInfo: "bright-cyan", StatusOK: "bright-green", StatusColon: "gray5", ReasonAlarm: "bright-red", ReasonError: "bright-red", ReasonSkip: "gray3", ReasonInfo: "bright-cyan", ReasonOK: "gray2", Spacer: "gray5", Indent: "gray5", UseColor: true, }, "plain": {UseColor: false}, }
Functions ¶
func CounterRendererMinWidth ¶ added in v0.9.1
func CounterRendererMinWidth() int
func InferFormatFromExportFileName ¶ added in v0.6.0
func MapRange ¶ added in v0.9.1
func MapRange(value int, valueRange RangeConstraint, desiredRange RangeConstraint) int
MapRange Re-maps a number from one range to another.
func TruncateString ¶
Types ¶
type CSVFormatter ¶ added in v0.6.0
type CSVFormatter struct {
// contains filtered or unexported fields
}
func (*CSVFormatter) FileExtension ¶ added in v0.9.0
func (j *CSVFormatter) FileExtension() string
func (*CSVFormatter) Format ¶ added in v0.6.0
func (j *CSVFormatter) Format(_ context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
type CSVRenderer ¶ added in v0.6.0
type CSVRenderer struct {
// contains filtered or unexported fields
}
func (CSVRenderer) Render ¶ added in v0.6.0
func (r CSVRenderer) Render(tree *controlexecute.ExecutionTree) [][]string
type CheckExportTarget ¶ added in v0.6.0
func NewCheckExportTarget ¶ added in v0.6.0
func NewCheckExportTarget(format string, file string, err error) CheckExportTarget
type ControlColorSchemaDefinition ¶
type ControlColorSchemaDefinition struct {
// group
GroupTitle string
Severity string
CountZeroFail string
CountZeroFailDivider string
CountDivider string
CountFail string
CountTotal string
CountTotalAllPassed string
CountGraphFail string
CountGraphPass string
CountGraphAlarm string
CountGraphError string
CountGraphInfo string
CountGraphOK string
CountGraphSkip string
CountGraphBracket string
// results
StatusAlarm string
StatusError string
StatusSkip string
StatusInfo string
StatusOK string
StatusColon string
ReasonAlarm string
ReasonError string
ReasonSkip string
ReasonInfo string
ReasonOK string
Spacer string
Indent string
UseColor bool
}
type ControlColorScheme ¶
type ControlColorScheme struct {
GroupTitle colorFunc
Severity colorFunc
CountZeroFail colorFunc
CountZeroFailDivider colorFunc
CountDivider colorFunc
CountFail colorFunc
CountTotal colorFunc
CountTotalAllPassed colorFunc
CountGraphFail colorFunc
CountGraphPass colorFunc
CountGraphAlarm colorFunc
CountGraphError colorFunc
CountGraphInfo colorFunc
CountGraphOK colorFunc
CountGraphSkip colorFunc
CountGraphBracket colorFunc
StatusAlarm colorFunc
StatusError colorFunc
StatusSkip colorFunc
StatusInfo colorFunc
StatusOK colorFunc
StatusColon colorFunc
ReasonAlarm colorFunc
ReasonError colorFunc
ReasonSkip colorFunc
ReasonInfo colorFunc
ReasonOK colorFunc
Spacer colorFunc
Indent colorFunc
ReasonColors map[string]colorFunc
StatusColors map[string]colorFunc
GraphColors map[string]colorFunc
UseColor bool
}
var ControlColors *ControlColorScheme
ControlColors is a global variable containing the current control color scheme
func NewControlColorScheme ¶
func NewControlColorScheme(def *ControlColorSchemaDefinition) (*ControlColorScheme, error)
func (*ControlColorScheme) Initialise ¶
func (c *ControlColorScheme) Initialise(def *ControlColorSchemaDefinition) error
type ControlRenderer ¶
type ControlRenderer struct {
// contains filtered or unexported fields
}
func NewControlRenderer ¶
func NewControlRenderer(run *controlexecute.ControlRun, parent *GroupRenderer) *ControlRenderer
func (ControlRenderer) Render ¶
func (r ControlRenderer) Render() string
type CounterGraphRenderer ¶
type CounterGraphRenderer struct {
// contains filtered or unexported fields
}
func NewCounterGraphRenderer ¶
func NewCounterGraphRenderer(failedControls, totalControls, maxTotalControls int, options CounterGraphRendererOptions) *CounterGraphRenderer
func (CounterGraphRenderer) Render ¶
func (r CounterGraphRenderer) Render() string
type CounterGraphRendererOptions ¶ added in v0.9.0
type CounterGraphRendererOptions struct {
FailedColorFunc colorFunc
}
type CounterRenderer ¶
type CounterRenderer struct {
// contains filtered or unexported fields
}
func NewCounterRenderer ¶
func NewCounterRenderer(failedControls, totalControls, maxFailedControls, maxTotalControls int, options CounterRendererOptions) *CounterRenderer
func (CounterRenderer) Render ¶
func (r CounterRenderer) Render() string
type CounterRendererOptions ¶ added in v0.9.0
type CounterRendererOptions struct {
AddLeadingSpace bool
}
type CsvColumnPair ¶ added in v0.6.0
type CsvColumnPair struct {
// contains filtered or unexported fields
}
type DimensionsRenderer ¶
type DimensionsRenderer struct {
// contains filtered or unexported fields
}
func NewDimensionsRenderer ¶
func NewDimensionsRenderer(dimensions []controlexecute.Dimension, colorGenerator *controlexecute.DimensionColorGenerator, width int) *DimensionsRenderer
func (DimensionsRenderer) Render ¶
func (r DimensionsRenderer) Render() string
Render returns the reason, truncated to the max length if necessary
type ErrorRenderer ¶
type ErrorRenderer struct {
// contains filtered or unexported fields
}
func NewErrorRenderer ¶
func NewErrorRenderer(err error, width int, indent string) *ErrorRenderer
func (ErrorRenderer) Render ¶
func (r ErrorRenderer) Render() string
type Formatter ¶ added in v0.6.0
type Formatter interface {
Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
FileExtension() string
}
func GetExportFormatter ¶ added in v0.6.0
func GetOutputFormatter ¶ added in v0.6.0
type FormatterMap ¶ added in v0.9.0
type GroupHeadingRenderer ¶
type GroupHeadingRenderer struct {
// contains filtered or unexported fields
}
func NewGroupHeadingRenderer ¶
func NewGroupHeadingRenderer(title string, failed, total, maxFailed, maxTotal, width int, indent string) *GroupHeadingRenderer
func (GroupHeadingRenderer) Render ¶
func (r GroupHeadingRenderer) Render() string
type GroupRenderer ¶
type GroupRenderer struct {
// contains filtered or unexported fields
}
func NewGroupRenderer ¶
func NewGroupRenderer(group *controlexecute.ResultGroup, parent *GroupRenderer, maxFailedControls, maxTotalControls int, resultTree *controlexecute.ExecutionTree, width int) *GroupRenderer
func (GroupRenderer) Render ¶
func (r GroupRenderer) Render() string
type GroupTitleRenderer ¶
type GroupTitleRenderer struct {
// contains filtered or unexported fields
}
func NewGroupTitleRenderer ¶
func NewGroupTitleRenderer(title string, width int) *GroupTitleRenderer
func (GroupTitleRenderer) Render ¶
func (r GroupTitleRenderer) Render() string
Render returns the title, truncated to the max length if necessary NOTE: adds a trailing space
type HTMLFormatter ¶ added in v0.9.0
type HTMLFormatter struct{}
func (*HTMLFormatter) FileExtension ¶ added in v0.9.0
func (j *HTMLFormatter) FileExtension() string
func (*HTMLFormatter) Format ¶ added in v0.9.0
func (j *HTMLFormatter) Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
type JSONFormatter ¶ added in v0.6.0
type JSONFormatter struct{}
func (*JSONFormatter) FileExtension ¶ added in v0.9.0
func (j *JSONFormatter) FileExtension() string
func (*JSONFormatter) Format ¶ added in v0.6.0
func (j *JSONFormatter) Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
type MarkdownFormatter ¶ added in v0.9.0
type MarkdownFormatter struct{}
func (*MarkdownFormatter) FileExtension ¶ added in v0.9.0
func (j *MarkdownFormatter) FileExtension() string
func (*MarkdownFormatter) Format ¶ added in v0.9.0
func (j *MarkdownFormatter) Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
type NullFormatter ¶ added in v0.6.0
type NullFormatter struct{}
NullFormatter is to be used when no output is expected. It always returns a `io.Reader` which reads an empty string
func (*NullFormatter) FileExtension ¶ added in v0.9.0
func (j *NullFormatter) FileExtension() string
func (*NullFormatter) Format ¶ added in v0.6.0
func (j *NullFormatter) Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
type RangeConstraint ¶ added in v0.9.1
type RangeConstraint struct {
// contains filtered or unexported fields
}
func NewRangeConstraint ¶ added in v0.9.1
func NewRangeConstraint(minimum int, maximum int) RangeConstraint
func (*RangeConstraint) Constrain ¶ added in v0.9.1
func (r *RangeConstraint) Constrain(value int) int
Constrain a number to be within a range.
type ResultColumns ¶ added in v0.6.0
type ResultColumns struct {
AllColumns []string
GroupColumns []CsvColumnPair
ResultColumns []CsvColumnPair
DimensionColumns []string
TagColumns []string
}
type ResultReasonRenderer ¶
type ResultReasonRenderer struct {
// contains filtered or unexported fields
}
func NewResultReasonRenderer ¶
func NewResultReasonRenderer(status, reason string, width int) *ResultReasonRenderer
func (ResultReasonRenderer) Render ¶
func (r ResultReasonRenderer) Render() string
Render returns the reason, truncated to the max length if necessary NOTE: adds a trailing space
type ResultRenderer ¶
type ResultRenderer struct {
// contains filtered or unexported fields
}
func NewResultRenderer ¶
func NewResultRenderer(status, reason string, dimensions []controlexecute.Dimension, colorGenerator *controlexecute.DimensionColorGenerator, width int, indent string) *ResultRenderer
func (ResultRenderer) Render ¶
func (r ResultRenderer) Render() string
type ResultStatusRenderer ¶
type ResultStatusRenderer struct {
// contains filtered or unexported fields
}
func NewResultStatusRenderer ¶
func NewResultStatusRenderer(status string) *ResultStatusRenderer
func (ResultStatusRenderer) Render ¶
func (r ResultStatusRenderer) Render() string
Render returns the status
type SeverityRenderer ¶
type SeverityRenderer struct {
// contains filtered or unexported fields
}
func NewSeverityRenderer ¶
func NewSeverityRenderer(severity string) *SeverityRenderer
func (SeverityRenderer) Render ¶
func (r SeverityRenderer) Render() string
Render returns ther severity oin upper case, got 'critical' and 'high' severities for all other values an empty string is returned NOTE: adds a trailing space
type SpacerRenderer ¶
type SpacerRenderer struct {
// contains filtered or unexported fields
}
func NewSpacerRenderer ¶
func NewSpacerRenderer(width int) *SpacerRenderer
func (SpacerRenderer) Render ¶
func (r SpacerRenderer) Render() string
Render returns a divider string of format: "....... " NOTE: adds a trailing space
type SummaryRenderer ¶ added in v0.9.0
type SummaryRenderer struct {
// contains filtered or unexported fields
}
func NewSummaryRenderer ¶ added in v0.9.0
func NewSummaryRenderer(resultTree *controlexecute.ExecutionTree, width int) *SummaryRenderer
func (SummaryRenderer) Render ¶ added in v0.9.0
func (r SummaryRenderer) Render() string
type SummarySeverityRenderer ¶ added in v0.9.0
type SummarySeverityRenderer struct {
// contains filtered or unexported fields
}
func NewSummarySeverityRenderer ¶ added in v0.9.0
func NewSummarySeverityRenderer(resultTree *controlexecute.ExecutionTree, width int) *SummarySeverityRenderer
func (*SummarySeverityRenderer) Render ¶ added in v0.9.0
func (r *SummarySeverityRenderer) Render() []string
type SummarySeverityRowRenderer ¶ added in v0.9.0
type SummarySeverityRowRenderer struct {
// contains filtered or unexported fields
}
func NewSummarySeverityRowRenderer ¶ added in v0.9.0
func NewSummarySeverityRowRenderer(resultTree *controlexecute.ExecutionTree, width int, severity string) *SummarySeverityRowRenderer
func (*SummarySeverityRowRenderer) Render ¶ added in v0.9.0
func (r *SummarySeverityRowRenderer) Render() string
type SummaryStatusRowRenderer ¶ added in v0.9.0
type SummaryStatusRowRenderer struct {
// contains filtered or unexported fields
}
func NewSummaryStatusRowRenderer ¶ added in v0.9.0
func NewSummaryStatusRowRenderer(resultTree *controlexecute.ExecutionTree, width int, status string) *SummaryStatusRowRenderer
func (*SummaryStatusRowRenderer) Render ¶ added in v0.9.0
func (r *SummaryStatusRowRenderer) Render() string
type SummaryTotalRowRenderer ¶ added in v0.9.0
type SummaryTotalRowRenderer struct {
// contains filtered or unexported fields
}
func NewSummaryTotalRowRenderer ¶ added in v0.9.0
func NewSummaryTotalRowRenderer(resultTree *controlexecute.ExecutionTree, width int) *SummaryTotalRowRenderer
func (*SummaryTotalRowRenderer) Render ¶ added in v0.9.0
func (r *SummaryTotalRowRenderer) Render() string
type TableRenderer ¶
type TableRenderer struct {
// contains filtered or unexported fields
}
func NewTableRenderer ¶
func NewTableRenderer(resultTree *controlexecute.ExecutionTree) *TableRenderer
func (TableRenderer) MinimumWidth ¶ added in v0.9.1
func (r TableRenderer) MinimumWidth() int
MinimumWidth is the width we require It is determined by the left indent, title, severity, counter and counter graph
func (TableRenderer) Render ¶
func (r TableRenderer) Render(width int) string
type TextFormatter ¶ added in v0.6.0
type TextFormatter struct{}
func (*TextFormatter) FileExtension ¶ added in v0.9.0
func (j *TextFormatter) FileExtension() string
func (*TextFormatter) Format ¶ added in v0.6.0
func (j *TextFormatter) Format(ctx context.Context, tree *controlexecute.ExecutionTree) (io.Reader, error)
Source Files
¶
- color_scheme.go
- control.go
- csv.go
- dimensions.go
- error.go
- formatter.go
- formatter_csv.go
- formatter_html.go
- formatter_json.go
- formatter_markdown.go
- formatter_text.go
- group.go
- group_counter.go
- group_counter_graph.go
- group_heading.go
- group_title.go
- range.go
- result.go
- result_columns.go
- result_reason.go
- result_status.go
- severity.go
- spacer.go
- summary.go
- summary_severity.go
- summary_severity_row.go
- summary_status_row.go
- summary_total_row.go
- table.go
- truncate.go