From cd59ee66408a908f7ef94548814514f6bc9fc906 Mon Sep 17 00:00:00 2001 From: RishabhBhatnagar Date: Thu, 9 Jan 2020 20:39:55 +0530 Subject: Create Go Module - Unpack directory v0 to move all the content to the root directory. - ./v0/* converted to ./* - all the test cases were fixed to remove one directory less indexing for test files - add go.mod - go version 1.13 is used to have a relatively stable versioning system Signed-off-by: RishabhBhatnagar --- reporter/reporter.go | 75 ++++++++++++++++++++++++++ reporter/reporter_test.go | 134 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 209 insertions(+) create mode 100644 reporter/reporter.go create mode 100644 reporter/reporter_test.go (limited to 'reporter') diff --git a/reporter/reporter.go b/reporter/reporter.go new file mode 100644 index 0000000..a794d8a --- /dev/null +++ b/reporter/reporter.go @@ -0,0 +1,75 @@ +// 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. +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later +package reporter + +import ( + "fmt" + "io" + "sort" + "text/tabwriter" + + "github.com/spdx/tools-golang/spdx" +) + +// Generate 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 { + if pkg.FilesAnalyzed == false { + return fmt.Errorf("Package FilesAnalyzed is false") + } + totalFound, totalNotFound, foundCounts := countLicenses(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 countLicenses(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 +} diff --git a/reporter/reporter_test.go b/reporter/reporter_test.go new file mode 100644 index 0000000..919e46b --- /dev/null +++ b/reporter/reporter_test.go @@ -0,0 +1,134 @@ +// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + +package reporter + +import ( + "bytes" + "testing" + + "github.com/spdx/tools-golang/spdx" +) + +// ===== Reporter top-level function tests ===== +func TestReporterCanMakeReportFromPackage(t *testing.T) { + pkg := &spdx.Package2_1{ + FilesAnalyzed: true, + Files: []*spdx.File2_1{ + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "NOASSERTION"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "NOASSERTION"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{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 := Generate(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 TestReporterReturnsErrorIfPackageFilesNotAnalyzed(t *testing.T) { + pkg := &spdx.Package2_1{ + FilesAnalyzed: false, + } + + // render as buffer of bytes + var got bytes.Buffer + err := Generate(pkg, &got) + if err == nil { + t.Errorf("Expected non-nil error, got nil") + } +} + +// ===== Utility functions ===== + +func TestCanGetCountsOfLicenses(t *testing.T) { + pkg := &spdx.Package2_1{ + FilesAnalyzed: true, + Files: []*spdx.File2_1{ + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "NOASSERTION"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "NOASSERTION"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "MIT"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "GPL-2.0-only"}, + &spdx.File2_1{LicenseConcluded: "NOASSERTION"}, + }, + } + + totalFound, totalNotFound, foundCounts := countLicenses(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 TestNilPackageReturnsZeroCountsOfLicenses(t *testing.T) { + totalFound, totalNotFound, foundCounts := countLicenses(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_1{} + totalFound, totalNotFound, foundCounts = countLicenses(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)) + } +} -- cgit v1.2.3