Remove persistedRC and unmarshal directly into TalismanRC

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

Author: tw-owen-nelson

talismanrc/rc_file.go

@@ -21,21 +21,21 @@ var (
 	currentRCFileName = DefaultRCFileName
 )
 
-func readConfigFromRCFile(fileReader func(string) ([]byte, error)) (*persistedRC, error) {
+func readConfigFromRCFile(fileReader func(string) ([]byte, error)) (*TalismanRC, error) {
 	fileContents, err := fileReader(currentRCFileName)
 	if err != nil {
 		panic(err)
 	}
 	return newPersistedRC(fileContents)
 }
 
-func newPersistedRC(fileContents []byte) (*persistedRC, error) {
-	talismanRCFromFile := persistedRC{}
+func newPersistedRC(fileContents []byte) (*TalismanRC, error) {
+	talismanRCFromFile := TalismanRC{}
 	err := yaml.Unmarshal(fileContents, &talismanRCFromFile)
 	if err != nil {
 		logr.Errorf("Unable to parse .talismanrc : %v", err)
 		fmt.Println(fmt.Errorf("\n\x1b[1m\x1b[31mUnable to parse .talismanrc %s. Please ensure it is following the right YAML structure\x1b[0m\x1b[0m", err))
-		return &persistedRC{}, err
+		return &TalismanRC{}, err
 	}
 	if talismanRCFromFile.Version == "" {
 		talismanRCFromFile.Version = DefaultRCVersion
@@ -54,7 +54,6 @@ func SetRcFilename__(rcFileName string) {
 type RepoFileReader func(string) ([]byte, error)
 
 var repoFileReader = func() RepoFileReader {
-
 	return func(path string) ([]byte, error) {
 		data, err := utility.SafeReadFile(path)
 		if err != nil {

talismanrc/rc_file_test.go

@@ -36,7 +36,7 @@ func TestShouldIgnoreUnformattedFiles(t *testing.T) {
 		})
 
 		talismanRC, _ := Load()
-		assert.True(t, talismanRC.AcceptsAll(), "Expected commented line '%s' to result in no ignore patterns", s)
+		assert.Equal(t, &TalismanRC{Version: "1.0"}, talismanRC, "Expected commented line '%s' to result in an empty TalismanRC")
 	}
 	setRepoFileReader(defaultRepoFileReader)
 }

talismanrc/talismanrc.go

@@ -2,7 +2,6 @@ package talismanrc
 
 import (
 	"os"
-	"regexp"
 	"sort"
 
 	logr "github.com/sirupsen/logrus"
@@ -24,17 +23,6 @@ type TalismanRC struct {
 	Version          string                 `yaml:"version"`
 }
 
-type persistedRC struct {
-	FileIgnoreConfig []FileIgnoreConfig     `yaml:"fileignoreconfig,omitempty"`
-	ScopeConfig      []ScopeConfig          `yaml:"scopeconfig,omitempty"`
-	CustomPatterns   []PatternString        `yaml:"custom_patterns,omitempty"`
-	CustomSeverities []CustomSeverityConfig `yaml:"custom_severities,omitempty"`
-	AllowedPatterns  []string               `yaml:"allowed_patterns,omitempty"`
-	Experimental     ExperimentalConfig     `yaml:"experimental,omitempty"`
-	Threshold        severity.Severity      `yaml:"threshold,omitempty"`
-	Version          string                 `yaml:"version"`
-}
-
 // SuggestRCFor returns the talismanRC file content corresponding to input ignore configs
 func SuggestRCFor(configs []FileIgnoreConfig) string {
 	tRC := TalismanRC{FileIgnoreConfig: configs, Version: DefaultRCVersion}
@@ -43,11 +31,6 @@ func SuggestRCFor(configs []FileIgnoreConfig) string {
 	return string(result)
 }
 
-// AcceptsAll returns true if there are no rules specified
-func (tRC *TalismanRC) AcceptsAll() bool {
-	return len(tRC.effectiveRules("any-detector")) == 0
-}
-
 // 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)
@@ -169,27 +152,6 @@ func (tRC *TalismanRC) effectiveRules(detectorName string) []string {
 	return result
 }
 
-func fromPersistedRC(configFromTalismanRCFile *persistedRC) *TalismanRC {
-	tRC := TalismanRC{}
-
-	tRC.Threshold = configFromTalismanRCFile.Threshold
-	tRC.ScopeConfig = configFromTalismanRCFile.ScopeConfig
-	tRC.Experimental = configFromTalismanRCFile.Experimental
-	tRC.CustomPatterns = configFromTalismanRCFile.CustomPatterns
-	tRC.CustomSeverities = configFromTalismanRCFile.CustomSeverities
-	tRC.AllowedPatterns = make([]*Pattern, len(configFromTalismanRCFile.AllowedPatterns))
-	for i, p := range configFromTalismanRCFile.AllowedPatterns {
-		tRC.AllowedPatterns[i] = &Pattern{regexp.MustCompile(p)}
-	}
-	tRC.Version = configFromTalismanRCFile.Version
-
-	tRC.FileIgnoreConfig = configFromTalismanRCFile.FileIgnoreConfig
-
-	return &tRC
-}
-
 func Load() (*TalismanRC, error) {
-	configFromTalismanRCFile, err := readConfigFromRCFile(repoFileReader())
-	talismanRC := fromPersistedRC(configFromTalismanRCFile)
-	return talismanRC, err
+	return readConfigFromRCFile(repoFileReader())
 }

talismanrc/talismanrc_test.go

@@ -49,11 +49,10 @@ custom_severities:
 - detector: Base64Content
   severity: low
 `)
-	persistedRC, _ := newPersistedRC(talismanRCContents)
-	talismanRC := fromPersistedRC(persistedRC)
-	assert.Equal(t, persistedRC.Threshold, severity.High)
-	assert.Equal(t, len(persistedRC.CustomSeverities), 1)
-	assert.Equal(t, persistedRC.CustomSeverities, talismanRC.CustomSeverities)
+	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) {