Warn when plz update updates a binary not in PATH

Author: sean-

src/update/update.go

@@ -15,6 +15,7 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"runtime"
 	"strconv"
@@ -91,6 +92,9 @@ func CheckAndUpdate(config *core.Configuration, updatesEnabled, updateCommand, f
 	// Clean out any old ones
 	clean(config, updateCommand)
 
+	// Warn if the binary in PATH isn't the one we just updated.
+	warnIfNotInPath(config)
+
 	// Now run the new one.
 	core.ReturnToInitialWorkingDir()
 	args := filterArgs(forceUpdate, append([]string{newPlease}, os.Args[1:]...))
@@ -406,6 +410,28 @@ func writeTarFile(hdr *tar.Header, r io.Reader, destination string) error {
 	return err
 }
 
+// warnIfNotInPath emits a warning if the binary found via PATH is not the one we just updated.
+// This catches the common case where e.g. a Homebrew-installed plz shadows the one in ~/.please.
+func warnIfNotInPath(config *core.Configuration) {
+	name := filepath.Base(os.Args[0])
+	pathBinary, err := exec.LookPath(name)
+	if err != nil {
+		return
+	}
+	pathBinary, _ = filepath.Abs(pathBinary)
+	if resolved, err := filepath.EvalSymlinks(pathBinary); err == nil {
+		pathBinary = resolved
+	}
+	location, _ := filepath.Abs(config.Please.Location)
+	if !strings.HasPrefix(pathBinary, location+string(filepath.Separator)) && pathBinary != location {
+		log.Warning("Updated %s in %s but %q in your PATH resolves to %s",
+			config.Please.Version.VersionString(), location, name, pathBinary)
+		log.Warning("To use the updated version, add %s to your PATH ahead of %s:",
+			location, filepath.Dir(pathBinary))
+		log.Warning("  export PATH=%s:$PATH", location)
+	}
+}
+
 // filterArgs filters out the --force update if forced updates were specified.
 // This is important so that we don't end up in a loop of repeatedly forcing re-downloads.
 func filterArgs(forceUpdate bool, args []string) []string {

src/update/update_test.go

@@ -151,6 +151,32 @@ func TestFilterArgs(t *testing.T) {
 	assert.Equal(t, []string{"plz", "update"}, filterArgs(true, []string{"plz", "update", "--force"}))
 }
 
+func TestWarnIfNotInPath(t *testing.T) {
+	// Create a fake binary in a temp directory and put it on PATH.
+	tmpDir := t.TempDir()
+	fakeBin := filepath.Join(tmpDir, "fake_plz")
+	assert.NoError(t, os.WriteFile(fakeBin, []byte("#!/bin/sh\n"), 0755))
+
+	oldPath := os.Getenv("PATH")
+	t.Setenv("PATH", tmpDir+string(os.PathListSeparator)+oldPath)
+	oldArgs := os.Args
+	defer func() { os.Args = oldArgs }()
+	os.Args = []string{"fake_plz"}
+
+	// When location matches the directory containing the binary, no warning expected.
+	c := makeConfig("warnpath")
+	c.Please.Location = tmpDir
+	warnIfNotInPath(c) // should not warn
+
+	// When location doesn't match, it should warn but not panic.
+	c.Please.Location = "/nonexistent/path"
+	warnIfNotInPath(c) // should warn but not panic
+
+	// When the binary isn't in PATH at all, should silently return.
+	os.Args = []string{"not_in_path_at_all"}
+	warnIfNotInPath(c) // should not panic
+}
+
 func TestFullDistVersion(t *testing.T) {
 	var v cli.Version
 	v.UnmarshalFlag("13.1.9")