fix(agent/usershell): check shell on darwin via dscl (#8366)

mafredri · web-flow · commit e508d9aa6ebf · 2023-07-11T20:27:50.000+03:00
diff --git a/agent/usershell/usershell_darwin.go b/agent/usershell/usershell_darwin.go
@@ -1,8 +1,25 @@
 package usershell
 
-import "os"
+import (
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	"golang.org/x/xerrors"
+)
 
 // Get returns the $SHELL environment variable.
-func Get(_ string) (string, error) {
-	return os.Getenv("SHELL"), nil
+func Get(username string) (string, error) {
+	// This command will output "UserShell: /bin/zsh" if successful, we
+	// can ignore the error since we have fallback behavior.
+	out, _ := exec.Command("dscl", ".", "-read", filepath.Join("/Users", username), "UserShell").Output()
+	s, ok := strings.CutPrefix(string(out), "UserShell: ")
+	if ok {
+		return strings.TrimSpace(s), nil
+	}
+	if s = os.Getenv("SHELL"); s != "" {
+		return s, nil
+	}
+	return "", xerrors.Errorf("shell for user %q not found via dscl or in $SHELL", username)
 }
diff --git a/agent/usershell/usershell_other.go b/agent/usershell/usershell_other.go
@@ -27,5 +27,8 @@ func Get(username string) (string, error) {
 		}
 		return parts[6], nil
 	}
-	return "", xerrors.Errorf("user %q not found in /etc/passwd", username)
+	if s := os.Getenv("SHELL"); s != "" {
+		return s, nil
+	}
+	return "", xerrors.Errorf("shell for user %q not found in /etc/passwd or $SHELL", username)
 }
diff --git a/agent/usershell/usershell_other_test.go b/agent/usershell/usershell_other_test.go
diff --git a/agent/usershell/usershell_test.go b/agent/usershell/usershell_test.go
@@ -0,0 +1,46 @@
+package usershell_test
+
+import (
+	"os/user"
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/agent/usershell"
+)
+
+//nolint:paralleltest,tparallel // This test sets an environment variable.
+func TestGet(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.SkipNow()
+	}
+
+	t.Run("Fallback", func(t *testing.T) {
+		t.Setenv("SHELL", "/bin/sh")
+
+		t.Run("NonExistentUser", func(t *testing.T) {
+			shell, err := usershell.Get("notauser")
+			require.NoError(t, err)
+			require.Equal(t, "/bin/sh", shell)
+		})
+	})
+
+	t.Run("NoFallback", func(t *testing.T) {
+		// Disable env fallback for these tests.
+		t.Setenv("SHELL", "")
+
+		t.Run("NotFound", func(t *testing.T) {
+			_, err := usershell.Get("notauser")
+			require.Error(t, err)
+		})
+
+		t.Run("User", func(t *testing.T) {
+			u, err := user.Current()
+			require.NoError(t, err)
+			shell, err := usershell.Get(u.Username)
+			require.NoError(t, err)
+			require.NotEmpty(t, shell)
+		})
+	})
+}

Original file line number	Diff line number	Diff line change
`@@ -27,5 +27,8 @@ func Get(username string) (string, error) {`
`27`	`27`	`}`
`28`	`28`	`return parts[6], nil`
`29`	`29`	`}`
`30`		`- return "", xerrors.Errorf("user %q not found in /etc/passwd", username)`
	`30`	`+ if s := os.Getenv("SHELL"); s != "" {`
	`31`	`+ return s, nil`
	`32`	`+ }`
	`33`	`+ return "", xerrors.Errorf("shell for user %q not found in /etc/passwd or $SHELL", username)`
`31`	`34`	`}`