Change whitelist to allowlist (#6)

Changes whitelist => allowlist, similar to elastic/cloud-on-k8s#3266, and yellowlist => maybelist to be consistent.

This is a breaking change as override files will need to be updated with the new field name.

Also adds expands the gitignore to include options from https://github.com/github/gitignore/blob/master/Go.gitignore

and begins a contributing doc to make the prereqs clearer.

.gitignore

@@ -1,3 +1,16 @@
 go-licence-detector
 out/
 bin/
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Prerequisites
+
+To submit a PR, please ensure you run `make generate` to ensure the NOTICE file is up to date. This may require you have `pkger` installed already, which you can do with `go get github.com/markbates/pkger/cmd/pkger`.

README.md

@@ -47,7 +47,7 @@ Allowed licence types can be specified using a JSON file with the following stru
 
 ```json
 {
-  "whitelist": [
+  "allowlist": [
     "Apache-2.0",
     "MIT"
   ]

assets/rules.json

@@ -1,5 +1,5 @@
 {
-  "whitelist": [
+  "allowlist": [
     "Apache-2.0",
     "BSD-2-Clause",
     "BSD-3-Clause",

detector/detector_test.go

@@ -112,7 +112,7 @@ func TestDetect(t *testing.T) {
 		},
 
 		{
-			name:            "LicenceNotWhitelisted",
+			name:            "LicenceNotAllowed",
 			includeIndirect: true,
 			overrides: map[string]dependency.Info{
 				"github.com/davecgh/go-spew":         {Name: "github.com/davecgh/go-spew", LicenceType: "Totally Legit License 2.0"},

detector/rules.go

@@ -31,14 +31,14 @@ const embeddedRulesFile = "go.elastic.co/go-licence-detector:/assets/rules.json"
 
 // rulesFile represents the structure of the rules file.
 type rulesFile struct {
-	Whitelist  []string `json:"whitelist"`
-	Yellowlist []string `json:"yellowlist"`
+	Allowlist  []string `json:"allowlist"`
+	Maybelist []string `json:"maybelist"`
 }
 
 // Rules holds rules for the detector.
 type Rules struct {
-	WhiteList  map[string]struct{}
-	YellowList map[string]struct{}
+	AllowList  map[string]struct{}
+	Maybelist map[string]struct{}
 }
 
 // LoadRules loads rules from the given path. Embedded rules file is loaded if the path is empty.
@@ -68,24 +68,24 @@ func LoadRules(path string) (*Rules, error) {
 	}
 
 	rules := &Rules{
-		WhiteList:  make(map[string]struct{}, len(rf.Whitelist)),
-		YellowList: make(map[string]struct{}, len(rf.Yellowlist)),
+		AllowList:  make(map[string]struct{}, len(rf.Allowlist)),
+		Maybelist: make(map[string]struct{}, len(rf.Maybelist)),
 	}
 
-	for _, w := range rf.Whitelist {
-		rules.WhiteList[w] = struct{}{}
+	for _, w := range rf.Allowlist {
+		rules.AllowList[w] = struct{}{}
 	}
 
-	for _, y := range rf.Yellowlist {
-		rules.YellowList[y] = struct{}{}
+	for _, y := range rf.Maybelist {
+		rules.Maybelist[y] = struct{}{}
 	}
 
 	return rules, nil
 }
 
 // IsAllowed returns true if the given licence is allowed by the rules.
 func (r *Rules) IsAllowed(licenceID string) bool {
-	_, isWhiteListed := r.WhiteList[licenceID]
-	_, isYellowListed := r.YellowList[licenceID]
-	return isWhiteListed || isYellowListed
+	_, isAllowListed := r.AllowList[licenceID]
+	_, isMaybeListed := r.Maybelist[licenceID]
+	return isAllowListed || isMaybeListed
 }

detector/rules_test.go

@@ -20,6 +20,7 @@ package detector
 import (
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -29,27 +30,27 @@ func TestLoadRules(t *testing.T) {
 
 		require.NoError(t, err)
 		require.NotNil(t, rules)
-		require.True(t, len(rules.WhiteList) > 0)
+		assert.True(t, len(rules.AllowList) > 0, rules)
 	})
 
 	t.Run("external", func(t *testing.T) {
 		rules, err := LoadRules("testdata/rules.json")
 
 		require.NoError(t, err)
 		require.NotNil(t, rules)
-		require.True(t, len(rules.WhiteList) > 0)
+		assert.True(t, len(rules.AllowList) > 0)
 	})
 }
 
-func TestRulesWhiteList(t *testing.T) {
+func TestRulesAllowList(t *testing.T) {
 	rules, err := LoadRules("testdata/rules.json")
 
 	require.NoError(t, err)
 	require.True(t, rules.IsAllowed("Apache-2.0"))
 	require.False(t, rules.IsAllowed("WTFPL"))
 }
 
-func TestRulesYellowList(t *testing.T) {
+func TestRulesMaybeList(t *testing.T) {
 	rules, err := LoadRules("testdata/rules.json")
 
 	require.NoError(t, err)

detector/testdata/rules.json

@@ -1,5 +1,5 @@
 {
-  "whitelist": [
+  "allowlist": [
     "Apache-2.0",
     "BSD-2-Clause",
     "BSD-3-Clause",
@@ -8,7 +8,7 @@
     "MPL-2.0",
     "Public Domain"
   ],
-  "yellowlist": [
+  "maybelist": [
     "GPL-3.0"
   ]
 }