#314 Fix issue with talismanRC

Author: svishwanath-tw

.gitignore

@@ -20,3 +20,5 @@ dist/
 *.mprof
 .envrc
 talisman_html_report
+.vscode
+.idea

cmd/talisman.go

@@ -51,18 +51,42 @@ var options struct {
 
 func init() {
 	log.SetOutput(os.Stderr)
-	flag.BoolVarP(&options.debug, "debug", "d", false, "enable debug mode (warning: very verbose)")
-	flag.StringVarP(&options.loglevel, "loglevel", "l", "error", "enable debug mode (warning: very verbose)")
-	flag.BoolVarP(&showVersion, "version", "v", false, "show current version of talisman")
-	flag.StringVarP(&options.pattern, "pattern", "p", "", "pattern (glob-like) of files to scan (ignores githooks)")
-	flag.StringVarP(&options.githook, "githook", "g", PrePush, "either pre-push or pre-commit")
-	flag.BoolVarP(&options.scan, "scan", "s", false, "scanner scans the git commit history for potential secrets")
-	flag.BoolVar(&options.ignoreHistory, "ignoreHistory", false, "scanner scans all files on current head, will not scan through git commit history")
-	flag.StringVarP(&options.checksum, "checksum", "c", "", "checksum calculator calculates checksum and suggests .talismanrc format")
-	flag.StringVarP(&options.reportDirectory, "reportDirectory", "r", "talisman_report", "directory where the scan reports will be stored")
-	flag.BoolVarP(&options.scanWithHtml, "scanWithHtml", "w", false, "generate html report (**Make sure you have installed talisman_html_report to use this, as mentioned in Readme**)")
-	flag.BoolVarP(&interactive, "interactive", "i", false, "interactively update talismanrc (only makes sense with -g/--githook)")
-	flag.BoolVarP(&options.shouldProfile, "profile", "", false, "interactively update talismanrc (only makes sense with -g/--githook)")
+	flag.BoolVarP(&options.debug,
+		"debug", "d", false,
+		"enable debug mode (warning: very verbose)")
+	flag.StringVarP(&options.loglevel,
+		"loglevel", "l", "error",
+		"enable debug mode (warning: very verbose)")
+	flag.BoolVarP(&showVersion,
+		"version", "v", false,
+		"show current version of talisman")
+	flag.StringVarP(&options.pattern,
+		"pattern", "p", "",
+		"pattern (glob-like) of files to scan (ignores githooks)")
+	flag.StringVarP(&options.githook,
+		"githook", "g", PrePush,
+		"either pre-push or pre-commit")
+	flag.BoolVarP(&options.scan,
+		"scan", "s", false,
+		"scanner scans the git commit history for potential secrets")
+	flag.BoolVar(&options.ignoreHistory,
+		"ignoreHistory", false,
+		"scanner scans all files on current head, will not scan through git commit history")
+	flag.StringVarP(&options.checksum,
+		"checksum", "c", "",
+		"checksum calculator calculates checksum and suggests .talismanrc format")
+	flag.StringVarP(&options.reportDirectory,
+		"reportDirectory", "r", "talisman_report",
+		"directory where the scan reports will be stored")
+	flag.BoolVarP(&options.scanWithHtml,
+		"scanWithHtml", "w", false,
+		"generate html report (**Make sure you have installed talisman_html_report to use this, as mentioned in Readme**)")
+	flag.BoolVarP(&interactive,
+		"interactive", "i", false,
+		"interactively update talismanrc (only makes sense with -g/--githook)")
+	flag.BoolVarP(&options.shouldProfile,
+		"profile", "f", false,
+		"profile cpu usage of talisman")
 
 }
 
@@ -151,7 +175,7 @@ func run(promptContext prompt.PromptContext) (returnCode int) {
 	}
 	bytes, _ := json.Marshal(options)
 	fields := make(map[string]interface{})
-	_ = json.Unmarshal(bytes, fields)
+	_ = json.Unmarshal(bytes, &fields)
 	log.WithFields(fields).Debug("Execution environment")
 
 	if options.checksum != "" {

git_testing/git_testing.go

@@ -8,8 +8,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/sirupsen/logrus"
 	lorem "github.com/drhodes/golorem"
+	"github.com/sirupsen/logrus"
 )
 
 var Logger *logrus.Entry

talismanrc/talismanrc.go

@@ -1,7 +1,6 @@
 package talismanrc
 
 import (
-	"log"
 	"os"
 	"regexp"
 	"sort"
@@ -52,6 +51,7 @@ type persistedRC struct {
 	Version string `default:"1.0" yaml:"version"`
 }
 
+//SuggestRCFor returns the talismanRC file content corresponding to input ignore configs
 func SuggestRCFor(configs []IgnoreConfig) string {
 	fileIgnoreConfigs := []FileIgnoreConfig{}
 	for _, config := range configs {
@@ -126,18 +126,18 @@ func (tRC *persistedRC) AddIgnores(mode Mode, entriesToAdd []IgnoreConfig) {
 		ignoreEntries, _ := yaml.Marshal(&talismanRCConfig)
 		file, err := fs.OpenFile(currentRCFileName, os.O_CREATE|os.O_WRONLY, 0644)
 		if err != nil {
-			log.Printf("error opening %s: %s", currentRCFileName, err)
+			logr.Errorf("error opening %s: %s", currentRCFileName, err)
 		}
 		defer func() {
 			err := file.Close()
 			if err != nil {
-				log.Printf("error closing %s: %s", currentRCFileName, err)
+				logr.Errorf("error closing %s: %s", currentRCFileName, err)
 			}
 		}()
 		logr.Debugf("Writing talismanrc: %v", string(ignoreEntries))
 		_, err = file.WriteString(string(ignoreEntries))
 		if err != nil {
-			log.Printf("error writing to %s: %s", currentRCFileName, err)
+			logr.Errorf("error writing to %s: %s", currentRCFileName, err)
 		}
 	}
 }
@@ -247,8 +247,8 @@ func fromPersistedRC(configFromTalismanRCFile *persistedRC, mode Mode) *Talisman
 			tRC.AllowedPatterns[i] = regexp.MustCompile(p)
 		}
 		tRC.IgnoreConfigs = make([]IgnoreConfig, len(configFromTalismanRCFile.FileIgnoreConfig))
-		for i, v := range configFromTalismanRCFile.FileIgnoreConfig {
-			tRC.IgnoreConfigs[i] = IgnoreConfig(&v)
+		for i := range configFromTalismanRCFile.FileIgnoreConfig {
+			tRC.IgnoreConfigs[i] = &configFromTalismanRCFile.FileIgnoreConfig[i]
 		}
 	}
 
@@ -265,8 +265,8 @@ func fromPersistedRC(configFromTalismanRCFile *persistedRC, mode Mode) *Talisman
 			tRC.AllowedPatterns[i] = regexp.MustCompile(p)
 		}
 		tRC.IgnoreConfigs = make([]IgnoreConfig, len(scanconfigFromTalismanRCFile.FileIgnoreConfig))
-		for i, v := range scanconfigFromTalismanRCFile.FileIgnoreConfig {
-			tRC.IgnoreConfigs[i] = IgnoreConfig(&v)
+		for i := range scanconfigFromTalismanRCFile.FileIgnoreConfig {
+			tRC.IgnoreConfigs[i] = &scanconfigFromTalismanRCFile.FileIgnoreConfig[i]
 		}
 	}
 	tRC.base = configFromTalismanRCFile
@@ -275,5 +275,6 @@ func fromPersistedRC(configFromTalismanRCFile *persistedRC, mode Mode) *Talisman
 
 func For(mode Mode) *TalismanRC {
 	configFromTalismanRCFile := ConfigFromFile()
-	return fromPersistedRC(configFromTalismanRCFile, mode)
+	talismanRC := fromPersistedRC(configFromTalismanRCFile, mode)
+	return talismanRC
 }

talismanrc/talismanrc_test.go

@@ -301,3 +301,28 @@ version: ""
 		assert.Equal(t, expectedRC, str)
 	})
 }
+
+func TestFor(t *testing.T) {
+	var repoFileReader = func(string) ([]byte, error) {
+		return []byte(`fileignoreconfig:
+- filename: testfile_1.yml
+  checksum: file1_checksum
+- filename: testfile_2.yml
+  checksum: file2_checksum
+- filename: testfile_3.yml
+  checksum: file3_checksum`), nil
+	}
+	t.Run("talismanrc.For(mode) should read multiple entries in rc file correctly", func(t *testing.T) {
+		setRepoFileReader(repoFileReader)
+		rc := For(HookMode)
+		assert.Equal(t, 3, len(rc.IgnoreConfigs))
+
+		assert.Equal(t, rc.IgnoreConfigs[0].GetFileName(), "testfile_1.yml")
+		assert.True(t, rc.IgnoreConfigs[0].ChecksumMatches("file1_checksum"))
+		assert.Equal(t, rc.IgnoreConfigs[1].GetFileName(), "testfile_2.yml")
+		assert.True(t, rc.IgnoreConfigs[1].ChecksumMatches("file2_checksum"))
+		assert.Equal(t, rc.IgnoreConfigs[2].GetFileName(), "testfile_3.yml")
+		assert.True(t, rc.IgnoreConfigs[2].ChecksumMatches("file3_checksum"))
+
+	})
+}