feat(generate-config): add overwrite flag and change default env file (#1604)

Author: rkpattnaik780

docs/commands/rhoas_generate-config.md

@@ -115,7 +115,7 @@ func BuildConfiguration(svcConfig *servicecontext.ServiceConfig, opts *options)
 	configurations.TokenURL = providerUrls.GetTokenUrl()
 	configurations.Name = configInstanceName
 
-	if err = WriteConfig(opts.configType, opts.fileName, configurations); err != nil {
+	if err = WriteConfig(opts, configurations); err != nil {
 		return err
 	}
 

pkg/cmd/generate/build-configs.go

@@ -6,6 +6,8 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+
+	"github.com/redhat-developer/app-services-cli/pkg/core/localize"
 )
 
 // configuration types for generate-config command
@@ -27,28 +29,35 @@ var (
 
 // WriteConfig saves the configurations to a file
 // in the specified output format
-func WriteConfig(configType string, filePath string, config *configValues) error {
+func WriteConfig(opts *options, config *configValues) error {
 
 	var fileBody bytes.Buffer
-	fileTemplate := getFileFormat(configType)
+	fileTemplate := getFileFormat(opts.configType)
 	err := fileTemplate.Execute(&fileBody, config)
 	if err != nil {
 		return err
 	}
 
 	fileData := []byte(fileBody.String())
-	if filePath == "" {
-		filePath = getDefaultPath(configType)
+	if opts.fileName == "" {
+		opts.fileName = getDefaultPath(opts.configType)
+	}
+
+	// If the file already exists, and the --overwrite flag is not set then return an error
+	// indicating that the user should explicitly request overwriting of the file
+	_, err = os.Stat(opts.fileName)
+	if err == nil && !opts.overwrite {
+		return opts.localizer.MustLocalizeError("generate.error.configFileAlreadyExists", localize.NewEntry("FilePath", opts.fileName))
 	}
 
-	return ioutil.WriteFile(filePath, fileData, 0o600)
+	return ioutil.WriteFile(opts.fileName, fileData, 0o600)
 }
 
 // getDefaultPath returns the default absolute path for the configuration file
 func getDefaultPath(configType string) (filePath string) {
 	switch configType {
 	case envFormat:
-		filePath = "rhoas.env"
+		filePath = ".env"
 	case propertiesFormat:
 		filePath = "rhoas.properties"
 	case jsonFormat:

pkg/cmd/generate/configurations.go

@@ -27,6 +27,7 @@ type options struct {
 	name       string
 	fileName   string
 	configType string
+	overwrite  bool
 }
 
 // NewGenerateCommand creates configuration files for service context
@@ -61,6 +62,7 @@ func NewGenerateCommand(f *factory.Factory) *cobra.Command {
 	flags := contextcmdutil.NewFlagSet(cmd, f)
 	flags.AddContextName(&opts.name)
 	flags.StringVar(&opts.configType, "type", "", opts.localizer.MustLocalize("generate.flag.type"))
+	cmd.Flags().BoolVar(&opts.overwrite, "overwrite", false, opts.localizer.MustLocalize("generate.flag.overwrite.description"))
 	cmd.Flags().StringVar(&opts.fileName, "output-file", "", opts.localizer.MustLocalize("generate.common.flag.fileLocation.description"))
 	_ = cmd.MarkFlagRequired("type")
 

pkg/cmd/generate/generate-config.go

@@ -28,10 +28,16 @@ $ rhoas generate-config --name qaprod --type secret
 [generate.flag.type]
 one='Type of configuration file to be generated'
 
+[generate.flag.overwrite.description]
+one = 'Forcibly overwrite a configuration file if it already exists'
+
 [generate.common.flag.fileLocation.description]
 description = 'Description for --output-file flag'
 one = 'Sets a custom file location to save the configurations'
 
+[generate.error.configFileAlreadyExists]
+description = 'Error message for when a configuration file alredy exists at a location'
+one = 'file {{.FilePath}} already exists. Use --overwrite to overwrite the file, or the --output-file flag to choose a different location'
 
 [generate.log.info.noSevices]
 one='No services available to generate configurations'