pkg/utils/yaml_utils/yaml_utils_test.go - master - githubmirror/lazygit

pkg/utils/yaml_utils/yaml_utils_test.go
441 строка12 KB
Stefan Haller
Add MoveYamlKey helper to move config keys between sections
03 июл 2026, 19:53
03 июл 2026, 19:53d53a9ea
package yaml_utils

import (
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	"gopkg.in/yaml.v3"
)

func TestRenameYamlKey(t *testing.T) {
	tests := []struct {
		name              string
		in                string
		path              []string
		newKey            string
		expectedOut       string
		expectedDidRename bool
		expectedErr       string
	}{
		{
			name:              "rename key",
			in:                "foo: 5\n",
			path:              []string{"foo"},
			newKey:            "bar",
			expectedOut:       "bar: 5\n",
			expectedDidRename: true,
			expectedErr:       "",
		},
		{
			name:              "rename key, nested",
			in:                "foo:\n  bar: 5\n",
			path:              []string{"foo", "bar"},
			newKey:            "baz",
			expectedOut:       "foo:\n  baz: 5\n",
			expectedDidRename: true,
			expectedErr:       "",
		},
		{
			name:              "rename non-scalar key",
			in:                "foo:\n  bar: 5\n",
			path:              []string{"foo"},
			newKey:            "qux",
			expectedOut:       "qux:\n  bar: 5\n",
			expectedDidRename: true,
			expectedErr:       "",
		},
		{
			name:              "don't rewrite file if value didn't change",
			in:                "foo:\n  bar: 5\n",
			path:              []string{"nonExistingKey"},
			newKey:            "qux",
			expectedOut:       "foo:\n  bar: 5\n",
			expectedDidRename: false,
			expectedErr:       "",
		},

		// Error cases
		{
			name:              "existing document is not a dictionary",
			in:                "42\n",
			path:              []string{"foo"},
			newKey:            "bar",
			expectedOut:       "42\n",
			expectedDidRename: false,
			expectedErr:       "yaml node in path is not a dictionary",
		},
		{
			name:              "not all path elements are dictionaries",
			in:                "foo:\n  bar: [1, 2, 3]\n",
			path:              []string{"foo", "bar", "baz"},
			newKey:            "qux",
			expectedOut:       "foo:\n  bar: [1, 2, 3]\n",
			expectedDidRename: false,
			expectedErr:       "yaml node in path is not a dictionary",
		},
		{
			name:              "new key exists",
			in:                "foo: 5\nbar: 7\n",
			path:              []string{"foo"},
			newKey:            "bar",
			expectedOut:       "foo: 5\nbar: 7\n",
			expectedDidRename: false,
			expectedErr:       "new key `bar' already exists",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.in)
			actualErr, didRename := RenameYamlKey(&node, test.path, test.newKey)
			if test.expectedErr == "" {
				assert.NoError(t, actualErr)
			} else {
				assert.EqualError(t, actualErr, test.expectedErr)
			}
			out := marshalForTest(t, &node)

			assert.Equal(t, test.expectedOut, out)

			assert.Equal(t, test.expectedDidRename, didRename)
		})
	}
}

func TestMoveYamlKey(t *testing.T) {
	tests := []struct {
		name            string
		in              string
		oldPath         []string
		newPath         []string
		expectedOut     string
		expectedDidMove bool
		expectedErr     string
	}{
		{
			name:            "move key into an existing section",
			in:              "keybinding:\n  worktrees:\n    viewWorktreeOptions: w\n  universal:\n    quit: q\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  universal:\n    quit: q\n    newWorktree: w\n",
			expectedDidMove: true,
		},
		{
			name:            "create the destination section if it doesn't exist",
			in:              "keybinding:\n  worktrees:\n    viewWorktreeOptions: w\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  universal:\n    newWorktree: w\n",
			expectedDidMove: true,
		},
		{
			name:            "keep non-empty siblings when pruning the old section",
			in:              "keybinding:\n  worktrees:\n    viewWorktreeOptions: w\n    other: x\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  worktrees:\n    other: x\n  universal:\n    newWorktree: w\n",
			expectedDidMove: true,
		},
		{
			name:            "don't rewrite file if the key doesn't exist",
			in:              "keybinding:\n  universal:\n    quit: q\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  universal:\n    quit: q\n",
			expectedDidMove: false,
		},

		// Error cases
		{
			name:            "destination key already exists",
			in:              "keybinding:\n  worktrees:\n    viewWorktreeOptions: w\n  universal:\n    newWorktree: x\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  worktrees:\n    viewWorktreeOptions: w\n  universal:\n    newWorktree: x\n",
			expectedDidMove: false,
			expectedErr:     "new key `newWorktree' already exists",
		},
		{
			name:            "node in path is not a dictionary",
			in:              "keybinding:\n  worktrees: nonsense\n",
			oldPath:         []string{"keybinding", "worktrees", "viewWorktreeOptions"},
			newPath:         []string{"keybinding", "universal", "newWorktree"},
			expectedOut:     "keybinding:\n  worktrees: nonsense\n",
			expectedDidMove: false,
			expectedErr:     "yaml node in path is not a dictionary",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.in)
			actualErr, didMove := MoveYamlKey(&node, test.oldPath, test.newPath)
			if test.expectedErr == "" {
				assert.NoError(t, actualErr)
			} else {
				assert.EqualError(t, actualErr, test.expectedErr)
			}
			out := marshalForTest(t, &node)

			assert.Equal(t, test.expectedOut, out)

			assert.Equal(t, test.expectedDidMove, didMove)
		})
	}
}

func TestWalk_paths(t *testing.T) {
	tests := []struct {
		name          string
		document      string
		expectedPaths []string
	}{
		{
			name:          "empty document",
			document:      "",
			expectedPaths: []string{},
		},
		{
			name:          "scalar",
			document:      "x: 5",
			expectedPaths: []string{"", "x"}, // called with an empty path for the root node
		},
		{
			name:          "nested",
			document:      "foo:\n  x: 5",
			expectedPaths: []string{"", "foo", "foo.x"},
		},
		{
			name:          "deeply nested",
			document:      "foo:\n  bar:\n    baz: 5",
			expectedPaths: []string{"", "foo", "foo.bar", "foo.bar.baz"},
		},
		{
			name:          "array",
			document:      "foo:\n  bar: [3, 7]",
			expectedPaths: []string{"", "foo", "foo.bar", "foo.bar[0]", "foo.bar[1]"},
		},
		{
			name:          "nested arrays",
			document:      "foo:\n  bar: [[3, 7], [8, 9]]",
			expectedPaths: []string{"", "foo", "foo.bar", "foo.bar[0]", "foo.bar[0][0]", "foo.bar[0][1]", "foo.bar[1]", "foo.bar[1][0]", "foo.bar[1][1]"},
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.document)
			paths := []string{}
			err := Walk(&node, func(node *yaml.Node, path string) {
				paths = append(paths, path)
			})

			assert.NoError(t, err)
			assert.Equal(t, test.expectedPaths, paths)
		})
	}
}

func TestWalk_inPlaceChanges(t *testing.T) {
	tests := []struct {
		name        string
		in          string
		callback    func(node *yaml.Node, path string)
		expectedOut string
	}{
		{
			name:     "no change",
			in:       "x: 5",
			callback: func(node *yaml.Node, path string) {},
		},
		{
			name: "change value",
			in:   "x: 5\ny: 3",
			callback: func(node *yaml.Node, path string) {
				if path == "x" {
					node.Value = "7"
				}
			},
			expectedOut: "x: 7\ny: 3\n",
		},
		{
			name: "change nested value",
			in:   "x:\n  y: 5",
			callback: func(node *yaml.Node, path string) {
				if path == "x.y" {
					node.Value = "7"
				}
			},
			expectedOut: "x:\n  y: 7\n",
		},
		{
			name: "change array value",
			in:   "x:\n  - y: 5",
			callback: func(node *yaml.Node, path string) {
				if path == "x[0].y" {
					node.Value = "7"
				}
			},
			expectedOut: "x:\n  - y: 7\n",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.in)
			err := Walk(&node, test.callback)
			assert.NoError(t, err)
			if test.expectedOut == "" {
				unmodifiedOriginal := unmarshalForTest(t, test.in)
				assert.Equal(t, unmodifiedOriginal, node)
			} else {
				result := marshalForTest(t, &node)
				assert.Equal(t, test.expectedOut, result)
			}
		})
	}
}

func TestTransformNode(t *testing.T) {
	transformIntValueToString := func(node *yaml.Node) error {
		if node.Kind == yaml.ScalarNode {
			if node.ShortTag() == "!!int" {
				node.Tag = "!!str"
				return nil
			} else if node.ShortTag() == "!!str" {
				// We have already transformed it,
				return nil
			}
			return fmt.Errorf("Node was of bad type")
		}
		return fmt.Errorf("Node was not a scalar")
	}

	tests := []struct {
		name        string
		in          string
		path        []string
		transform   func(node *yaml.Node) error
		expectedOut string
	}{
		{
			name:      "Path not present",
			in:        "foo: 1",
			path:      []string{"bar"},
			transform: transformIntValueToString,
		},
		{
			name: "Part of path present",
			in: `
foo:
  bar: 2`,
			path:      []string{"foo", "baz"},
			transform: transformIntValueToString,
		},
		{
			name: "Successfully Transforms to string",
			in: `
foo:
  bar: 2`,
			path:      []string{"foo", "bar"},
			transform: transformIntValueToString,
			expectedOut: `foo:
  bar: "2"
`, // Note the trailing newline changes because of how it re-marshalls
		},
		{
			name: "Does nothing when already transformed",
			in: `
foo:
  bar: "2"`,
			path:      []string{"foo", "bar"},
			transform: transformIntValueToString,
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.in)
			err := TransformNode(&node, test.path, test.transform)
			if err != nil {
				t.Fatal(err)
			}
			if test.expectedOut == "" {
				unmodifiedOriginal := unmarshalForTest(t, test.in)
				assert.Equal(t, unmodifiedOriginal, node)
			} else {
				result := marshalForTest(t, &node)
				assert.Equal(t, test.expectedOut, result)
			}
		})
	}
}

func TestRemoveKey(t *testing.T) {
	tests := []struct {
		name                 string
		in                   string
		key                  string
		expectedOut          string
		expectedRemovedKey   string
		expectedRemovedValue string
	}{
		{
			name: "Key not present",
			in:   "foo: 1",
			key:  "bar",
		},
		{
			name:                 "Key present",
			in:                   "foo: 1\nbar: 2\nbaz: 3\n",
			key:                  "bar",
			expectedOut:          "foo: 1\nbaz: 3\n",
			expectedRemovedKey:   "bar",
			expectedRemovedValue: "2",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			node := unmarshalForTest(t, test.in)
			removedKey, removedValue := RemoveKey(node.Content[0], test.key)
			if test.expectedOut == "" {
				unmodifiedOriginal := unmarshalForTest(t, test.in)
				assert.Equal(t, unmodifiedOriginal, node)
			} else {
				result := marshalForTest(t, &node)
				assert.Equal(t, test.expectedOut, result)
			}
			if test.expectedRemovedKey == "" {
				assert.Nil(t, removedKey)
			} else {
				assert.Equal(t, test.expectedRemovedKey, removedKey.Value)
			}
			if test.expectedRemovedValue == "" {
				assert.Nil(t, removedValue)
			} else {
				assert.Equal(t, test.expectedRemovedValue, removedValue.Value)
			}
		})
	}
}

func unmarshalForTest(t *testing.T, input string) yaml.Node {
	t.Helper()
	var node yaml.Node
	err := yaml.Unmarshal([]byte(input), &node)
	if err != nil {
		t.Fatal(err)
	}
	return node
}

func marshalForTest(t *testing.T, node *yaml.Node) string {
	t.Helper()
	result, err := YamlMarshal(node)
	if err != nil {
		t.Fatal(err)
	}
	return string(result)
}