Make coder dotfiles symlinking idempotent (coder#7525)

spikecurtis · web-flow · commit 0b156420dee2 · 2023-05-15T21:00:50.000+04:00
Signed-off-by: Spike Curtis &lt;spike@coder.com&gt;
diff --git a/cli/dotfiles.go b/cli/dotfiles.go
@@ -225,6 +225,10 @@ func (r *RootCmd) dotfiles() *clibase.Cmd {
 					}
 				}
 
+				// attempt to delete the file before creating a new symlink.  This overwrites any existing symlinks
+				// which are typically leftover from a previous call to coder dotfiles.  We do this best effort and
+				// ignore errors because the symlink may or may not exist.  Any regular files are backed up above.
+				_ = os.Remove(to)
 				err = os.Symlink(from, to)
 				if err != nil {
 					return xerrors.Errorf("symlinking %s to %s: %w", from, to, err)
diff --git a/cli/dotfiles_test.go b/cli/dotfiles_test.go
@@ -116,6 +116,17 @@ func TestDotfiles(t *testing.T) {
 		b, err = os.ReadFile(filepath.Join(string(root), ".bashrc.bak"))
 		require.NoError(t, err)
 		require.Equal(t, string(b), "backup")
+
+		// check for idempotency
+		inv, _ = clitest.New(t, "dotfiles", "--global-config", string(root), "--symlink-dir", string(root), "-y", testRepo)
+		err = inv.Run()
+		require.NoError(t, err)
+		b, err = os.ReadFile(filepath.Join(string(root), ".bashrc"))
+		require.NoError(t, err)
+		require.Equal(t, string(b), "wow")
+		b, err = os.ReadFile(filepath.Join(string(root), ".bashrc.bak"))
+		require.NoError(t, err)
+		require.Equal(t, string(b), "backup")
 	})
 }
 

Original file line number	Diff line number	Diff line change
`@@ -225,6 +225,10 @@ func (r RootCmd) dotfiles() clibase.Cmd {`
`225`	`225`	`}`
`226`	`226`	`}`
`227`	`227`
	`228`	`+ // attempt to delete the file before creating a new symlink. This overwrites any existing symlinks`
	`229`	`+ // which are typically leftover from a previous call to coder dotfiles. We do this best effort and`
	`230`	`+ // ignore errors because the symlink may or may not exist. Any regular files are backed up above.`
	`231`	`+ _ = os.Remove(to)`
`228`	`232`	`err = os.Symlink(from, to)`
`229`	`233`	`if err != nil {`
`230`	`234`	`return xerrors.Errorf("symlinking %s to %s: %w", from, to, err)`