aboutsummaryrefslogtreecommitdiff
path: root/v0/reporter/reporter_test.go
blob: 65fc261acdb250bb7723697a08fd79b59f50c9f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

package reporter

import (
	"bytes"
	"testing"

	"github.com/spdx/tools-golang/v0/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))
	}
}