add_test.go

package cmd

import (
	"path/filepath"
	"testing"

	"github.com/spf13/cobra"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/twpayne/go-vfs/vfst"

	"github.com/twpayne/chezmoi/internal/chezmoi"
)

func TestAddAfterModification(t *testing.T) {
	fs, cleanup, err := vfst.NewTestFS(map[string]interface{}{
		"/home/user":                      &vfst.Dir{Perm: 0o755},
		"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
		"/home/user/.bashrc":              "# contents of .bashrc\n",
	})
	require.NoError(t, err)
	defer cleanup()
	c := newTestConfig(fs)
	args := []string{"/home/user/.bashrc"}
	assert.NoError(t, c.runAddCmd(nil, args))
	vfst.RunTests(t, fs, "",
		vfst.TestPath("/home/user/.local/share/chezmoi/dot_bashrc",
			vfst.TestModeIsRegular,
			vfst.TestContentsString("# contents of .bashrc\n"),
		),
	)
	assert.NoError(t, fs.WriteFile("/home/user/.bashrc", []byte("# new contents of .bashrc\n"), 0o644))
	assert.NoError(t, c.runAddCmd(nil, args))
	vfst.RunTests(t, fs, "",
		vfst.TestPath("/home/user/.local/share/chezmoi/dot_bashrc",
			vfst.TestModeIsRegular,
			vfst.TestContentsString("# new contents of .bashrc\n"),
		),
	)
}

func TestAddCommand(t *testing.T) {
	for _, tc := range []struct {
		name   string
		args   []string
		add    addCmdConfig
		follow bool
		root   interface{}
		tests  interface{}
	}{
		{
			name: "add_dir",
			args: []string{"/home/user/.config/htop"},
			root: map[string]interface{}{
				"/home/user/.config/htop": &vfst.Dir{Perm: 0o755},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi",
					vfst.TestIsDir,
					vfst.TestModePerm(0o700),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config",
					vfst.TestIsDir,
					vfst.TestModePerm(0o755),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/htop",
					vfst.TestIsDir,
					vfst.TestModePerm(0o755),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/htop/.keep",
					vfst.TestModeIsRegular,
					vfst.TestModePerm(0o644),
					vfst.TestContents(nil),
				),
			},
		},
		{
			name: "add_non_empty_dir",
			args: []string{"/home/user/.config/htop"},
			root: map[string]interface{}{
				"/home/user/.config/htop": map[string]interface{}{
					"foo": "bar",
				},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi",
					vfst.TestIsDir,
					vfst.TestModePerm(0o700),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config",
					vfst.TestIsDir,
					vfst.TestModePerm(0o755),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/htop",
					vfst.TestIsDir,
					vfst.TestModePerm(0o755),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/htop/.keep",
					vfst.TestModeIsRegular,
					vfst.TestModePerm(0o644),
					vfst.TestContents(nil),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/htop/foo",
					vfst.TestDoesNotExist,
				),
			},
		},
		{
			name: "add_first_file",
			args: []string{"/home/user/.bashrc"},
			root: map[string]interface{}{
				"/home/user/.bashrc": "foo",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi",
					vfst.TestIsDir,
					vfst.TestModePerm(0o700),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_bashrc",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("foo"),
				),
			},
		},
		{
			name: "add_autotemplate",
			args: []string{"/home/user/.gitconfig"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					AutoTemplate: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/.gitconfig":           "[user]\n\tname = John Smith\n\temail = john.smith@company.com\n",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_gitconfig.tmpl",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("[user]\n\tname = {{ .name }}\n\temail = {{ .email }}\n"),
				),
			},
		},
		{
			name: "add_autotemplate_escape",
			args: []string{"/home/user/.vimrc"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					AutoTemplate: true,
				},
			},
			root: map[string]interface{}{
				"/home/user": map[string]interface{}{
					".local/share/chezmoi": &vfst.Dir{Perm: 0o700},
					".vimrc":               "vim: set foldmethod=marker foldmarker={{,}}",
				},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_vimrc.tmpl",
					vfst.TestModeIsRegular,
					vfst.TestContentsString(`vim: set foldmethod=marker foldmarker={{ "{{" }},{{ "}}" }}`),
				),
			},
		},
		{
			// Test for PR #393
			// Ensure that auto template generating is disabled by default
			name: "add_autotemplate_off_by_default",
			args: []string{"/home/user/.gitconfig"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Template: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/.gitconfig":           "[user]\n\tname = John Smith\n\temail = john.smith@company.com\n",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_gitconfig.tmpl",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("[user]\n\tname = John Smith\n\temail = john.smith@company.com\n"),
				),
			},
		},
		{
			name: "add_recursive",
			args: []string{"/home/user/.config"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Recursive: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                             &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi":        &vfst.Dir{Perm: 0o700},
				"/home/user/.config/micro/settings.json": "{}",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/micro/settings.json",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("{}"),
				),
			},
		},
		{
			name: "add_nested_directory",
			args: []string{"/home/user/.config/micro/settings.json"},
			root: map[string]interface{}{
				"/home/user":                             &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi":        &vfst.Dir{Perm: 0o700},
				"/home/user/.config/micro/settings.json": "{}",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/dot_config/micro/settings.json",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("{}"),
				),
			},
		},
		{
			name: "add_exact_dir",
			args: []string{"/home/user/dir"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Exact: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/dir":                  &vfst.Dir{Perm: 0o755},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/exact_dir",
					vfst.TestIsDir,
				),
			},
		},
		{
			name: "add_exact_dir_recursive",
			args: []string{"/home/user/dir"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Exact:     true,
					Recursive: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/dir": map[string]interface{}{
					"foo": "bar",
				},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/exact_dir",
					vfst.TestIsDir,
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/exact_dir/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bar"),
				),
			},
		},
		{
			name: "add_empty_file",
			args: []string{"/home/user/empty"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Empty: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/empty":                "",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/empty_empty",
					vfst.TestModeIsRegular,
					vfst.TestContents(nil),
				),
			},
		},
		{
			name: "add_empty_file_in_subdir",
			args: []string{"/home/user/subdir/empty"},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/subdir/empty":         "",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/subdir",
					vfst.TestIsDir,
				),
			},
		},
		{
			name: "add_symlink",
			args: []string{"/home/user/foo"},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/foo":                  &vfst.Symlink{Target: "bar"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/symlink_foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bar"),
				),
			},
		},
		{
			name:   "add_followed_symlink",
			args:   []string{"/home/user/foo"},
			follow: true,
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/foo":                  &vfst.Symlink{Target: "bar"},
				"/home/user/bar":                  "bux",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bux"),
				),
			},
		},
		{
			name:   "add_symlink_follow",
			args:   []string{"/home/user/foo"},
			follow: true,
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/.dotfiles/foo":        "bar",
				"/home/user/foo":                  &vfst.Symlink{Target: ".dotfiles/foo"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bar"),
				),
			},
		},
		{
			name: "add_symlink_no_follow",
			args: []string{"/home/user/foo"},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/.dotfiles/foo":        "bar",
				"/home/user/foo":                  &vfst.Symlink{Target: ".dotfiles/foo"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/symlink_foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString(filepath.FromSlash(".dotfiles/foo")),
				),
			},
		},
		{
			name:   "add_symlink_follow_double",
			args:   []string{"/home/user/foo"},
			follow: true,
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/.dotfiles/baz":        "qux",
				"/home/user/foo":                  &vfst.Symlink{Target: "bar"},
				"/home/user/bar":                  &vfst.Symlink{Target: ".dotfiles/baz"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("qux"),
				),
			},
		},
		{
			name: "add_symlink_in_dir_recursive",
			args: []string{"/home/user/foo"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Recursive: true,
				},
			},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/foo/bar":              &vfst.Symlink{Target: "baz"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestIsDir,
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/foo/symlink_bar",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("baz"),
				),
			},
		},
		{
			name: "add_symlink_with_parent_dir",
			args: []string{"/home/user/foo/bar/baz"},
			root: map[string]interface{}{
				"/home/user":                      &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
				"/home/user/foo/bar/baz":          &vfst.Symlink{Target: "qux"},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestIsDir,
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/foo/bar",
					vfst.TestIsDir,
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/foo/bar/symlink_baz",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("qux"),
				),
			},
		},
		{
			name: "dont_add_ignored_file",
			args: []string{"/home/user/foo"},
			root: map[string]interface{}{
				"/home/user": &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{
					Perm: 0o700,
					Entries: map[string]interface{}{
						".chezmoiignore": "foo\n",
					},
				},
				"/home/user/foo": "bar",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestDoesNotExist,
				),
			},
		},
		{
			name: "dont_add_ignored_file_recursive",
			args: []string{"/home/user/foo"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Recursive: true,
				},
			},
			root: map[string]interface{}{
				"/home/user": &vfst.Dir{Perm: 0o755},
				"/home/user/.local/share/chezmoi": &vfst.Dir{
					Perm: 0o700,
					Entries: map[string]interface{}{
						"exact_foo/.chezmoiignore": "bar/qux\n",
					},
				},
				"/home/user/foo/bar": map[string]interface{}{
					"baz": "baz",
					"qux": "quz",
				},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/exact_foo/bar/baz",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("baz"),
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/exact_foo/bar/qux",
					vfst.TestDoesNotExist,
				),
			},
		},
		{
			name: "remove_existing_source_without_empty",
			args: []string{"/home/user/foo"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Empty: false,
				},
			},
			root: map[string]interface{}{
				"/home/user/foo":                      "",
				"/home/user/.local/share/chezmoi/foo": "bar",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestDoesNotExist,
				),
			},
		},
		{
			name: "replace_existing_source_with_empty",
			args: []string{"/home/user/foo"},
			add: addCmdConfig{
				options: chezmoi.AddOptions{
					Empty: true,
				},
			},
			root: map[string]interface{}{
				"/home/user/foo":                      "",
				"/home/user/.local/share/chezmoi/foo": "bar",
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi/empty_foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString(""),
				),
			},
		},
		{
			name: "dest_dir_is_symlink",
			args: []string{"/home/user/foo"},
			root: []interface{}{
				map[string]interface{}{
					"/local/home/user/.local/share/chezmoi": &vfst.Dir{Perm: 0o700},
					"/local/home/user/foo":                  "bar",
				},
				map[string]interface{}{
					"/home/user": &vfst.Symlink{Target: "../local/home/user"},
				},
			},
			tests: []vfst.Test{
				vfst.TestPath("/home/user/.local/share/chezmoi",
					vfst.TestIsDir,
				),
				vfst.TestPath("/home/user/.local/share/chezmoi/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bar"),
				),
				vfst.TestPath("/local/home/user/.local/share/chezmoi",
					vfst.TestIsDir,
				),
				vfst.TestPath("/local/home/user/.local/share/chezmoi/foo",
					vfst.TestModeIsRegular,
					vfst.TestContentsString("bar"),
				),
			},
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			fs, cleanup, err := vfst.NewTestFS(tc.root)
			require.NoError(t, err)
			defer cleanup()
			c := newTestConfig(
				fs,
				withFollow(tc.follow),
				withData(map[string]interface{}{
					"name":  "John Smith",
					"email": "john.smith@company.com",
				}),
				withAddCmdConfig(tc.add),
			)
			assert.NoError(t, c.runAddCmd(&cobra.Command{}, tc.args))
			vfst.RunTests(t, fs, "", tc.tests)
		})
	}
}

func TestIssue192(t *testing.T) {
	root := []interface{}{
		map[string]interface{}{
			"/local/home/user": &vfst.Dir{
				Perm: 0o750,
				Entries: map[string]interface{}{
					".local/share/chezmoi": &vfst.Dir{Perm: 0o700},
					"snoop/.list":          "# contents of .list\n",
				},
			},
		},
		map[string]interface{}{
			"/home/user": &vfst.Symlink{Target: "/local/home/user/"},
		},
	}
	fs, cleanup, err := vfst.NewTestFS(root)
	require.NoError(t, err)
	defer cleanup()
	c := newTestConfig(fs)
	assert.NoError(t, c.runAddCmd(nil, []string{"/home/user/snoop/.list"}))
	vfst.RunTests(t, fs, "",
		vfst.TestPath("/local/home/user/.local/share/chezmoi/snoop/dot_list",
			vfst.TestModeIsRegular,
			vfst.TestContentsString("# contents of .list\n"),
		),
	)
}