mirror of
https://github.com/anchore/syft.git
synced 2025-11-21 10:23:18 +01:00
51b9c73c31
* add basic documentation for catalogers (with refactoring for simplification) Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * add docs for catalog parsers, UI, and event bus Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * update bus phrasing Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
87 lines
3.0 KiB
Go
87 lines
3.0 KiB
Go
package cataloger
|
|
|
|
import (
|
|
"github.com/anchore/stereoscope/pkg/file"
|
|
"github.com/anchore/syft/internal/bus"
|
|
"github.com/anchore/syft/internal/log"
|
|
"github.com/anchore/syft/syft/event"
|
|
"github.com/anchore/syft/syft/pkg"
|
|
"github.com/anchore/syft/syft/scope"
|
|
"github.com/hashicorp/go-multierror"
|
|
"github.com/wagoodman/go-partybus"
|
|
"github.com/wagoodman/go-progress"
|
|
)
|
|
|
|
// Monitor provides progress-related data for observing the progress of a Catalog() call (published on the event bus).
|
|
type Monitor struct {
|
|
FilesProcessed progress.Monitorable // the number of files selected and contents analyzed from all registered catalogers
|
|
PackagesDiscovered progress.Monitorable // the number of packages discovered from all registered catalogers
|
|
}
|
|
|
|
// newMonitor creates a new Monitor object and publishes the object on the bus as a CatalogerStarted event.
|
|
func newMonitor() (*progress.Manual, *progress.Manual) {
|
|
filesProcessed := progress.Manual{}
|
|
packagesDiscovered := progress.Manual{}
|
|
|
|
bus.Publish(partybus.Event{
|
|
Type: event.CatalogerStarted,
|
|
Value: Monitor{
|
|
FilesProcessed: progress.Monitorable(&filesProcessed),
|
|
PackagesDiscovered: progress.Monitorable(&packagesDiscovered),
|
|
},
|
|
})
|
|
return &filesProcessed, &packagesDiscovered
|
|
}
|
|
|
|
// Catalog a given scope (container image or filesystem) with the given catalogers, returning all discovered packages.
|
|
// In order to efficiently retrieve contents from a underlying container image the content fetch requests are
|
|
// done in bulk. Specifically, all files of interest are collected from each catalogers and accumulated into a single
|
|
// request.
|
|
func Catalog(s scope.Resolver, catalogers ...Cataloger) (*pkg.Catalog, error) {
|
|
catalog := pkg.NewCatalog()
|
|
fileSelection := make([]file.Reference, 0)
|
|
|
|
filesProcessed, packagesDiscovered := newMonitor()
|
|
|
|
// ask catalogers for files to extract from the image tar
|
|
for _, a := range catalogers {
|
|
fileSelection = append(fileSelection, a.SelectFiles(s)...)
|
|
log.Debugf("cataloger '%s' selected '%d' files", a.Name(), len(fileSelection))
|
|
filesProcessed.N += int64(len(fileSelection))
|
|
}
|
|
|
|
// fetch contents for requested selection by catalogers
|
|
// TODO: we should consider refactoring to return a set of io.Readers instead of the full contents themselves (allow for optional buffering).
|
|
contents, err := s.MultipleFileContentsByRef(fileSelection...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// perform analysis, accumulating errors for each failed analysis
|
|
var errs error
|
|
for _, a := range catalogers {
|
|
// TODO: check for multiple rounds of analyses by Iterate error
|
|
packages, err := a.Catalog(contents)
|
|
if err != nil {
|
|
errs = multierror.Append(errs, err)
|
|
continue
|
|
}
|
|
|
|
log.Debugf("cataloger '%s' discovered '%d' packages", a.Name(), len(packages))
|
|
packagesDiscovered.N += int64(len(packages))
|
|
|
|
for _, p := range packages {
|
|
catalog.Add(p)
|
|
}
|
|
}
|
|
|
|
if errs != nil {
|
|
return nil, errs
|
|
}
|
|
|
|
filesProcessed.SetCompleted()
|
|
packagesDiscovered.SetCompleted()
|
|
|
|
return catalog, nil
|
|
}
|