types

Documentation

Index

• Constants
• Variables
• type Domain
• type DomainResources
• type LulaValidation
  • func CreateFailingLulaValidation(name string) *LulaValidation
  • func CreatePassingLulaValidation(name string) *LulaValidation
  • func (val *LulaValidation) GetDomainResourcesAsJSON() []byte
  • func (val *LulaValidation) RequireExecutionConfirmation() (confirm bool)
  • func (val *LulaValidation) Validate(ctx context.Context, opts ...LulaValidationOption) error
• type LulaValidationMap
• type LulaValidationOption
  • func ExecutionAllowed(executionAllowed bool) LulaValidationOption
  • func GetResourcesOnly(onlyResources bool) LulaValidationOption
  • func Interactive(isInteractive bool) LulaValidationOption
  • func WithSpinner(spinner *message.Spinner) LulaValidationOption
  • func WithStaticResources(resources DomainResources) LulaValidationOption
• type LulaValidationType
• type Provider
• type Result

Constants

const (
	LulaValidationWorkDir contextKey = iota
)

Variables

var (
	ErrExecutionNotAllowed = errors.New("execution not allowed")
	ErrDomainGetResources  = errors.New("domain GetResources error")
	ErrProviderEvaluate    = errors.New("provider Evaluate error")
)

Define base errors for validations

Types

type Domain

type Domain interface {
	GetResources(context.Context) (DomainResources, error)
	IsExecutable() bool
}

type DomainResources

type DomainResources map[string]interface{}

type LulaValidation

type LulaValidation struct {
	// Name of the Validation
	Name string

	// UUID of the validation - tied to the component-definition.backmatter
	UUID string

	// Provider is the provider that is evaluating the validation
	Provider *Provider

	// Domain is the domain that provides the evidence for the validation
	Domain *Domain

	// DomainResources is the set of resources that the domain is providing
	DomainResources *DomainResources

	// LulaValidationType is the type of validation that is being performed
	LulaValidationType LulaValidationType

	// Evaluated is a boolean that represents if the validation has been evaluated
	Evaluated bool

	// Result is the result of the validation
	Result *Result
}

func CreateFailingLulaValidation

func CreateFailingLulaValidation(name string) *LulaValidation

CreateFailingLulaValidation creates a placeholder LulaValidation object that is always failing

func CreatePassingLulaValidation

func CreatePassingLulaValidation(name string) *LulaValidation

CreatePassingLulaValidation creates a placeholder LulaValidation object that is always passing

func (*LulaValidation) GetDomainResourcesAsJSON

func (val *LulaValidation) GetDomainResourcesAsJSON() []byte

Return domain resources as a json []byte

func (*LulaValidation) RequireExecutionConfirmation

func (val *LulaValidation) RequireExecutionConfirmation() (confirm bool)

Check if the validation requires confirmation before possible execution code is run

func (*LulaValidation) Validate

func (val *LulaValidation) Validate(ctx context.Context, opts ...LulaValidationOption) error

Perform the validation, and store the result in the LulaValidation struct

type LulaValidationMap

type LulaValidationMap = map[string]LulaValidation

LulaValidationMap is a map of LulaValidation objects

type LulaValidationOption

type LulaValidationOption func(*lulaValidationOptions)

func ExecutionAllowed

func ExecutionAllowed(executionAllowed bool) LulaValidationOption

ExecutionAllowed sets the value of the executionAllowed field in the LulaValidation object

func GetResourcesOnly

func GetResourcesOnly(onlyResources bool) LulaValidationOption

RequireExecutionConfirmation is a function that returns a boolean indicating if the validation requires confirmation before execution

func Interactive

func Interactive(isInteractive bool) LulaValidationOption

Interactive is a function that returns a boolean indicating if the validation should be interactive

func WithSpinner

func WithSpinner(spinner *message.Spinner) LulaValidationOption

WithSpinner returns a LulaValidationOption that sets the spinner for the LulaValidation object

func WithStaticResources

func WithStaticResources(resources DomainResources) LulaValidationOption

WithStaticResources sets the static resources for the LulaValidation object

type LulaValidationType

type LulaValidationType string

const (
	LulaValidationTypeNormal  LulaValidationType = "Lula Validation"
	DefaultLulaValidationType LulaValidationType = LulaValidationTypeNormal
)

type Provider

type Provider interface {
	Evaluate(DomainResources) (Result, error)
}

type Result

type Result struct {
	UUID         string            `json:"uuid" yaml:"uuid"`
	ControlId    string            `json:"control-id" yaml:"control-id"`
	Description  string            `json:"description" yaml:"description"`
	Passing      int               `json:"passing" yaml:"passing"`
	Failing      int               `json:"failing" yaml:"failing"`
	State        string            `json:"state" yaml:"state"`
	Observations map[string]string `json:"observations" yaml:"observations"`
}

native type for conversion to targeted report format