reporting

Documentation

Index

• Constants
• type ColumnStyle
  • func (c ColumnStyle) String() string
• type ScanCell
• type ScanDetailTable
• type ScanReport
  • func (s *ScanReport) ToHTML() ([]byte, error)
  • func (s *ScanReport) ToMarkdown() []byte
• type ScanRow

Constants

const (
	Green = iota + 1
	Yellow
	Red
	Grey
	Black
)

enum for style types

Types

type ColumnStyle

type ColumnStyle int

ColumnStyle defines style for a specific column

func (ColumnStyle) String

func (c ColumnStyle) String() string

type ScanCell

type ScanCell struct {
	Content string      `json:"content"`
	Style   ColumnStyle `json:"style"`
}

ScanCell defines one column of a scan result table

type ScanDetailTable

type ScanDetailTable struct {
	Headers       []string  `json:"headers"`
	Rows          []ScanRow `json:"rows"`
	WithCounter   bool      `json:"withCounter"`
	CounterHeader string    `json:"counterHeader"`
	NoRowsMessage string    `json:"noRowsMessage"`
}

ScanDetailTable defines a table containing scan result details

type ScanReport

type ScanReport struct {
	StepName       string          `json:"stepName"`
	Title          string          `json:"title"`
	Subheaders     []string        `json:"subheaders"`
	Overview       []string        `json:"overview"`
	FurtherInfo    string          `json:"furtherInfo"`
	ReportTime     time.Time       `json:"reportTime"`
	DetailTable    ScanDetailTable `json:"detailTable"`
	SuccessfulScan bool            `json:"successfulScan"`
}

ScanReport defines the elements of a scan report used by various scan steps

func (*ScanReport) ToHTML

func (s *ScanReport) ToHTML() ([]byte, error)

ToHTML creates a HTML version of the report

func (*ScanReport) ToMarkdown

func (s *ScanReport) ToMarkdown() []byte

ToMarkdown creates a markdown version of the report content

type ScanRow

type ScanRow struct {
	Columns []ScanCell `json:"columns"`
}

ScanRow defines one row of a scan result table