output

Documentation

Index

• Constants
• func ExitCode(results []CheckResult) int
• func ExitCodeFailOnWarn(results []CheckResult) int
• func Outputs() []string
• type AzureDevOps
  • func NewAzureDevOps(w io.Writer) *AzureDevOps
  • func (t *AzureDevOps) Output(checkResults []CheckResult) error
  • func (t *AzureDevOps) Report(_ []*tester.Result, _ string) error
• type CheckResult
• type GitHub
  • func NewGitHub(w io.Writer) *GitHub
  • func (t *GitHub) Output(checkResults []CheckResult) error
  • func (t *GitHub) Report(_ []*tester.Result, _ string) error
• type JSON
  • func NewJSON(w io.Writer) *JSON
  • func (j *JSON) Output(results []CheckResult) error
  • func (j *JSON) Report(_ []*tester.Result, _ string) error
• type JUnit
  • func NewJUnit(w io.Writer, hideMessage bool) *JUnit
  • func (j *JUnit) Output(results []CheckResult) error
  • func (j *JUnit) Report(_ []*tester.Result, _ string) error
• type Options
• type Outputter
  • func Get(format string, options Options) Outputter
• type QueryResult
  • func (q QueryResult) Passed() bool
• type Result
  • func NewResult(metadata map[string]interface{}) (Result, error)
  • func (r Result) Passed() bool
• type Standard
  • func NewStandard(w io.Writer) *Standard
  • func (s *Standard) Output(results []CheckResult) error
  • func (s *Standard) Report(results []*tester.Result, flag string) error
• type TAP
  • func NewTAP(w io.Writer) *TAP
  • func (t *TAP) Output(checkResults []CheckResult) error
  • func (t *TAP) Report(_ []*tester.Result, _ string) error
• type Table
  • func NewTable(w io.Writer) *Table
  • func (t *Table) Output(checkResults []CheckResult) error
  • func (t *Table) Report(_ []*tester.Result, _ string) error

Constants

const (
	OutputStandard    = "stdout"
	OutputJSON        = "json"
	OutputTAP         = "tap"
	OutputTable       = "table"
	OutputJUnit       = "junit"
	OutputGitHub      = "github"
	OutputAzureDevOps = "azuredevops"
)

The defined output formats represent all of the supported formats that can be used to format and render results.

Functions

func ExitCode

func ExitCode(results []CheckResult) int

ExitCode returns the exit code that should be returned given all of the returned results.

func ExitCodeFailOnWarn

func ExitCodeFailOnWarn(results []CheckResult) int

ExitCodeFailOnWarn returns the exit code that should be returned given all of the returned results, and will consider warnings as failures.

func Outputs

func Outputs() []string

Outputs returns the available output formats.

Types

type AzureDevOps

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

AzureDevOps represents an Outputter that outputs results in AzureDevOps Pipelines format. https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands

func NewAzureDevOps

func NewAzureDevOps(w io.Writer) *AzureDevOps

NewAzureDevOps creates a new AzureDevOps with the given writer.

func (*AzureDevOps) Output

func (t *AzureDevOps) Output(checkResults []CheckResult) error

Output outputs the results.

func (*AzureDevOps) Report

func (t *AzureDevOps) Report(_ []*tester.Result, _ string) error

type CheckResult

type CheckResult struct {
	FileName   string        `json:"filename"`
	Namespace  string        `json:"namespace"`
	Successes  int           `json:"successes"`
	Skipped    []Result      `json:"skipped,omitempty"`
	Warnings   []Result      `json:"warnings,omitempty"`
	Failures   []Result      `json:"failures,omitempty"`
	Exceptions []Result      `json:"exceptions,omitempty"`
	Queries    []QueryResult `json:"queries,omitempty"`
}

CheckResult describes the result of a conftest policy evaluation. Errors produced by rego should be considered separate from other classes of exceptions.

type GitHub

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

GitHub represents an Outputter that outputs results in GitHub workflow format. https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions

func NewGitHub

func NewGitHub(w io.Writer) *GitHub

NewGitHub creates a new GitHub with the given writer.

func (*GitHub) Output

func (t *GitHub) Output(checkResults []CheckResult) error

Output outputs the results.

func (*GitHub) Report

func (t *GitHub) Report(_ []*tester.Result, _ string) error

type JSON

type JSON struct {
	Writer io.Writer
}

JSON represents an Outputter that outputs results in JSON format.

func NewJSON

func NewJSON(w io.Writer) *JSON

NewJSON creates a new JSON with the given writer.

func (*JSON) Output

func (j *JSON) Output(results []CheckResult) error

Output outputs the results.

func (*JSON) Report

func (j *JSON) Report(_ []*tester.Result, _ string) error

type JUnit

type JUnit struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

JUnit represents an Outputter that outputs results in JUnit format.

func NewJUnit

func NewJUnit(w io.Writer, hideMessage bool) *JUnit

NewJUnit creates a new JUnit with the given writer.

func (*JUnit) Output

func (j *JUnit) Output(results []CheckResult) error

Output outputs the results.

func (*JUnit) Report

func (j *JUnit) Report(_ []*tester.Result, _ string) error

type Options

type Options struct {
	Tracing            bool
	NoColor            bool
	SuppressExceptions bool
	ShowSkipped        bool
	JUnitHideMessage   bool
	File               *os.File
}

Options represents the options available when configuring an Outputter.

type Outputter

type Outputter interface {
	Output([]CheckResult) error
	Report([]*tester.Result, string) error
}

Outputter controls how results of an evaluation will be recorded and reported to the end user.

func Get

func Get(format string, options Options) Outputter

Get returns a type that can render output in the given format.

type QueryResult

type QueryResult struct {

	// Query is the fully qualified query that was used
	// to determine the result. Ex: (data.main.deny)
	Query string `json:"query"`

	// Results are the individual results of the query.
	// When querying data.main.deny, multiple deny rules can
	// exist, producing multiple results.
	Results []Result `json:"results"`

	// Traces represents a single trace of how the query was
	// evaluated. Each trace value is a trace line.
	Traces []string `json:"traces"`

	// Output represents anything print()'ed during the query
	// evaluation. Each value is a print() call's result.
	Outputs []string `json:"outputs,omitempty"`
}

QueryResult describes the result of evaluting a query.

func (QueryResult) Passed

func (q QueryResult) Passed() bool

Passed returns true if all of the results in the query passed and no failures were found.

type Result

type Result struct {
	Message  string                 `json:"msg"`
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	Outputs  []string               `json:"outputs,omitempty"`
}

Result describes the result of a single rule evaluation.

func NewResult

func NewResult(metadata map[string]interface{}) (Result, error)

NewResult creates a new result. An error is returned if the metadata could not be successfully parsed.

func (Result) Passed

func (r Result) Passed() bool

Passed returns true if the result did not fail a policy.

type Standard

type Standard struct {
	Writer io.Writer

	// Tracing will render the trace results of the
	// queries when set to true.
	Tracing bool

	// NoColor will disable all coloring when
	// set to true.
	NoColor bool

	// SuppressExceptions will disable output for exceptions when set to true.
	SuppressExceptions bool

	// ShowSkipped whether to show skipped tests
	// in the output.
	ShowSkipped bool
}

Standard represents an Outputter that outputs results in a human readable format.

func NewStandard

func NewStandard(w io.Writer) *Standard

NewStandard creates a new Standard with the given writer.

func (*Standard) Output

func (s *Standard) Output(results []CheckResult) error

Output outputs the results.

func (*Standard) Report

func (s *Standard) Report(results []*tester.Result, flag string) error

Report outputs results similar to OPA test output

type TAP

type TAP struct {
	Writer io.Writer
}

TAP represents an Outputter that outputs results in TAP format.

func NewTAP

func NewTAP(w io.Writer) *TAP

NewTAP creates a new TAP with the given writer.

func (*TAP) Output

func (t *TAP) Output(checkResults []CheckResult) error

Output outputs the results.

func (*TAP) Report

func (t *TAP) Report(_ []*tester.Result, _ string) error

type Table

type Table struct {
	Writer io.Writer
}

Table represents an Outputter that outputs results in a tabular format.

func NewTable

func NewTable(w io.Writer) *Table

NewTable creates a new Table with the given writer.

func (*Table) Output

func (t *Table) Output(checkResults []CheckResult) error

Output outputs the results.

func (*Table) Report

func (t *Table) Report(_ []*tester.Result, _ string) error