From 1e75edca9522aa82d1f269929d907209f93b3575 Mon Sep 17 00:00:00 2001 From: Steve Winslow Date: Sun, 14 Jun 2020 15:56:47 -0400 Subject: Add reporter and tests for 2.2 Signed-off-by: Steve Winslow --- reporter/reporter.go | 77 ++++++++++++++++++++++-- reporter/reporter_test.go | 146 ++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 206 insertions(+), 17 deletions(-) (limited to 'reporter') diff --git a/reporter/reporter.go b/reporter/reporter.go index a794d8a..acb47b5 100644 --- a/reporter/reporter.go +++ b/reporter/reporter.go @@ -1,6 +1,6 @@ // Package reporter contains functions to generate a basic license count -// report from an in-memory SPDX Package section (version 2.1) whose -// Files have been analyzed. +// report from an in-memory SPDX Package section whose Files have been +// analyzed. // SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later package reporter @@ -13,14 +13,79 @@ import ( "github.com/spdx/tools-golang/spdx" ) -// Generate takes a Package whose Files have been analyzed and an +// ===== 2.1 Reporter functions ===== + +// Generate2_1 takes a Package whose Files have been analyzed and an +// io.Writer, and outputs to the io.Writer a tabulated count of +// the number of Files for each unique LicenseConcluded in the set. +func Generate2_1(pkg *spdx.Package2_1, w io.Writer) error { + if pkg.FilesAnalyzed == false { + return fmt.Errorf("Package FilesAnalyzed is false") + } + totalFound, totalNotFound, foundCounts := countLicenses2_1(pkg) + + wr := tabwriter.NewWriter(w, 0, 0, 2, ' ', tabwriter.AlignRight) + + fmt.Fprintf(wr, "%d\t License found\n", totalFound) + fmt.Fprintf(wr, "%d\t License not found\n", totalNotFound) + fmt.Fprintf(wr, "%d\t TOTAL\n", totalFound+totalNotFound) + fmt.Fprintf(wr, "\n") + + counts := []struct { + lic string + count int + }{} + for k, v := range foundCounts { + var entry struct { + lic string + count int + } + entry.lic = k + entry.count = v + counts = append(counts, entry) + } + + sort.Slice(counts, func(i, j int) bool { return counts[i].count > counts[j].count }) + + for _, c := range counts { + fmt.Fprintf(wr, "%d\t %s\n", c.count, c.lic) + } + fmt.Fprintf(wr, "%d\t TOTAL FOUND\n", totalFound) + + wr.Flush() + return nil +} + +func countLicenses2_1(pkg *spdx.Package2_1) (int, int, map[string]int) { + if pkg == nil || pkg.Files == nil { + return 0, 0, nil + } + + totalFound := 0 + totalNotFound := 0 + foundCounts := map[string]int{} + for _, f := range pkg.Files { + if f.LicenseConcluded == "" || f.LicenseConcluded == "NOASSERTION" { + totalNotFound++ + } else { + totalFound++ + foundCounts[f.LicenseConcluded]++ + } + } + + return totalFound, totalNotFound, foundCounts +} + +// ===== 2.2 Reporter functions ===== + +// Generate2_2 takes a Package whose Files have been analyzed and an // io.Writer, and outputs to the io.Writer a tabulated count of // the number of Files for each unique LicenseConcluded in the set. -func Generate(pkg *spdx.Package2_1, w io.Writer) error { +func Generate2_2(pkg *spdx.Package2_2, w io.Writer) error { if pkg.FilesAnalyzed == false { return fmt.Errorf("Package FilesAnalyzed is false") } - totalFound, totalNotFound, foundCounts := countLicenses(pkg) + totalFound, totalNotFound, foundCounts := countLicenses2_2(pkg) wr := tabwriter.NewWriter(w, 0, 0, 2, ' ', tabwriter.AlignRight) @@ -54,7 +119,7 @@ func Generate(pkg *spdx.Package2_1, w io.Writer) error { return nil } -func countLicenses(pkg *spdx.Package2_1) (int, int, map[string]int) { +func countLicenses2_2(pkg *spdx.Package2_2) (int, int, map[string]int) { if pkg == nil || pkg.Files == nil { return 0, 0, nil } diff --git a/reporter/reporter_test.go b/reporter/reporter_test.go index c0d7940..9de377e 100644 --- a/reporter/reporter_test.go +++ b/reporter/reporter_test.go @@ -9,8 +9,8 @@ import ( "github.com/spdx/tools-golang/spdx" ) -// ===== Reporter top-level function tests ===== -func TestReporterCanMakeReportFromPackage(t *testing.T) { +// ===== 2.1 Reporter top-level function tests ===== +func Test2_1ReporterCanMakeReportFromPackage(t *testing.T) { pkg := &spdx.Package2_1{ FilesAnalyzed: true, Files: map[spdx.ElementID]*spdx.File2_1{ @@ -41,7 +41,7 @@ func TestReporterCanMakeReportFromPackage(t *testing.T) { // render as buffer of bytes var got bytes.Buffer - err := Generate(pkg, &got) + err := Generate2_1(pkg, &got) if err != nil { t.Errorf("Expected nil error, got %v", err) } @@ -53,22 +53,22 @@ func TestReporterCanMakeReportFromPackage(t *testing.T) { } } -func TestReporterReturnsErrorIfPackageFilesNotAnalyzed(t *testing.T) { +func Test2_1ReporterReturnsErrorIfPackageFilesNotAnalyzed(t *testing.T) { pkg := &spdx.Package2_1{ FilesAnalyzed: false, } // render as buffer of bytes var got bytes.Buffer - err := Generate(pkg, &got) + err := Generate2_1(pkg, &got) if err == nil { t.Errorf("Expected non-nil error, got nil") } } -// ===== Utility functions ===== +// ===== 2.1 Utility functions ===== -func TestCanGetCountsOfLicenses(t *testing.T) { +func Test2_1CanGetCountsOfLicenses(t *testing.T) { pkg := &spdx.Package2_1{ FilesAnalyzed: true, Files: map[spdx.ElementID]*spdx.File2_1{ @@ -87,7 +87,7 @@ func TestCanGetCountsOfLicenses(t *testing.T) { }, } - totalFound, totalNotFound, foundCounts := countLicenses(pkg) + totalFound, totalNotFound, foundCounts := countLicenses2_1(pkg) if totalFound != 9 { t.Errorf("expected %v, got %v", 9, totalFound) } @@ -108,8 +108,8 @@ func TestCanGetCountsOfLicenses(t *testing.T) { } } -func TestNilPackageReturnsZeroCountsOfLicenses(t *testing.T) { - totalFound, totalNotFound, foundCounts := countLicenses(nil) +func Test2_1NilPackageReturnsZeroCountsOfLicenses(t *testing.T) { + totalFound, totalNotFound, foundCounts := countLicenses2_1(nil) if totalFound != 0 { t.Errorf("expected %v, got %v", 0, totalFound) } @@ -121,7 +121,131 @@ func TestNilPackageReturnsZeroCountsOfLicenses(t *testing.T) { } pkg := &spdx.Package2_1{} - totalFound, totalNotFound, foundCounts = countLicenses(pkg) + totalFound, totalNotFound, foundCounts = countLicenses2_1(pkg) + if totalFound != 0 { + t.Errorf("expected %v, got %v", 0, totalFound) + } + if totalNotFound != 0 { + t.Errorf("expected %v, got %v", 0, totalNotFound) + } + if len(foundCounts) != 0 { + t.Fatalf("expected %v, got %v", 0, len(foundCounts)) + } +} + +// ===== 2.2 Reporter top-level function tests ===== +func Test2_2ReporterCanMakeReportFromPackage(t *testing.T) { + pkg := &spdx.Package2_2{ + FilesAnalyzed: true, + Files: map[spdx.ElementID]*spdx.File2_2{ + spdx.ElementID("File0"): &spdx.File2_2{FileSPDXIdentifier: "File0", LicenseConcluded: "MIT"}, + spdx.ElementID("File1"): &spdx.File2_2{FileSPDXIdentifier: "File1", LicenseConcluded: "NOASSERTION"}, + spdx.ElementID("File2"): &spdx.File2_2{FileSPDXIdentifier: "File2", LicenseConcluded: "MIT"}, + spdx.ElementID("File3"): &spdx.File2_2{FileSPDXIdentifier: "File3", LicenseConcluded: "MIT"}, + spdx.ElementID("File4"): &spdx.File2_2{FileSPDXIdentifier: "File4", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File5"): &spdx.File2_2{FileSPDXIdentifier: "File5", LicenseConcluded: "NOASSERTION"}, + spdx.ElementID("File6"): &spdx.File2_2{FileSPDXIdentifier: "File6", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File7"): &spdx.File2_2{FileSPDXIdentifier: "File7", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File8"): &spdx.File2_2{FileSPDXIdentifier: "File8", LicenseConcluded: "MIT"}, + spdx.ElementID("File9"): &spdx.File2_2{FileSPDXIdentifier: "File9", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File10"): &spdx.File2_2{FileSPDXIdentifier: "File10", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File11"): &spdx.File2_2{FileSPDXIdentifier: "File11", LicenseConcluded: "NOASSERTION"}, + }, + } + + // what we want to get, as a buffer of bytes + want := bytes.NewBufferString(` 9 License found + 3 License not found + 12 TOTAL + + 5 GPL-2.0-only + 4 MIT + 9 TOTAL FOUND +`) + + // render as buffer of bytes + var got bytes.Buffer + err := Generate2_2(pkg, &got) + if err != nil { + t.Errorf("Expected nil error, got %v", err) + } + + // check that they match + c := bytes.Compare(want.Bytes(), got.Bytes()) + if c != 0 { + t.Errorf("Expected %v, got %v", want.String(), got.String()) + } +} + +func Test2_2ReporterReturnsErrorIfPackageFilesNotAnalyzed(t *testing.T) { + pkg := &spdx.Package2_2{ + FilesAnalyzed: false, + } + + // render as buffer of bytes + var got bytes.Buffer + err := Generate2_2(pkg, &got) + if err == nil { + t.Errorf("Expected non-nil error, got nil") + } +} + +// ===== 2.2 Utility functions ===== + +func Test2_2CanGetCountsOfLicenses(t *testing.T) { + pkg := &spdx.Package2_2{ + FilesAnalyzed: true, + Files: map[spdx.ElementID]*spdx.File2_2{ + spdx.ElementID("File0"): &spdx.File2_2{FileSPDXIdentifier: "File0", LicenseConcluded: "MIT"}, + spdx.ElementID("File1"): &spdx.File2_2{FileSPDXIdentifier: "File1", LicenseConcluded: "NOASSERTION"}, + spdx.ElementID("File2"): &spdx.File2_2{FileSPDXIdentifier: "File2", LicenseConcluded: "MIT"}, + spdx.ElementID("File3"): &spdx.File2_2{FileSPDXIdentifier: "File3", LicenseConcluded: "MIT"}, + spdx.ElementID("File4"): &spdx.File2_2{FileSPDXIdentifier: "File4", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File5"): &spdx.File2_2{FileSPDXIdentifier: "File5", LicenseConcluded: "NOASSERTION"}, + spdx.ElementID("File6"): &spdx.File2_2{FileSPDXIdentifier: "File6", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File7"): &spdx.File2_2{FileSPDXIdentifier: "File7", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File8"): &spdx.File2_2{FileSPDXIdentifier: "File8", LicenseConcluded: "MIT"}, + spdx.ElementID("File9"): &spdx.File2_2{FileSPDXIdentifier: "File9", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File10"): &spdx.File2_2{FileSPDXIdentifier: "File10", LicenseConcluded: "GPL-2.0-only"}, + spdx.ElementID("File11"): &spdx.File2_2{FileSPDXIdentifier: "File11", LicenseConcluded: "NOASSERTION"}, + }, + } + + totalFound, totalNotFound, foundCounts := countLicenses2_2(pkg) + if totalFound != 9 { + t.Errorf("expected %v, got %v", 9, totalFound) + } + if totalNotFound != 3 { + t.Errorf("expected %v, got %v", 3, totalNotFound) + } + if len(foundCounts) != 2 { + t.Fatalf("expected %v, got %v", 2, len(foundCounts)) + } + + // foundCounts is a map of license ID to count of licenses + // confirm that the results are as expected + if foundCounts["GPL-2.0-only"] != 5 { + t.Errorf("expected %v, got %v", 5, foundCounts["GPL-2.0-only"]) + } + if foundCounts["MIT"] != 4 { + t.Errorf("expected %v, got %v", 4, foundCounts["MIT"]) + } +} + +func Test2_2NilPackageReturnsZeroCountsOfLicenses(t *testing.T) { + totalFound, totalNotFound, foundCounts := countLicenses2_2(nil) + if totalFound != 0 { + t.Errorf("expected %v, got %v", 0, totalFound) + } + if totalNotFound != 0 { + t.Errorf("expected %v, got %v", 0, totalNotFound) + } + if len(foundCounts) != 0 { + t.Fatalf("expected %v, got %v", 0, len(foundCounts)) + } + + pkg := &spdx.Package2_2{} + totalFound, totalNotFound, foundCounts = countLicenses2_2(pkg) if totalFound != 0 { t.Errorf("expected %v, got %v", 0, totalFound) } -- cgit v1.2.3