rule

Documentation

Index

• func StatusDescription(status Status) string
• func StatusIcon(status Status) rune
• type CheckResult
  • func AcceptedCheckResult(message string, target Target) CheckResult
  • func ErroredCheckResult(message string, target Target) CheckResult
  • func FailedCheckResult(message string, target Target) CheckResult
  • func NotImplementedCheckResult(message string, target Target) CheckResult
  • func PassedCheckResult(message string, target Target) CheckResult
  • func SkippedCheckResult(message string, target Target) CheckResult
  • func WarningCheckResult(message string, target Target) CheckResult
• type Rule
• type RuleResult
  • func SingleCheckResult(r Rule, checkResult CheckResult) RuleResult
• type SkipRule
  • func NewSkipRule(id, name, justification string, status Status) *SkipRule
  • func (s *SkipRule) ID() string
  • func (s *SkipRule) Name() string
  • func (s *SkipRule) Run(context.Context) (RuleResult, error)
• type Status
  • func Statuses() []Status
  • func (a Status) Less(b Status) bool
• type Target
  • func NewTarget(keyValuePairs ...string) Target
  • func (t Target) With(keyValuePairs ...string) Target

Functions

func StatusDescription

func StatusDescription(status Status) string

StatusDescription returns the description of a given Status string.

func StatusIcon

func StatusIcon(status Status) rune

StatusIcon returns the icon of a given Status string.

Types

type CheckResult

type CheckResult struct {
	Status  Status
	Message string
	Target  Target
}

CheckResult contains information about a Rule check. Returned from Rule runs.

func AcceptedCheckResult

func AcceptedCheckResult(message string, target Target) CheckResult

AcceptedCheckResult returns a CheckResult with Accepted status and the given message and target

func ErroredCheckResult

func ErroredCheckResult(message string, target Target) CheckResult

ErroredCheckResult returns a CheckResult with Errored status and the given message and target

func FailedCheckResult

func FailedCheckResult(message string, target Target) CheckResult

FailedCheckResult returns a CheckResult with Failed status and the given message and target

func NotImplementedCheckResult

func NotImplementedCheckResult(message string, target Target) CheckResult

NotImplementedCheckResult returns a CheckResult with v status and the given message and target

func PassedCheckResult

func PassedCheckResult(message string, target Target) CheckResult

PassedCheckResult returns a CheckResult with Passed status and the given message and target

func SkippedCheckResult

func SkippedCheckResult(message string, target Target) CheckResult

SkippedCheckResult returns a CheckResult with Skipped status and the given message and target

func WarningCheckResult

func WarningCheckResult(message string, target Target) CheckResult

WarningCheckResult returns a CheckResult with Warning status and the given message and target

type Rule

type Rule interface {
	ID() string
	Name() string
	Run(ctx context.Context) (RuleResult, error)
}

Rule defines what is considered a rule in the context of Diki.

type RuleResult

type RuleResult struct {
	RuleID, RuleName string
	CheckResults     []CheckResult
}

RuleResult contains a Rule identification and the results of a Rule run.

func SingleCheckResult

func SingleCheckResult(r Rule, checkResult CheckResult) RuleResult

SingleCheckResult returns a RuleResult containing a single check.

type SkipRule

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

SkipRule is a Rule that always reports a predefined status.

func NewSkipRule

func NewSkipRule(id, name, justification string, status Status) *SkipRule

NewSkipRule returns a new skipped Rule.

func (*SkipRule) ID

func (s *SkipRule) ID() string

ID returns the id of the Rule.

func (*SkipRule) Name

func (s *SkipRule) Name() string

Name returns the name of the Rule.

func (*SkipRule) Run

func (s *SkipRule) Run(context.Context) (RuleResult, error)

Run immediately returns a RuleResult containing a single CheckResult with a predefined status and justification.

type Status

type Status string

Status of a CheckResult

const (
	// Passed status indicates that a check is satisfied.
	Passed Status = "Passed"
	// Skipped status indicates that a rule is skipped with explanation.
	Skipped Status = "Skipped"
	// Accepted status indicates that a check violation is accepted and justified
	// based on additional configuration.
	Accepted Status = "Accepted"
	// Warning status indicates that there is ambiguity and the check was not performed with confidence.
	Warning Status = "Warning"
	// Failed status indicates that a check reported a violation.
	Failed Status = "Failed"
	// Errored status indicates that an unexpected error occured during check execution.
	Errored Status = "Errored"
	// NotImplemented status indicates that a rule/check is not implemented.
	NotImplemented Status = "Not Implemented"
)

func Statuses

func Statuses() []Status

Statuses returns all supported statuses.

func (Status) Less

func (a Status) Less(b Status) bool

Less is used to define the priority of the statuses. The ascending order is as follows Passed, Skipped, Accepted, Warning, Failed, Errored, Not Implemented

type Target

type Target map[string]string

Target is used to describe the things that were checked during ruleset runs.

func NewTarget

func NewTarget(keyValuePairs ...string) Target

NewTarget creates a new Target with the given key values. Panics if the number of arguments is an odd number.

func (Target) With

func (t Target) With(keyValuePairs ...string) Target

With creates a new Target with additional key values. It does not modify the original one. Panics if the number of arguments is an odd number.