scanpipeline

type Options ¶

type Options struct {
	Client *scanoss.Client // required

	// Services are the decoration services to gather over the components. The caller resolves
	// these — from a flag, a config file, or nothing at all — and hands over the result: this
	// package knows services, not whatever vocabulary produced them.
	Services []scanoss.Service

	// SourceDeclared asks for declared dependencies to be sourced from the dependency manifests in
	// the same tree, and merged into the inventory alongside the scan's detected components. It is
	// not a decoration service: nothing is fetched, the manifests already carry resolved PURLs.
	SourceDeclared bool

	SourcePath string         // file or directory to scan (required)
	Threads    int            // fingerprint workers (<1 => 1)
	Filter     filter.Options // file-collection filters (directory scans)
	// DependencySettings is the scanoss.json skip rules for the dependencies
	// operation. The manifest collection is a stage of its own, with its own
	// profile, so it cannot reuse Filter.Settings (which holds the scanning
	// section). Nil when there is no scanoss.json.
	DependencySettings *filter.Settings
	ScanOptions        []scanoss.ScanOption // per-scan tuning (chunk size, poll interval, BOM, ...)

	// OnProgress receives every layer's progress. Optional; nil reports nothing. The pipeline runs
	// layers concurrently, so it must be safe for concurrent use.
	OnProgress func(Progress)
}

Options configures Run, the full scan pipeline over a source path. Every layer reports through OnProgress — the steps the pipeline runs itself and the ones it delegates to the SDK alike, so a caller listens on one channel rather than reconciling two.

type Progress ¶ added in v0.5.0

type Progress struct {
	Layer  string // which layer is reporting; see the Layer* constants
	Status Status // where that layer is
	Done   int    // units done, only ever growing
	Total  int    // units in total; 0 when the layer cannot say
}

Progress is one update from one pipeline layer, whether the pipeline ran that layer itself or delegated it to the SDK. Every field means the same thing for every layer, so a consumer can render any update without knowing which layer produced it, or how that layer works.

Done and Total only ever grow within a layer. Where the underlying work says otherwise — the server-side scan runs in passes that each restart their own counter — it is normalised here, so that no consumer has to know.

type Reporter ¶ added in v0.5.0

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

Reporter turns the SDK's stages into this package's layer updates. Run wires one up itself; it is exported for the callers that drive the SDK directly — `results` resumes a scan and enriches it, collecting and fingerprinting nothing — so that every entry point reports layers the same way and the translation exists in one place.

Hand it to a call with WithScanReporter and WithDecorationReporter — the reporter belongs to the operation, not to the client, so the same client can serve several with different listeners.

func NewReporter(on func(Progress)) *Reporter

func (r *Reporter) Decorating(service string, done, total int)

func (r *Reporter) Fingerprinting(done, total int)

func (r *Reporter) Scanning(e scanossapi.ScanEnvelope)

func (r *Reporter) Uploading(done, total int)

type Result ¶

type Result struct {
	Inventory     sbom.Inventory
	WFP           []byte
	ProcessErrors int
}

Result is the outcome of Run: the gathered inventory, the generated WFP (for --save-wfp) and the count of files that failed to fingerprint.

What the filters excluded is not here: it is reported as the collect layer completing, while the scan is still ahead, rather than handed back once everything is over.

func Run(ctx context.Context, opts Options) (Result, error)

type Status ¶ added in v0.5.0

type Status string

Status is a layer's position in its lifecycle, normalised so that layers as different as a local file walk and a queued server-side scan are rendered the same way.

const (
	StatusPending   Status = "pending" // known, not started: a queued scan, a layer awaiting its turn
	StatusRunning   Status = "running"
	StatusCompleted Status = "completed"
	StatusFailed    Status = "failed"
)