contracts

Documentation

Index

• Constants
• type AuditResult
  • func RunAudit(contracts []*Contract, tags []string, root string) AuditResult
• type Check
• type CheckResult
• type Contract
  • func LoadDir(dir string) ([]*Contract, error)
• type OnFail

Constants

const (
	OnFailFail             = engine.OnFailFail
	OnFailWarn             = engine.OnFailWarn
	OnFailRequireExemption = engine.OnFailRequireExemption
	OnFailEscalate         = engine.OnFailEscalate
	OnFailHaltAgents       = engine.OnFailHaltAgents
	OnFailAlert            = engine.OnFailAlert
	OnFailHalt             = engine.OnFailHalt
)

Types

type AuditResult

type AuditResult = engine.AuditResult

func RunAudit

func RunAudit(contracts []*Contract, tags []string, root string) AuditResult

RunAudit evaluates loaded contracts for a given project/contracts root.

type Check

type Check = engine.Check

type CheckResult

type CheckResult = engine.CheckResult

type Contract

type Contract = engine.Contract

func LoadDir

func LoadDir(dir string) ([]*Contract, error)

LoadDir loads all YAML contracts from a directory.

type OnFail

type OnFail = engine.OnFail