Merge pull request #134 from debricked/122-add-support-for-exclusion-…

…through-env

Add option to use comma seperated env var for default exclusion

internal/cmd/files/find/find.go

@@ -11,7 +11,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-var exclusions = file.DefaultExclusions()
+var exclusions = file.Exclusions()
 var jsonPrint bool
 var lockfileOnly bool
 var strictness int
@@ -46,6 +46,8 @@ Special Terms | Meaning
 "[class]"     | matches any single non-Separator character against a class of characters ([see "character classes"])
 "{alt1,...}"  | matches a sequence of characters if one of the comma-separated alternatives matches
 
+Exclude flags could alternatively be set using DEBRICKED_EXCLUSIONS="path1,path2,path3".
+
 Example: 
 $ debricked files find . `+exampleFlags)
 

internal/cmd/resolve/resolve.go

@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-var exclusions = file.DefaultExclusions()
+var exclusions = file.Exclusions()
 
 const (
 	ExclusionFlag = "exclusion"
@@ -41,6 +41,8 @@ Special Terms | Meaning
 "[class]"     | matches any single non-Separator character against a class of characters ([see "character classes"])
 "{alt1,...}"  | matches a sequence of characters if one of the comma-separated alternatives matches
 
+Exclude flags could alternatively be set using DEBRICKED_EXCLUSIONS="path1,path2,path3".
+
 Example: 
 $ debricked files resolve . `+exampleFlags)
 

internal/cmd/scan/scan.go

@@ -18,7 +18,7 @@ var branchName string
 var commitAuthor string
 var repositoryUrl string
 var integrationName string
-var exclusions = file.DefaultExclusions()
+var exclusions = file.Exclusions()
 var noResolve bool
 var noFingerprint bool
 var passOnDowntime bool
@@ -79,6 +79,8 @@ Special Terms | Meaning
 "[class]"     | matches any single non-Separator character against a class of characters ([see "character classes"])
 "{alt1,...}"  | matches a sequence of characters if one of the comma-separated alternatives matches
 
+Exclude flags could alternatively be set using DEBRICKED_EXCLUSIONS="path1,path2,path3".
+
 Examples: 
 $ debricked scan . `+exampleFlags)
 	cmd.Flags().BoolVarP(&passOnDowntime, PassOnTimeOut, "p", false, "pass scan if there is a service access timeout")

internal/file/default_exclusion.go → internal/file/exclusion.go

@@ -1,6 +1,12 @@
 package file
 
-import "path/filepath"
+import (
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+const debrickedExclusionEnvVar = "DEBRICKED_EXCLUSIONS"
 
 func DefaultExclusions() []string {
 	return []string{
@@ -11,6 +17,17 @@ func DefaultExclusions() []string {
 	}
 }
 
+func Exclusions() []string {
+	values := DefaultExclusions()
+
+	envValue := os.Getenv(debrickedExclusionEnvVar)
+	if envValue != "" {
+		values = strings.Split(envValue, ",")
+	}
+
+	return values
+}
+
 var EXCLUDED_DIRS_FINGERPRINT = []string{
 	"nbproject", "nbbuild", "nbdist", "node_modules",
 	"__pycache__", "_yardoc", "eggs",

internal/file/exclusion_test.go

@@ -0,0 +1,85 @@
+package file
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDefaultExclusions(t *testing.T) {
+	separator := string(os.PathSeparator)
+	for _, ex := range DefaultExclusions() {
+		exParts := strings.Split(ex, separator)
+		assert.Greaterf(t, len(exParts), 0, "failed to assert that %s used correct separator. Proper separator %s", ex, separator)
+	}
+}
+
+func TestExclusionsWithTokenEnvVariable(t *testing.T) {
+	oldEnvValue := os.Getenv(debrickedExclusionEnvVar)
+	err := os.Setenv(debrickedExclusionEnvVar, "*/**.lock,**/node_modules/**,*\\**.ex")
+
+	if err != nil {
+		t.Fatalf("failed to set env var %s", debrickedExclusionEnvVar)
+	}
+
+	defer func(key, value string) {
+		err := os.Setenv(key, value)
+		if err != nil {
+			t.Fatalf("failed to reset env var %s", debrickedExclusionEnvVar)
+		}
+	}(debrickedExclusionEnvVar, oldEnvValue)
+
+	gt := []string{"*/**.lock", "**/node_modules/**", "*\\**.ex"}
+	exclusions := Exclusions()
+	assert.Equal(t, gt, exclusions)
+
+}
+
+func TestExclusionsWithEmptyTokenEnvVariable(t *testing.T) {
+	oldEnvValue := os.Getenv(debrickedExclusionEnvVar)
+	err := os.Setenv(debrickedExclusionEnvVar, "")
+
+	if err != nil {
+		t.Fatalf("failed to set env var %s", debrickedExclusionEnvVar)
+	}
+
+	defer func(key, value string) {
+		err := os.Setenv(key, value)
+		if err != nil {
+			t.Fatalf("failed to reset env var %s", debrickedExclusionEnvVar)
+		}
+	}(debrickedExclusionEnvVar, oldEnvValue)
+
+	gt := []string{
+		filepath.Join("**", "node_modules", "**"),
+		filepath.Join("**", "vendor", "**"),
+		filepath.Join("**", ".git", "**"),
+		filepath.Join("**", "obj", "**"),
+	}
+	defaultExclusions := Exclusions()
+	assert.Equal(t, gt, defaultExclusions)
+}
+
+func TestDefaultExclusionsFingerprint(t *testing.T) {
+	expectedExclusions := []string{
+		filepath.Join("**", "nbproject", "**"),
+		filepath.Join("**", "nbbuild", "**"),
+		filepath.Join("**", "nbdist", "**"),
+		filepath.Join("**", "node_modules", "**"),
+		filepath.Join("**", "__pycache__", "**"),
+		filepath.Join("**", "_yardoc", "**"),
+		filepath.Join("**", "eggs", "**"),
+		filepath.Join("**", "wheels", "**"),
+		filepath.Join("**", "htmlcov", "**"),
+		filepath.Join("**", "__pypackages__", "**"),
+		"**/*.egg-info/**",
+		"**/*venv/**",
+	}
+
+	exclusions := DefaultExclusionsFingerprint()
+
+	assert.ElementsMatch(t, expectedExclusions, exclusions, "DefaultExclusionsFingerprint did not return the expected exclusions")
+}