plugin

Documentation

Index

• type Input
• type Meta
  • func ParseConfig(cfg interface{}) (Meta, error)
• type Mode

Types

type Input

type Input struct {
	Meta Meta            `json:"meta"`
	Args json.RawMessage `json:"args"`
}

Input merges runner metadata with config args

type Meta

type Meta struct {
	Mode Mode `json:"mode"`
}

Meta passes additional information to the check from the runner

func ParseConfig

func ParseConfig(cfg interface{}) (Meta, error)

ParseConfig loads the config from stdin

type Mode

type Mode int

Mode signals whether the check should return expected or actual value

const (
	// Actual checks the current state of the check
	Actual Mode = iota
	// Expected checks the desired state of the check
	Expected
)