printer

Documentation

Index

• Constants
• Variables
• type ControlSummary
  • func (controlSummary *ControlSummary) ToSlice() []string
• type IPrinter
  • func GetPrinter(printFormat string) IPrinter
• type JUnitFailure
• type JUnitProperty
• type JUnitSkipMessage
• type JUnitTestCase
• type JUnitTestSuite
• type JUnitTestSuites
• type JsonPrinter
  • func NewJsonPrinter() *JsonPrinter
  • func (jsonPrinter *JsonPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)
  • func (jsonPrinter *JsonPrinter) Score(score float32)
  • func (jsonPrinter *JsonPrinter) SetWriter(outputFile string)
• type JunitPrinter
  • func NewJunitPrinter() *JunitPrinter
  • func (junitPrinter *JunitPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)
  • func (junitPrinter *JunitPrinter) Score(score float32)
  • func (junitPrinter *JunitPrinter) SetWriter(outputFile string)
• type PrettyPrinter
  • func NewPrettyPrinter() *PrettyPrinter
  • func (printer *PrettyPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)
  • func (printer *PrettyPrinter) Score(score float32)
  • func (printer *PrettyPrinter) SetWriter(outputFile string)
• type SilentPrinter
  • func (silentPrinter *SilentPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)
• type Summary
  • func NewSummary() Summary
• type WorkloadSummary
  • func (workloadSummary *WorkloadSummary) ToString() string

Constants

const (
	PrettyFormat       string = "pretty-printer"
	JsonFormat         string = "json"
	JunitResultPrinter string = "junit"
)

const EmptyPercentage = "NaN"

Variables

var INDENT = "   "

Types

type ControlSummary

type ControlSummary struct {
	TotalResources    int
	TotalFailed       int
	TotalWarnign      int
	Description       string
	Remediation       string
	ListInputKinds    []string
	FailedWorkloads   map[string][]WorkloadSummary // <namespace>:[<WorkloadSummary>]
	ExcludedWorkloads map[string][]WorkloadSummary // <namespace>:[<WorkloadSummary>]
}

func (*ControlSummary) ToSlice

func (controlSummary *ControlSummary) ToSlice() []string

type IPrinter

type IPrinter interface {
	ActionPrint(opaSessionObj *cautils.OPASessionObj)
	SetWriter(outputFile string)
	Score(score float32)
}

func GetPrinter

func GetPrinter(printFormat string) IPrinter

type JUnitFailure

type JUnitFailure struct {
	Message  string `xml:"message,attr"`
	Type     string `xml:"type,attr"`
	Contents string `xml:",chardata"`
}

JUnitFailure contains data related to a failed test.

type JUnitProperty

type JUnitProperty struct {
	Name  string `xml:"name,attr"`
	Value string `xml:"value,attr"`
}

JUnitProperty represents a key/value pair used to define properties.

type JUnitSkipMessage

type JUnitSkipMessage struct {
	Message string `xml:"message,attr"`
}

JUnitSkipMessage contains the reason why a testcase was skipped.

type JUnitTestCase

type JUnitTestCase struct {
	XMLName     xml.Name          `xml:"testcase"`
	Classname   string            `xml:"classname,attr"`
	Name        string            `xml:"name,attr"`
	Time        string            `xml:"time,attr"`
	Resources   int               `xml:"resources,attr"`
	Excluded    int               `xml:"excluded,attr"`
	Failed      int               `xml:"filed,attr"`
	SkipMessage *JUnitSkipMessage `xml:"skipped,omitempty"`
	Failure     *JUnitFailure     `xml:"failure,omitempty"`
}

JUnitTestCase is a single test case with its result.

type JUnitTestSuite

type JUnitTestSuite struct {
	XMLName    xml.Name        `xml:"testsuite"`
	Tests      int             `xml:"tests,attr"`
	Time       string          `xml:"time,attr"`
	Name       string          `xml:"name,attr"`
	Resources  int             `xml:"resources,attr"`
	Excluded   int             `xml:"excluded,attr"`
	Failed     int             `xml:"filed,attr"`
	Properties []JUnitProperty `xml:"properties>property,omitempty"`
	TestCases  []JUnitTestCase `xml:"testcase"`
}

JUnitTestSuite is a single JUnit test suite which may contain many testcases.

type JUnitTestSuites

type JUnitTestSuites struct {
	XMLName xml.Name         `xml:"testsuites"`
	Suites  []JUnitTestSuite `xml:"testsuite"`
}

type JsonPrinter

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

func NewJsonPrinter

func NewJsonPrinter() *JsonPrinter

func (*JsonPrinter) ActionPrint

func (jsonPrinter *JsonPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)

func (*JsonPrinter) Score

func (jsonPrinter *JsonPrinter) Score(score float32)

func (*JsonPrinter) SetWriter

func (jsonPrinter *JsonPrinter) SetWriter(outputFile string)

type JunitPrinter

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

func NewJunitPrinter

func NewJunitPrinter() *JunitPrinter

func (*JunitPrinter) ActionPrint

func (junitPrinter *JunitPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)

func (*JunitPrinter) Score

func (junitPrinter *JunitPrinter) Score(score float32)

func (*JunitPrinter) SetWriter

func (junitPrinter *JunitPrinter) SetWriter(outputFile string)

type PrettyPrinter

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

func NewPrettyPrinter

func NewPrettyPrinter() *PrettyPrinter

func (*PrettyPrinter) ActionPrint

func (printer *PrettyPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)

func (*PrettyPrinter) Score

func (printer *PrettyPrinter) Score(score float32)

func (*PrettyPrinter) SetWriter

func (printer *PrettyPrinter) SetWriter(outputFile string)

type SilentPrinter

type SilentPrinter struct {
}

func (*SilentPrinter) ActionPrint

func (silentPrinter *SilentPrinter) ActionPrint(opaSessionObj *cautils.OPASessionObj)

type Summary

type Summary map[string]ControlSummary

func NewSummary

func NewSummary() Summary

type WorkloadSummary

type WorkloadSummary struct {
	Kind      string
	Name      string
	Namespace string
	Group     string
	Exception *armotypes.PostureExceptionPolicy
}

func (*WorkloadSummary) ToString

func (workloadSummary *WorkloadSummary) ToString() string