Refinements in tests and defining filePath

Author: marceljk

internal/cmd/config/profile/export/export.go

@@ -2,6 +2,8 @@ package export
 
 import (
 	"fmt"
+	"path/filepath"
+	"strings"
 
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/config"
@@ -17,12 +19,14 @@ const (
 	profileNameArg = "PROFILE_NAME"
 
 	filePathFlag = "file-path"
+
+	configFileExtension = "json"
 )
 
 type inputModel struct {
 	*globalflags.GlobalFlagModel
 	ProfileName string
-	ExportPath  string
+	FilePath    string
 }
 
 func NewCmd(p *print.Printer) *cobra.Command {
@@ -32,7 +36,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 		Long:  "Exports a CLI configuration profile.",
 		Example: examples.Build(
 			examples.NewExample(
-				`Export a profile with name "PROFILE_NAME" to the current path`,
+				`Export a profile with name "PROFILE_NAME" to a file in your current directory`,
 				"$ stackit config profile export PROFILE_NAME",
 			),
 			examples.NewExample(
@@ -47,12 +51,12 @@ func NewCmd(p *print.Printer) *cobra.Command {
 				return err
 			}
 
-			err = config.ExportProfile(p, model.ProfileName, model.ExportPath)
+			err = config.ExportProfile(p, model.ProfileName, model.FilePath)
 			if err != nil {
 				return fmt.Errorf("could not export profile: %w", err)
 			}
 
-			p.Info("Exported profile %q\n", model.ProfileName)
+			p.Info("Exported profile %q to %q\n", model.ProfileName, model.FilePath)
 
 			return nil
 		},
@@ -62,7 +66,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
 }
 
 func configureFlags(cmd *cobra.Command) {
-	cmd.Flags().String(filePathFlag, "", "Path where the config should be saved. E.g. '--file-path ~/config.json', '--file-path ~/'")
+	cmd.Flags().StringP(filePathFlag, "f", "", "If set, writes the payload to the given. If unset, writes the payload to you current directory with the name of the profile. E.g. '--file-path ~/my-config.json', '--file-path ~/'")
 }
 
 func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inputModel, error) {
@@ -72,7 +76,13 @@ func parseInput(p *print.Printer, cmd *cobra.Command, inputArgs []string) (*inpu
 	model := inputModel{
 		GlobalFlagModel: globalFlags,
 		ProfileName:     profileName,
-		ExportPath:      flags.FlagToStringValue(p, cmd, filePathFlag),
+		FilePath:        flags.FlagToStringValue(p, cmd, filePathFlag),
+	}
+
+	// If filePath contains does not contain a file name, then add a default name
+	if !strings.HasSuffix(model.FilePath, fmt.Sprintf(".%s", configFileExtension)) {
+		exportFileName := fmt.Sprintf("%s.%s", model.ProfileName, configFileExtension)
+		model.FilePath = filepath.Join(model.FilePath, exportFileName)
 	}
 
 	if p.IsVerbosityDebug() {

internal/cmd/config/profile/export/export_test.go

@@ -1,6 +1,7 @@
 package export
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/stackitcloud/stackit-cli/internal/pkg/globalflags"
@@ -11,7 +12,7 @@ import (
 
 const (
 	testProfileArg = "default"
-	testExportPath = "/tmp/stackit-profiles"
+	testExportPath = "/tmp/stackit-profiles/" + testProfileArg + ".json"
 )
 
 func fixtureArgValues(mods ...func(args []string)) []string {
@@ -40,7 +41,7 @@ func fixtureInputModel(mods ...func(inputModel *inputModel)) *inputModel {
 			Verbosity: globalflags.VerbosityDefault,
 		},
 		ProfileName: testProfileArg,
-		ExportPath:  testExportPath,
+		FilePath:    testExportPath,
 	}
 	for _, mod := range mods {
 		mod(model)
@@ -81,7 +82,7 @@ func TestParseInput(t *testing.T) {
 			flagValues:  map[string]string{},
 			isValid:     true,
 			expectedModel: fixtureInputModel(func(inputModel *inputModel) {
-				inputModel.ExportPath = ""
+				inputModel.FilePath = fmt.Sprintf("%s.json", testProfileArg)
 			}),
 		},
 	}

internal/pkg/config/config.go

@@ -105,7 +105,11 @@ var configFolderPath string
 var profileFilePath string
 
 func InitConfig() {
-	defaultConfigFolderPath = getInitialConfigDir()
+	initConfig(getInitialConfigDir())
+}
+
+func initConfig(configPath string) {
+	defaultConfigFolderPath = configPath
 	profileFilePath = getInitialProfileFilePath() // Profile file path is in the default config folder
 
 	configProfile, err := GetProfile()

internal/pkg/config/profiles.go

@@ -400,8 +400,8 @@ func ImportProfile(p *print.Printer, profileName, config string, setAsActive boo
 }
 
 // ExportProfile exports a profile configuration
-// Is exports the profile to the filePath.
-func ExportProfile(p *print.Printer, profile, filePath string) error {
+// Is exports the profile to the exportPath. The exportPath must contain in the suffix `.json` as file extension
+func ExportProfile(p *print.Printer, profile, exportPath string) error {
 	err := ValidateProfile(profile)
 	if err != nil {
 		return fmt.Errorf("validate profile: %w", err)
@@ -418,24 +418,22 @@ func ExportProfile(p *print.Printer, profile, filePath string) error {
 	profilePath := GetProfileFolderPath(profile)
 	configFile := getConfigFilePath(profilePath)
 
-	exportFileName := fmt.Sprintf("%s.%s", profile, configFileExtension)
-	exportFilePath := filePath
-	if !strings.HasSuffix(exportFilePath, fmt.Sprintf(".%s", configFileExtension)) {
-		exportFilePath = filepath.Join(filePath, exportFileName)
+	if !strings.HasSuffix(exportPath, fmt.Sprintf(".%s", configFileExtension)) {
+		return fmt.Errorf("export file name must end with '.%s'", configFileExtension)
 	}
 
-	_, err = os.Stat(exportFilePath)
+	_, err = os.Stat(exportPath)
 	if err == nil {
-		return fmt.Errorf("file %q already exists in the export path. Delete the existing file or define a different export path", exportFileName)
+		return &errors.FileAlreadyExistsError{Filename: exportPath}
 	}
 
-	err = fileutils.CopyFile(configFile, exportFilePath)
+	err = fileutils.CopyFile(configFile, exportPath)
 	if err != nil {
-		return fmt.Errorf("export config file to %q: %w", exportFilePath, err)
+		return fmt.Errorf("export config file to %q: %w", exportPath, err)
 	}
 
 	if p != nil {
-		p.Debug(print.DebugLevel, "exported profile %q to %q", profile, exportFilePath)
+		p.Debug(print.DebugLevel, "exported profile %q to %q", profile, exportPath)
 	}
 
 	return nil

internal/pkg/config/profiles_test.go

@@ -199,14 +199,20 @@ func TestExportProfile(t *testing.T) {
 		}(testDir)
 	})
 
+	defaultConfigFolderPath = filepath.Join(testDir, "config")
+	err = os.Mkdir(defaultConfigFolderPath, 0o750)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	// Create prerequisite profile
 	p := print.NewPrinter()
 	profileName := "export-profile-test"
 	err = CreateProfile(p, profileName, true, true)
 	if err != nil {
 		t.Fatalf("could not create prerequisite profile, %v", err)
 	}
-	InitConfig()
+	initConfig(defaultConfigFolderPath)
 	err = Write()
 	if err != nil {
 		t.Fatalf("could not write profile, %v", err)
@@ -229,24 +235,18 @@ func TestExportProfile(t *testing.T) {
 		{
 			description: "valid profile",
 			profile:     profileName,
-			filePath:    testDir,
+			filePath:    filepath.Join(testDir, fmt.Sprintf("custom-name.%s", configFileExtension)),
 			isValid:     true,
 		},
 		{
 			description: "invalid profile",
 			profile:     "invalid-my-profile",
 			isValid:     false,
 		},
-		{
-			description: "custom file name",
-			profile:     profileName,
-			filePath:    filepath.Join(testDir, fmt.Sprintf("custom-name.%s", configFileExtension)),
-			isValid:     true,
-		},
 		{
 			description: "not existing path",
 			profile:     profileName,
-			filePath:    filepath.Join(testDir, "invalid", "path"),
+			filePath:    filepath.Join(testDir, "invalid", "path", fmt.Sprintf("custom-name.%s", configFileExtension)),
 			isValid:     false,
 		},
 	}