migrate scope option to image metadata (from source)

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>

schema/json/schema.json

@@ -339,16 +339,12 @@
                 "name": {
                     "type": "string"
                 },
-                "scope": {
-                    "type": "string"
-                },
                 "version": {
                     "type": "string"
                 }
             },
             "required": [
                 "name",
-                "scope",
                 "version"
             ],
             "type": "object"
@@ -409,6 +405,9 @@
                                 "mediaType": {
                                     "type": "string"
                                 },
+                                "scope": {
+                                    "type": "string"
+                                },
                                 "size": {
                                     "type": "integer"
                                 },
@@ -426,6 +425,7 @@
                                 "digest",
                                 "layers",
                                 "mediaType",
+                                "scope",
                                 "size",
                                 "tags",
                                 "userInput"

syft/lib.go

@@ -83,11 +83,11 @@ func CatalogFromScope(s source.Source) (*pkg.Catalog, error) {
 }
 
 // CatalogFromJSON takes an existing syft report and generates catalog primitives.
-func CatalogFromJSON(reader io.Reader) (*pkg.Catalog, *distro.Distro, *source.ImageMetadata, error) {
+func CatalogFromJSON(reader io.Reader) (*pkg.Catalog, *distro.Distro, source.Metadata, error) {
 	var doc jsonPresenter.Document
 	decoder := json.NewDecoder(reader)
 	if err := decoder.Decode(&doc); err != nil {
-		return nil, nil, nil, err
+		return nil, nil, source.Metadata{}, err
 	}
 
 	var pkgs = make([]pkg.Package, len(doc.Artifacts))
@@ -104,18 +104,12 @@ func CatalogFromJSON(reader io.Reader) (*pkg.Catalog, *distro.Distro, *source.Im
 		distroType = distro.Type(doc.Distro.Name)
 	}
 
-	d, err := distro.NewDistro(distroType, doc.Distro.Version, doc.Distro.IDLike)
+	theDistro, err := distro.NewDistro(distroType, doc.Distro.Version, doc.Distro.IDLike)
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, source.Metadata{}, err
 	}
 
-	var imageMetadata *source.ImageMetadata
+	return catalog, &theDistro, doc.Source.ToSourceMetadata(), nil
-	if doc.Source.Type == "image" {
-		payload := doc.Source.Target.(source.ImageMetadata)
-		imageMetadata = &payload
-	}
-
-	return catalog, &d, imageMetadata, nil
 }
 
 // SetLogger sets the logger object used for all syft logging calls.

syft/presenter/cyclonedx/test-fixtures/snapshot/TestCycloneDxDirsPresenter.golden

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<bom xmlns="http://cyclonedx.org/schema/bom/1.2" xmlns:bd="http://cyclonedx.org/schema/ext/bom-descriptor/1.0" version="1" serialNumber="urn:uuid:2bbada20-3e87-44ea-9a56-1aa0e4dd01a0">
+<bom xmlns="http://cyclonedx.org/schema/bom/1.2" xmlns:bd="http://cyclonedx.org/schema/ext/bom-descriptor/1.0" version="1" serialNumber="urn:uuid:815fdd6b-917e-423d-8c91-1fe648141505">
   <components>
     <component type="library">
       <name>package1</name>
@@ -21,7 +21,7 @@
     </component>
   </components>
   <bd:metadata>
-    <bd:timestamp>2020-09-23T18:26:58-04:00</bd:timestamp>
+    <bd:timestamp>2020-11-16T08:45:54-05:00</bd:timestamp>
     <bd:tool>
       <bd:vendor>anchore</bd:vendor>
       <bd:name>syft</bd:name>

syft/presenter/cyclonedx/test-fixtures/snapshot/TestCycloneDxImgsPresenter.golden

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<bom xmlns="http://cyclonedx.org/schema/bom/1.2" xmlns:bd="http://cyclonedx.org/schema/ext/bom-descriptor/1.0" version="1" serialNumber="urn:uuid:94dae829-4d5d-482f-afab-27f43f919e2c">
+<bom xmlns="http://cyclonedx.org/schema/bom/1.2" xmlns:bd="http://cyclonedx.org/schema/ext/bom-descriptor/1.0" version="1" serialNumber="urn:uuid:3cb10332-1645-44f6-be4a-4f8be5a60cf8">
   <components>
     <component type="library">
       <name>package1</name>
@@ -21,15 +21,15 @@
     </component>
   </components>
   <bd:metadata>
-    <bd:timestamp>2020-09-23T18:26:58-04:00</bd:timestamp>
+    <bd:timestamp>2020-11-16T08:45:54-05:00</bd:timestamp>
     <bd:tool>
       <bd:vendor>anchore</bd:vendor>
       <bd:name>syft</bd:name>
       <bd:version>[not provided]</bd:version>
     </bd:tool>
     <bd:component type="container">
-      <name>index.docker.io/library/stereoscope-fixture-image-simple</name>
+      <name>user-image-input</name>
-      <version>04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7</version>
+      <version>sha256:2731251dc34951c0e50fcc643b4c5f74922dad1a5d98f302b504cf46cd5d9368</version>
     </bd:component>
   </bd:metadata>
 </bom>

syft/presenter/json/descriptor.go

@@ -0,0 +1,7 @@
+package json
+
+// Descriptor describes what created the document as well as surrounding metadata
+type Descriptor struct {
+	Name    string `json:"name"`
+	Version string `json:"version"`
+}

syft/presenter/json/distribution.go

@@ -0,0 +1,8 @@
+package json
+
+// Distribution provides information about a detected Linux Distribution
+type Distribution struct {
+	Name    string `json:"name"`
+	Version string `json:"version"`
+	IDLike  string `json:"idLike"`
+}

syft/presenter/json/document.go

@@ -15,20 +15,6 @@ type Document struct {
 	Descriptor Descriptor   `json:"descriptor"`
 }
 
-// Descriptor describes what created the document as well as surrounding metadata
-type Descriptor struct {
-	Name    string `json:"name"`
-	Version string `json:"version"`
-	Scope   string `json:"scope"`
-}
-
-// Distribution provides information about a detected Linux Distribution
-type Distribution struct {
-	Name    string `json:"name"`
-	Version string `json:"version"`
-	IDLike  string `json:"idLike"`
-}
-
 func NewDocument(catalog *pkg.Catalog, srcMetadata source.Metadata, d distro.Distro) (Document, error) {
 	src, err := NewSource(srcMetadata)
 	if err != nil {
@@ -51,7 +37,6 @@ func NewDocument(catalog *pkg.Catalog, srcMetadata source.Metadata, d distro.Dis
 		Descriptor: Descriptor{
 			Name:    internal.ApplicationName,
 			Version: version.FromBuild().Version,
-			Scope:   srcMetadata.Scope.String(),
 		},
 	}
 

syft/presenter/json/source.go

@@ -56,3 +56,16 @@ func (s *Source) UnmarshalJSON(b []byte) error {
 
 	return nil
 }
+
+func (s *Source) ToSourceMetadata() source.Metadata {
+	var metadata source.Metadata
+	switch s.Type {
+	case "directory":
+		metadata.Scheme = source.DirectoryScheme
+		metadata.Path = s.Target.(string)
+	case "image":
+		metadata.Scheme = source.ImageScheme
+		metadata.ImageMetadata = s.Target.(source.ImageMetadata)
+	}
+	return metadata
+}

syft/presenter/json/test-fixtures/snapshot/TestJsonDirsPresenter.golden

@@ -4,9 +4,7 @@
    "name": "package-1",
    "version": "1.0.1",
    "type": "python",
-   "foundBy": [
+   "foundBy": "the-cataloger-1",
-    "the-cataloger-1"
-   ],
    "locations": [
     {
      "path": "/some/path/pkg1"
@@ -31,9 +29,7 @@
    "name": "package-2",
    "version": "2.0.1",
    "type": "deb",
-   "foundBy": [
+   "foundBy": "the-cataloger-2",
-    "the-cataloger-2"
-   ],
    "locations": [
     {
      "path": "/some/path/pkg1"
@@ -64,7 +60,6 @@
  },
  "descriptor": {
   "name": "syft",
-  "version": "[not provided]",
+  "version": "[not provided]"
-  "scope": ""
  }
 }

syft/presenter/json/test-fixtures/snapshot/TestJsonImgsPresenter.golden

@@ -4,9 +4,7 @@
    "name": "package-1",
    "version": "1.0.1",
    "type": "python",
-   "foundBy": [
+   "foundBy": "the-cataloger-1",
-    "the-cataloger-1"
-   ],
    "locations": [
     {
      "path": "/somefile-1.txt",
@@ -32,9 +30,7 @@
    "name": "package-2",
    "version": "2.0.1",
    "type": "deb",
-   "foundBy": [
+   "foundBy": "the-cataloger-2",
-    "the-cataloger-2"
-   ],
    "locations": [
     {
      "path": "/somefile-2.txt",
@@ -58,6 +54,8 @@
  "source": {
   "type": "image",
   "target": {
+   "userInput": "user-image-input",
+   "scope": "AllLayers",
    "layers": [
     {
      "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
@@ -90,7 +88,6 @@
  },
  "descriptor": {
   "name": "syft",
-  "version": "[not provided]",
+  "version": "[not provided]"
-  "scope": "AllLayers"
  }
 }

syft/source/image_metadata.go

@@ -4,6 +4,7 @@ import "github.com/anchore/stereoscope/pkg/image"
 
 type ImageMetadata struct {
 	UserInput string          `json:"userInput"`
+	Scope     Scope           `json:"scope"` // specific perspective to catalog
 	Layers    []LayerMetadata `json:"layers"`
 	Size      int64           `json:"size"`
 	Digest    string          `json:"digest"`
@@ -17,7 +18,7 @@ type LayerMetadata struct {
 	Size      int64  `json:"size"`
 }
 
-func NewImageMetadata(img *image.Image, userInput string) ImageMetadata {
+func NewImageMetadata(img *image.Image, userInput string, scope Scope) ImageMetadata {
 	// populate artifacts...
 	tags := make([]string, len(img.Metadata.Tags))
 	for idx, tag := range img.Metadata.Tags {
@@ -25,6 +26,7 @@ func NewImageMetadata(img *image.Image, userInput string) ImageMetadata {
 	}
 	theImg := ImageMetadata{
 		UserInput: userInput,
+		Scope:     scope,
 		Digest:    img.Metadata.Digest,
 		Size:      img.Metadata.Size,
 		MediaType: string(img.Metadata.MediaType),

syft/source/metadata.go

@@ -1,7 +1,6 @@
 package source
 
 type Metadata struct {
-	Scope         Scope         // specific perspective to catalog
 	Scheme        Scheme        // the source data scheme type (directory or image)
 	ImageMetadata ImageMetadata // all image info (image only)
 	Path          string        // the root path to be cataloged (directory only)

syft/source/source.go

@@ -85,12 +85,12 @@ func NewFromDirectory(path string) (Source, error) {
 
 // NewFromImage creates a new source object tailored to catalog a given container image, relative to the
 // option given (e.g. all-layers, squashed, etc)
-func NewFromImage(img *image.Image, option Scope, userImageStr string) (Source, error) {
+func NewFromImage(img *image.Image, scope Scope, userImageStr string) (Source, error) {
 	if img == nil {
 		return Source{}, fmt.Errorf("no image given")
 	}
 
-	resolver, err := getImageResolver(img, option)
+	resolver, err := getImageResolver(img, scope)
 	if err != nil {
 		return Source{}, fmt.Errorf("could not determine file resolver: %w", err)
 	}
@@ -99,9 +99,8 @@ func NewFromImage(img *image.Image, option Scope, userImageStr string) (Source,
 		Resolver: resolver,
 		Image:    img,
 		Metadata: Metadata{
-			Scope:         option,
 			Scheme:        ImageScheme,
-			ImageMetadata: NewImageMetadata(img, userImageStr),
+			ImageMetadata: NewImageMetadata(img, userImageStr, scope),
 		},
 	}, nil
 }

test/integration/document_import_test.go

@@ -42,12 +42,12 @@ func TestCatalogFromJSON(t *testing.T) {
 				t.Fatalf("failed to write to presenter: %+v", err)
 			}
 
-			actualCatalog, actualDistro, imageMetadata, err := syft.CatalogFromJSON(&buf)
+			actualCatalog, actualDistro, sourceMetadata, err := syft.CatalogFromJSON(&buf)
 			if err != nil {
 				t.Fatalf("failed to import document: %+v", err)
 			}
 
-			for _, d := range deep.Equal(*imageMetadata, expectedSource.Metadata.ImageMetadata) {
+			for _, d := range deep.Equal(sourceMetadata, expectedSource.Metadata) {
 				t.Errorf("   image metadata diff: %+v", d)
 			}