task

type CatalogingFactoryConfig ¶

type CatalogingFactoryConfig struct {
	ComplianceConfig     cataloging.ComplianceConfig
	SearchConfig         cataloging.SearchConfig
	RelationshipsConfig  cataloging.RelationshipsConfig
	DataGenerationConfig cataloging.DataGenerationConfig
	LicenseConfig        cataloging.LicenseConfig
	PackagesConfig       pkgcataloging.Config
	FilesConfig          filecataloging.Config
}

func DefaultCatalogingFactoryConfig() CatalogingFactoryConfig

type ErrInvalidExpression ¶

type ErrInvalidExpression struct {
	Expression string
	Operation  Operation
	Err        error
}

ErrInvalidExpression represents an expression that cannot be parsed or can be parsed but is logically invalid.

func (e ErrInvalidExpression) Error() string

type Expression ¶

type Expression struct {
	Operation Operation
	Operand   string
	Errors    []error
}

Expression represents a single operation-operand pair with (all validation errors). E.g. "+foo", "-bar", or "something" are all expressions. Some validations are relevant to not only the syntax (operation and operator) but other are sensitive to the context of the operand (e.g. if a given operand is a tag or a name, validated against the operation).

func (e Expression) String() string

type Expressions ¶

type Expressions []Expression

Expressions represents a list of expressions.

func (e Expressions) Clone() Expressions

func (e Expressions) Errors() (errs []error)

func (e Expressions) Len() int

func (e Expressions) Less(i, j int) bool

func (e Expressions) Swap(i, j int)

func (e Expressions) Validate() error

type Factories ¶ added in v1.20.0

type Factories []factory

func DefaultFileTaskFactories() Factories

func DefaultPackageTaskFactories() Factories

func (f Factories) Tasks(cfg CatalogingFactoryConfig) ([]Task, error)

type Operation ¶

type Operation string

Operation represents the type of operation to perform on the operand (set, add, remove, sub-select).

const (
	SetOperation       Operation = "set"
	AddOperation       Operation = "add"
	SubSelectOperation Operation = "sub-select"
	RemoveOperation    Operation = "remove"
)

type Selection ¶

type Selection struct {
	Request      cataloging.SelectionRequest
	Result       *strset.Set
	TokensByTask map[string]TokenSelection
}

Selection represents the users request for a subset of tasks to run and the resulting set of task names that were selected. Additionally, all tokens that were matched on to reach the returned conclusion are also provided.

func SelectInGroups(taskGroups [][]Task, selectionRequest cataloging.SelectionRequest) ([][]Task, Selection, error)

type Selector ¶

type Selector interface {
	HasAllSelectors(...string) bool
	Selectors() []string
}

type Task ¶

type Task interface {
	Name() string
	Execute(context.Context, file.Resolver, sbomsync.Builder) error
}

Task is a function that can wrap a cataloger to populate the SBOM with data (coordinated through the mutex).

func NewDeepSquashedScopeCleanupTask() Task

func NewEnvironmentTask() Task

func NewOSFeatureDetectionTask() Task

func NewPackageTask(cfg CatalogingFactoryConfig, c pkg.Cataloger, tags ...string) Task

func NewRelationshipsTask(cfg cataloging.RelationshipsConfig, src source.Description) Task

func NewTask(name string, tsk func(context.Context, file.Resolver, sbomsync.Builder) error, tags ...string) Task

func NewUnknownsLabelerTask(cfg cataloging.UnknownsConfig) Task

type TokenSelection ¶

type TokenSelection struct {
	SelectedOn   *strset.Set
	DeselectedOn *strset.Set
}

TokenSelection represents the tokens that were matched on to either include or exclude a given task (based on expression evaluation).