Interface Check

apps/advisor/pkg/app/checks/ifaces.go:14–28

Check returns metadata about the check being executed and the list of Steps

// Check returns metadata about the check being executed and the list of Steps
type Check interface {
	// ID returns the unique identifier of the check
	ID() string
	// Name returns the human-readable name of the check
	Name() string
	// Item returns the item that will be checked
	Item(ctx context.Context, id string) (any, error)
	// Items returns the list of items that will be checked
	Items(ctx context.Context) ([]any, error)
	// Steps returns the list of steps that will be executed
	Steps() []Step
	// Init initializes the check. It's called before running the steps and should be idempotent.
	// The result should not be cached, it should be initialized from scratch.
	Init(ctx context.Context) error
}

// Step is a single step in a check, including its metadata
type Step interface {