fixing a bug in jsonsaver - avoid producing invalid JSON with "Files:…

… null" and "Snippets: null" if saving a package without files (filesAnalyzed is false) Signed-off-by: Yan Yagudayev <yany@jfrog.com>
spdx · Dec 14, 2021 · 775169f · 775169f
1 parent 1d27f44
commit 775169f
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/jsonsaver/saver2v2/save_document.go b/jsonsaver/saver2v2/save_document.go
@@ -71,7 +71,7 @@ func RenderDocument2_2(doc *spdx.Document2_2, buf *bytes.Buffer) error {
 	}
 
 	// save files and snippets from spdx to json
-	if allfiles != nil {
+	if len(allfiles) > 0 {
 		_, err = renderFiles2_2(doc, jsondocument, allfiles)
 		if err != nil {
 			return err

diff --git a/jsonsaver/saver2v2/save_document_test.go b/jsonsaver/saver2v2/save_document_test.go
@@ -88,6 +88,11 @@ func TestRenderDocument2_2(t *testing.T) {
 				RefB:         spdx.DocElementID{DocumentRefID: "", ElementRefID: "Package"},
 				Relationship: "CONTAINS",
 			},
+			{
+				RefA:         spdx.DocElementID{DocumentRefID: "", ElementRefID: "DOCUMENT"},
+				RefB:         spdx.DocElementID{DocumentRefID: "", ElementRefID: "p1"},
+				Relationship: "CONTAINS",
+			},
 			{
 				RefA:                spdx.DocElementID{DocumentRefID: "", ElementRefID: "DOCUMENT"},
 				RefB:                spdx.DocElementID{DocumentRefID: "", ElementRefID: "File"},
@@ -172,6 +177,25 @@ func TestRenderDocument2_2(t *testing.T) {
 				PackageSupplierPerson:               "Jane Doe (jane.doe@example.com)",
 				PackageVersion:                      "2.11.1",
 			},
+			"p1": {
+				PackageName:               "p1",
+				PackageSPDXIdentifier:     "p1",
+				PackageDownloadLocation:   "http://example.com/p1/p1-0.1.0-master.tar.gz",
+				FilesAnalyzed:             false,
+				IsFilesAnalyzedTagPresent: true,
+				// NOTE that verification code MUST be omitted from output,
+				// even if present in model, since FilesAnalyzed is false
+				PackageLicenseConcluded: "GPL-2.0-or-later",
+				// NOTE that license info from files MUST be omitted from output
+				// even if present in model, since FilesAnalyzed is false
+				PackageLicenseInfoFromFiles: []string{
+					"Apache-1.1",
+					"Apache-2.0",
+					"GPL-2.0-or-later",
+				},
+				PackageLicenseDeclared: "Apache-2.0 OR GPL-2.0-or-later",
+				PackageCopyrightText:   "Copyright (c) John Doe, Inc.",
+			},
 		},
 		UnpackagedFiles: map[spdx.ElementID]*spdx.File2_2{
 			"File": {
@@ -204,7 +228,7 @@ func TestRenderDocument2_2(t *testing.T) {
 		"spdxVersion":       "SPDX-2.2",
 		"SPDXID":            "SPDXRef-DOCUMENT",
 		"documentNamespace": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301",
-		"documentDescribes": []string{"SPDXRef-Package"},
+		"documentDescribes": []string{"SPDXRef-File"},
 		"name":              "SPDX-Tools-v2.0",
 		"comment":           "This document was created using SPDX 2.0 using licenses from the web site.",
 		"creationInfo": map[string]interface{}{
@@ -255,6 +279,11 @@ func TestRenderDocument2_2(t *testing.T) {
 				"relatedSpdxElement": "SPDXRef-Package",
 				"relationshipType":   "CONTAINS",
 			},
+			map[string]interface{}{
+				"spdxElementId":      "SPDXRef-DOCUMENT",
+				"relatedSpdxElement": "SPDXRef-p1",
+				"relationshipType":   "CONTAINS",
+			},
 			map[string]interface{}{
 				"spdxElementId":      "SPDXRef-DOCUMENT",
 				"relatedSpdxElement": "SPDXRef-File",
@@ -315,6 +344,16 @@ func TestRenderDocument2_2(t *testing.T) {
 				"supplier":    "Person: Jane Doe (jane.doe@example.com)",
 				"versionInfo": "2.11.1",
 			},
+			map[string]interface{}{
+				"SPDXID":               "SPDXRef-p1",
+				"copyrightText":        "Copyright (c) John Doe, Inc.",
+				"downloadLocation":     "http://example.com/p1/p1-0.1.0-master.tar.gz",
+				"filesAnalyzed":        false,
+				"licenseConcluded":     "GPL-2.0-or-later",
+				"licenseDeclared":      "Apache-2.0 OR GPL-2.0-or-later",
+				"licenseInfoFromFiles": []string{"Apache-1.1", "Apache-2.0", "GPL-2.0-or-later"},
+				"name":                 "p1",
+			},
 		},
 		"files": []interface{}{
 			map[string]interface{}{