coder · f0ssel · May 25, 2022 · May 23, 2022 · May 23, 2022 · May 24, 2022
diff --git a/cli/dotfiles.go b/cli/dotfiles.go
@@ -0,0 +1,212 @@
+package cli
+
+import (
+	"fmt"
+	"io/fs"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	"github.com/spf13/cobra"
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/cli/cliflag"
+	"github.com/coder/coder/cli/cliui"
+)
+
+func dotfiles() *cobra.Command {
+	var (
+		homeDir string
+	)
+	cmd := &cobra.Command{
+		Use:     "dotfiles [git_repo_url]",
+		Args:    cobra.ExactArgs(1),
+		Short:   "Checkout and install a dotfiles repository.",
+		Example: "coder dotfiles [-y] git@github.com:example/dotfiles.git",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var (
+				dotfilesRepoDir = "dotfiles"
+				gitRepo         = args[0]
+				cfgDir          = string(createConfig(cmd))
+				dotfilesDir     = filepath.Join(cfgDir, dotfilesRepoDir)
+				subcommands     = []string{"clone", args[0], dotfilesRepoDir}
+				gitCmdDir       = cfgDir
+				promptText      = fmt.Sprintf("Cloning %s into directory %s.\n  Continue?", gitRepo, dotfilesDir)
+				// This follows the same pattern outlined by others in the market:
+				// https://github.com/coder/coder/pull/1696#issue-1245742312
+				installScriptSet = []string{
+					"install.sh",
+					"install",
+					"bootstrap.sh",
+					"bootstrap",
+					"script/bootstrap",
+					"setup.sh",
+					"setup",
+					"script/setup",
+				}
+			)
+
+			_, _ = fmt.Fprint(cmd.OutOrStdout(), "Checking if dotfiles repository already exists...\n")
+			dotfilesExists, err := dirExists(dotfilesDir)
+			if err != nil {
+				return xerrors.Errorf("checking dir %s: %w", dotfilesDir, err)
+			}
+
+			// if repo exists already do a git pull instead of clone
+			if dotfilesExists {
+				_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Found dotfiles repository at %s\n", dotfilesDir)
+				gitCmdDir = dotfilesDir
+				subcommands = []string{"pull", "--ff-only"}
+				promptText = fmt.Sprintf("Pulling latest from %s into directory %s.\n  Continue?", gitRepo, dotfilesDir)
+			} else {
+				_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Did not find dotfiles repository at %s\n", dotfilesDir)
 			}
+
+			_, err = cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      promptText,
+				IsConfirm: true,
+			})
+			if err != nil {
+				return err
+			}
+
+			// ensure config dir exists
+			err = os.MkdirAll(gitCmdDir, 0750)
+			if err != nil {
+				return xerrors.Errorf("ensuring dir at %s: %w", gitCmdDir, err)
+			}
+
+			// check if git ssh command already exists so we can just wrap it
+			gitsshCmd := os.Getenv("GIT_SSH_COMMAND")
+			if gitsshCmd == "" {
+				gitsshCmd = "ssh"
+			}
+
+			// clone or pull repo
+			c := exec.CommandContext(cmd.Context(), "git", subcommands...)
+			c.Dir = gitCmdDir
+			c.Env = append(os.Environ(), fmt.Sprintf(`GIT_SSH_COMMAND=%s -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no`, gitsshCmd))
+			out, err := c.CombinedOutput()
+			if err != nil {
+				_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Error.Render(string(out)))
+				return err
+			}
+			_, _ = fmt.Fprintln(cmd.OutOrStdout(), string(out))
+
+			files, err := os.ReadDir(dotfilesDir)
+			if err != nil {
+				return xerrors.Errorf("reading files in dir %s: %w", dotfilesDir, err)
+			}
+
+			var dotfiles []string
+			for _, f := range files {
+				// make sure we do not copy `.git*` files
+				if strings.HasPrefix(f.Name(), ".") && !strings.HasPrefix(f.Name(), ".git") {
+					dotfiles = append(dotfiles, f.Name())
+				}
+			}
+
+			script := findScript(installScriptSet, files)
+			if script == "" {
+				if len(dotfiles) == 0 {
+					_, _ = fmt.Fprintln(cmd.OutOrStdout(), "No install scripts or dotfiles found, nothing to do.")
+					return nil
+				}
+
+				_, err = cliui.Prompt(cmd, cliui.PromptOptions{
+					Text:      "No install scripts found, symlinking dotfiles to home directory.\n\n  Continue?",
+					IsConfirm: true,
+				})
+				if err != nil {
+					return err
+				}
+
+				if homeDir == "" {
+					homeDir, err = os.UserHomeDir()
+					if err != nil {
+						return xerrors.Errorf("getting user home: %w", err)
+					}
+				}
+
+				for _, df := range dotfiles {
+					from := filepath.Join(dotfilesDir, df)
+					to := filepath.Join(homeDir, df)
+					_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Symlinking %s to %s...\n", from, to)
+					// if file already exists at destination remove it
+					// this behavior matches `ln -f`
+					_, err := os.Lstat(to)
+					if err == nil {
+						err := os.Remove(to)
+						if err != nil {
+							return xerrors.Errorf("removing destination file %s: %w", to, err)
+						}
+					}
+
+					err = os.Symlink(from, to)
+					if err != nil {
+						return xerrors.Errorf("symlinking %s to %s: %w", from, to, err)
+					}
+				}
+
+				_, _ = fmt.Fprintln(cmd.OutOrStdout(), "Dotfiles installation complete.")
+				return nil
+			}
+
+			_, err = cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      fmt.Sprintf("Running install script %s.\n\n  Continue?", script),
+				IsConfirm: true,
+			})
+			if err != nil {
+				return err
+			}
+
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), "Running %s...\n", script)
+			// it is safe to use a variable command here because it's from
+			// a filtered list of pre-approved install scripts
+			// nolint:gosec
+			scriptCmd := exec.CommandContext(cmd.Context(), fmt.Sprintf("./%s", script))
+			scriptCmd.Dir = dotfilesDir
+			out, err = scriptCmd.CombinedOutput()
+			if err != nil {
+				_, _ = fmt.Fprintln(cmd.OutOrStdout(), cliui.Styles.Error.Render(string(out)))
+				return xerrors.Errorf("running %s: %w", script, err)
+			}
+			_, _ = fmt.Fprintln(cmd.OutOrStdout(), string(out))
+
+			_, _ = fmt.Fprintln(cmd.OutOrStdout(), "Dotfiles installation complete.")
+			return nil
+		},
+	}
+	cliui.AllowSkipPrompt(cmd)
+	cliflag.StringVarP(cmd.Flags(), &homeDir, "home-dir", "", "CODER_HOME_DIR", "", "Specifies the home directory for the dotfiles symlink destination. If empty will use $HOME.")
+
+	return cmd
+}
+
+// dirExists checks if the dir already exists.
+func dirExists(name string) (bool, error) {
+	_, err := os.Stat(name)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return false, nil
+		}
+
+		return false, xerrors.Errorf("stat dir: %w", err)
+	}
+
+	return true, nil
+}
+
+// findScript will find the first file that matches the script set.
+func findScript(scriptSet []string, files []fs.DirEntry) string {
+	for _, i := range scriptSet {
+		for _, f := range files {
+			if f.Name() == i {
+				return f.Name()
+			}
+		}
+	}
+
+	return ""
+}
diff --git a/cli/dotfiles_test.go b/cli/dotfiles_test.go
@@ -0,0 +1,88 @@
+package cli_test
+
+import (
+	"os"
+	"os/exec"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+    
+	"github.com/coder/coder/cli/clitest"
+)
+
+// nolint:paralleltest
+func TestDotfiles(t *testing.T) {
+	t.Run("MissingArg", func(t *testing.T) {
+		cmd, _ := clitest.New(t, "dotfiles")
+		err := cmd.Execute()
+		assert.Error(t, err)
+	})
+	t.Run("NoInstallScript", func(t *testing.T) {
+		_, root := clitest.New(t)
+		testRepo := filepath.Join(string(root), "test-repo")
+
+		err := os.MkdirAll(testRepo, 0750)
+		assert.NoError(t, err)
+
+		c := exec.Command("git", "init")
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		// nolint:gosec
+		err = os.WriteFile(filepath.Join(testRepo, ".bashrc"), []byte("wow"), 0750)
+		assert.NoError(t, err)
+
+		c = exec.Command("git", "add", ".bashrc")
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		c = exec.Command("git", "commit", "-m", `"add .bashrc"`)
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		cmd, _ := clitest.New(t, "dotfiles", "--global-config", string(root), "--home-dir", string(root), "-y", testRepo)
+		err = cmd.Execute()
+		assert.NoError(t, err)
+
+		b, err := os.ReadFile(filepath.Join(string(root), ".bashrc"))
+		assert.NoError(t, err)
+		assert.Equal(t, string(b), "wow")
+	})
+	t.Run("InstallScript", func(t *testing.T) {
+		_, root := clitest.New(t)
+		testRepo := filepath.Join(string(root), "test-repo")
+		err := os.MkdirAll(testRepo, 0750)
+		assert.NoError(t, err)
+
+		c := exec.Command("git", "init")
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		// nolint:gosec
+		err = os.WriteFile(filepath.Join(testRepo, "install.sh"), []byte("#!/bin/bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0750)
+		assert.NoError(t, err)
+
+		c = exec.Command("git", "add", "install.sh")
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		c = exec.Command("git", "commit", "-m", `"add install.sh"`)
+		c.Dir = testRepo
+		err = c.Run()
+		assert.NoError(t, err)
+
+		cmd, _ := clitest.New(t, "dotfiles", "--global-config", string(root), "--home-dir", string(root), "-y", testRepo)
+		err = cmd.Execute()
+		assert.NoError(t, err)
+
+		b, err := os.ReadFile(filepath.Join(string(root), ".bashrc"))
+		assert.NoError(t, err)
+		assert.Equal(t, string(b), "wow\n")
+	})
+}
diff --git a/cli/root.go b/cli/root.go
@@ -69,6 +69,7 @@ func Root() *cobra.Command {
 		configSSH(),
 		create(),
 		delete(),
+		dotfiles(),
 		gitssh(),
 		list(),
 		login(),