Fix talismanrc suggestion in non-interactive mode

Author: svishwanath-tw

detector/helpers/detection_results.go

@@ -337,13 +337,12 @@ func getUserConfirmation(configs []talismanrc.IgnoreConfig, promptContext prompt
 }
 
 func printTalismanIgnoreSuggestion(entriesToAdd []talismanrc.IgnoreConfig) {
-	talismanRC := &talismanrc.TalismanRC{IgnoreConfigs: entriesToAdd}
-	ignoreEntries, _ := yaml.Marshal(talismanRC)
+	ignoreEntries := talismanrc.SuggestRCFor(entriesToAdd)
 	suggestString := fmt.Sprintf("\n\x1b[33mIf you are absolutely sure that you want to ignore the " +
 		"above files from talisman detectors, consider pasting the following format in .talismanrc file" +
 		" in the project root\x1b[0m\n")
 	fmt.Println(suggestString)
-	fmt.Println(string(ignoreEntries))
+	fmt.Println(ignoreEntries)
 }
 
 func confirm(config talismanrc.IgnoreConfig, promptContext prompt.PromptContext) bool {

talismanrc/talismanrc.go

@@ -52,6 +52,22 @@ type persistedRC struct {
 	Version string `default:"1.0" yaml:"version"`
 }
 
+func SuggestRCFor(configs []IgnoreConfig) string {
+	fileIgnoreConfigs := []FileIgnoreConfig{}
+	for _, config := range configs {
+		fIC, ok := config.(*FileIgnoreConfig)
+		if ok {
+			fileIgnoreConfigs = append(fileIgnoreConfigs, *fIC)
+		} else {
+			logr.Debugf("Ignoring unknown IgnoreConfig : %#v", config)
+		}
+	}
+	pRC := persistedRC{FileIgnoreConfig: fileIgnoreConfigs}
+	result, _ := yaml.Marshal(pRC)
+
+	return string(result)
+}
+
 //AcceptsAll returns true if there are no rules specified
 func (tRC *TalismanRC) AcceptsAll() bool {
 	return len(tRC.effectiveRules("any-detector")) == 0

talismanrc/talismanrc_test.go

@@ -263,3 +263,41 @@ func TestScanFileIgnoreConfig_GetAllowedPatterns(t *testing.T) {
 	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 := []IgnoreConfig{
+			&FileIgnoreConfig{
+				FileName: "some_filename",
+				Checksum: "some_checksum",
+			},
+		}
+		expectedRC := `fileignoreconfig:
+- filename: some_filename
+  checksum: some_checksum
+version: ""
+`
+		str := SuggestRCFor(fileIgnoreConfigs)
+		assert.Equal(t, expectedRC, str)
+	})
+
+	t.Run("should ignore invalid configs", func(t *testing.T) {
+		fileIgnoreConfigs := []IgnoreConfig{
+			&FileIgnoreConfig{
+				FileName: "some_filename",
+				Checksum: "some_checksum",
+			},
+			&ScanFileIgnoreConfig{
+				FileName:  "some_other_filename",
+				Checksums: []string{"some_other_checksum"},
+			},
+		}
+		expectedRC := `fileignoreconfig:
+- filename: some_filename
+  checksum: some_checksum
+version: ""
+`
+		str := SuggestRCFor(fileIgnoreConfigs)
+		assert.Equal(t, expectedRC, str)
+	})
+}