diff options
author | Ian Ling <ian@iancaling.com> | 2022-04-08 08:52:57 -0700 |
---|---|---|
committer | Ian Ling <ian@iancaling.com> | 2022-04-25 15:00:47 -0700 |
commit | 460cf54ece7eba418c50407ee35544c5d63588a7 (patch) | |
tree | 07ec7aaf51a92a1ae209e540f45241f990561919 /builder/builder2v1 | |
parent | fa24fac85dd550a3f815896241081a1246810d2c (diff) | |
download | spdx-tools-460cf54ece7eba418c50407ee35544c5d63588a7.tar.gz |
Overhaul structs, refactor JSON parser and saver
Signed-off-by: Ian Ling <ian@iancaling.com>
Diffstat (limited to 'builder/builder2v1')
-rw-r--r-- | builder/builder2v1/build_creation_info.go | 42 | ||||
-rw-r--r-- | builder/builder2v1/build_creation_info_test.go | 112 | ||||
-rw-r--r-- | builder/builder2v1/build_file.go | 19 | ||||
-rw-r--r-- | builder/builder2v1/build_file_test.go | 33 | ||||
-rw-r--r-- | builder/builder2v1/build_package.go | 4 | ||||
-rw-r--r-- | builder/builder2v1/build_package_test.go | 47 |
6 files changed, 106 insertions, 151 deletions
diff --git a/builder/builder2v1/build_creation_info.go b/builder/builder2v1/build_creation_info.go index 1d8c77f..c838b92 100644 --- a/builder/builder2v1/build_creation_info.go +++ b/builder/builder2v1/build_creation_info.go @@ -3,7 +3,6 @@ package builder2v1 import ( - "fmt" "time" "github.com/spdx/tools-golang/spdx" @@ -11,29 +10,21 @@ import ( // BuildCreationInfoSection2_1 creates an SPDX Package (version 2.1), returning that // package or error if any is encountered. Arguments: -// - packageName: name of package / directory -// - code: verification code from Package -// - namespacePrefix: prefix for DocumentNamespace (packageName and code will be added) // - creatorType: one of Person, Organization or Tool // - creator: creator string // - testValues: for testing only; call with nil when using in production -func BuildCreationInfoSection2_1(packageName string, code string, namespacePrefix string, creatorType string, creator string, testValues map[string]string) (*spdx.CreationInfo2_1, error) { +func BuildCreationInfoSection2_1(creatorType string, creator string, testValues map[string]string) (*spdx.CreationInfo2_1, error) { // build creator slices - cPersons := []string{} - cOrganizations := []string{} - cTools := []string{} - // add builder as a tool - cTools = append(cTools, "github.com/spdx/tools-golang/builder") - - switch creatorType { - case "Person": - cPersons = append(cPersons, creator) - case "Organization": - cOrganizations = append(cOrganizations, creator) - case "Tool": - cTools = append(cTools, creator) - default: - cPersons = append(cPersons, creator) + creators := []spdx.Creator{ + // add builder as a tool + { + Creator: "github.com/spdx/tools-golang/builder", + CreatorType: "Tool", + }, + { + Creator: creator, + CreatorType: creatorType, + }, } // use test Created time if passing test values @@ -45,15 +36,8 @@ func BuildCreationInfoSection2_1(packageName string, code string, namespacePrefi } ci := &spdx.CreationInfo2_1{ - SPDXVersion: "SPDX-2.1", - DataLicense: "CC0-1.0", - SPDXIdentifier: spdx.ElementID("DOCUMENT"), - DocumentName: packageName, - DocumentNamespace: fmt.Sprintf("%s%s-%s", namespacePrefix, packageName, code), - CreatorPersons: cPersons, - CreatorOrganizations: cOrganizations, - CreatorTools: cTools, - Created: created, + Creators: creators, + Created: created, } return ci, nil } diff --git a/builder/builder2v1/build_creation_info_test.go b/builder/builder2v1/build_creation_info_test.go index b45f2f0..9684fde 100644 --- a/builder/builder2v1/build_creation_info_test.go +++ b/builder/builder2v1/build_creation_info_test.go @@ -3,24 +3,17 @@ package builder2v1 import ( - "fmt" "testing" - - "github.com/spdx/tools-golang/spdx" ) // ===== CreationInfo section builder tests ===== func TestBuilder2_1CanBuildCreationInfoSection(t *testing.T) { - - namespacePrefix := "https://github.com/swinslow/spdx-docs/spdx-go/testdata-whatever-" creatorType := "Organization" creator := "Jane Doe LLC" testValues := make(map[string]string) testValues["Created"] = "2018-10-20T16:48:00Z" - packageName := "project1" - verificationCode := "TESTCODE" - ci, err := BuildCreationInfoSection2_1(packageName, verificationCode, namespacePrefix, creatorType, creator, testValues) + ci, err := BuildCreationInfoSection2_1(creatorType, creator, testValues) if err != nil { t.Fatalf("expected nil error, got %v", err) } @@ -28,36 +21,14 @@ func TestBuilder2_1CanBuildCreationInfoSection(t *testing.T) { if ci == nil { t.Fatalf("expected non-nil CreationInfo, got nil") } - if ci.SPDXVersion != "SPDX-2.1" { - t.Errorf("expected %s, got %s", "SPDX-2.1", ci.SPDXVersion) - } - if ci.DataLicense != "CC0-1.0" { - t.Errorf("expected %s, got %s", "CC0-1.0", ci.DataLicense) - } - if ci.SPDXIdentifier != spdx.ElementID("DOCUMENT") { - t.Errorf("expected %s, got %v", "DOCUMENT", ci.SPDXIdentifier) - } - if ci.DocumentName != "project1" { - t.Errorf("expected %s, got %s", "project1", ci.DocumentName) - } - wantNamespace := fmt.Sprintf("https://github.com/swinslow/spdx-docs/spdx-go/testdata-whatever-project1-%s", verificationCode) - if ci.DocumentNamespace != wantNamespace { - t.Errorf("expected %s, got %s", wantNamespace, ci.DocumentNamespace) - } - if len(ci.CreatorPersons) != 0 { - t.Fatalf("expected %d, got %d", 0, len(ci.CreatorPersons)) - } - if len(ci.CreatorOrganizations) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorOrganizations)) + if len(ci.Creators) != 2 { + t.Fatalf("expected %d, got %d", 2, len(ci.Creators)) } - if ci.CreatorOrganizations[0] != "Jane Doe LLC" { - t.Errorf("expected %s, got %s", "Jane Doe LLC", ci.CreatorOrganizations[0]) + if ci.Creators[1].Creator != "Jane Doe LLC" { + t.Errorf("expected %s, got %s", "Jane Doe LLC", ci.Creators[1].Creator) } - if len(ci.CreatorTools) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorTools)) - } - if ci.CreatorTools[0] != "github.com/spdx/tools-golang/builder" { - t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.CreatorTools[0]) + if ci.Creators[0].Creator != "github.com/spdx/tools-golang/builder" { + t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.Creators[0].Creator) } if ci.Created != "2018-10-20T16:48:00Z" { t.Errorf("expected %s, got %s", "2018-10-20T16:48:00Z", ci.Created) @@ -65,15 +36,12 @@ func TestBuilder2_1CanBuildCreationInfoSection(t *testing.T) { } func TestBuilder2_1CanBuildCreationInfoSectionWithCreatorPerson(t *testing.T) { - namespacePrefix := "https://github.com/swinslow/spdx-docs/spdx-go/testdata-whatever-" creatorType := "Person" creator := "John Doe" testValues := make(map[string]string) testValues["Created"] = "2018-10-20T16:48:00Z" - packageName := "project1" - verificationCode := "TESTCODE" - ci, err := BuildCreationInfoSection2_1(packageName, verificationCode, namespacePrefix, creatorType, creator, testValues) + ci, err := BuildCreationInfoSection2_1(creatorType, creator, testValues) if err != nil { t.Fatalf("expected nil error, got %v", err) } @@ -81,33 +49,24 @@ func TestBuilder2_1CanBuildCreationInfoSectionWithCreatorPerson(t *testing.T) { if ci == nil { t.Fatalf("expected non-nil CreationInfo, got nil") } - if len(ci.CreatorPersons) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorPersons)) - } - if ci.CreatorPersons[0] != "John Doe" { - t.Errorf("expected %s, got %s", "John Doe", ci.CreatorPersons[0]) + if len(ci.Creators) != 2 { + t.Fatalf("expected %d, got %d", 2, len(ci.Creators)) } - if len(ci.CreatorOrganizations) != 0 { - t.Fatalf("expected %d, got %d", 0, len(ci.CreatorOrganizations)) + if ci.Creators[1].Creator != "John Doe" { + t.Errorf("expected %s, got %s", "John Doe", ci.Creators[1].Creator) } - if len(ci.CreatorTools) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorTools)) - } - if ci.CreatorTools[0] != "github.com/spdx/tools-golang/builder" { - t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.CreatorTools[0]) + if ci.Creators[0].Creator != "github.com/spdx/tools-golang/builder" { + t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.Creators[0].Creator) } } func TestBuilder2_1CanBuildCreationInfoSectionWithCreatorTool(t *testing.T) { - namespacePrefix := "https://github.com/swinslow/spdx-docs/spdx-go/testdata-whatever-" creatorType := "Tool" creator := "some-other-tool-2.1" testValues := make(map[string]string) testValues["Created"] = "2018-10-20T16:48:00Z" - packageName := "project1" - verificationCode := "TESTCODE" - ci, err := BuildCreationInfoSection2_1(packageName, verificationCode, namespacePrefix, creatorType, creator, testValues) + ci, err := BuildCreationInfoSection2_1(creatorType, creator, testValues) if err != nil { t.Fatalf("expected nil error, got %v", err) } @@ -115,33 +74,24 @@ func TestBuilder2_1CanBuildCreationInfoSectionWithCreatorTool(t *testing.T) { if ci == nil { t.Fatalf("expected non-nil CreationInfo, got nil") } - if len(ci.CreatorPersons) != 0 { - t.Fatalf("expected %d, got %d", 0, len(ci.CreatorPersons)) - } - if len(ci.CreatorOrganizations) != 0 { - t.Fatalf("expected %d, got %d", 0, len(ci.CreatorOrganizations)) + if len(ci.Creators) != 2 { + t.Fatalf("expected %d, got %d", 2, len(ci.Creators)) } - if len(ci.CreatorTools) != 2 { - t.Fatalf("expected %d, got %d", 2, len(ci.CreatorTools)) + if ci.Creators[0].Creator != "github.com/spdx/tools-golang/builder" { + t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.Creators[0]) } - if ci.CreatorTools[0] != "github.com/spdx/tools-golang/builder" { - t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.CreatorTools[0]) - } - if ci.CreatorTools[1] != "some-other-tool-2.1" { - t.Errorf("expected %s, got %s", "some-other-tool-2.1", ci.CreatorTools[1]) + if ci.Creators[1].Creator != "some-other-tool-2.1" { + t.Errorf("expected %s, got %s", "some-other-tool-2.1", ci.Creators[1]) } } func TestBuilder2_1CanBuildCreationInfoSectionWithInvalidPerson(t *testing.T) { - namespacePrefix := "https://github.com/swinslow/spdx-docs/spdx-go/testdata-whatever-" creatorType := "Whatever" creator := "John Doe" testValues := make(map[string]string) testValues["Created"] = "2018-10-20T16:48:00Z" - packageName := "project1" - verificationCode := "TESTCODE" - ci, err := BuildCreationInfoSection2_1(packageName, verificationCode, namespacePrefix, creatorType, creator, testValues) + ci, err := BuildCreationInfoSection2_1(creatorType, creator, testValues) if err != nil { t.Fatalf("expected nil error, got %v", err) } @@ -149,19 +99,13 @@ func TestBuilder2_1CanBuildCreationInfoSectionWithInvalidPerson(t *testing.T) { if ci == nil { t.Fatalf("expected non-nil CreationInfo, got nil") } - if len(ci.CreatorPersons) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorPersons)) - } - if ci.CreatorPersons[0] != "John Doe" { - t.Errorf("expected %s, got %s", "John Doe", ci.CreatorPersons[0]) - } - if len(ci.CreatorOrganizations) != 0 { - t.Fatalf("expected %d, got %d", 0, len(ci.CreatorOrganizations)) + if len(ci.Creators) != 2 { + t.Fatalf("expected %d, got %d", 2, len(ci.Creators)) } - if len(ci.CreatorTools) != 1 { - t.Fatalf("expected %d, got %d", 1, len(ci.CreatorTools)) + if ci.Creators[1].Creator != "John Doe" { + t.Errorf("expected %s, got %s", "John Doe", ci.Creators[1]) } - if ci.CreatorTools[0] != "github.com/spdx/tools-golang/builder" { - t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.CreatorTools[0]) + if ci.Creators[0].Creator != "github.com/spdx/tools-golang/builder" { + t.Errorf("expected %s, got %s", "github.com/spdx/tools-golang/builder", ci.Creators[0]) } } diff --git a/builder/builder2v1/build_file.go b/builder/builder2v1/build_file.go index b47268c..7e9e52e 100644 --- a/builder/builder2v1/build_file.go +++ b/builder/builder2v1/build_file.go @@ -32,11 +32,22 @@ func BuildFileSection2_1(filePath string, prefix string, fileNumber int) (*spdx. f := &spdx.File2_1{ FileName: filePath, FileSPDXIdentifier: spdx.ElementID(i), - FileChecksumSHA1: ssha1, - FileChecksumSHA256: ssha256, - FileChecksumMD5: smd5, + Checksums: []spdx.Checksum{ + { + Algorithm: spdx.SHA1, + Value: ssha1, + }, + { + Algorithm: spdx.SHA256, + Value: ssha256, + }, + { + Algorithm: spdx.MD5, + Value: smd5, + }, + }, LicenseConcluded: "NOASSERTION", - LicenseInfoInFile: []string{"NOASSERTION"}, + LicenseInfoInFiles: []string{"NOASSERTION"}, FileCopyrightText: "NOASSERTION", } diff --git a/builder/builder2v1/build_file_test.go b/builder/builder2v1/build_file_test.go index 6ef157a..cea297b 100644 --- a/builder/builder2v1/build_file_test.go +++ b/builder/builder2v1/build_file_test.go @@ -28,23 +28,32 @@ func TestBuilder2_1CanBuildFileSection(t *testing.T) { if file1.FileSPDXIdentifier != spdx.ElementID("File17") { t.Errorf("expected %v, got %v", "File17", file1.FileSPDXIdentifier) } - if file1.FileChecksumSHA1 != "024f870eb6323f532515f7a09d5646a97083b819" { - t.Errorf("expected %v, got %v", "024f870eb6323f532515f7a09d5646a97083b819", file1.FileChecksumSHA1) - } - if file1.FileChecksumSHA256 != "b14e44284ca477b4c0db34b15ca4c454b2947cce7883e22321cf2984050e15bf" { - t.Errorf("expected %v, got %v", "b14e44284ca477b4c0db34b15ca4c454b2947cce7883e22321cf2984050e15bf", file1.FileChecksumSHA256) - } - if file1.FileChecksumMD5 != "37c8208479dfe42d2bb29debd6e32d4a" { - t.Errorf("expected %v, got %v", "37c8208479dfe42d2bb29debd6e32d4a", file1.FileChecksumMD5) + + for _, checksum := range file1.Checksums { + switch checksum.Algorithm { + case spdx.SHA1: + if checksum.Value != "024f870eb6323f532515f7a09d5646a97083b819" { + t.Errorf("expected %v, got %v", "024f870eb6323f532515f7a09d5646a97083b819", checksum.Value) + } + case spdx.SHA256: + if checksum.Value != "b14e44284ca477b4c0db34b15ca4c454b2947cce7883e22321cf2984050e15bf" { + t.Errorf("expected %v, got %v", "b14e44284ca477b4c0db34b15ca4c454b2947cce7883e22321cf2984050e15bf", checksum.Value) + } + case spdx.MD5: + if checksum.Value != "37c8208479dfe42d2bb29debd6e32d4a" { + t.Errorf("expected %v, got %v", "37c8208479dfe42d2bb29debd6e32d4a", checksum.Value) + } + } } + if file1.LicenseConcluded != "NOASSERTION" { t.Errorf("expected %v, got %v", "NOASSERTION", file1.LicenseConcluded) } - if len(file1.LicenseInfoInFile) != 1 { - t.Errorf("expected %v, got %v", 1, len(file1.LicenseInfoInFile)) + if len(file1.LicenseInfoInFiles) != 1 { + t.Errorf("expected %v, got %v", 1, len(file1.LicenseInfoInFiles)) } else { - if file1.LicenseInfoInFile[0] != "NOASSERTION" { - t.Errorf("expected %v, got %v", "NOASSERTION", file1.LicenseInfoInFile[0]) + if file1.LicenseInfoInFiles[0] != "NOASSERTION" { + t.Errorf("expected %v, got %v", "NOASSERTION", file1.LicenseInfoInFiles[0]) } } if file1.FileCopyrightText != "NOASSERTION" { diff --git a/builder/builder2v1/build_package.go b/builder/builder2v1/build_package.go index e59e676..f39bb53 100644 --- a/builder/builder2v1/build_package.go +++ b/builder/builder2v1/build_package.go @@ -35,7 +35,7 @@ func BuildPackageSection2_1(packageName string, dirRoot string, pathsIgnore []st dirRootLen = len(dirRoot) } - files := map[spdx.ElementID]*spdx.File2_1{} + files := []*spdx.File2_1{} fileNumber := 0 for _, fp := range filepaths { newFilePatch := "" @@ -48,7 +48,7 @@ func BuildPackageSection2_1(packageName string, dirRoot string, pathsIgnore []st if err != nil { return nil, err } - files[newFile.FileSPDXIdentifier] = newFile + files = append(files, newFile) fileNumber++ } // get the verification code diff --git a/builder/builder2v1/build_package_test.go b/builder/builder2v1/build_package_test.go index 7128834..1458637 100644 --- a/builder/builder2v1/build_package_test.go +++ b/builder/builder2v1/build_package_test.go @@ -13,7 +13,7 @@ func TestBuilder2_1CanBuildPackageSection(t *testing.T) { packageName := "project1" dirRoot := "../../testdata/project1/" - wantVerificationCode := "fc9ac4a370af0a471c2e52af66d6b4cf4e2ba12b" + wantVerificationCode := spdx.PackageVerificationCode{Value: "fc9ac4a370af0a471c2e52af66d6b4cf4e2ba12b"} pkg, err := BuildPackageSection2_1(packageName, dirRoot, nil) if err != nil { @@ -38,7 +38,7 @@ func TestBuilder2_1CanBuildPackageSection(t *testing.T) { if pkg.IsFilesAnalyzedTagPresent != true { t.Errorf("expected %v, got %v", true, pkg.IsFilesAnalyzedTagPresent) } - if pkg.PackageVerificationCode != wantVerificationCode { + if pkg.PackageVerificationCode.Value != wantVerificationCode.Value { t.Errorf("expected %v, got %v", wantVerificationCode, pkg.PackageVerificationCode) } if pkg.PackageLicenseConcluded != "NOASSERTION" { @@ -61,7 +61,7 @@ func TestBuilder2_1CanBuildPackageSection(t *testing.T) { if len(pkg.Files) != 5 { t.Fatalf("expected %d, got %d", 5, len(pkg.Files)) } - fileEmpty := pkg.Files[spdx.ElementID("File0")] + fileEmpty := pkg.Files[0] if fileEmpty == nil { t.Fatalf("expected non-nil file, got nil") } @@ -71,23 +71,30 @@ func TestBuilder2_1CanBuildPackageSection(t *testing.T) { if fileEmpty.FileSPDXIdentifier != spdx.ElementID("File0") { t.Errorf("expected %v, got %v", "File0", fileEmpty.FileSPDXIdentifier) } - if fileEmpty.FileChecksumSHA1 != "da39a3ee5e6b4b0d3255bfef95601890afd80709" { - t.Errorf("expected %v, got %v", "da39a3ee5e6b4b0d3255bfef95601890afd80709", fileEmpty.FileChecksumSHA1) - } - if fileEmpty.FileChecksumSHA256 != "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" { - t.Errorf("expected %v, got %v", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", fileEmpty.FileChecksumSHA256) - } - if fileEmpty.FileChecksumMD5 != "d41d8cd98f00b204e9800998ecf8427e" { - t.Errorf("expected %v, got %v", "d41d8cd98f00b204e9800998ecf8427e", fileEmpty.FileChecksumMD5) + for _, checksum := range fileEmpty.Checksums { + switch checksum.Algorithm { + case spdx.SHA1: + if checksum.Value != "da39a3ee5e6b4b0d3255bfef95601890afd80709" { + t.Errorf("expected %v, got %v", "da39a3ee5e6b4b0d3255bfef95601890afd80709", checksum.Value) + } + case spdx.SHA256: + if checksum.Value != "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" { + t.Errorf("expected %v, got %v", "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", checksum.Value) + } + case spdx.MD5: + if checksum.Value != "d41d8cd98f00b204e9800998ecf8427e" { + t.Errorf("expected %v, got %v", "d41d8cd98f00b204e9800998ecf8427e", checksum.Value) + } + } } if fileEmpty.LicenseConcluded != "NOASSERTION" { t.Errorf("expected %v, got %v", "NOASSERTION", fileEmpty.LicenseConcluded) } - if len(fileEmpty.LicenseInfoInFile) != 1 { - t.Errorf("expected %v, got %v", 1, len(fileEmpty.LicenseInfoInFile)) + if len(fileEmpty.LicenseInfoInFiles) != 1 { + t.Errorf("expected %v, got %v", 1, len(fileEmpty.LicenseInfoInFiles)) } else { - if fileEmpty.LicenseInfoInFile[0] != "NOASSERTION" { - t.Errorf("expected %v, got %v", "NOASSERTION", fileEmpty.LicenseInfoInFile[0]) + if fileEmpty.LicenseInfoInFiles[0] != "NOASSERTION" { + t.Errorf("expected %v, got %v", "NOASSERTION", fileEmpty.LicenseInfoInFiles[0]) } } if fileEmpty.FileCopyrightText != "NOASSERTION" { @@ -118,31 +125,31 @@ func TestBuilder2_1CanIgnoreFiles(t *testing.T) { } want := "./dontscan.txt" - got := pkg.Files[spdx.ElementID("File0")].FileName + got := pkg.Files[0].FileName if want != got { t.Errorf("expected %v, got %v", want, got) } want = "./keep/keep.txt" - got = pkg.Files[spdx.ElementID("File1")].FileName + got = pkg.Files[1].FileName if want != got { t.Errorf("expected %v, got %v", want, got) } want = "./keep.txt" - got = pkg.Files[spdx.ElementID("File2")].FileName + got = pkg.Files[2].FileName if want != got { t.Errorf("expected %v, got %v", want, got) } want = "./subdir/keep/dontscan.txt" - got = pkg.Files[spdx.ElementID("File3")].FileName + got = pkg.Files[3].FileName if want != got { t.Errorf("expected %v, got %v", want, got) } want = "./subdir/keep/keep.txt" - got = pkg.Files[spdx.ElementID("File4")].FileName + got = pkg.Files[4].FileName if want != got { t.Errorf("expected %v, got %v", want, got) } |