Works on my Windows desktop?

ammario · ammario · commit 77d1d9e7213a · 2023-04-21T20:31:15.000-05:00
diff --git a/agent/agent.go b/agent/agent.go
@@ -18,6 +18,7 @@ import (
 	"os/user"
 	"path/filepath"
 	"reflect"
+	"regexp"
 	"runtime"
 	"sort"
 	"strconv"
@@ -205,9 +206,15 @@ func (a *agent) runLoop(ctx context.Context) {
 	}
 }
 
+var isPowershellRe = regexp.MustCompile(`^(powershell|pwsh)(\.exe)?$`)
+
 func createMetadataCommand(ctx context.Context, script string) (*exec.Cmd, error) {
 	// This is largely copied from agentssh, but for some reason the command
-	// generated there always returns exit status 1 in Windows.
+	// generated there always returns exit status 1 in Windows powershell.
+	//
+	// This function puts special PowerShell branching in place that fixes the issue,
+	// but I'm hesitant on porting it to agentssh before understanding exactly what's
+	// happening.
 	currentUser, err := user.Current()
 	if err != nil {
 		return nil, xerrors.Errorf("get current user: %w", err)
@@ -219,19 +226,21 @@ func createMetadataCommand(ctx context.Context, script string) (*exec.Cmd, error
 		return nil, xerrors.Errorf("get user shell: %w", err)
 	}
 
-	var caller string
+	var args []string
 	switch {
-	case filepath.Base(shell) == "pwsh.exe":
-		caller = "-Command"
 	case runtime.GOOS == "windows":
-		caller = "/c"
+		if isPowershellRe.MatchString(filepath.Base(shell)) {
+			args = append(args, "-NoProfile", "-NonInteractive", "-Command")
+		} else {
+			// Probably cmd.exe
+			args = append(args, "/c")
+		}
+
 	default:
-		caller = "-c"
+		args = append(args, "-c")
 	}
-	// args := []string{caller, "Get-Process"}
-	args := []string{"-NoProfile", "-NonInteractive"}
-	_ = caller
-	return exec.CommandContext(ctx, "powershell", args...), nil
+	args = append(args, script)
+	return exec.CommandContext(ctx, shell, args...), nil
 }
 
 func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMetadataDescription) *codersdk.WorkspaceAgentMetadataResult {
@@ -251,14 +260,6 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
 		return result
 	}
 
-	// execPath, err := exec.LookPath("cmd.exe")
-	// if err != nil {
-	// 	result.Error = fmt.Sprintf("look path: %+v", err)
-	// 	return result
-	// }
-
-	// cmd = exec.CommandContext(ctx, execPath, "/c", "echo hello")
-
 	cmd.Stdout = &out
 	cmd.Stderr = &out
 	cmd.Stdin = io.LimitReader(nil, 0)
@@ -281,8 +282,6 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
 		out.Truncate(bufLimit)
 	}
 
-	fmt.Printf("ran %+v %+q: %v\n", cmd.Path, cmd.Args, err)
-
 	if err != nil {
 		result.Error = fmt.Sprintf("run cmd: %+v", err)
 	}
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -1031,7 +1031,7 @@ func TestAgent_Metadata(t *testing.T) {
 		}, testutil.WaitShort, testutil.IntervalMedium)
 
 		collectedAt1 := gotMd["greeting"].CollectedAt
-		if !assert.Equal(t, "hello\n", gotMd["greeting"].Value) {
+		if !assert.Equal(t, "hello", strings.TrimSpace(gotMd["greeting"].Value)) {
 			t.Logf("got: %+v", gotMd)
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -1031,7 +1031,7 @@ func TestAgent_Metadata(t *testing.T) {`
`1031`	`1031`	`}, testutil.WaitShort, testutil.IntervalMedium)`
`1032`	`1032`
`1033`	`1033`	`collectedAt1 := gotMd["greeting"].CollectedAt`
`1034`		`- if !assert.Equal(t, "hello\n", gotMd["greeting"].Value) {`
	`1034`	`+ if !assert.Equal(t, "hello", strings.TrimSpace(gotMd["greeting"].Value)) {`
`1035`	`1035`	`t.Logf("got: %+v", gotMd)`
`1036`	`1036`	`}`
`1037`	`1037`