Merge pull request #389 from secrethub/fix/migrate-config-template

Fix `migrate config templates` command

Author: edif2008

internals/secrethub/migrate_config_envfile.go

@@ -1,7 +1,6 @@
 package secrethub
 
 import (
-	"bytes"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -40,18 +39,22 @@ func (cmd *MigrateConfigEnvfileCommand) Run() error {
 		return err
 	}
 
-	outFile, err := os.Create(".env")
+	output, replaceCount, err := migrateTemplateTags(string(inFileContents), refMapping, "%s")
 	if err != nil {
-		return fmt.Errorf("cannot create output .env file: %s", err)
+		return err
+	}
+
+	inFileInfo, err := os.Stat(filepath)
+	if err != nil {
+		return ErrReadFile(filepath, err)
 	}
-	defer outFile.Close()
 
-	replaceCount, err := migrateTemplateTags(bytes.NewBuffer(inFileContents), outFile, refMapping, "%s")
+	err = ioutil.WriteFile(".env", []byte(output), inFileInfo.Mode())
 	if err != nil {
 		return err
 	}
 
-	fmt.Fprintf(cmd.io.Output(), "Created new .env file with %d op:// references\n", len(replaceCount))
+	fmt.Fprintf(cmd.io.Output(), "Created new .env file with %d op:// references\n", replaceCount)
 
 	return nil
 }

internals/secrethub/migrate_config_references.go

@@ -3,6 +3,7 @@ package secrethub
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
 	"regexp"
 	"strings"
 
@@ -60,7 +61,12 @@ func migrateReferences(inFile string, outFile string, mapping referenceMapping)
 		return nil, fmt.Errorf("no 1Password equivalent present in your migration plan for the following secrets:\n- %s", strings.Join(misses, "\n- "))
 	}
 
-	err = ioutil.WriteFile(outFile, []byte(output), 0666)
+	inFileInfo, err := os.Stat(inFile)
+	if err != nil {
+		return nil, ErrReadFile(inFile, err)
+	}
+
+	err = ioutil.WriteFile(outFile, []byte(output), inFileInfo.Mode())
 	if err != nil {
 		return nil, err
 	}

internals/secrethub/migrate_config_templates.go

@@ -2,7 +2,6 @@ package secrethub
 
 import (
 	"fmt"
-	"io"
 	"io/ioutil"
 	"os"
 	"regexp"
@@ -31,31 +30,35 @@ func (cmd *MigrateConfigTemplatesCommand) Run() error {
 	refMapping.stripSecretHubURIScheme()
 
 	for _, filepath := range cmd.inFiles {
-		file, err := os.Open(filepath)
+		inFileContents, err := ioutil.ReadFile(filepath)
 		if err != nil {
 			return ErrReadFile(filepath, err)
 		}
-		defer file.Close()
 
-		replaceCount, err := migrateTemplateTags(file, file, refMapping, "{{ %s }}")
+		output, replaceCount, err := migrateTemplateTags(string(inFileContents), refMapping, "{{ %s }}")
 		if err != nil {
 			return err
 		}
 
-		fmt.Fprintf(cmd.io.Output(), "Updated %s with %d op:// references\n", filepath, len(replaceCount))
+		inFileInfo, err := os.Stat(filepath)
+		if err != nil {
+			return ErrReadFile(filepath, err)
+		}
+
+		err = ioutil.WriteFile(filepath, []byte(output), inFileInfo.Mode())
+		if err != nil {
+			return err
+		}
+
+		fmt.Fprintf(cmd.io.Output(), "Updated %s with %d op:// references\n", filepath, replaceCount)
 	}
 
 	return nil
 }
 
-func migrateTemplateTags(inFile io.Reader, outFile io.Writer, mapping referenceMapping, formatString string) ([]string, error) {
-	raw, err := ioutil.ReadAll(inFile)
-	if err != nil {
-		return nil, ErrReadFile(inFile, err)
-	}
-
+func migrateTemplateTags(inFileContents string, mapping referenceMapping, formatString string) (string, int, error) {
 	var hits, misses []string
-	output := regexpSecretTemplateTags.ReplaceAllStringFunc(string(raw), func(templateTag string) string {
+	output := regexpSecretTemplateTags.ReplaceAllStringFunc(inFileContents, func(templateTag string) string {
 		path := regexpSecretTemplatePath.FindString(templateTag)
 		if path == "" {
 			misses = append(misses, templateTag)
@@ -86,15 +89,10 @@ func migrateTemplateTags(inFile io.Reader, outFile io.Writer, mapping referenceM
 			errMsg += "\nDid you specify every possible value for your template variables? E.g. --var varname1=a,b,c,d --var varname2=x,y,z"
 		}
 
-		return nil, fmt.Errorf(errMsg)
-	}
-
-	_, err = io.WriteString(outFile, output)
-	if err != nil {
-		return nil, err
+		return "", 0, fmt.Errorf(errMsg)
 	}
 
-	return hits, nil
+	return output, len(hits), nil
 }
 
 type MigrateConfigTemplatesCommand struct {

internals/secrethub/migrate_config_test.go

@@ -1,7 +1,6 @@
 package secrethub
 
 import (
-	"bytes"
 	"testing"
 
 	"github.com/secrethub/secrethub-go/internals/assert"
@@ -103,20 +102,20 @@ func TestMigrateTemplates(t *testing.T) {
 		},
 	} {
 		t.Run(name, func(t *testing.T) {
-			var out bytes.Buffer
+			var out string
 			m := referenceMapping(tc.mapping)
 			m.stripSecretHubURIScheme()
 			err := m.addVarPossibilities(tc.vars)
 			assert.OK(t, err)
 
-			_, err = migrateTemplateTags(bytes.NewReader([]byte(tc.in)), &out, m, "{{ %s }}")
+			out, _, err = migrateTemplateTags(tc.in, m, "{{ %s }}")
 			if tc.expectedErr {
 				assert.Equal(t, err != nil, true)
 				return
 			}
 
 			assert.OK(t, err)
-			assert.Equal(t, out.String(), tc.expected)
+			assert.Equal(t, out, tc.expected)
 		})
 	}
 }
@@ -225,7 +224,7 @@ func TestMigrateEnvfile(t *testing.T) {
 		},
 	} {
 		t.Run(name, func(t *testing.T) {
-			var out bytes.Buffer
+			var out string
 			m := referenceMapping(tc.mapping)
 			m.stripSecretHubURIScheme()
 			err := m.addVarPossibilities(tc.vars)
@@ -237,7 +236,7 @@ func TestMigrateEnvfile(t *testing.T) {
 					return err
 				}
 
-				_, err = migrateTemplateTags(bytes.NewReader([]byte(tc.in)), &out, m, "%s")
+				out, _, err = migrateTemplateTags(tc.in, m, "%s")
 				return err
 			}()
 
@@ -247,7 +246,7 @@ func TestMigrateEnvfile(t *testing.T) {
 			}
 
 			assert.OK(t, err)
-			assert.Equal(t, out.String(), tc.expected)
+			assert.Equal(t, out, tc.expected)
 		})
 	}
 }