Clarify talismanrc method notes and names

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

Author: tw-owen-nelson

cmd/runner.go

@@ -34,7 +34,7 @@ func (r *runner) Run(tRC *talismanrc.TalismanRC, promptContext prompt.PromptCont
 	ie := helpers.BuildIgnoreEvaluator(r.mode, tRC, repo)
 
 	setCustomSeverities(tRC)
-	additionsToScan := tRC.FilterAdditions(r.additions)
+	additionsToScan := tRC.RemoveScopedFiles(r.additions)
 
 	detector.DefaultChain(tRC, ie).Test(additionsToScan, tRC, r.results)
 	r.printReport(promptContext)

cmd/scanner_cmd.go

@@ -31,7 +31,7 @@ func (s *ScannerCmd) Run() int {
 	fmt.Printf("\n\n")
 	utility.CreateArt("Running Scan..")
 
-	additionsToScan := s.tRC.FilterAdditions(s.additions)
+	additionsToScan := s.tRC.RemoveScopedFiles(s.additions)
 
 	detector.DefaultChain(s.tRC, s.ignoreEvaluator).Test(additionsToScan, s.tRC, s.results)
 	reportsPath, err := report.GenerateReport(s.results, s.reportDirectory)

detector/filecontent/filecontent_detector.go

@@ -119,7 +119,7 @@ func (fc *FileContentDetector) Test(comparator helpers.IgnoreEvaluator, currentA
 				data := []byte(content)
 				addition.Data = data
 			}
-			addition.Data = []byte(talismanRC.FilterAllowedPatternsFromAddition(addition))
+			addition.Data = []byte(talismanRC.RemoveAllowedPatterns(addition))
 			for _, ct := range contentTypes {
 				contents <- content{
 					name:        addition.Name,

detector/pattern/pattern_detector.go

@@ -50,7 +50,7 @@ func (detector PatternDetector) Test(comparator helpers.IgnoreEvaluator, current
 				ignoredFilePaths <- addition.Path
 				return
 			}
-			detections := detector.secretsPattern.check(ignoreConfig.FilterAllowedPatternsFromAddition(addition), ignoreConfig.Threshold)
+			detections := detector.secretsPattern.check(ignoreConfig.RemoveAllowedPatterns(addition), ignoreConfig.Threshold)
 			matches <- match{name: addition.Name, path: addition.Path, detections: detections, commits: addition.Commits}
 		}(addition)
 	}

talismanrc/rc_file.go

@@ -20,16 +20,17 @@ var (
 	currentRCFileName = DefaultRCFileName
 )
 
+// Load creates a TalismanRC struct based on a .talismanrc file, if present
 func Load() (*TalismanRC, error) {
 	fileContents, err := afero.ReadFile(fs, currentRCFileName)
 	if err != nil {
 		// File does not exist or is not readable, proceed as if there is no .talismanrc
 		fileContents = []byte{}
 	}
-	return newPersistedRC(fileContents)
+	return talismanRCFromYaml(fileContents)
 }
 
-func newPersistedRC(fileContents []byte) (*TalismanRC, error) {
+func talismanRCFromYaml(fileContents []byte) (*TalismanRC, error) {
 	talismanRCFromFile := TalismanRC{}
 	err := yaml.Unmarshal(fileContents, &talismanRCFromFile)
 	if err != nil {

talismanrc/rc_file_test.go

@@ -59,7 +59,7 @@ fileignoreconfig:
 custom_patterns:
 - 'pwd_[a-z]{8,20}'`)
 
-		rc, err := newPersistedRC(fileContents)
+		rc, err := talismanRCFromYaml(fileContents)
 		assert.Nil(t, err, "Should successfully unmarshal valid yaml")
 		assert.Equal(t, 1, len(rc.FileIgnoreConfig))
 		assert.Equal(t, 1, len(rc.CustomPatterns))
@@ -75,7 +75,7 @@ fileignoreconfig:
 - filename: testfile_3.yml
   checksum: file3_checksum`)
 
-		rc, _ := newPersistedRC(fileContent)
+		rc, _ := talismanRCFromYaml(fileContent)
 		assert.Equal(t, 3, len(rc.FileIgnoreConfig))
 
 		assert.Equal(t, rc.FileIgnoreConfig[0].GetFileName(), "testfile_1.yml")
@@ -88,7 +88,7 @@ fileignoreconfig:
 
 	t.Run("Should read severity level", func(t *testing.T) {
 		talismanRCContents := []byte("threshold: high")
-		persistedTalismanrc, _ := newPersistedRC(talismanRCContents)
+		persistedTalismanrc, _ := talismanRCFromYaml(talismanRCContents)
 		assert.Equal(t, persistedTalismanrc.Threshold, severity.High)
 	})
 
@@ -98,15 +98,15 @@ custom_severities:
 - detector: Base64Content
   severity: low
 `)
-		talismanRC, _ := newPersistedRC(talismanRCContents)
+		talismanRC, _ := talismanRCFromYaml(talismanRCContents)
 		assert.Equal(t, talismanRC.CustomSeverities, []CustomSeverityConfig{{Detector: "Base64Content", Severity: severity.Low}})
 	})
 }
 
 func TestShouldIgnoreUnformattedFiles(t *testing.T) {
 	for _, s := range []string{"#", "#monkey", "# this monkey likes bananas  "} {
 		fileContents := []byte(s)
-		talismanRC, err := newPersistedRC(fileContents)
+		talismanRC, err := talismanRCFromYaml(fileContents)
 		assert.Nil(t, err, "Should successfully unmarshal commented yaml")
 		assert.Equal(t, &TalismanRC{Version: "1.0"}, talismanRC, "Expected commented line '%s' to result in an empty TalismanRC")
 	}

talismanrc/talismanrc.go

@@ -23,21 +23,16 @@ type TalismanRC struct {
 	Version          string                 `yaml:"version"`
 }
 
-// SuggestRCFor returns the talismanRC file content corresponding to input ignore configs
+// SuggestRCFor returns a string representation of a .talismanrc for the specified FileIgnoreConfigs
 func SuggestRCFor(configs []FileIgnoreConfig) string {
 	tRC := TalismanRC{FileIgnoreConfig: configs, Version: DefaultRCVersion}
 	result, _ := yaml.Marshal(tRC)
 
 	return string(result)
 }
 
-// Accept answers true if the Addition.Path is configured to be checked by the detectors
-func (tRC *TalismanRC) Accept(addition gitrepo.Addition, detectorName string) bool {
-	return !tRC.Deny(addition, detectorName)
-}
-
-// FilterAdditions removes scope files from additions
-func (tRC *TalismanRC) FilterAdditions(additions []gitrepo.Addition) []gitrepo.Addition {
+// RemoveScopedFiles removes scope files from additions
+func (tRC *TalismanRC) RemoveScopedFiles(additions []gitrepo.Addition) []gitrepo.Addition {
 	var applicableScopeFileNames []string
 	if tRC.ScopeConfig != nil {
 		for _, scope := range tRC.ScopeConfig {
@@ -62,6 +57,7 @@ func (tRC *TalismanRC) FilterAdditions(additions []gitrepo.Addition) []gitrepo.A
 	return result
 }
 
+// AddIgnores inserts the specified FileIgnoreConfigs to an existing .talismanrc file, or creates one if it doesn't exist.
 func (tRC *TalismanRC) AddIgnores(entriesToAdd []FileIgnoreConfig) {
 	if len(entriesToAdd) > 0 {
 		logr.Debugf("Adding entries: %v", entriesToAdd)
@@ -112,18 +108,8 @@ func combineFileIgnores(exsiting, incoming []FileIgnoreConfig) []FileIgnoreConfi
 	return result
 }
 
-// Deny answers true if the Addition.Path is configured to be ignored and not checked by the detectors
-func (tRC *TalismanRC) Deny(addition gitrepo.Addition, detectorName string) bool {
-	for _, pattern := range tRC.effectiveRules(detectorName) {
-		if addition.Matches(pattern) {
-			return true
-		}
-	}
-	return false
-}
-
-// Strip git addition
-func (tRC *TalismanRC) FilterAllowedPatternsFromAddition(addition gitrepo.Addition) string {
+// RemoveAllowedPatterns removes globally- and per-file allowed patterns from an Addition
+func (tRC *TalismanRC) RemoveAllowedPatterns(addition gitrepo.Addition) string {
 	additionPathAsString := string(addition.Path)
 	// Processing global allowed patterns
 	for _, pattern := range tRC.AllowedPatterns {
@@ -141,13 +127,27 @@ func (tRC *TalismanRC) FilterAllowedPatternsFromAddition(addition gitrepo.Additi
 	return string(addition.Data)
 }
 
+// Deny answers true if the Addition should NOT be checked by the specified detector
+func (tRC *TalismanRC) Deny(addition gitrepo.Addition, detectorName string) bool {
+	for _, pattern := range tRC.effectiveRules(detectorName) {
+		if addition.Matches(pattern) {
+			return true
+		}
+	}
+	return false
+}
+
+// Accept answers true if the Addition should be checked by the specified detector
+func (tRC *TalismanRC) Accept(addition gitrepo.Addition, detectorName string) bool {
+	return !tRC.Deny(addition, detectorName)
+}
+
 func (tRC *TalismanRC) effectiveRules(detectorName string) []string {
 	var result []string
 	for _, ignore := range tRC.FileIgnoreConfig {
 		if ignore.isEffective(detectorName) {
 			result = append(result, ignore.GetFileName())
 		}
 	}
-
 	return result
 }

talismanrc/talismanrc_test.go

@@ -44,7 +44,7 @@ func TestShouldFilterAllowedPatternsFromAddition(t *testing.T) {
 	gitRepoAddition1 := testAdditionWithData("file1", []byte(fileContent))
 	talismanrc := &TalismanRC{AllowedPatterns: []*Pattern{{regexp.MustCompile(hex)}}}
 
-	fileContentFiltered := talismanrc.FilterAllowedPatternsFromAddition(gitRepoAddition1)
+	fileContentFiltered := talismanrc.RemoveAllowedPatterns(gitRepoAddition1)
 
 	assert.Equal(t, fileContentFiltered, "Prefix content")
 }
@@ -56,8 +56,8 @@ func TestShouldFilterAllowedPatternsFromAdditionBasedOnFileConfig(t *testing.T)
 	gitRepoAddition2 := testAdditionWithData("file2", []byte(fileContent))
 	talismanrc := createTalismanRCWithFileIgnores("file1", "somedetector", []string{hexContent})
 
-	fileContentFiltered1 := talismanrc.FilterAllowedPatternsFromAddition(gitRepoAddition1)
-	fileContentFiltered2 := talismanrc.FilterAllowedPatternsFromAddition(gitRepoAddition2)
+	fileContentFiltered1 := talismanrc.RemoveAllowedPatterns(gitRepoAddition1)
+	fileContentFiltered2 := talismanrc.RemoveAllowedPatterns(gitRepoAddition2)
 
 	assert.Equal(t, fileContentFiltered1, "Prefix content")
 	assert.Equal(t, fileContentFiltered2, fileContent)
@@ -111,7 +111,7 @@ func TestIgnoreAdditionsByScope(t *testing.T) {
 	for scopeName, additions := range testTable {
 		t.Run(fmt.Sprintf("should ignore files for %s scope", scopeName), func(t *testing.T) {
 			talismanRCConfig := createTalismanRCWithScopeIgnores([]string{scopeName})
-			filteredAdditions := talismanRCConfig.FilterAdditions(additions)
+			filteredAdditions := talismanRCConfig.RemoveScopedFiles(additions)
 			for _, addition := range additions {
 				assert.NotContains(t, filteredAdditions, addition, "Expected %s to be ignored", addition.Name)
 			}