Add tests for YAMLStringify

cfg/types_test.go

@@ -28,7 +28,7 @@ func TestOctalTypeInConfigStringify(t *testing.T) {
 		},
 	}
 
-	str, err := util.Stringify(&c)
+	str, err := util.JSONStringify(&c)
 
 	if assert.NoError(t, err) {
 		assert.Equal(t, "file-system:\n    dir-mode: \"755\"\n", str)
@@ -37,7 +37,7 @@ func TestOctalTypeInConfigStringify(t *testing.T) {
 func TestOctalStringify(t *testing.T) {
 	o := Octal(0765)
 
-	str, err := util.Stringify(&o)
+	str, err := util.JSONStringify(&o)
 
 	if assert.NoError(t, err) {
 		assert.Equal(t, "\"765\"\n", str)

cmd/legacy_main.go

@@ -90,22 +90,22 @@ func getUserAgent(appName string, config string) string {
 }
 
 func logNewConfiguration(newConfig *cfg.Config) {
-	cfgStr, err := util.Stringify(newConfig)
+	cfgStr, err := util.YAMLStringify(newConfig)
 	if err != nil {
 		logger.Warnf("failed to stringify configuration: %v", err)
 		return
 	}
 	logger.Infof("GCSFuse mount config: %s", cfgStr)
 }
 func logLegacyConfiguration(flags *flagStorage, mountConfig *config.MountConfig) {
-	flagsStringified, err := util.Stringify(*flags)
+	flagsStringified, err := util.JSONStringify(*flags)
 	if err != nil {
 		logger.Warnf("failed to stringify cli flags: %v", err)
 	} else {
 		logger.Infof("GCSFuse mount command flags: %s", flagsStringified)
 	}
 
-	mountConfigStringified, err := util.Stringify(*mountConfig)
+	mountConfigStringified, err := util.JSONStringify(*mountConfig)
 	if err != nil {
 		logger.Warnf("failed to stringify config-file: %v", err)
 	} else {

internal/util/util.go

@@ -24,6 +24,8 @@ import (
 	"path/filepath"
 	"strings"
 	"time"
+
+	"gopkg.in/yaml.v3"
 )
 
 const (
@@ -75,12 +77,24 @@ func GetResolvedPath(filePath string) (resolvedPath string, err error) {
 	}
 }
 
-// Stringify marshals an object (only exported attribute) to a JSON string. If marshalling fails, it returns an empty string.
-func Stringify(input any) (string, error) {
+// JSONStringify marshals an object (only exported attribute) to a JSON string. If marshalling fails, it returns an empty string.
+//
+// Deprecated: use YAMLStringify
+func JSONStringify(input any) (string, error) {
 	inputBytes, err := json.Marshal(input)
 
 	if err != nil {
-		return "", fmt.Errorf("error in Stringify %w", err)
+		return "", fmt.Errorf("error in JSONStringify %w", err)
+	}
+	return string(inputBytes), nil
+}
+
+// YAMLStringify marshals an object to a YAML string. If marshalling fails, it returns an error.
+func YAMLStringify(input any) (string, error) {
+	inputBytes, err := yaml.Marshal(input)
+
+	if err != nil {
+		return "", fmt.Errorf("error in YAMLStringify %w", err)
 	}
 	return string(inputBytes), nil
 }

internal/util/util_test.go

@@ -148,6 +148,43 @@ func (ts *UtilTest) ResolveWhenParentProcDirEnvSetAndAbsoluteFilePath() {
 	assert.Equal(ts.T(), "/var/dir/test.txt", resolvedPath)
 }
 
+func TestYAMLStringify(t *testing.T) {
+	tests := []struct {
+		name     string
+		obj      any
+		expected string
+	}{
+		{
+			name: "Test Map",
+			obj: map[string]int{
+				"1": 1,
+				"2": 2,
+				"3": 3,
+			},
+			expected: "\"1\": 1\n\"2\": 2\n\"3\": 3\n",
+		},
+		{
+			name: "Test Nested Map",
+			obj: map[string]any{
+				"1": 1,
+				"2": map[string]int{
+					"3": 1,
+				},
+			},
+			expected: "\"1\": 1\n\"2\":\n    \"3\": 1\n",
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			s, err := YAMLStringify(tc.obj)
+
+			if assert.NoError(t, err) {
+				assert.Equal(t, tc.expected, s)
+			}
+		})
+	}
+}
 func (ts *UtilTest) TestStringifyShouldReturnAllFieldsPassedInCustomObjectAsMarshalledString() {
 	sampleMap := map[string]int{
 		"1": 1,
@@ -163,7 +200,7 @@ func (ts *UtilTest) TestStringifyShouldReturnAllFieldsPassedInCustomObjectAsMars
 		NestedValue: sampleNestedValue,
 	}
 
-	actual, _ := Stringify(customObject)
+	actual, _ := JSONStringify(customObject)
 
 	expected := "{\"Value\":\"test_value\",\"NestedValue\":{\"SomeField\":10,\"SomeOther\":{\"1\":1,\"2\":2,\"3\":3}}}"
 	assert.Equal(ts.T(), expected, actual)
@@ -174,7 +211,7 @@ func (ts *UtilTest) TestStringifyShouldReturnEmptyStringWhenMarshalErrorsOut() {
 		value: "example",
 	}
 
-	actual, _ := Stringify(customInstance)
+	actual, _ := JSONStringify(customInstance)
 
 	expected := ""
 	assert.Equal(ts.T(), expected, actual)