report

Documentation

Index

• Variables
• func WriteResults(format string, output io.Writer, severities []dbTypes.Severity, ...) error
• type JSONWriter
  • func (jw JSONWriter) Write(results Results) error
• type Result
• type Results
• type TableWriter
  • func (tw TableWriter) Write(results Results) error
• type TemplateWriter
  • func NewTemplateWriter(output io.Writer, outputTemplate string) (*TemplateWriter, error)
  • func (tw TemplateWriter) Write(results Results) error
• type Writer

Variables

var Now = time.Now

Now returns the current time

Functions

func WriteResults

func WriteResults(format string, output io.Writer, severities []dbTypes.Severity, results Results, outputTemplate string, light bool) error

WriteResults writes the result to output, format as passed in argument

Types

type JSONWriter

type JSONWriter struct {
	Output io.Writer
}

JSONWriter implements result Writer

func (JSONWriter) Write

func (jw JSONWriter) Write(results Results) error

Write writes the results in JSON format

type Result

type Result struct {
	Target          string                        `json:"Target"`
	Type            string                        `json:"Type,omitempty"`
	Packages        []ftypes.Package              `json:"Packages,omitempty"`
	Vulnerabilities []types.DetectedVulnerability `json:"Vulnerabilities"`
}

Result to hold image scan results

type Results

type Results []Result

Results to hold list of Result

type TableWriter

type TableWriter struct {
	Severities []dbTypes.Severity
	Output     io.Writer
	Light      bool
}

TableWriter implements Writer and output in tabular form

func (TableWriter) Write

func (tw TableWriter) Write(results Results) error

Write writes the result on standard output

type TemplateWriter

type TemplateWriter struct {
	Output   io.Writer
	Template *template.Template
}

TemplateWriter write result in custom format defined by user's template

func NewTemplateWriter

func NewTemplateWriter(output io.Writer, outputTemplate string) (*TemplateWriter, error)

NewTemplateWriter is the factory method to return TemplateWriter object

func (TemplateWriter) Write

func (tw TemplateWriter) Write(results Results) error

Write writes result

type Writer

type Writer interface {
	Write(Results) error
}

Writer defines the result write operation