feat: generalize HOMEDIR management and respect XDG_CONFIG_HOME, fixes #5807

.buildkite/test.sh

@@ -192,9 +192,13 @@ fi
 # Make sure we start with mutagen daemon off.
 unset MUTAGEN_DATA_DIRECTORY
 if [ -f ~/.ddev/bin/mutagen -o -f ~/.ddev/bin/mutagen.exe ]; then
+  # This line can be removed when ~/.ddev/.mdd is well established in master, probably July 2024
   MUTAGEN_DATA_DIRECTORY=~/.ddev_mutagen_data_directory/ ~/.ddev/bin/mutagen sync terminate -a || true
+  MUTAGEN_DATA_DIRECTORY=~/.ddev/.mdd/ ~/.ddev/bin/mutagen sync terminate -a || true
   MUTAGEN_DATA_DIRECTORY=~/.mutagen ~/.ddev/bin/mutagen daemon stop || true
+  # This line can be removed when ~/.ddev/.mdd is well established in master, probably July 2024
   MUTAGEN_DATA_DIRECTORY=~/.ddev_mutagen_data_directory/ ~/.ddev/bin/mutagen daemon stop || true
+  MUTAGEN_DATA_DIRECTORY=~/.ddev/.mdd/ ~/.ddev/bin/mutagen daemon stop || true
 fi
 if command -v killall >/dev/null ; then
   killall mutagen || true

.spellcheckwordlist.txt

@@ -163,6 +163,7 @@ WSL2
 WantedBy
 Webhosting
 XDebug
+XDG
 Xhprof
 Zoho
 XSym

cmd/ddev/cmd/autocompletion_test.go

@@ -1,16 +1,18 @@
 package cmd
 
 import (
-	"github.com/ddev/ddev/pkg/dockerutil"
 	"os"
 	"path/filepath"
 	"runtime"
 	"strings"
 	"testing"
 
 	"github.com/ddev/ddev/pkg/ddevapp"
+	"github.com/ddev/ddev/pkg/dockerutil"
 	"github.com/ddev/ddev/pkg/exec"
 	"github.com/ddev/ddev/pkg/fileutil"
+	"github.com/ddev/ddev/pkg/globalconfig"
+	"github.com/ddev/ddev/pkg/testcommon"
 	asrt "github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -225,8 +227,7 @@ func TestAutocompletionForCustomCmds(t *testing.T) {
 	app, err := ddevapp.NewApp("", false)
 	assert.NoError(err)
 
-	tmpHome, _, err := makeTempHomeDir(app, t)
-	require.NoError(t, err)
+	tmpXdgConfigHomeDir := testcommon.CopyGlobalDdevDir(t)
 
 	testdataCustomCommandsDir := filepath.Join(origDir, "testdata", t.Name())
 
@@ -235,20 +236,13 @@ func TestAutocompletionForCustomCmds(t *testing.T) {
 		assert.NoError(err)
 		err = app.Stop(true, false)
 		assert.NoError(err)
-		// Stop the Mutagen daemon running in the bogus homedir
-		ddevapp.StopMutagenDaemon()
-		_ = os.RemoveAll(tmpHome)
+		testcommon.ResetGlobalDdevDir(t, tmpXdgConfigHomeDir)
 		_ = fileutil.PurgeDirectory(filepath.Join(site.Dir, ".ddev", "commands"))
 	})
 	err = app.Start()
 	require.NoError(t, err)
 
-	// We can't use the standard getGlobalDDevDir here because *our* global hasn't changed.
-	// It's changed via $HOME for the DDEV subprocess
-	err = os.MkdirAll(filepath.Join(tmpHome, ".ddev"), 0755)
-	assert.NoError(err)
-
-	tmpHomeGlobalCommandsDir := filepath.Join(tmpHome, ".ddev", "commands")
+	tmpHomeGlobalCommandsDir := filepath.Join(globalconfig.GetGlobalDdevDir(), "commands")
 	projectCommandsDir := app.GetConfigPath("commands")
 
 	// Remove existing commands
@@ -299,8 +293,7 @@ func TestAutocompleteTermsForCustomCmds(t *testing.T) {
 	app, err := ddevapp.NewApp("", false)
 	assert.NoError(err)
 
-	tmpHome, _, err := makeTempHomeDir(app, t)
-	require.NoError(t, err)
+	tmpXdgConfigHomeDir := testcommon.CopyGlobalDdevDir(t)
 
 	testdataCustomCommandsDir := filepath.Join(origDir, "testdata", t.Name())
 
@@ -309,20 +302,13 @@ func TestAutocompleteTermsForCustomCmds(t *testing.T) {
 		assert.NoError(err)
 		err = app.Stop(true, false)
 		assert.NoError(err)
-		// Stop the Mutagen daemon running in the bogus homedir
-		ddevapp.StopMutagenDaemon()
-		_ = os.RemoveAll(tmpHome)
+		testcommon.ResetGlobalDdevDir(t, tmpXdgConfigHomeDir)
 		_ = fileutil.PurgeDirectory(filepath.Join(site.Dir, ".ddev", "commands"))
 	})
 	err = app.Start()
 	require.NoError(t, err)
 
-	// We can't use the standard getGlobalDDevDir here because *our* global hasn't changed.
-	// It's changed via $HOME for the DDEV subprocess
-	err = os.MkdirAll(filepath.Join(tmpHome, ".ddev"), 0755)
-	assert.NoError(err)
-
-	tmpHomeGlobalCommandsDir := filepath.Join(tmpHome, ".ddev", "commands")
+	tmpHomeGlobalCommandsDir := filepath.Join(globalconfig.GetGlobalDdevDir(), "commands")
 	projectCommandsDir := app.GetConfigPath("commands")
 
 	// Remove existing commands

cmd/ddev/cmd/commands_test.go

@@ -35,8 +35,7 @@ func TestCustomCommands(t *testing.T) {
 	app, err := ddevapp.NewApp("", false)
 	assert.NoError(err)
 
-	tmpHome, origHome, err := makeTempHomeDir(app, t)
-	require.NoError(t, err)
+	tmpXdgConfigHomeDir := testcommon.CopyGlobalDdevDir(t)
 
 	testdataCustomCommandsDir := filepath.Join(origDir, "testdata", t.Name())
 
@@ -46,24 +45,18 @@ func TestCustomCommands(t *testing.T) {
 		assert.NoError(err)
 		err = app.Stop(true, false)
 		assert.NoError(err)
-		// Stop the Mutagen daemon running in the bogus homedir
-		ddevapp.StopMutagenDaemon()
+		testcommon.ResetGlobalDdevDir(t, tmpXdgConfigHomeDir)
 		runTime()
 		app.Type = origType
 		err = app.WriteConfig()
 		assert.NoError(err)
-		_ = os.RemoveAll(tmpHome)
 		_ = fileutil.PurgeDirectory(filepath.Join(site.Dir, ".ddev", "commands"))
 	})
 	// We must start the app before copying commands, so they don't get copied over
 	err = app.Start()
 	require.NoError(t, err)
 
-	// We can't use the standard getGlobalDDevDir here because *our* global hasn't changed.
-	// It's changed via $HOME for the DDEV subprocess
-	err = os.MkdirAll(filepath.Join(tmpHome, ".ddev"), 0755)
-	assert.NoError(err)
-	tmpHomeGlobalCommandsDir := filepath.Join(tmpHome, ".ddev", "commands")
+	tmpHomeGlobalCommandsDir := filepath.Join(globalconfig.GetGlobalDdevDir(), "commands")
 	err = os.RemoveAll(tmpHomeGlobalCommandsDir)
 	assert.NoError(err)
 
@@ -76,7 +69,7 @@ func TestCustomCommands(t *testing.T) {
 	assert.NoError(err)
 
 	// We need to run some assertions outside of the context of a project first
-	err = os.Chdir(tmpHome)
+	err = os.Chdir(tmpXdgConfigHomeDir)
 	require.NoError(t, err)
 
 	// Check that only global host commands with the XXX annotation display here
@@ -299,10 +292,6 @@ func TestCustomCommands(t *testing.T) {
 		assert.FileExists(filepath.Join(projectCommandsDir, f))
 	}
 
-	// Make sure we haven't accidentally created anything inappropriate in ~/.ddev
-	assert.False(fileutil.FileExists(filepath.Join(tmpHome, ".ddev", ".globalcommands")))
-	assert.False(fileutil.FileExists(filepath.Join(origHome, ".ddev", ".globalcommands")))
-
 	// Make sure that the old launch, mysql, and xdebug commands aren't in the project directory
 	for _, command := range []string{"db/mysql", "host/launch", "web/xdebug"} {
 		cmdPath := app.GetConfigPath(filepath.Join("commands", command))
@@ -535,49 +524,3 @@ func TestNpmYarnCommands(t *testing.T) {
 		require.NoError(t, err)
 	}
 }
-
-// makeTempHomeDir makes a temporary home directory named for the test being executed.
-// Don't forget to run `ddevapp.StopMutagenDaemon()` and `os.RemoveAll(tmpHome)` in the
-// test's cleanup function.
-func makeTempHomeDir(app *ddevapp.DdevApp, t *testing.T) (string, string, error) {
-	// Before changing HOME, make sure that Mutagen is already running if we are using it,
-	// so we don't accidentally start it in the wrong directory
-	err := globalconfig.ReadGlobalConfig()
-	if err != nil {
-		return "", "", err
-	}
-	if globalconfig.DdevGlobalConfig.IsMutagenEnabled() {
-		out, err := exec.RunHostCommand(globalconfig.GetMutagenPath(), "daemon", "start")
-		if err != nil {
-			return "", "", fmt.Errorf("unable to run Mutagen daemon start, out='%s', err=%v", out, err)
-		}
-	}
-
-	// Must be stopped before changing homedir or Mutagen will lose track
-	// of sessions which are also tracked in the homedir.
-	err = app.Stop(true, false)
-	if err != nil {
-		return "", "", err
-	}
-
-	origHome, err := os.UserHomeDir()
-	require.NoError(t, err)
-	if runtime.GOOS == "windows" {
-		origHome = os.Getenv("USERPROFILE")
-	}
-
-	tmpHome := testcommon.CreateTmpDir(t.Name() + "-tempHome")
-
-	// Change the homedir temporarily
-	t.Setenv("HOME", tmpHome)
-	t.Setenv("USERPROFILE", tmpHome)
-	t.Setenv("DDEV_DEBUG", "")
-
-	// Make sure we have the .ddev/bin dir we need
-	err = fileutil.CopyDir(filepath.Join(origHome, ".ddev/bin"), filepath.Join(tmpHome, ".ddev/bin"))
-	if err != nil {
-		return "", "", err
-	}
-
-	return tmpHome, origHome, nil
-}

cmd/ddev/cmd/config_test.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	copy2 "github.com/otiai10/copy"
 	"os"
 	"path/filepath"
 	"reflect"
@@ -16,6 +15,7 @@ import (
 	"github.com/ddev/ddev/pkg/globalconfig"
 	"github.com/ddev/ddev/pkg/nodeps"
 	"github.com/ddev/ddev/pkg/testcommon"
+	copy2 "github.com/otiai10/copy"
 	asrt "github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"gopkg.in/yaml.v3"
@@ -651,6 +651,9 @@ func TestConfigGitignore(t *testing.T) {
 
 	origDir, _ := os.Getwd()
 
+	tmpXdgConfigHomeDir := testcommon.CopyGlobalDdevDir(t)
+	globalDdevDir := globalconfig.GetGlobalDdevDir()
+
 	// Create a temporary directory and switch to it.
 	testDir := testcommon.CreateTmpDir(t.Name())
 
@@ -664,8 +667,7 @@ func TestConfigGitignore(t *testing.T) {
 		assert.NoError(err)
 		err = os.Chdir(origDir)
 		assert.NoError(err)
-		_, err = exec.RunHostCommand("bash", "-c", fmt.Sprintf("rm -f ~/.ddev/commands/web/%s ~/.ddev/homeadditions/%s", t.Name(), t.Name()))
-		assert.NoError(err)
+		testcommon.ResetGlobalDdevDir(t, tmpXdgConfigHomeDir)
 		_ = os.RemoveAll(testDir)
 	})
 
@@ -682,10 +684,10 @@ func TestConfigGitignore(t *testing.T) {
 	out = strings.ReplaceAll(out, "new file:   .ddev/config.yaml", "")
 	assert.NotContains(out, "new file:")
 
-	_, err = exec.RunHostCommand("bash", "-c", fmt.Sprintf("touch ~/.ddev/commands/web/%s ~/.ddev/homeadditions/%s", t.Name(), t.Name()))
+	_, err = exec.RunHostCommand("bash", "-c", fmt.Sprintf(`touch "/%s" "/%s"`, filepath.Join(globalDdevDir, "commands", "web", t.Name()), filepath.Join(globalDdevDir, "homeadditions", t.Name())))
 	assert.NoError(err)
 	if err != nil {
-		out, err = exec.RunHostCommand("bash", "-c", "ls -l ~/.ddev && ls -lR ~/.ddev/commands ~/.ddev/homeadditions")
+		out, err = exec.RunHostCommand("bash", "-c", fmt.Sprintf(`ls -l "/%s" && ls -lR "/%s" "/%s"`, globalDdevDir, filepath.Join(globalDdevDir, "commands"), filepath.Join(globalDdevDir, "homeadditions")))
 		assert.NoError(err)
 		t.Logf("Contents of global .ddev: \n=====\n%s\n====", out)
 	}

cmd/ddev/cmd/homeadditions_test.go

@@ -6,12 +6,10 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/ddev/ddev/pkg/config/types"
 	"github.com/ddev/ddev/pkg/ddevapp"
 	"github.com/ddev/ddev/pkg/exec"
 	"github.com/ddev/ddev/pkg/fileutil"
 	"github.com/ddev/ddev/pkg/globalconfig"
-	"github.com/ddev/ddev/pkg/nodeps"
 	"github.com/ddev/ddev/pkg/testcommon"
 	asrt "github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -20,32 +18,18 @@ import (
 // TestHomeadditions makes sure that extra files added to
 // .ddev/homeadditions and ~/.ddev/homeadditions get added into the container's ~/
 func TestHomeadditions(t *testing.T) {
-	if nodeps.PerformanceModeDefault == types.PerformanceModeMutagen ||
-		(globalconfig.DdevGlobalConfig.IsMutagenEnabled() &&
-			nodeps.PerformanceModeDefault != types.PerformanceModeNone) ||
-		nodeps.NoBindMountsDefault {
-		t.Skip("Skipping because this changes homedir and breaks Mutagen functionality")
-	}
 	assert := asrt.New(t)
 
 	origDir, _ := os.Getwd()
 	testdata := filepath.Join(origDir, "testdata", t.Name())
 
-	tmpHome := testcommon.CreateTmpDir(t.Name() + "tempHome")
-	// Change the homedir temporarily
-	t.Setenv("HOME", tmpHome)
-	t.Setenv("USERPROFILE", tmpHome)
+	tmpXdgConfigHomeDir := testcommon.CopyGlobalDdevDir(t)
 
+	tmpHomeGlobalHomeadditionsDir := filepath.Join(globalconfig.GetGlobalDdevDir(), "homeadditions")
+	err := os.RemoveAll(tmpHomeGlobalHomeadditionsDir)
+	assert.NoError(err)
 	site := TestSites[0]
 	projectHomeadditionsDir := filepath.Join(site.Dir, ".ddev", "homeadditions")
-
-	// We can't use the standard getGlobalDDevDir here because *our* global hasn't changed.
-	// It's changed via $HOME for the DDEV subprocess
-	err := os.MkdirAll(filepath.Join(tmpHome, ".ddev"), 0755)
-	assert.NoError(err)
-	tmpHomeGlobalHomeadditionsDir := filepath.Join(tmpHome, ".ddev", "homeadditions")
-	err = os.RemoveAll(tmpHomeGlobalHomeadditionsDir)
-	assert.NoError(err)
 	err = os.RemoveAll(projectHomeadditionsDir)
 	assert.NoError(err)
 	err = fileutil.CopyDir(filepath.Join(testdata, "global"), tmpHomeGlobalHomeadditionsDir)
@@ -55,16 +39,10 @@ func TestHomeadditions(t *testing.T) {
 	err = os.Chdir(site.Dir)
 	require.NoError(t, err)
 	t.Cleanup(func() {
-		_, err := os.Stat(globalconfig.GetMutagenPath())
-		if err == nil {
-			out, err := exec.RunHostCommand(DdevBin, "debug", "mutagen", "daemon", "stop")
-			assert.NoError(err, "mutagen daemon stop returned %s", string(out))
-		}
-
 		err = os.Chdir(origDir)
 		assert.NoError(err)
 		_ = fileutil.PurgeDirectory(projectHomeadditionsDir)
-		_ = os.RemoveAll(tmpHome)
+		testcommon.ResetGlobalDdevDir(t, tmpXdgConfigHomeDir)
 	})
 
 	// Before we can symlink global, need to make sure anything is already gone

cmd/ddev/cmd/mutagen-version.go

@@ -0,0 +1,66 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"github.com/ddev/ddev/pkg/globalconfig"
+	"github.com/ddev/ddev/pkg/output"
+	"github.com/ddev/ddev/pkg/styles"
+	"github.com/ddev/ddev/pkg/versionconstants"
+	"github.com/jedib0t/go-pretty/v6/table"
+	"github.com/spf13/cobra"
+	"sort"
+)
+
+// MutagenVersionCmd implements the ddev mutagen version command
+var MutagenVersionCmd = &cobra.Command{
+	Use:     "version",
+	Short:   "Display the version of the Mutagen binary and the location of its components.",
+	Example: `"ddev mutagen version"`,
+	Run: func(_ *cobra.Command, _ []string) {
+
+		v := make(map[string]string)
+		v["version"] = versionconstants.RequiredMutagenVersion
+		v["binary"] = globalconfig.GetMutagenPath()
+		v["enabled"] = fmt.Sprintf("%t", globalconfig.DdevGlobalConfig.IsMutagenEnabled())
+		v["MUTAGEN_DATA_DIRECTORY"] = globalconfig.GetMutagenDataDirectory()
+
+		var out bytes.Buffer
+		t := table.NewWriter()
+		t.SetOutputMirror(&out)
+
+		// Use simplest possible output
+		s := styles.GetTableStyle("default")
+		s.Options.SeparateRows = false
+		s.Options.SeparateFooter = false
+		s.Options.SeparateColumns = false
+		s.Options.SeparateHeader = false
+		s.Options.DrawBorder = false
+		t.SetStyle(s)
+
+		t.AppendHeader(table.Row{"Item", "Value"})
+
+		// Ensure "version" is always the first row
+		t.AppendRow(table.Row{"version", v["version"]})
+
+		keys := make([]string, 0, len(v))
+		for k := range v {
+			if k != "version" {
+				keys = append(keys, k)
+			}
+		}
+		sort.Strings(keys)
+
+		for _, label := range keys {
+			t.AppendRow(table.Row{
+				label, v[label],
+			})
+		}
+		t.Render()
+		output.UserOut.WithField("raw", v).Println(out.String())
+	},
+}
+
+func init() {
+	MutagenCmd.AddCommand(MutagenVersionCmd)
+}