Merge pull request #57 from supreeth7/config-name-fix

Change config file name
openshift · Mar 30, 2023 · 0040057 · 0040057
2 parents d802596 + 322aace
commit 0040057
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 13 deletions.
diff --git a/pkg/cli/config/config.go b/pkg/cli/config/config.go
@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"path/filepath"
 
 	"github.com/openshift/backplane-cli/pkg/info"
 )
@@ -13,31 +14,41 @@ type BackplaneConfiguration struct {
 	ProxyURL string `json:"proxy-url"`
 }
 
-func GetBackplaneConfigFile() string {
+func GetBackplaneConfigFile() (string, error) {
 	path, bpConfigFound := os.LookupEnv(info.BACKPLANE_CONFIG_PATH_ENV_NAME)
 	if bpConfigFound {
-		return path
+		return path, nil
 	}
 
-	return getConfiDefaultPath(info.BACKPLANE_CONFIG_DEFAULT_FILE_NAME)
+	configFile, err := getDefaultConfigPath()
+	if err != nil {
+		return "", err
+	}
+
+	return configFile, nil
 }
 
 // Get Backplane config default path
-func getConfiDefaultPath(fileName string) string {
-	configDir, err := os.UserConfigDir()
-
+func getDefaultConfigPath() (string, error) {
+	UserHomeDir, err := os.UserHomeDir()
 	if err != nil {
-		return fileName
+		return "", err
 	}
 
-	return configDir + "/" + fileName
+	configFilePath := filepath.Join(UserHomeDir, info.BACKPLANE_CONFIG_DEFAULT_FILE_PATH, info.BACKPLANE_CONFIG_DEFAULT_FILE_NAME)
+
+	return configFilePath, nil
 }
 
 // Get Backplane ProxyUrl from config
 func GetBackplaneConfiguration() (bpConfig BackplaneConfiguration, err error) {
 
 	// Check proxy url from the config file
-	filePath := GetBackplaneConfigFile()
+	filePath, err := GetBackplaneConfigFile()
+	if err != nil {
+		return bpConfig, err
+	}
+
 	if _, err := os.Stat(filePath); err == nil {
 		file, err := os.Open(filePath)
 

diff --git a/pkg/cli/config/config_test.go b/pkg/cli/config/config_test.go
@@ -9,15 +9,25 @@ import (
 func TestGetBackplaneConfigFile(t *testing.T) {
 	t.Run("it returns the Backplane configuration file path if it exists in the user's env", func(t *testing.T) {
 		t.Setenv(info.BACKPLANE_CONFIG_PATH_ENV_NAME, "~/.backplane.stg.env.json")
-		path := GetBackplaneConfigFile()
+		path, err := GetBackplaneConfigFile()
+		if err != nil {
+			t.Error(err)
+		}
 		if path != "~/.backplane.stg.env.json" {
 			t.Errorf("expected path to be %v, got %v", "~/.backplane.stg.env.json", path)
 		}
 	})
 
 	t.Run("it returns the default configuration file path if it does not exist in the user's env", func(t *testing.T) {
-		path := GetBackplaneConfigFile()
-		expectedPath := getConfiDefaultPath(info.BACKPLANE_CONFIG_DEFAULT_FILE_NAME)
+		path, err := GetBackplaneConfigFile()
+		if err != nil {
+			t.Error(err)
+		}
+
+		expectedPath, err := getDefaultConfigPath()
+		if err != nil {
+			t.Error(err)
+		}
 		if path != expectedPath {
 			t.Errorf("expected path to be %v, got %v", expectedPath, path)
 		}

diff --git a/pkg/info/info.go b/pkg/info/info.go
@@ -10,7 +10,8 @@ const (
 	BACKPLANE_URL_ENV_NAME             = "BACKPLANE_URL"
 	BACKPLANE_PROXY_ENV_NAME           = "HTTPS_PROXY"
 	BACKPLANE_CONFIG_PATH_ENV_NAME     = "BACKPLANE_CONFIG"
-	BACKPLANE_CONFIG_DEFAULT_FILE_NAME = ".backplane.json"
+	BACKPLANE_CONFIG_DEFAULT_FILE_PATH = ".config/backplane"
+	BACKPLANE_CONFIG_DEFAULT_FILE_NAME = "config.json"
 
 	// GitHub API get fetch the latest tag
 	UpstreamReleaseAPI = "https://api.github.com/repos/openshift/backplane-cli/releases/latest"