feat: Support scanning license files in golang packages over the network (#1630)

Signed-off-by: Avi Deitcher <avi@deitcher.net>
Signed-off-by: Keith Zantow <kzantow@gmail.com>
Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
Co-authored-by: Keith Zantow <kzantow@gmail.com>
Co-authored-by: Alex Goodman <alex.goodman@anchore.com>

syft/event/cataloger_task.go

@@ -0,0 +1,52 @@
+package event
+
+import (
+	"github.com/wagoodman/go-partybus"
+	"github.com/wagoodman/go-progress"
+
+	"github.com/anchore/syft/internal/bus"
+)
+
+type CatalogerTask struct {
+	prog *progress.Manual
+	// Title
+	Title string
+	// TitleOnCompletion a string to use as title when completed
+	TitleOnCompletion string
+	// SubStatus indicates this progress should be rendered as a sub-item
+	SubStatus bool
+	// RemoveOnCompletion indicates this progress line will be removed when completed
+	RemoveOnCompletion bool
+	// value is the value to display -- not public as SetValue needs to be called to initialize this progress
+	value string
+}
+
+func (e *CatalogerTask) init() {
+	e.prog = progress.NewManual(-1)
+
+	bus.Publish(partybus.Event{
+		Type:   CatalogerTaskStarted,
+		Source: e,
+	})
+}
+
+func (e *CatalogerTask) SetCompleted() {
+	if e.prog != nil {
+		e.prog.SetCompleted()
+	}
+}
+
+func (e *CatalogerTask) SetValue(value string) {
+	if e.prog == nil {
+		e.init()
+	}
+	e.value = value
+}
+
+func (e *CatalogerTask) GetValue() string {
+	return e.value
+}
+
+func (e *CatalogerTask) GetMonitor() *progress.Manual {
+	return e.prog
+}

syft/event/event.go

@@ -34,4 +34,7 @@ const (
 
 	// AttestationStarted is a partybus event that occurs when starting an SBOM attestation process
 	AttestationStarted partybus.EventType = "syft-attestation-started-event"
+
+	// CatalogerTaskStarted is a partybus event that occurs when starting a task within a cataloger
+	CatalogerTaskStarted partybus.EventType = "syft-cataloger-task-started"
 )

syft/event/parsers/parsers.go

@@ -111,6 +111,19 @@ func ParseFileIndexingStarted(e partybus.Event) (string, progress.StagedProgress
 	return path, prog, nil
 }
 
+func ParseCatalogerTaskStarted(e partybus.Event) (*event.CatalogerTask, error) {
+	if err := checkEventType(e.Type, event.CatalogerTaskStarted); err != nil {
+		return nil, err
+	}
+
+	source, ok := e.Source.(*event.CatalogerTask)
+	if !ok {
+		return nil, newPayloadErr(e.Type, "Source", e.Source)
+	}
+
+	return source, nil
+}
+
 func ParseExit(e partybus.Event) (func() error, error) {
 	if err := checkEventType(e.Type, event.Exit); err != nil {
 		return nil, err