compliance package structures for license metadata
package to read, consume, and analyze license metadata and dependency
graph.
Bug: 68860345
Bug: 151177513
Bug: 151953481
Change-Id: I3ebf44e4d5195b9851fd076161049bf82ed76dd2
diff --git a/tools/compliance/conditionset_test.go b/tools/compliance/conditionset_test.go
new file mode 100644
index 0000000..eac0680
--- /dev/null
+++ b/tools/compliance/conditionset_test.go
@@ -0,0 +1,590 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package compliance
+
+import (
+ "sort"
+ "strings"
+ "testing"
+)
+
+type byName map[string][]string
+
+func (bn byName) checkPublic(ls *LicenseConditionSet, t *testing.T) {
+ for names, expected := range bn {
+ name := ConditionNames(strings.Split(names, ":"))
+ if ls.HasAnyByName(name) {
+ if len(expected) == 0 {
+ t.Errorf("unexpected LicenseConditionSet.HasAnyByName(%q): got true, want false", name)
+ }
+ } else {
+ if len(expected) != 0 {
+ t.Errorf("unexpected LicenseConditionSet.HasAnyByName(%q): got false, want true", name)
+ }
+ }
+ if len(expected) != ls.CountByName(name) {
+ t.Errorf("unexpected LicenseConditionSet.CountByName(%q): got %d, want %d", name, ls.CountByName(name), len(expected))
+ }
+ byName := ls.ByName(name).AsList()
+ if len(expected) != len(byName) {
+ t.Errorf("unexpected LicenseConditionSet.ByName(%q): got %v, want %v", name, byName, expected)
+ } else {
+ sort.Strings(expected)
+ actual := make([]string, 0, len(byName))
+ for _, lc := range byName {
+ actual = append(actual, lc.Origin().Name())
+ }
+ sort.Strings(actual)
+ for i := 0; i < len(expected); i++ {
+ if expected[i] != actual[i] {
+ t.Errorf("unexpected LicenseConditionSet.ByName(%q) index %d in %v: got %s, want %s", name, i, actual, actual[i], expected[i])
+ }
+ }
+ }
+ }
+}
+
+type byOrigin map[string][]string
+
+func (bo byOrigin) checkPublic(lg *LicenseGraph, ls *LicenseConditionSet, t *testing.T) {
+ expectedCount := 0
+ for origin, expected := range bo {
+ expectedCount += len(expected)
+ onode := newTestNode(lg, origin)
+ if ls.HasAnyByOrigin(onode) {
+ if len(expected) == 0 {
+ t.Errorf("unexpected LicenseConditionSet.HasAnyByOrigin(%q): got true, want false", origin)
+ }
+ } else {
+ if len(expected) != 0 {
+ t.Errorf("unexpected LicenseConditionSet.HasAnyByOrigin(%q): got false, want true", origin)
+ }
+ }
+ if len(expected) != ls.CountByOrigin(onode) {
+ t.Errorf("unexpected LicenseConditionSet.CountByOrigin(%q): got %d, want %d", origin, ls.CountByOrigin(onode), len(expected))
+ }
+ byOrigin := ls.ByOrigin(onode).AsList()
+ if len(expected) != len(byOrigin) {
+ t.Errorf("unexpected LicenseConditionSet.ByOrigin(%q): got %v, want %v", origin, byOrigin, expected)
+ } else {
+ sort.Strings(expected)
+ actual := make([]string, 0, len(byOrigin))
+ for _, lc := range byOrigin {
+ actual = append(actual, lc.Name())
+ }
+ sort.Strings(actual)
+ for i := 0; i < len(expected); i++ {
+ if expected[i] != actual[i] {
+ t.Errorf("unexpected LicenseConditionSet.ByOrigin(%q) index %d in %v: got %s, want %s", origin, i, actual, actual[i], expected[i])
+ }
+ }
+ }
+ }
+ if expectedCount != ls.Count() {
+ t.Errorf("unexpected LicenseConditionSet.Count(): got %d, want %d", ls.Count(), expectedCount)
+ }
+ if ls.IsEmpty() {
+ if expectedCount != 0 {
+ t.Errorf("unexpected LicenseConditionSet.IsEmpty(): got true, want false")
+ }
+ } else {
+ if expectedCount == 0 {
+ t.Errorf("unexpected LicenseConditionSet.IsEmpty(): got false, want true")
+ }
+ }
+}
+
+func TestConditionSet(t *testing.T) {
+ tests := []struct {
+ name string
+ conditions map[string][]string
+ add map[string][]string
+ byName map[string][]string
+ byOrigin map[string][]string
+ }{
+ {
+ name: "empty",
+ conditions: map[string][]string{},
+ add: map[string][]string{},
+ byName: map[string][]string{
+ "notice": []string{},
+ "restricted": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{},
+ "lib1": []string{},
+ "bin2": []string{},
+ "lib2": []string{},
+ },
+ },
+ {
+ name: "noticeonly",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "lib1"},
+ },
+ byName: map[string][]string{
+ "notice": []string{"bin1", "lib1"},
+ "restricted": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice"},
+ "lib1": []string{"notice"},
+ "bin2": []string{},
+ "lib2": []string{},
+ },
+ },
+ {
+ name: "noticeonlyadded",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "lib1"},
+ },
+ add: map[string][]string{
+ "notice": []string{"bin1", "bin2"},
+ },
+ byName: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1"},
+ "restricted": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice"},
+ "lib1": []string{"notice"},
+ "bin2": []string{"notice"},
+ "lib2": []string{},
+ },
+ },
+ {
+ name: "everything",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ add: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "bin2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "allbutoneeach",
+ conditions: map[string][]string{
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"reciprocal", "restricted", "by_exception_only"},
+ "bin2": []string{"notice", "restricted", "by_exception_only"},
+ "lib1": []string{"notice", "reciprocal", "by_exception_only"},
+ "lib2": []string{"notice", "reciprocal", "restricted"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "allbutoneeachadded",
+ conditions: map[string][]string{
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ add: map[string][]string{
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"reciprocal", "restricted", "by_exception_only"},
+ "bin2": []string{"notice", "restricted", "by_exception_only"},
+ "lib1": []string{"notice", "reciprocal", "by_exception_only"},
+ "lib2": []string{"notice", "reciprocal", "restricted"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "allbutoneeachfilled",
+ conditions: map[string][]string{
+ "notice": []string{"bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1"},
+ },
+ add: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1"},
+ "reciprocal": []string{"bin1", "bin2", "lib2"},
+ "restricted": []string{"bin1", "lib1", "lib2"},
+ "by_exception_only": []string{"bin2", "lib1", "lib2"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "bin2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "oneeach",
+ conditions: map[string][]string{
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice"},
+ "bin2": []string{"reciprocal"},
+ "lib1": []string{"restricted"},
+ "lib2": []string{"by_exception_only"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "oneeachoverlap",
+ conditions: map[string][]string{
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ add: map[string][]string{
+ "notice": []string{"lib2"},
+ "reciprocal": []string{"lib1"},
+ "restricted": []string{"bin2"},
+ "by_exception_only": []string{"bin1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1", "lib2"},
+ "reciprocal": []string{"bin2", "lib1"},
+ "restricted": []string{"bin2", "lib1"},
+ "by_exception_only": []string{"bin1", "lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"by_exception_only", "notice"},
+ "bin2": []string{"reciprocal", "restricted"},
+ "lib1": []string{"reciprocal", "restricted"},
+ "lib2": []string{"by_exception_only", "notice"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "oneeachadded",
+ conditions: map[string][]string{
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ add: map[string][]string{
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1"},
+ "reciprocal": []string{"bin2"},
+ "restricted": []string{"lib1"},
+ "by_exception_only": []string{"lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice"},
+ "bin2": []string{"reciprocal"},
+ "lib1": []string{"restricted"},
+ "lib2": []string{"by_exception_only"},
+ "other": []string{},
+ },
+ },
+ }
+ for _, tt := range tests {
+ testPublicInterface := func(lg *LicenseGraph, cs *LicenseConditionSet, t *testing.T) {
+ byName(tt.byName).checkPublic(cs, t)
+ byOrigin(tt.byOrigin).checkPublic(lg, cs, t)
+ }
+ t.Run(tt.name+"_public_interface", func(t *testing.T) {
+ lg := newLicenseGraph()
+ cs := NewLicenseConditionSet(toConditionList(lg, tt.conditions)...)
+ if tt.add != nil {
+ cs.Add(toConditionList(lg, tt.add)...)
+ }
+ testPublicInterface(lg, cs, t)
+ })
+
+ t.Run("Copy() of "+tt.name+"_public_interface", func(t *testing.T) {
+ lg := newLicenseGraph()
+ cs := NewLicenseConditionSet(toConditionList(lg, tt.conditions)...)
+ if tt.add != nil {
+ cs.Add(toConditionList(lg, tt.add)...)
+ }
+ testPublicInterface(lg, cs.Copy(), t)
+ })
+
+ testPrivateInterface := func(lg *LicenseGraph, cs *LicenseConditionSet, t *testing.T) {
+ slist := make([]string, 0, cs.Count())
+ for origin, expected := range tt.byOrigin {
+ for _, name := range expected {
+ slist = append(slist, origin+";"+name)
+ }
+ }
+ actualSlist := cs.asStringList(";")
+ if len(slist) != len(actualSlist) {
+ t.Errorf("unexpected LicenseConditionSet.asStringList(\";\"): got %v, want %v", actualSlist, slist)
+ } else {
+ sort.Strings(slist)
+ sort.Strings(actualSlist)
+ for i := 0; i < len(slist); i++ {
+ if slist[i] != actualSlist[i] {
+ t.Errorf("unexpected LicenseConditionSet.asStringList(\";\") index %d in %v: got %s, want %s", i, actualSlist, actualSlist[i], slist[i])
+ }
+ }
+ }
+ }
+
+ t.Run(tt.name+"_private_list_interface", func(t *testing.T) {
+ lg := newLicenseGraph()
+ cs := newLicenseConditionSet()
+ for name, origins := range tt.conditions {
+ for _, origin := range origins {
+ cs.add(newTestNode(lg, origin), name)
+ }
+ }
+ if tt.add != nil {
+ cs.Add(toConditionList(lg, tt.add)...)
+ }
+ testPrivateInterface(lg, cs, t)
+ })
+
+ t.Run(tt.name+"_private_set_interface", func(t *testing.T) {
+ lg := newLicenseGraph()
+ cs := newLicenseConditionSet()
+ for name, origins := range tt.conditions {
+ for _, origin := range origins {
+ cs.add(newTestNode(lg, origin), name)
+ }
+ }
+ if tt.add != nil {
+ other := newLicenseConditionSet()
+ for name, origins := range tt.add {
+ for _, origin := range origins {
+ other.add(newTestNode(lg, origin), name)
+ }
+ }
+ cs.AddSet(other)
+ }
+ testPrivateInterface(lg, cs, t)
+ })
+ }
+}
+
+func TestConditionSet_Removals(t *testing.T) {
+ tests := []struct {
+ name string
+ conditions map[string][]string
+ removeByName []ConditionNames
+ removeSet map[string][]string
+ byName map[string][]string
+ byOrigin map[string][]string
+ }{
+ {
+ name: "emptybyname",
+ conditions: map[string][]string{},
+ removeByName: []ConditionNames{{"reciprocal", "restricted"}},
+ byName: map[string][]string{
+ "notice": []string{},
+ "restricted": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{},
+ "lib1": []string{},
+ "bin2": []string{},
+ "lib2": []string{},
+ },
+ },
+ {
+ name: "emptybyset",
+ conditions: map[string][]string{},
+ removeSet: map[string][]string{
+ "notice": []string{"bin1", "bin2"},
+ "restricted": []string{"lib1", "lib2"},
+ },
+ byName: map[string][]string{
+ "notice": []string{},
+ "restricted": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{},
+ "lib1": []string{},
+ "bin2": []string{},
+ "lib2": []string{},
+ },
+ },
+ {
+ name: "everythingremovenone",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ removeByName: []ConditionNames{{"permissive", "unencumbered"}},
+ removeSet: map[string][]string{
+ "notice": []string{"apk1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "bin2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib1": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "lib2": []string{"notice", "reciprocal", "restricted", "by_exception_only"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "everythingremovesome",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ removeByName: []ConditionNames{{"restricted", "by_exception_only"}},
+ removeSet: map[string][]string{
+ "notice": []string{"lib1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{"bin1", "bin2", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{},
+ "by_exception_only": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{"notice", "reciprocal"},
+ "bin2": []string{"notice", "reciprocal"},
+ "lib1": []string{"reciprocal"},
+ "lib2": []string{"notice", "reciprocal"},
+ "other": []string{},
+ },
+ },
+ {
+ name: "everythingremoveall",
+ conditions: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1", "bin2", "lib1", "lib2"},
+ "by_exception_only": []string{"bin1", "bin2", "lib1", "lib2"},
+ },
+ removeByName: []ConditionNames{{"restricted", "by_exception_only"}},
+ removeSet: map[string][]string{
+ "notice": []string{"bin1", "bin2", "lib1", "lib2"},
+ "reciprocal": []string{"bin1", "bin2", "lib1", "lib2"},
+ "restricted": []string{"bin1"},
+ },
+ byName: map[string][]string{
+ "permissive": []string{},
+ "notice": []string{},
+ "reciprocal": []string{},
+ "restricted": []string{},
+ "by_exception_only": []string{},
+ },
+ byOrigin: map[string][]string{
+ "bin1": []string{},
+ "bin2": []string{},
+ "lib1": []string{},
+ "lib2": []string{},
+ "other": []string{},
+ },
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ lg := newLicenseGraph()
+ cs := newLicenseConditionSet()
+ for name, origins := range tt.conditions {
+ for _, origin := range origins {
+ cs.add(newTestNode(lg, origin), name)
+ }
+ }
+ if tt.removeByName != nil {
+ cs.RemoveAllByName(tt.removeByName...)
+ }
+ if tt.removeSet != nil {
+ other := newLicenseConditionSet()
+ for name, origins := range tt.removeSet {
+ for _, origin := range origins {
+ other.add(newTestNode(lg, origin), name)
+ }
+ }
+ cs.RemoveSet(other)
+ }
+ byName(tt.byName).checkPublic(cs, t)
+ byOrigin(tt.byOrigin).checkPublic(lg, cs, t)
+ })
+ }
+}