diff options
author | Steve Winslow <steve@swinslow.net> | 2021-07-04 10:54:31 -0400 |
---|---|---|
committer | Steve Winslow <steve@swinslow.net> | 2021-07-04 10:54:31 -0400 |
commit | b238c888559fcfaba7abc4d73741b633746c10d2 (patch) | |
tree | 9533e565af699fe44069e9ee3b1e3f02061191f3 /tvloader/parser2v1 | |
parent | b5d120102fa763bbe482a85a00d9a4d4b4e34657 (diff) | |
download | spdx-tools-b238c888559fcfaba7abc4d73741b633746c10d2.tar.gz |
Minor cleanup edits to text and comments
Signed-off-by: Steve Winslow <steve@swinslow.net>
Diffstat (limited to 'tvloader/parser2v1')
-rw-r--r-- | tvloader/parser2v1/parse_creation_info.go | 7 | ||||
-rw-r--r-- | tvloader/parser2v1/parse_file_test.go | 15 | ||||
-rw-r--r-- | tvloader/parser2v1/parse_package.go | 2 | ||||
-rw-r--r-- | tvloader/parser2v1/parse_package_test.go | 4 | ||||
-rw-r--r-- | tvloader/parser2v1/parse_snippet.go | 2 | ||||
-rw-r--r-- | tvloader/parser2v1/parse_snippet_test.go | 8 | ||||
-rw-r--r-- | tvloader/parser2v1/parser_test.go | 8 |
7 files changed, 24 insertions, 22 deletions
diff --git a/tvloader/parser2v1/parse_creation_info.go b/tvloader/parser2v1/parse_creation_info.go index dd9a004..8742bf2 100644 --- a/tvloader/parser2v1/parse_creation_info.go +++ b/tvloader/parser2v1/parse_creation_info.go @@ -76,8 +76,11 @@ func (parser *tvParser2_1) parsePairFromCreationInfo2_1(tag string, value string // tag for going on to package section case "PackageName": - // Error if last file does not has FileSPDXId - if parser.file != nil && parser.file.FileSPDXIdentifier == spdx.ElementID("") { + // error if last file does not have an identifier + // this may be a null case: can we ever have a "last file" in + // the "creation info" state? should go on to "file" state + // even when parsing unpackaged files. + if parser.file != nil && parser.file.FileSPDXIdentifier == nullSpdxElementId2_1 { return fmt.Errorf("file with FileName %s does not have SPDX identifier", parser.file.FileName) } parser.st = psPackage2_1 diff --git a/tvloader/parser2v1/parse_file_test.go b/tvloader/parser2v1/parse_file_test.go index df14a18..9f42b55 100644 --- a/tvloader/parser2v1/parse_file_test.go +++ b/tvloader/parser2v1/parse_file_test.go @@ -886,7 +886,7 @@ func TestParser2_1FailsIfArtifactURIBeforeArtifactName(t *testing.T) { } func TestParser2_1FilesWithoutSpdxIdThrowError(t *testing.T) { - // case 1 : The previous file (packaged or unpackaged does not contain spdxID) + // case 1: The previous file (packaged or unpackaged) does not contain spdxID parser1 := tvParser2_1{ doc: &spdx.Document2_1{Packages: map[spdx.ElementID]*spdx.Package2_1{}}, st: psFile2_1, @@ -895,12 +895,11 @@ func TestParser2_1FilesWithoutSpdxIdThrowError(t *testing.T) { err := parser1.parsePair2_1("FileName", "f2") if err == nil { - t.Errorf("files withoutSpdx Identifiers getting accepted") + t.Errorf("file without SPDX Identifier getting accepted") } - // case 2 : Invalid file with snippet - // Last unpackaged file before the snippet start - // Last file of a package and New package starts + // case 2: Invalid file with snippet + // Last unpackaged file before a snippet starts sid1 := spdx.ElementID("s1") fileName := "f2.txt" parser2 := tvParser2_1{ @@ -910,11 +909,11 @@ func TestParser2_1FilesWithoutSpdxIdThrowError(t *testing.T) { } err = parser2.parsePair2_1("SnippetSPDXID", string(sid1)) if err == nil { - t.Errorf("files withoutSpdx Identifiers getting accepted") + t.Errorf("file without SPDX Identifier getting accepted") } // case 3 : Invalid File without snippets - // Last unpackaged file before the packges start + // Last unpackaged file before a package starts // Last file of a package and New package starts parser3 := tvParser2_1{ doc: &spdx.Document2_1{}, @@ -927,6 +926,6 @@ func TestParser2_1FilesWithoutSpdxIdThrowError(t *testing.T) { } err = parser3.parsePair2_1("PackageName", "p2") if err == nil { - t.Errorf("files withoutSpdx Identifiers getting accepted") + t.Errorf("files withoutSpdx Identifier getting accepted") } } diff --git a/tvloader/parser2v1/parse_package.go b/tvloader/parser2v1/parse_package.go index eb96f4c..a867107 100644 --- a/tvloader/parser2v1/parse_package.go +++ b/tvloader/parser2v1/parse_package.go @@ -20,7 +20,7 @@ func (parser *tvParser2_1) parsePairFromPackage2_1(tag string, value string) err case "PackageName": // if package already has a name, create and go on to a new package if parser.pkg == nil || parser.pkg.PackageName != "" { - // check if the previous package contained a spdxId or not + // check if the previous package contained an spdxId or not if parser.pkg != nil && parser.pkg.PackageSPDXIdentifier == nullSpdxElementId2_1 { return fmt.Errorf("package with PackageName %s does not have SPDX identifier", parser.pkg.PackageName) } diff --git a/tvloader/parser2v1/parse_package_test.go b/tvloader/parser2v1/parse_package_test.go index e43727b..3cda3ce 100644 --- a/tvloader/parser2v1/parse_package_test.go +++ b/tvloader/parser2v1/parse_package_test.go @@ -1070,7 +1070,7 @@ func TestFailsPackageExternalRefWithInvalidFormat(t *testing.T) { } func TestParser2_1PackageWithoutSpdxIdentifierThrowsError(t *testing.T) { - // More than one package , the previous package doesn't contain the SPDXID + // More than one package, the previous package doesn't contain the SPDXID pkgOldName := "p1" parser := tvParser2_1{ doc: &spdx.Document2_1{Packages: map[spdx.ElementID]*spdx.Package2_1{}}, @@ -1090,6 +1090,6 @@ func TestParser2_1PackageWithoutSpdxIdentifierThrowsError(t *testing.T) { pkgName := "p2" err := parser.parsePair2_1("PackageName", pkgName) if err == nil { - t.Errorf("packages withoutSpdx Identifiers getting accepted") + t.Errorf("package without SPDX Identifier getting accepted") } } diff --git a/tvloader/parser2v1/parse_snippet.go b/tvloader/parser2v1/parse_snippet.go index b8aafad..d590383 100644 --- a/tvloader/parser2v1/parse_snippet.go +++ b/tvloader/parser2v1/parse_snippet.go @@ -13,7 +13,7 @@ func (parser *tvParser2_1) parsePairFromSnippet2_1(tag string, value string) err switch tag { // tag for creating new snippet section case "SnippetSPDXID": - // check here whether the file containe + // check here whether the previous file contained an SPDX ID or not if parser.file != nil && parser.file.FileSPDXIdentifier == nullSpdxElementId2_1 { return fmt.Errorf("file with FileName %s does not have SPDX identifier", parser.file.FileName) } diff --git a/tvloader/parser2v1/parse_snippet_test.go b/tvloader/parser2v1/parse_snippet_test.go index 7b83f3d..603abc5 100644 --- a/tvloader/parser2v1/parse_snippet_test.go +++ b/tvloader/parser2v1/parse_snippet_test.go @@ -587,10 +587,10 @@ func TestParser2_1FailsForInvalidSnippetLineValues(t *testing.T) { } } -func TestParser2_1FilesWithoutSpdxIdThrowErrorWithSniipets(t *testing.T) { +func TestParser2_1FilesWithoutSpdxIdThrowErrorWithSnippets(t *testing.T) { // Invalid file with snippet - // Last unpackaged file before the snippet start - // Last file of a package and New package starts + // Last unpackaged file before the snippet starts + // Last file of a package and new snippet starts fileName := "f2.txt" sid1 := spdx.ElementID("s1") parser2 := tvParser2_1{ @@ -600,7 +600,7 @@ func TestParser2_1FilesWithoutSpdxIdThrowErrorWithSniipets(t *testing.T) { } err := parser2.parsePair2_1("SnippetSPDXID", string(sid1)) if err == nil { - t.Errorf("files withoutSpdx Identifiers getting accepted") + t.Errorf("files without SPDX Identifiers getting accepted") } } diff --git a/tvloader/parser2v1/parser_test.go b/tvloader/parser2v1/parser_test.go index 0678fd7..9fe051f 100644 --- a/tvloader/parser2v1/parser_test.go +++ b/tvloader/parser2v1/parser_test.go @@ -79,7 +79,7 @@ func TestParser2_1StartFailsToParseIfInInvalidState(t *testing.T) { } func TestParser2_1FilesWithoutSpdxIdThrowErrorAtCompleteParse(t *testing.T) { - // case + // case: checks the last file // Last unpackaged file no packages in doc // Last file of last package in the doc tvPairs := []reader.TagValuePair{ @@ -90,12 +90,12 @@ func TestParser2_1FilesWithoutSpdxIdThrowErrorAtCompleteParse(t *testing.T) { } _, err := ParseTagValues(tvPairs) if err == nil { - t.Errorf("files withoutSpdx Identifiers getting accepted") + t.Errorf("file without SPDX Identifier getting accepted") } } func TestParser2_1PackageWithoutSpdxIdThrowErrorAtCompleteParse(t *testing.T) { - // case : Checks the last package + // case: Checks the last package tvPairs := []reader.TagValuePair{ {Tag: "SPDXVersion", Value: "SPDX-2.1"}, {Tag: "DataLicense", Value: "CC0-1.0"}, @@ -104,6 +104,6 @@ func TestParser2_1PackageWithoutSpdxIdThrowErrorAtCompleteParse(t *testing.T) { } _, err := ParseTagValues(tvPairs) if err == nil { - t.Errorf("packages withoutSpdx Identifiers getting accepted") + t.Errorf("package without SPDX Identifier getting accepted") } } |