update sterescope + add json presenter

imgbom/analyzer/analyzer.go

@@ -7,6 +7,7 @@ import (
 )
 
 type Analyzer interface {
+	// TODO: add ID / Name for analyze for uniquely identifying this analyzer type
 	SelectFiles([]*tree.FileTree) []file.Reference
 	// NOTE: one of the errors which is returned is "IterationNeeded", which indicates to the driver to
 	// continue with another Select/Analyze pass

imgbom/analyzer/dpkg/analyzer.go

@@ -54,7 +54,6 @@ func (a *Analyzer) Analyze(contents map[file.Reference]string) ([]pkg.Package, e
 				Metadata: entry,
 			})
 		}
-
 	}
 	return packages, nil
 }

imgbom/analyzer/dummy/analyzer.go

@@ -1,30 +0,0 @@
-package dummy
-
-import (
-	"github.com/anchore/imgbom/imgbom/pkg"
-	"github.com/anchore/stereoscope/pkg/file"
-	"github.com/anchore/stereoscope/pkg/tree"
-)
-
-// TODO: delete me
-
-type Analyzer struct{}
-
-func NewAnalyzer() *Analyzer {
-	return &Analyzer{}
-}
-
-func (a *Analyzer) SelectFiles(trees []*tree.FileTree) []file.Reference {
-	return []file.Reference{*trees[0].File("/etc/centos-release")}
-}
-
-func (a *Analyzer) Analyze(contents map[file.Reference]string) ([]pkg.Package, error) {
-	return []pkg.Package{
-		{
-			Name:     "dummy",
-			Version:  "1.0.0",
-			Type:     pkg.DebPkg,
-			Metadata: pkg.DummyPackage{Extra: "some extra metadata"},
-		},
-	}, nil
-}

imgbom/pkg/catalog.go

@@ -4,19 +4,45 @@ package pkg
 
 type Catalog struct {
 	// TODO: catalog by package ID for potential indexing
-	Packages map[Type][]Package
+	packages map[Type][]Package
 }
 
 func NewCatalog() Catalog {
 	return Catalog{
-		Packages: make(map[Type][]Package),
+		packages: make(map[Type][]Package),
 	}
 }
 
 func (c *Catalog) Add(p Package) {
-	_, ok := c.Packages[p.Type]
+	_, ok := c.packages[p.Type]
 	if !ok {
-		c.Packages[p.Type] = make([]Package, 0)
+		c.packages[p.Type] = make([]Package, 0)
 	}
-	c.Packages[p.Type] = append(c.Packages[p.Type], p)
+	c.packages[p.Type] = append(c.packages[p.Type], p)
 }
+
+func (c *Catalog) Enumerate(types ...Type) <-chan Package {
+	channel := make(chan Package)
+	go func() {
+		defer close(channel)
+		for ty, packages := range c.packages {
+			if len(types) != 0 {
+				found := false
+			typeCheck:
+				for _, t := range types {
+					if t == ty {
+						found = true
+						break typeCheck
+					}
+				}
+				if !found {
+					continue
+				}
+			}
+			for _, p := range packages {
+				channel <- p
+			}
+		}
+	}()
+	return channel
+}

imgbom/pkg/dummy_package.go

@@ -1,6 +0,0 @@
-package pkg
-
-// TODO: delete me
-type DummyPackage struct {
-	Extra string
-}

imgbom/pkg/package.go

@@ -4,6 +4,7 @@ import "github.com/anchore/stereoscope/pkg/file"
 
 // TODO: add package ID (random/incremental)
 
+// TODO: add field to trace which analyzer detected this
 type Package struct {
 	Name     string
 	Version  string

imgbom/pkg/type.go

@@ -14,4 +14,21 @@ const (
 
 type Type uint
 
-// TODO: stringer...
+var typeStr = []string{
+	"UnknownPackage",
+	"apk",
+	"deb",
+	"java",
+	"node",
+	"pacman",
+	"python",
+	"rpm",
+	"ruby",
+}
+
+func (t Type) String() string {
+	if int(t) >= len(typeStr) {
+		return typeStr[0]
+	}
+	return typeStr[t]
+}

imgbom/presenter/json/presenter.go

@@ -0,0 +1,114 @@
+package json
+
+import (
+	"encoding/json"
+	"io"
+
+	"github.com/anchore/imgbom/imgbom/pkg"
+	stereoscopeImg "github.com/anchore/stereoscope/pkg/image"
+)
+
+type Presenter struct{}
+
+func NewPresenter() *Presenter {
+	return &Presenter{}
+}
+
+type document struct {
+	Image     image      `json:"image"`
+	Artifacts []artifact `json:"artifacts"`
+}
+
+type image struct {
+	Layers    []layer  `json:"layers"`
+	Size      int64    `json:"size"`
+	Digest    string   `json:"digest"`
+	MediaType string   `json:"mediaType"`
+	Tags      []string `json:"tags"`
+}
+
+type layer struct {
+	MediaType string `json:"mediaType"`
+	Digest    string `json:"digest"`
+	Size      int64  `json:"size"`
+}
+
+type source struct {
+	Source  string   `json:"source"`
+	Layer   int      `json:"layer"`
+	Effects []string `json:"effects"`
+}
+
+type artifact struct {
+	Name     string      `json:"name"`
+	Version  string      `json:"version"`
+	Type     string      `json:"type"`
+	Analyzer string      `json:"analyzer"`
+	Sources  []source    `json:"sources"`
+	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 {
+		tags[idx] = tag.String()
+	}
+
+	doc := document{
+		Image: image{
+			Digest:    img.Metadata.Digest,
+			Size:      img.Metadata.Size,
+			MediaType: string(img.Metadata.MediaType),
+			Tags:      tags,
+			Layers:    make([]layer, len(img.Layers)),
+		},
+		Artifacts: make([]artifact, 0),
+	}
+
+	// populate image...
+	for idx, l := range img.Layers {
+		doc.Image.Layers[idx] = layer{
+			MediaType: string(l.Metadata.MediaType),
+			Digest:    l.Metadata.Digest,
+			Size:      l.Metadata.Size,
+		}
+	}
+
+	// populate artifacts...
+	for p := range catalog.Enumerate() {
+		art := artifact{
+			Name:     p.Name,
+			Version:  p.Version,
+			Type:     p.Type.String(),
+			Analyzer: "TODO", // TODO
+			Sources:  make([]source, len(p.Source)),
+			Metadata: p.Metadata,
+		}
+
+		for idx, src := range p.Source {
+			fileMetadata, err := img.FileCatalog.Get(src)
+			if err != nil {
+				// TODO: replace
+				panic(err)
+			}
+
+			srcObj := source{
+				Source:  "",
+				Layer:   int(fileMetadata.Source.Metadata.Index),
+				Effects: []string{}, // TODO
+			}
+			art.Sources[idx] = srcObj
+		}
+
+		doc.Artifacts = append(doc.Artifacts, art)
+	}
+
+	bytes, err := json.Marshal(&doc)
+	if err != nil {
+		// TODO: replace
+		panic(err)
+	}
+
+	_, err = output.Write(bytes)
+	return err
+}

imgbom/presenter/json/presenter_test.go

@@ -0,0 +1,90 @@
+package json
+
+import (
+	"bytes"
+	"flag"
+	"testing"
+
+	"github.com/anchore/go-testutils"
+	"github.com/anchore/imgbom/imgbom/pkg"
+	"github.com/anchore/stereoscope/pkg/file"
+	"github.com/sergi/go-diff/diffmatchpatch"
+)
+
+var update = flag.Bool("update", false, "update the *.golden files for json presenters")
+
+// TODO: add a JSON schema and write a test that validates output against the schema
+// func validateAgainstV1Schema(t *testing.T, json string) {
+// 	fullSchemaPath, err := filepath.Abs("v1-schema.json")
+// 	if err != nil {
+// 		t.Fatal("could not get path to schema:", err)
+// 	}
+// 	schemaLoader := gojsonschema.NewReferenceLoader(fmt.Sprintf("file://%s", fullSchemaPath))
+// 	documentLoader := gojsonschema.NewStringLoader(json)
+
+// 	result, err := gojsonschema.Validate(schemaLoader, documentLoader)
+// 	if err != nil {
+// 		t.Fatal("unable to validate json schema:", err.Error())
+// 	}
+
+// 	if !result.Valid() {
+// 		t.Errorf("failed json schema validation:")
+// 		for _, desc := range result.Errors() {
+// 			t.Errorf("  - %s\n", desc)
+// 		}
+// 	}
+// }
+
+func TestJsonPresenter(t *testing.T) {
+	pres := NewPresenter()
+	var buffer bytes.Buffer
+
+	testImage := "image-simple"
+
+	if *update {
+		testutils.UpdateGoldenFixtureImage(t, testImage)
+	}
+
+	catalog := pkg.NewCatalog()
+	img := testutils.GetGoldenFixtureImage(t, testImage)
+
+	// populate catalog with test data
+	catalog.Add(pkg.Package{
+		Name:    "package-1",
+		Version: "1.0.1",
+		Source: []file.Reference{
+			*img.SquashedTree.File("/somefile-1.txt"),
+		},
+		Type: pkg.DebPkg,
+	})
+	catalog.Add(pkg.Package{
+		Name:    "package-2",
+		Version: "2.0.1",
+		Source: []file.Reference{
+			*img.SquashedTree.File("/somefile-2.txt"),
+		},
+		Type: pkg.DebPkg,
+	})
+
+	// run presenter
+	err := pres.Present(&buffer, img, catalog)
+	if err != nil {
+		t.Fatal(err)
+	}
+	actual := buffer.Bytes()
+
+	if *update {
+		testutils.UpdateGoldenFileContents(t, actual)
+	}
+
+	var expected = testutils.GetGoldenFileContents(t)
+
+	if !bytes.Equal(expected, actual) {
+		dmp := diffmatchpatch.New()
+		diffs := dmp.DiffMain(string(actual), string(expected), true)
+		t.Errorf("mismatched output:\n%s", dmp.DiffPrettyText(diffs))
+	}
+
+	// TODO: add me back in when there is a JSON schema
+	// validateAgainstV1Schema(t, string(actual))
+}

imgbom/presenter/json/test-fixtures/image-simple/Dockerfile

@@ -0,0 +1,6 @@
+# Note: changes to this file will result in updating several test values. Consider making a new image fixture instead of editing this one.
+FROM scratch
+ADD file-1.txt /somefile-1.txt
+ADD file-2.txt /somefile-2.txt
+# note: adding a directory will behave differently on docker engine v18 vs v19
+ADD target /

imgbom/presenter/json/test-fixtures/image-simple/file-1.txt

@@ -0,0 +1 @@
+this file has contents

imgbom/presenter/json/test-fixtures/image-simple/file-2.txt

@@ -0,0 +1 @@
+file-2 contents!

imgbom/presenter/json/test-fixtures/image-simple/target/really/nested/file-3.txt

@@ -0,0 +1,2 @@
+another file!
+with lines...

imgbom/presenter/json/test-fixtures/snapshot/TestJsonPresenter.golden

@@ -0,0 +1 @@
+{"image":{"layers":[{"mediaType":"application/vnd.docker.image.rootfs.diff.tar.gzip","digest":"sha256:056c0789fa9ad629ceae6d09713fb035f84115af3c4a88a43aa60f13bc683053","size":22},{"mediaType":"application/vnd.docker.image.rootfs.diff.tar.gzip","digest":"sha256:b461c48116592c570a66fed71d5b09662a8172e168b7938cf317af47872cdc9b","size":16},{"mediaType":"application/vnd.docker.image.rootfs.diff.tar.gzip","digest":"sha256:00b80053e05c01da485015610d288ce3185fac00d251e2ada02b45a7a7c5f589","size":27}],"size":65,"digest":"sha256:3c53d2d891940f8d8e95acb77b58752f54dc5de9d91d19dd90ced2db76256cea","mediaType":"application/vnd.docker.distribution.manifest.v2+json","tags":["anchore-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7"]},"artifacts":[{"name":"package-1","version":"1.0.1","type":"deb","analyzer":"TODO","sources":[{"source":"","layer":0,"effects":[]}],"metadata":null},{"name":"package-2","version":"2.0.1","type":"deb","analyzer":"TODO","sources":[{"source":"","layer":1,"effects":[]}],"metadata":null}]}

imgbom/presenter/option.go

@@ -0,0 +1,25 @@
+package presenter
+
+const (
+	UnknownPresenterOption Option = iota
+	JSONOption
+)
+
+var optionStr = []string{
+	"UnknownPresenterOption",
+	"json",
+}
+
+var Options = []Option{
+	JSONOption,
+}
+
+type Option int
+
+func (o Option) String() string {
+	if int(o) >= len(optionStr) || int(o) < 0 {
+		return optionStr[0]
+	}
+
+	return optionStr[o]
+}

imgbom/presenter/presenter.go

@@ -0,0 +1,23 @@
+package presenter
+
+import (
+	"io"
+	"strings"
+
+	"github.com/anchore/imgbom/imgbom/pkg"
+	"github.com/anchore/imgbom/imgbom/presenter/json"
+	"github.com/anchore/stereoscope/pkg/image"
+)
+
+type Presenter interface {
+	Present(io.Writer, *image.Image, pkg.Catalog) error
+}
+
+func GetPresenter(userStr string) Presenter {
+	switch strings.ToLower(userStr) {
+	case JSONOption.String():
+		return json.NewPresenter()
+	default:
+		return nil
+	}
+}

imgbom/scope/scope_test.go

@@ -1,19 +1,20 @@
 package scope
 
 import (
+	"testing"
+
 	"github.com/anchore/stereoscope/pkg/image"
 	"github.com/anchore/stereoscope/pkg/tree"
-	"testing"
 )
 
 func testScopeImage(t *testing.T) *image.Image {
 	t.Helper()
 
-	one := image.NewLayer(0, nil)
+	one := image.NewLayer(nil)
 	one.Tree = tree.NewFileTree()
 	one.Tree.AddPath("/tree/first/path.txt")
 
-	two := image.NewLayer(1, nil)
+	two := image.NewLayer(nil)
 	two.Tree = tree.NewFileTree()
 	two.Tree.AddPath("/tree/second/path.txt")