Remove MetadataType from core package object and normalize JSON metadataType values (#1983)

* [wip] Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * distinct the package metadata functions Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * remove metadata type from package core model Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * incorporate review feedback for names Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add RPM archive metadata and split parser helpers Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * clarify the python package metadata type Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename the KB metadata type Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * break hackage and composer types by use case Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * linting fix Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix encoding and decoding for syft-json and cyclonedx Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * bump json schema to 11 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update cyclonedx-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update cyclonedx-xml snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update spdx-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update spdx-tv snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update syft-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * correct metadata type in stack yaml parser test Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix bom-ref redactor for cyclonedx-xml Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add tests for legacy package metadata names Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * regenerate json schema v11 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix legacy HackageMetadataType reflect type value check Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * packagemetadata discovery should account for type shadowing Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * bump json schema version to v12 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update json schema to incorporate changes from main Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add syft-json legacy config option Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add tests around v11-v12 json decoding Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add docs for SYFT_JSON_LEGACY Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename structs to be compliant with new naming scheme Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
2026-10-31 06:26:30 +01:00 · 2023-10-30 12:12:04 -04:00
parent f442586ec9
commit 1aaa644007
261 changed files with 7010 additions and 4040 deletions
@@ -13,14 +13,13 @@ func TestParseConanlock(t *testing.T) {
 	fixture := "test-fixtures/conan.lock"
 	expected := []pkg.Package{
 		{
-			Name:         "mfast",
-			Version:      "1.2.2",
-			PURL:         "pkg:conan/my_user/mfast@1.2.2?channel=my_channel",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "mfast",
+			Version:   "1.2.2",
+			PURL:      "pkg:conan/my_user/mfast@1.2.2?channel=my_channel",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "mfast/1.2.2@my_user/my_channel#c6f6387c9b99780f0ee05e25f99d0f39",
 				Options: map[string]string{
 					"fPIC":                            "True",
@@ -105,14 +104,13 @@ func TestParseConanlock(t *testing.T) {
 			},
 		},
 		{
-			Name:         "boost",
-			Version:      "1.75.0",
-			PURL:         "pkg:conan/boost@1.75.0",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "boost",
+			Version:   "1.75.0",
+			PURL:      "pkg:conan/boost@1.75.0",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "boost/1.75.0#a9c318f067216f900900e044e7af4ab1",
 				Options: map[string]string{
 					"addr2line_location":        "/usr/bin/addr2line",
@@ -192,14 +190,13 @@ func TestParseConanlock(t *testing.T) {
 			},
 		},
 		{
-			Name:         "zlib",
-			Version:      "1.2.12",
-			PURL:         "pkg:conan/zlib@1.2.12",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "zlib",
+			Version:   "1.2.12",
+			PURL:      "pkg:conan/zlib@1.2.12",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "zlib/1.2.12#c67ce17f2e96b972d42393ce50a76a1a",
 				Options: map[string]string{
 					"fPIC":   "True",
@@ -211,14 +208,13 @@ func TestParseConanlock(t *testing.T) {
 			},
 		},
 		{
-			Name:         "bzip2",
-			Version:      "1.0.8",
-			PURL:         "pkg:conan/bzip2@1.0.8",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "bzip2",
+			Version:   "1.0.8",
+			PURL:      "pkg:conan/bzip2@1.0.8",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "bzip2/1.0.8#62a8031289639043797cf53fa876d0ef",
 				Options: map[string]string{
 					"build_executable": "True",
@@ -231,14 +227,13 @@ func TestParseConanlock(t *testing.T) {
 			},
 		},
 		{
-			Name:         "libbacktrace",
-			Version:      "cci.20210118",
-			PURL:         "pkg:conan/libbacktrace@cci.20210118",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "libbacktrace",
+			Version:   "cci.20210118",
+			PURL:      "pkg:conan/libbacktrace@cci.20210118",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "libbacktrace/cci.20210118#76e40b760e0bcd602d46db56b22820ab",
 				Options: map[string]string{
 					"fPIC":   "True",
@@ -250,14 +245,13 @@ func TestParseConanlock(t *testing.T) {
 			},
 		},
 		{
-			Name:         "tinyxml2",
-			Version:      "9.0.0",
-			PURL:         "pkg:conan/tinyxml2@9.0.0",
-			Locations:    file.NewLocationSet(file.NewLocation(fixture)),
-			Language:     pkg.CPP,
-			Type:         pkg.ConanPkg,
-			MetadataType: pkg.ConanLockMetadataType,
-			Metadata: pkg.ConanLockMetadata{
+			Name:      "tinyxml2",
+			Version:   "9.0.0",
+			PURL:      "pkg:conan/tinyxml2@9.0.0",
+			Locations: file.NewLocationSet(file.NewLocation(fixture)),
+			Language:  pkg.CPP,
+			Type:      pkg.ConanPkg,
+			Metadata: pkg.ConanLockEntry{
 				Ref: "tinyxml2/9.0.0#9f13a36ebfc222cd55fe531a0a8d94d1",
 				Options: map[string]string{
 					"fPIC":   "True",