fixit

type Applicability struct {
	// Failing is true while the originating check does not pass.
	Failing bool `json:"failing"`
	// Detail is the check result as a person reads it.
	Detail string `json:"detail"`
	// Signature feeds the fingerprint; empty means Detail. Set it when Detail
	// carries volatile numbers that should not re-arm a demoted fix.
	Signature string `json:"-"`
	// Kind lowers the fix's tier for this host; empty keeps Fix.Kind.
	Kind    Kind     `json:"kind,omitempty"`
	Reason  string   `json:"reason,omitempty"`
	Changes []Change `json:"changes"`
	Command string   `json:"command,omitempty"`
	Param   *Param   `json:"param,omitempty"`
}

type Attempt struct {
	FixID       string        `json:"fix_id"`
	Subject     string        `json:"subject"`
	At          time.Time     `json:"at"`
	Actor       string        `json:"actor"`
	Outcome     OutcomeStatus `json:"outcome"`
	Detail      string        `json:"detail"`
	Fingerprint string        `json:"fingerprint"`
}

type BackupDeps struct {
	Check func(ctx context.Context) (CheckState, error)
	// Create takes a snapshot and returns its name; nil means backups are not configured.
	Create func(ctx context.Context) (string, error)
}

type Change struct {
	Label  string `json:"label"`
	Detail string `json:"detail,omitempty"`
	Bytes  int64  `json:"bytes,omitempty"`
}

type CheckState struct {
	Failing bool
	Detail  string
}

type DiskDeps struct {
	Free        func(ctx context.Context) (free, total int64, err error)
	Reclaimable func(ctx context.Context) (DiskReclaim, error)
	Prune       func(ctx context.Context) (freed int64, err error)
	// WarnFreePercent is the free-space percentage below which the check fails.
	WarnFreePercent float64
}

type DiskReclaim struct {
	ContainersBytes int64
	ImagesBytes     int64
	VolumesBytes    int64
	BuildCacheBytes int64
	OrphanNetworks  []string
}

type Engine struct {
	// contains filtered or unexported fields
}

type EngineOption func(*Engine)

type Finding struct {
	Failing bool
	Detail  string
	// Command is the exact host command; empty means there is no single command.
	Command string
	// Reason is prose guidance shown when there is no command.
	Reason string
}

type Fix struct {
	ID         string
	CheckID    string
	Subject    string
	Kind       Kind
	Title      string
	Why        string
	Risk       Risk
	Reversible bool
	// Needs is the API ability the caller must hold to apply.
	Needs string
	// Detect re-runs the originating check and plans the fix.
	Detect func(ctx context.Context) (Applicability, error)
	// Run performs the change; nil for guided and manual fixes.
	Run func(ctx context.Context, in Input) error
}

type GuidedDeps struct {
	ID      string
	CheckID string
	Subject string
	Title   string
	Why     string
	Risk    Risk
	Check   func(ctx context.Context) (Finding, error)
}

type HostEnv struct {
	Mode        string
	Unit        string
	Root        bool
	TunPresent  bool
	CapNetAdmin bool
	Executable  string
}

type HostReader struct {
	ReadFile   func(path string) ([]byte, error)
	Exists     func(path string) bool
	Getenv     func(key string) string
	Geteuid    func() int
	Executable func() string
}

type Input struct {
	Actor  string
	Params map[string]string
}

type Kind string

type LegacyTokensDeps struct {
	// Pending counts pre-upgrade tokens not yet migrated.
	Pending func(ctx context.Context) (int, error)
	// Migrate imports every pending token; nil means the auth library is not configured.
	Migrate func(ctx context.Context) error
}

type NetworkPoolDeps struct {
	Usage func(ctx context.Context) (enabled bool, inUse, capacity int, err error)
	// Orphans lists networks a prune would remove.
	Orphans func(ctx context.Context) ([]string, error)
	Prune   func(ctx context.Context) (removed []string, err error)
	// WarnPercent is the usage above which the check fails.
	WarnPercent int
	// PoolEnv names the env var that widens the pool.
	PoolEnv string
}

type Option struct {
	Value string `json:"value"`
	Label string `json:"label"`
}

type OrphansDeps struct {
	Check       func(ctx context.Context) (CheckState, error)
	Reclaimable func(ctx context.Context) (DiskReclaim, error)
	Prune       func(ctx context.Context) (freed int64, err error)
}

type OutcomeStatus string

type Param struct {
	Name    string   `json:"name"`
	Options []Option `json:"options"`
	Default string   `json:"default,omitempty"`
	Free    bool     `json:"free"`
}

type PortHolder struct {
	Process   string
	PID       int
	Container string
}

type PublicAddressDeps struct {
	Check      func(ctx context.Context) (CheckState, error)
	Candidates func(ctx context.Context) []Option
	Save       func(ctx context.Context, host, actor string) error
}

type Result struct {
	FixID   string        `json:"fix_id"`
	Outcome OutcomeStatus `json:"outcome"`
	Detail  string        `json:"detail"`
	View    View          `json:"view"`
}

type Risk string

type State string

type Store interface {
	RecentAttempts(ctx context.Context, fixID, subject string, limit int) ([]Attempt, error)
	CountAttemptsSince(ctx context.Context, fixID string, since time.Time) (int, error)
	RecordAttempt(ctx context.Context, a Attempt) error
}

type UDPPortDeps struct {
	Check  func(ctx context.Context) (CheckState, error)
	Port   int
	Holder func(ctx context.Context, port int) (PortHolder, bool)
}

type View struct {
	ID         string        `json:"id"`
	CheckID    string        `json:"check_id"`
	Subject    string        `json:"subject"`
	Title      string        `json:"title"`
	Why        string        `json:"why"`
	Risk       Risk          `json:"risk"`
	Reversible bool          `json:"reversible"`
	Needs      string        `json:"needs"`
	State      State         `json:"state"`
	BaseKind   Kind          `json:"base_kind"`
	Kind       Kind          `json:"kind"`
	Failing    bool          `json:"failing"`
	Detail     string        `json:"detail"`
	Reason     string        `json:"reason,omitempty"`
	Changes    []Change      `json:"changes"`
	Command    string        `json:"command,omitempty"`
	Param      *Param        `json:"param,omitempty"`
	LastTried  *Attempt      `json:"last_attempt,omitempty"`
	Attempts   []Attempt     `json:"attempts"`
	Blocked    string        `json:"blocked,omitempty"`
	RetryAfter time.Duration `json:"-"`
}

type WireGuardDeps struct {
	Check func(ctx context.Context) (CheckState, error)
	Host  func() HostEnv
	// FallbackUnit names the systemd unit when the cgroup does not.
	FallbackUnit string
}