Organize talismanrc tests

Authored-by: Owen Nelson <[email protected]>

Author: tw-owen-nelson

talismanrc/rc_file_test.go

@@ -1,14 +1,56 @@
 package talismanrc
 
 import (
+	"regexp"
 	"talisman/detector/severity"
 	"testing"
 
+	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
 )
 
+func TestLoadingFromFile(t *testing.T) {
+	fs := afero.NewMemMapFs()
+	file, err := afero.TempFile(fs, "", DefaultRCFileName)
+	assert.NoError(t, err, "Problem setting up test .talismanrc?")
+	talismanRCFile := file.Name()
+	SetFs__(fs)
+
+	t.Run("Creates an empty TalismanRC if .talismanrc file doesn't exist", func(t *testing.T) {
+		SetRcFilename__("not-a-file")
+		emptyRC, err := Load()
+		assert.NoError(t, err, "Should not error if there is a problem reading the file")
+		assert.Equal(t, &TalismanRC{Version: DefaultRCVersion}, emptyRC)
+	})
+
+	t.Run("Loads all valid TalismanRC fields", func(t *testing.T) {
+		SetRcFilename__(talismanRCFile)
+		err = afero.WriteFile(fs, talismanRCFile, []byte(fullyConfiguredTalismanRC), 0666)
+		assert.NoError(t, err, "Problem setting up test .talismanrc?")
+
+		talismanRCFromFile, _ := Load()
+		expectedTalismanRC := &TalismanRC{
+			FileIgnoreConfig: []FileIgnoreConfig{
+				{FileName: "existing.pem", Checksum: "123444ddssa75333b25b6275f97680604add51b84eb8f4a3b9dcbbc652e6f27ac"}},
+			ScopeConfig: []ScopeConfig{{"go"}},
+			AllowedPatterns: []*Pattern{
+				{regexp.MustCompile("this-is-okay")},
+				{regexp.MustCompile("key={listOfThings.id}")}},
+			CustomPatterns: []PatternString{"this-isn't-okay"},
+			Threshold:      severity.Medium,
+			CustomSeverities: []CustomSeverityConfig{
+				{Detector: "HexContent", Severity: severity.Low}},
+			Experimental: ExperimentalConfig{Base64EntropyThreshold: 4.7},
+			Version:      "1.0",
+		}
+		assert.Equal(t, expectedTalismanRC, talismanRCFromFile)
+	})
+
+	SetRcFilename__(DefaultRCFileName)
+}
+
 func TestUnmarshalsValidYaml(t *testing.T) {
-	t.Run("talismanrc should not fail as long as the yaml structure is correct", func(t *testing.T) {
+	t.Run("Should not fail as long as the yaml structure is correct", func(t *testing.T) {
 		fileContents := []byte(`
 ---
 fileignoreconfig:
@@ -23,7 +65,7 @@ custom_patterns:
 		assert.Equal(t, 1, len(rc.CustomPatterns))
 	})
 
-	t.Run("talismanrc.For(mode) should read multiple entries in rc file correctly", func(t *testing.T) {
+	t.Run("Should read multiple entries in rc file correctly", func(t *testing.T) {
 		fileContent := []byte(`
 fileignoreconfig:
 - filename: testfile_1.yml
@@ -43,6 +85,22 @@ fileignoreconfig:
 		assert.Equal(t, rc.FileIgnoreConfig[2].GetFileName(), "testfile_3.yml")
 		assert.True(t, rc.FileIgnoreConfig[2].ChecksumMatches("file3_checksum"))
 	})
+
+	t.Run("Should read severity level", func(t *testing.T) {
+		talismanRCContents := []byte("threshold: high")
+		persistedTalismanrc, _ := newPersistedRC(talismanRCContents)
+		assert.Equal(t, persistedTalismanrc.Threshold, severity.High)
+	})
+
+	t.Run("Should read custom severities", func(t *testing.T) {
+		talismanRCContents := []byte(`
+custom_severities:
+- detector: Base64Content
+  severity: low
+`)
+		talismanRC, _ := newPersistedRC(talismanRCContents)
+		assert.Equal(t, talismanRC.CustomSeverities, []CustomSeverityConfig{{Detector: "Base64Content", Severity: severity.Low}})
+	})
 }
 
 func TestShouldIgnoreUnformattedFiles(t *testing.T) {
@@ -53,9 +111,3 @@ func TestShouldIgnoreUnformattedFiles(t *testing.T) {
 		assert.Equal(t, &TalismanRC{Version: "1.0"}, talismanRC, "Expected commented line '%s' to result in an empty TalismanRC")
 	}
 }
-
-func TestShouldConvertThresholdToValue(t *testing.T) {
-	talismanRCContents := []byte("threshold: high")
-	persistedTalismanrc, _ := newPersistedRC(talismanRCContents)
-	assert.Equal(t, persistedTalismanrc.Threshold, severity.High)
-}

talismanrc/talismanrc_test.go

@@ -14,6 +14,26 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+const fullyConfiguredTalismanRC = `
+---
+fileignoreconfig:
+- filename: existing.pem
+  checksum: 123444ddssa75333b25b6275f97680604add51b84eb8f4a3b9dcbbc652e6f27ac
+scopeconfig: [scope: go]
+allowed_patterns:
+- this-is-okay
+- key={listOfThings.id}
+custom_patterns:
+- this-isn't-okay
+threshold: medium
+custom_severities:
+- detector: HexContent
+  severity: low
+experimental:
+  base64EntropyThreshold: 4.7
+version: 1.0
+`
+
 func init() {
 	logr.SetOutput(io.Discard)
 }
@@ -43,18 +63,6 @@ func TestShouldFilterAllowedPatternsFromAdditionBasedOnFileConfig(t *testing.T)
 	assert.Equal(t, fileContentFiltered2, fileContent)
 }
 
-func TestObeysCustomSeverityLevelsAndThreshold(t *testing.T) {
-	talismanRCContents := []byte(`threshold: high
-custom_severities:
-- detector: Base64Content
-  severity: low
-`)
-	talismanRC, _ := newPersistedRC(talismanRCContents)
-	assert.Equal(t, talismanRC.Threshold, severity.High)
-	assert.Equal(t, len(talismanRC.CustomSeverities), 1)
-	assert.Equal(t, talismanRC.CustomSeverities, []CustomSeverityConfig{{Detector: "Base64Content", Severity: severity.Low}})
-}
-
 func TestDirectoryPatterns(t *testing.T) {
 	assertAccepts("foo/", "", "bar", t)
 	assertAccepts("foo/", "", "foo", t)
@@ -138,25 +146,7 @@ func TestAddingFileIgnores(t *testing.T) {
 	})
 
 	t.Run("When there already is a .talismanrc", func(t *testing.T) {
-		existingContent := `
-fileignoreconfig:
-- filename: existing.pem
-  checksum: 123444ddssa75333b25b6275f97680604add51b84eb8f4a3b9dcbbc652e6f27ac
-scopeconfig: [scope: go]
-allowed_patterns:
-- this-is-okay
-- key={listOfThings.id}
-custom_patterns:
-- this-isn't-okay
-threshold: medium
-custom_severities:
-- detector: HexContent
-  severity: low
-experimental:
-  base64EntropyThreshold: 4.7
-version: 1.0
-`
-		err = afero.WriteFile(fs, ignoreFile, []byte(existingContent), 0666)
+		err = afero.WriteFile(fs, ignoreFile, []byte(fullyConfiguredTalismanRC), 0666)
 		assert.NoError(t, err)
 
 		initialRCConfig, _ := Load()
@@ -229,37 +219,6 @@ func createTalismanRCWithScopeIgnores(scopesToIgnore []string) *TalismanRC {
 	return &TalismanRC{ScopeConfig: scopeConfigs}
 }
 
-func TestFileIgnoreConfig_ChecksumMatches(t *testing.T) {
-	fileIgnoreConfig := &FileIgnoreConfig{
-		FileName:        "some_filename",
-		Checksum:        "some_checksum",
-		IgnoreDetectors: nil,
-		AllowedPatterns: nil,
-	}
-
-	assert.True(t, fileIgnoreConfig.ChecksumMatches("some_checksum"))
-	assert.False(t, fileIgnoreConfig.ChecksumMatches("some_other_checksum"))
-}
-
-func TestFileIgnoreConfig_GetAllowedPatterns(t *testing.T) {
-	fileIgnoreConfig := &FileIgnoreConfig{
-		FileName:        "some_filename",
-		Checksum:        "some_checksum",
-		IgnoreDetectors: nil,
-		AllowedPatterns: nil,
-	}
-
-	//No allowed patterns specified
-	allowedPatterns := fileIgnoreConfig.GetAllowedPatterns()
-	assert.Equal(t, 0, len(allowedPatterns))
-
-	fileIgnoreConfig.compiledPatterns = nil
-	fileIgnoreConfig.AllowedPatterns = []string{"[Ff]ile[nN]ame"}
-	allowedPatterns = fileIgnoreConfig.GetAllowedPatterns()
-	assert.Equal(t, 1, len(allowedPatterns))
-	assert.Regexp(t, allowedPatterns[0], "fileName")
-}
-
 func TestSuggestRCFor(t *testing.T) {
 	t.Run("should suggest proper RC when ignore configs are valid", func(t *testing.T) {
 		fileIgnoreConfigs := []FileIgnoreConfig{

talismanrc/types_test.go

@@ -31,3 +31,36 @@ func TestCustomMarshalling(t *testing.T) {
 		assert.Equal(t, pattern.String(), strings.TrimSpace(string(str)))
 	})
 }
+
+func TestFileIgnoreConfig(t *testing.T) {
+	t.Run("Checksum matching", func(t *testing.T) {
+		fileIgnoreConfig := &FileIgnoreConfig{
+			FileName:        "some_filename",
+			Checksum:        "some_checksum",
+			IgnoreDetectors: nil,
+			AllowedPatterns: nil,
+		}
+
+		assert.True(t, fileIgnoreConfig.ChecksumMatches("some_checksum"))
+		assert.False(t, fileIgnoreConfig.ChecksumMatches("some_other_checksum"))
+	})
+
+	t.Run("Compiles regexes for patterns as needed", func(t *testing.T) {
+		fileIgnoreConfig := &FileIgnoreConfig{
+			FileName:        "some_filename",
+			Checksum:        "some_checksum",
+			IgnoreDetectors: nil,
+			AllowedPatterns: nil,
+		}
+
+		//No allowed patterns specified
+		allowedPatterns := fileIgnoreConfig.GetAllowedPatterns()
+		assert.Equal(t, 0, len(allowedPatterns))
+
+		fileIgnoreConfig.compiledPatterns = nil
+		fileIgnoreConfig.AllowedPatterns = []string{"[Ff]ile[nN]ame"}
+		allowedPatterns = fileIgnoreConfig.GetAllowedPatterns()
+		assert.Equal(t, 1, len(allowedPatterns))
+		assert.Regexp(t, allowedPatterns[0], "fileName")
+	})
+}