fix(mnq): fix XDG_CONFIG_HOME compliance in NATS context directory (#5206)

Author: jremy42

internal/namespaces/mnq/v1beta1/custom_nats_helpers.go

@@ -85,7 +85,6 @@ func writeFile(
 
 func getNATSContextDir(ctx context.Context) (string, error) {
 	xdgConfigHome := core.ExtractEnv(ctx, "XDG_CONFIG_HOME")
-	interactive.Println("xdgConfigHome:", xdgConfigHome)
 	if xdgConfigHome == "" {
 		homeDir := core.ExtractEnv(ctx, "HOME")
 		if homeDir == "" {
@@ -95,7 +94,7 @@ func getNATSContextDir(ctx context.Context) (string, error) {
 		return filepath.Join(homeDir, ".config", "nats", "context"), nil
 	}
 
-	return xdgConfigHome, nil
+	return filepath.Join(xdgConfigHome, "nats", "context"), nil
 }
 
 func saveNATSCredentials(

internal/namespaces/mnq/v1beta1/custom_nats_test.go

@@ -2,6 +2,7 @@ package mnq_test
 
 import (
 	"os"
+	"path/filepath"
 	"reflect"
 	"regexp"
 	"testing"
@@ -31,43 +32,11 @@ func Test_CreateContext(t *testing.T) {
 					Replacement: "Select context using `nats context select context-placeholder`",
 				},
 			),
-			func(t *testing.T, ctx *core.CheckFuncCtx) {
-				t.Helper()
-				result, isSuccessResult := ctx.Result.(*core.SuccessResult)
-				assert.True(
-					t,
-					isSuccessResult,
-					"Expected result to be of type *core.SuccessResult, got %s",
-					reflect.TypeOf(result).String(),
-				)
-				assert.NotNil(t, result)
-				expectedContextFile := result.Resource
-				if !mnq.FileExists(expectedContextFile) {
-					t.Errorf(
-						"Expected credentials file not found expected [%s] ",
-						expectedContextFile,
-					)
-				} else {
-					ctx.Meta["deleteFiles"] = []string{expectedContextFile}
-				}
-			},
+			checkContextFile,
 		),
 		AfterFunc: core.AfterFuncCombine(
 			deleteNATSAccount("NATS"),
-			func(ctx *core.AfterFuncCtx) error {
-				if ctx.Meta["deleteFiles"] == nil {
-					return nil
-				}
-				filesToDelete := ctx.Meta["deleteFiles"].([]string)
-				for _, file := range filesToDelete {
-					err := os.Remove(file)
-					if err != nil {
-						t.Errorf("Failed to delete the file : %s", err)
-					}
-				}
-
-				return nil
-			},
+			afterFuncDeleteFiles,
 		),
 	}))
 }
@@ -106,3 +75,127 @@ func Test_CreateContextNoInteractiveTermAndMultiAccount(t *testing.T) {
 		AfterFunc: core.AfterFuncCombine(deleteNATSAccount("NATS"), deleteNATSAccount("NATS2")),
 	}))
 }
+
+func beforeFuncCopyConfigToTmpHome() core.BeforeFunc {
+	return core.BeforeFuncWhenUpdatingCassette(func(ctx *core.BeforeFuncCtx) error {
+		realHomeDir, err := os.UserHomeDir()
+		if err != nil {
+			return err
+		}
+
+		realConfigPath := filepath.Join(realHomeDir, ".config", "scw", "config.yaml")
+		if _, err := os.Stat(realConfigPath); os.IsNotExist(err) {
+			return nil
+		}
+
+		tmpHomeDir := ctx.OverrideEnv["HOME"]
+		tmpConfigDir := filepath.Join(tmpHomeDir, ".config", "scw")
+		if err := os.MkdirAll(tmpConfigDir, 0o0755); err != nil {
+			return err
+		}
+
+		data, err := os.ReadFile(realConfigPath)
+		if err != nil {
+			return err
+		}
+
+		return os.WriteFile(filepath.Join(tmpConfigDir, "config.yaml"), data, 0o644)
+	})
+}
+
+func checkContextFile(t *testing.T, ctx *core.CheckFuncCtx) {
+	t.Helper()
+	result, isSuccessResult := ctx.Result.(*core.SuccessResult)
+	assert.True(
+		t,
+		isSuccessResult,
+		"Expected result to be of type *core.SuccessResult, got %s",
+		reflect.TypeOf(result).String(),
+	)
+	assert.NotNil(t, result)
+	expectedContextFile := result.Resource
+	if !mnq.FileExists(expectedContextFile) {
+		t.Errorf("Expected credentials file not found expected [%s]", expectedContextFile)
+	} else {
+		ctx.Meta["deleteFiles"] = []string{expectedContextFile}
+	}
+}
+
+func checkContextFileInXDGConfigHome(t *testing.T, ctx *core.CheckFuncCtx) {
+	t.Helper()
+	checkContextFile(t, ctx)
+
+	result := ctx.Result.(*core.SuccessResult)
+	expectedContextFile := result.Resource
+	xdgConfigHome := ctx.OverrideEnv["XDG_CONFIG_HOME"]
+	tmpHomeDir := ctx.OverrideEnv["HOME"]
+
+	expectedContextDir := filepath.Join(xdgConfigHome, "nats", "context")
+	assert.Contains(
+		t,
+		expectedContextFile,
+		expectedContextDir,
+		"Context file should be in XDG_CONFIG_HOME/nats/context, got: %s",
+		expectedContextFile,
+	)
+
+	tmpHomeNatsDir := filepath.Join(tmpHomeDir, ".config", "nats", "context")
+	_, err := os.Stat(tmpHomeNatsDir)
+	assert.True(
+		t,
+		os.IsNotExist(err),
+		"Files should not be created in HOME/.config/nats/context when XDG_CONFIG_HOME is set: %s",
+		tmpHomeNatsDir,
+	)
+}
+
+func afterFuncDeleteFiles(ctx *core.AfterFuncCtx) error {
+	if ctx.Meta["deleteFiles"] == nil {
+		return nil
+	}
+	filesToDelete := ctx.Meta["deleteFiles"].([]string)
+	for _, file := range filesToDelete {
+		if err := os.Remove(file); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func Test_CreateContextWithXDGConfigHome(t *testing.T) {
+	xdgConfigHomeDir := t.TempDir()
+
+	t.Run("XDG_CONFIG_HOME compliance", core.Test(&core.TestConfig{
+		Commands: mnq.GetCommands(),
+		BeforeFunc: core.BeforeFuncCombine(
+			beforeFuncCopyConfigToTmpHome(),
+			createNATSAccount("NATS"),
+		),
+		Cmd:        "scw mnq nats create-context nats-account-id={{ .NATS.ID }}",
+		TmpHomeDir: true,
+		OverrideEnv: map[string]string{
+			"XDG_CONFIG_HOME": xdgConfigHomeDir,
+		},
+		Check: core.TestCheckCombine(
+			core.TestCheckExitCode(0),
+			core.TestCheckGoldenAndReplacePatterns(
+				core.GoldenReplacement{
+					Pattern:     regexp.MustCompile(`cli[\w-]*creds[\w-]*`),
+					Replacement: "credential-placeholder",
+				},
+				core.GoldenReplacement{
+					Pattern: regexp.MustCompile(
+						"(Select context using `nats context select )cli[\\w-]*`",
+					),
+					Replacement: "Select context using `nats context select context-placeholder`",
+				},
+			),
+			checkContextFileInXDGConfigHome,
+		),
+		AfterFunc: core.AfterFuncCombine(
+			deleteNATSAccount("NATS"),
+			afterFuncDeleteFiles,
+		),
+	}))
+}