version

Documentation

Index

• Variables
• type Alert
• type AuditChecker
  • func NewAuditChecker(checkURL, version string) *AuditChecker
  • func NewDefaultAuditChecker(checkURL string) *AuditChecker
  • func (a *AuditChecker) Check(ctx context.Context) (*AuditResponse, error)
  • func (a *AuditChecker) CheckAndLog(ctx context.Context, log logging.Logger)
  • func (a *AuditChecker) Close()
  • func (a *AuditChecker) LastCheck() (*AuditResponse, error)
  • func (a *AuditChecker) StartPeriodicCheck(ctx context.Context, interval time.Duration, log logging.Logger) bool
  • func (a *AuditChecker) StopPeriodicCheck()
• type AuditResponse
  • func (a *AuditResponse) UpgradeRecommendedURL() string

Variables

var (
	ErrAuditCheckFailed = errors.New("audit check request failed")
	ErrMissingCheckURL  = errors.New("missing audit check URL")
)

var (
	UnreleasedVersion = "dev"
	// Version is the current git version of the code.  It is filled in by "make build".
	// Make sure to change that target in Makefile if you change its name or package.
	Version = "dev"
)

Types

type Alert

type Alert struct {
	ID               string `json:"id"`
	AffectedVersions string `json:"affected_versions"`
	PatchedVersions  string `json:"patched_versions"`
	Description      string `json:"description"`
}

type AuditChecker

type AuditChecker struct {
	CheckURL string
	Client   http.Client
	Version  string
	// contains filtered or unexported fields
}

func NewAuditChecker

func NewAuditChecker(checkURL, version string) *AuditChecker

func NewDefaultAuditChecker

func NewDefaultAuditChecker(checkURL string) *AuditChecker

func (*AuditChecker) Check

func (a *AuditChecker) Check(ctx context.Context) (*AuditResponse, error)

func (*AuditChecker) CheckAndLog

func (a *AuditChecker) CheckAndLog(ctx context.Context, log logging.Logger)

CheckAndLog performs an audit check, logs and keeps the last response

func (*AuditChecker) Close

func (a *AuditChecker) Close()

Close release resources used by audit checker - ex: periodic check

func (*AuditChecker) LastCheck

func (a *AuditChecker) LastCheck() (*AuditResponse, error)

func (*AuditChecker) StartPeriodicCheck

func (a *AuditChecker) StartPeriodicCheck(ctx context.Context, interval time.Duration, log logging.Logger) bool

StartPeriodicCheck performs one check and continues every 'interval' in the background check results will be found in the log and updated for 'LastCheck' Return false if periodic check already ran

func (*AuditChecker) StopPeriodicCheck

func (a *AuditChecker) StopPeriodicCheck()

type AuditResponse

type AuditResponse struct {
	UpgradeURL string  `json:"upgrade_url,omitempty"`
	Alerts     []Alert `json:"alerts"`
}

func (*AuditResponse) UpgradeRecommendedURL

func (a *AuditResponse) UpgradeRecommendedURL() string