setup

Sep 1, 2025

Changes in this version

+ var ErrEmptyDatasourceConfig = errors.New("datasource configuration is empty")

+ var ErrInvalidAcquisitionFilename = errors.New("acquisition filename must not contain slashes (/) or backslashes (\\)")

+ var ErrMissingAcquisitionFilename = errors.New("a filename for the datasource configuration is required")

+ var ErrMissingSourceField = errors.New("source field is required")

+ var ErrSystemdPropertyNotFound = errors.New("systemd property not found")

+ type AcquisitionSpec struct

+ Datasource DatasourceConfig

+ Filename string

+ func (a *AcquisitionSpec) AddHeader(content []byte) []byte

+ func (a *AcquisitionSpec) Open(toDir string) (*os.File, error)

+ func (a *AcquisitionSpec) Path(toDir string) (string, error)

+ func (a *AcquisitionSpec) ToYAML() ([]byte, error)

+ func (a *AcquisitionSpec) Validate() error

+ type DatasourceConfig map[string]any

+ func (d DatasourceConfig) Validate() error

+ type DetectConfig struct

+ Detect map[string]ServiceProfile

+ func NewDetectConfig(detectReader io.Reader) (*DetectConfig, error)

+ func (d *DetectConfig) ListSupportedServices() []string

+ type DetectOptions struct

+ SkipServices []string

+ SkipSystemd bool

+ WantServices []string

+ type Executor func(ctx context.Context, name string, args ...string) *exec.Cmd

+ type ExprEnvironment struct

+ Ctx context.Context

+ Host host.InfoStat

+ Path ExprPath

+ System *ExprSystem

+ Systemd *ExprSystemd

+ Version ExprVersion

+ Windows *ExprWindows

+ type ExprPath interface

+ Exists func(ctx context.Context, path string) bool

+ Glob func(ctx context.Context, glob string) []string

+ type ExprSystem struct

+ func NewExprSystem(runningProcesses ProcessMap) *ExprSystem

+ func (e *ExprSystem) ProcessRunning(ctx context.Context, processName string) (bool, error)

+ type ExprSystemd struct

+ func NewExprSystemd(installedUnits UnitMap, logger logrus.FieldLogger) *ExprSystemd

+ func (e *ExprSystemd) UnitConfig(ctx context.Context, unitName, key string) (string, error)

+ func (e *ExprSystemd) UnitInstalled(ctx context.Context, unitName string) (bool, error)

+ func (e *ExprSystemd) UnitLogsToJournal(ctx context.Context, unitName string) (bool, error)

+ type ExprVersion struct

+ func (ExprVersion) Check(version, constraint string) (bool, error)

+ type ExprWindows struct

+ func NewExprWindows() (*ExprWindows, error)

+ func (e *ExprWindows) ServiceEnabled(serviceName string) (bool, error)

+ type HubSpec map[string][]string

+ type InstallRecommendation struct

+ AcquisitionSpec AcquisitionSpec

+ HubSpec HubSpec

+ type OSExprPath struct

+ func (OSExprPath) Exists(_ context.Context, path string) bool

+ func (OSExprPath) Glob(_ context.Context, pattern string) []string

+ type ProcessMap map[string]struct

+ func DetectProcesses(ctx context.Context, logger logrus.FieldLogger) (ProcessMap, error)

+ type ServiceMap map[string]bool — windows/amd64

+ type ServicePlan struct

+ Name string

+ type ServiceProfile struct

+ When []string

+ func (s *ServiceProfile) Compile() error

+ func (s *ServiceProfile) Evaluate(env *ExprEnvironment, logger logrus.FieldLogger) (bool, error)

+ type Setup struct

+ Plans []ServicePlan

+ func BuildSetup(ctx context.Context, detectConfig *DetectConfig, opts DetectOptions, ...) (*Setup, error)

+ func ParseSetupYAML(input io.Reader, showSource bool, wantColor bool) (*Setup, error)

+ func (s *Setup) CollectAcquisitionSpecs() []AcquisitionSpec

+ func (s *Setup) CollectHubSpecs() []HubSpec

+ func (s *Setup) DetectedServices() []string

+ func (s *Setup) ToYAML(outYaml bool) ([]byte, error)

+ type UnitConfig map[string]string

+ func NewUnitConfig(ctx context.Context, executor Executor, unit string) (UnitConfig, error)

+ type UnitInfo struct

+ Config UnitConfig

+ type UnitMap map[string]UnitInfo

+ func DetectSystemdUnits(ctx context.Context, executor Executor) (UnitMap, error)