oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2026-11-03 07:56:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

add and use event bus for UI progress

Browse Source
This commit is contained in:
Alex Goodman
2020-06-25 10:39:11 -04:00
parent 2e9e969c5f
commit 926b5f2a50
24 changed files with 725 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
imgbom/cataloger/controller.go
+30
View File
@@ -4,11 +4,15 @@ import (
"github.com/anchore/imgbom/imgbom/cataloger/bundler"
"github.com/anchore/imgbom/imgbom/cataloger/dpkg"
"github.com/anchore/imgbom/imgbom/cataloger/python"
"github.com/anchore/imgbom/imgbom/event"
"github.com/anchore/imgbom/imgbom/pkg"
"github.com/anchore/imgbom/imgbom/scope"
"github.com/anchore/imgbom/internal/bus"
"github.com/anchore/imgbom/internal/log"
"github.com/anchore/stereoscope/pkg/file"
"github.com/hashicorp/go-multierror"
"github.com/wagoodman/go-partybus"
"github.com/wagoodman/go-progress"
)
var controllerInstance controller
@@ -48,14 +52,36 @@ func (c *controller) add(a Cataloger) {
c.catalogers = append(c.catalogers, a)
}
type Monitor struct {
FilesProcessed progress.Monitorable
PackagesDiscovered progress.Monitorable
}
func (c *controller) trackCataloger() (*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
}
func (c *controller) catalog(s scope.Scope) (*pkg.Catalog, error) {
catalog := pkg.NewCatalog()
fileSelection := make([]file.Reference, 0)
filesProcessed, packagesDiscovered := c.trackCataloger()
// ask catalogers for files to extract from the image tar
for _, a := range c.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
@@ -75,6 +101,7 @@ func (c *controller) catalog(s scope.Scope) (*pkg.Catalog, error) {
}
log.Debugf("cataloger '%s' discovered '%d' packages", a.Name(), len(packages))
packagesDiscovered.N += int64(len(packages))
for _, p := range packages {
catalog.Add(p)
@@ -85,5 +112,8 @@ func (c *controller) catalog(s scope.Scope) (*pkg.Catalog, error) {
return nil, errs
}
filesProcessed.SetCompleted()
packagesDiscovered.SetCompleted()
return catalog, nil
}
imgbom/event/event.go
+8
View File
@@ -0,0 +1,8 @@
package event
import "github.com/wagoodman/go-partybus"
const (
CatalogerStarted partybus.EventType = "cataloger-started-event"
CatalogerFinished partybus.EventType = "cataloger-finished-event"
)
imgbom/event/parsers/parsers.go
+61
View File
@@ -0,0 +1,61 @@
package parsers
import (
"fmt"
"github.com/anchore/imgbom/imgbom/cataloger"
"github.com/anchore/imgbom/imgbom/event"
"github.com/anchore/imgbom/imgbom/presenter"
"github.com/wagoodman/go-partybus"
)
type ErrBadPayload struct {
Type partybus.EventType
Field string
Value interface{}
}
func (e *ErrBadPayload) Error() string {
return fmt.Sprintf("event='%s' has bad event payload field='%v': '%+v'", string(e.Type), e.Field, e.Value)
}
func newPayloadErr(t partybus.EventType, field string, value interface{}) error {
return &ErrBadPayload{
Type: t,
Field: field,
Value: value,
}
}
func checkEventType(actual, expected partybus.EventType) error {
if actual != expected {
return newPayloadErr(expected, "Type", actual)
}
return nil
}
func ParseCatalogerStarted(e partybus.Event) (*cataloger.Monitor, error) {
if err := checkEventType(e.Type, event.CatalogerStarted); err != nil {
return nil, err
}
monitor, ok := e.Value.(cataloger.Monitor)
if !ok {
return nil, newPayloadErr(e.Type, "Value", e.Value)
}
return &monitor, nil
}
func ParseCatalogerFinished(e partybus.Event) (presenter.Presenter, error) {
if err := checkEventType(e.Type, event.CatalogerFinished); err != nil {
return nil, err
}
pres, ok := e.Value.(presenter.Presenter)
if !ok {
return nil, newPayloadErr(e.Type, "Value", e.Value)
}
return pres, nil
}
imgbom/lib.go
+6
View File
@@ -6,8 +6,10 @@ import (
"github.com/anchore/imgbom/imgbom/logger"
"github.com/anchore/imgbom/imgbom/pkg"
"github.com/anchore/imgbom/imgbom/scope"
"github.com/anchore/imgbom/internal/bus"
"github.com/anchore/imgbom/internal/log"
"github.com/anchore/stereoscope/pkg/image"
"github.com/wagoodman/go-partybus"
)
func IdentifyDistro(img *image.Image) *distro.Distro {
@@ -26,3 +28,7 @@ func CatalogImage(img *image.Image, o scope.Option) (*pkg.Catalog, error) {
func SetLogger(logger logger.Logger) {
log.Log = logger
}
func SetBus(b *partybus.Bus) {
bus.SetPublisher(b)
}
imgbom/presenter/json/presenter.go
+19 -13
View File
@@ -9,10 +9,16 @@ import (
stereoscopeImg "github.com/anchore/stereoscope/pkg/image"
)
type Presenter struct{}
type Presenter struct {
img *stereoscopeImg.Image
catalog *pkg.Catalog
}
func NewPresenter() *Presenter {
return &Presenter{}
func NewPresenter(img *stereoscopeImg.Image, catalog *pkg.Catalog) *Presenter {
return &Presenter{
img: img,
catalog: catalog,
}
}
type document struct {
@@ -49,25 +55,25 @@ type artifact struct {
Metadata interface{} `json:"metadata"`
}
func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, catalog *pkg.Catalog) error {
tags := make([]string, len(img.Metadata.Tags))
for idx, tag := range img.Metadata.Tags {
func (pres *Presenter) Present(output io.Writer) error {
tags := make([]string, len(pres.img.Metadata.Tags))
for idx, tag := range pres.img.Metadata.Tags {
tags[idx] = tag.String()
}
doc := document{
Image: image{
Digest: img.Metadata.Digest,
Size: img.Metadata.Size,
MediaType: string(img.Metadata.MediaType),
Digest: pres.img.Metadata.Digest,
Size: pres.img.Metadata.Size,
MediaType: string(pres.img.Metadata.MediaType),
Tags: tags,
Layers: make([]layer, len(img.Layers)),
Layers: make([]layer, len(pres.img.Layers)),
},
Artifacts: make([]artifact, 0),
}
// populate image...
for idx, l := range img.Layers {
for idx, l := range pres.img.Layers {
doc.Image.Layers[idx] = layer{
MediaType: string(l.Metadata.MediaType),
Digest: l.Metadata.Digest,
@@ -76,7 +82,7 @@ func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, cata
}
// populate artifacts...
for p := range catalog.Enumerate() {
for p := range pres.catalog.Enumerate() {
art := artifact{
Name: p.Name,
Version: p.Version,
@@ -86,7 +92,7 @@ func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, cata
}
for idx, src := range p.Source {
fileMetadata, err := img.FileCatalog.Get(src)
fileMetadata, err := pres.img.FileCatalog.Get(src)
if err != nil {
// TODO: test case
log.Errorf("could not get metadata from catalog (presenter=json): %+v", src)
imgbom/presenter/json/presenter_test.go
+3 -2
View File
@@ -36,7 +36,6 @@ var update = flag.Bool("update", false, "update the *.golden files for json pres
// }
func TestJsonPresenter(t *testing.T) {
pres := NewPresenter()
var buffer bytes.Buffer
testImage := "image-simple"
@@ -66,8 +65,10 @@ func TestJsonPresenter(t *testing.T) {
Type: pkg.DebPkg,
})
pres := NewPresenter(img, catalog)
// run presenter
err := pres.Present(&buffer, img, catalog)
err := pres.Present(&buffer)
if err != nil {
t.Fatal(err)
}
imgbom/presenter/presenter.go
+5 -4
View File
@@ -10,15 +10,16 @@ import (
)
type Presenter interface {
Present(io.Writer, *image.Image, *pkg.Catalog) error
Present(io.Writer) error
}
func GetPresenter(option Option) Presenter {
func GetPresenter(option Option, img *image.Image, catalog *pkg.Catalog) Presenter {
switch option {
case JSONPresenter:
return json.NewPresenter()
return json.NewPresenter(img, catalog)
case TextPresenter:
return text.NewPresenter()
return text.NewPresenter(img, catalog)
default:
return nil
}
imgbom/presenter/text/presenter.go
+14 -8
View File
@@ -10,17 +10,23 @@ import (
)
// Presenter holds the Present method to produce output
type Presenter struct{}
type Presenter struct {
img *stereoscopeImg.Image
catalog *pkg.Catalog
}
// NewPresenter is a constructor for a Presenter
func NewPresenter() *Presenter {
return &Presenter{}
func NewPresenter(img *stereoscopeImg.Image, catalog *pkg.Catalog) *Presenter {
return &Presenter{
img: img,
catalog: catalog,
}
}
// Present is a method that is in charge of writing to an output buffer
func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, catalog *pkg.Catalog) error {
tags := make([]string, len(img.Metadata.Tags))
for idx, tag := range img.Metadata.Tags {
func (pres *Presenter) Present(output io.Writer) error {
tags := make([]string, len(pres.img.Metadata.Tags))
for idx, tag := range pres.img.Metadata.Tags {
tags[idx] = tag.String()
}
@@ -30,7 +36,7 @@ func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, cata
fmt.Fprintln(w, "[Image]")
for idx, l := range img.Layers {
for idx, l := range pres.img.Layers {
fmt.Fprintln(w, " Layer:\t", idx)
fmt.Fprintln(w, " Digest:\t", l.Metadata.Digest)
fmt.Fprintln(w, " Size:\t", l.Metadata.Size)
@@ -40,7 +46,7 @@ func (pres *Presenter) Present(output io.Writer, img *stereoscopeImg.Image, cata
}
// populate artifacts...
for p := range catalog.Enumerate() {
for p := range pres.catalog.Enumerate() {
fmt.Fprintln(w, fmt.Sprintf("[%s]", p.Name))
fmt.Fprintln(w, " Version:\t", p.Version)
fmt.Fprintln(w, " Type:\t", p.Type.String())
imgbom/presenter/text/presenter_test.go
+2 -2
View File
@@ -19,7 +19,6 @@ type PackageInfo struct {
}
func TestTextPresenter(t *testing.T) {
pres := NewPresenter()
var buffer bytes.Buffer
catalog := pkg.NewCatalog()
@@ -53,8 +52,9 @@ func TestTextPresenter(t *testing.T) {
l.Metadata.Digest = "sha256:ad8ecdc058976c07e7e347cb89fa9ad86a294b5ceaae6d09713fb035f84115abf3c4a2388a4af3aa60f13b94f4c6846930bdf53"
}
pres := NewPresenter(img, catalog)
// run presenter
err := pres.Present(&buffer, img, catalog)
err := pres.Present(&buffer)
if err != nil {
t.Fatal(err)
}