Use afero helper to update .talismanrc file

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

Author: tw-owen-nelson

talismanrc/rc_file.go

@@ -44,6 +44,14 @@ func talismanRCFromYaml(fileContents []byte) (*TalismanRC, error) {
 	return &talismanRCFromFile, nil
 }
 
+func (tRC *TalismanRC) saveToFile() {
+	ignoreEntries, _ := yaml.Marshal(&tRC)
+	err := afero.WriteFile(fs, currentRCFileName, ignoreEntries, 0644)
+	if err != nil {
+		logr.Errorf("error writing to %s: %s", currentRCFileName, err)
+	}
+}
+
 func SetFs__(_fs afero.Fs) {
 	fs = _fs
 }

talismanrc/rc_file_test.go

@@ -49,6 +49,32 @@ func TestLoadingFromFile(t *testing.T) {
 	SetRcFilename__(DefaultRCFileName)
 }
 
+func TestWritingToFile(t *testing.T) {
+	tRC := &TalismanRC{Version: DefaultRCVersion}
+	fs := afero.NewMemMapFs()
+	SetFs__(fs)
+
+	t.Run("When there is no .talismanrc file", func(t *testing.T) {
+		talismanRCFileExists, _ := afero.Exists(fs, DefaultRCFileName)
+		assert.False(t, talismanRCFileExists, "Problem setting up tests")
+		tRC.saveToFile()
+		talismanRCFileExists, _ = afero.Exists(fs, DefaultRCFileName)
+		assert.True(t, talismanRCFileExists, "Should have created a new .talismanrc file")
+		fileContents, _ := afero.ReadFile(fs, DefaultRCFileName)
+		assert.Equal(t, "version: \"1.0\"\n", string(fileContents))
+	})
+
+	t.Run("When there already is a .talismanrc file", func(t *testing.T) {
+		err := afero.WriteFile(fs, DefaultRCFileName, []byte("Some existing content to overwrite"), 0666)
+		assert.NoError(t, err, "Problem setting up tests")
+		tRC.saveToFile()
+		talismanRCFileExists, _ := afero.Exists(fs, DefaultRCFileName)
+		assert.True(t, talismanRCFileExists, "Should have created a new .talismanrc file")
+		fileContents, _ := afero.ReadFile(fs, DefaultRCFileName)
+		assert.Equal(t, "version: \"1.0\"\n", string(fileContents))
+	})
+}
+
 func TestUnmarshalsValidYaml(t *testing.T) {
 	t.Run("Should not fail as long as the yaml structure is correct", func(t *testing.T) {
 		fileContents := []byte(`

talismanrc/talismanrc.go

@@ -1,7 +1,6 @@
 package talismanrc
 
 import (
-	"os"
 	"sort"
 
 	logr "github.com/sirupsen/logrus"
@@ -62,23 +61,7 @@ func (tRC *TalismanRC) AddIgnores(entriesToAdd []FileIgnoreConfig) {
 	if len(entriesToAdd) > 0 {
 		logr.Debugf("Adding entries: %v", entriesToAdd)
 		tRC.FileIgnoreConfig = combineFileIgnores(tRC.FileIgnoreConfig, entriesToAdd)
-
-		ignoreEntries, _ := yaml.Marshal(&tRC)
-		file, err := fs.OpenFile(currentRCFileName, os.O_CREATE|os.O_WRONLY, 0644)
-		if err != nil {
-			logr.Errorf("error opening %s: %s", currentRCFileName, err)
-		}
-		defer func() {
-			err := file.Close()
-			if err != nil {
-				logr.Errorf("error closing %s: %s", currentRCFileName, err)
-			}
-		}()
-		logr.Debugf("Writing talismanrc: %v", string(ignoreEntries))
-		_, err = file.WriteString(string(ignoreEntries))
-		if err != nil {
-			logr.Errorf("error writing to %s: %s", currentRCFileName, err)
-		}
+		tRC.saveToFile()
 	}
 }
 

talismanrc/talismanrc_test.go

@@ -136,16 +136,15 @@ func TestAddingFileIgnores(t *testing.T) {
 	ignoreConfig := FileIgnoreConfig{
 		FileName: "Foo",
 		Checksum: "SomeCheckSum"}
-	t.Run("When .talismanrc doesn't exist yet", func(t *testing.T) {
-
+	t.Run("When .talismanrc is empty", func(t *testing.T) {
 		initialRCConfig, _ := Load()
 		initialRCConfig.AddIgnores([]FileIgnoreConfig{ignoreConfig})
 		newRCConfig, _ := Load()
 		assert.Equal(t, 1, len(newRCConfig.FileIgnoreConfig))
 		_ = fs.Remove(ignoreFile)
 	})
 
-	t.Run("When there already is a .talismanrc", func(t *testing.T) {
+	t.Run("When .talismanrc has lots of configurations", func(t *testing.T) {
 		err = afero.WriteFile(fs, ignoreFile, []byte(fullyConfiguredTalismanRC), 0666)
 		assert.NoError(t, err)