Windows: show correct Docker Desktop start command (#162)

Author: anisaoshafi

internal/runtime/docker.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"log"
 	"os"
+	"os/exec"
 	"path/filepath"
 	stdruntime "runtime"
 	"strconv"
@@ -83,21 +84,37 @@ func (d *DockerRuntime) EmitUnhealthyError(sink output.Sink, err error) {
 	actions := []output.ErrorAction{
 		{Label: "Install Docker:", Value: "https://docs.docker.com/get-docker/"},
 	}
+	summary := err.Error()
 	switch stdruntime.GOOS {
 	case "darwin":
 		actions = append([]output.ErrorAction{{Label: "Start Docker Desktop:", Value: "open -a Docker"}}, actions...)
 	case "linux":
 		actions = append([]output.ErrorAction{{Label: "Start Docker:", Value: "sudo systemctl start docker"}}, actions...)
 	case "windows":
-		actions = append([]output.ErrorAction{{Label: "Start Docker Desktop:", Value: "Start-Process 'Docker Desktop'"}}, actions...)
+		actions = append([]output.ErrorAction{{Label: "Start Docker Desktop:", Value: windowsDockerStartCommand(os.Getenv, exec.LookPath)}}, actions...)
+		// Suppress the raw error: on Windows it's a named-pipe message that users can't act on.
+		summary = ""
 	}
 	output.EmitError(sink, output.ErrorEvent{
 		Title:   "Docker is not available",
-		Summary: err.Error(),
+		Summary: summary,
 		Actions: actions,
 	})
 }
 
+// PSModulePath is always set by PowerShell and never by cmd.exe; use it to pick the right start command.
+// Prefers "docker desktop start" (documented CLI method); falls back to the full executable path.
+func windowsDockerStartCommand(getenv func(string) string, lookPath func(string) (string, error)) string {
+	if _, err := lookPath("docker"); err == nil {
+		return "docker desktop start"
+	}
+	const exePath = `C:\Program Files\Docker\Docker\Docker Desktop.exe`
+	if getenv("PSModulePath") != "" {
+		return "& '" + exePath + "'"
+	}
+	return `"` + exePath + `"`
+}
+
 func (d *DockerRuntime) PullImage(ctx context.Context, imageName string, progress chan<- PullProgress) error {
 	reader, err := d.client.ImagePull(ctx, imageName, image.PullOptions{})
 	if err != nil {

internal/runtime/docker_test.go

@@ -1,6 +1,7 @@
 package runtime
 
 import (
+	"errors"
 	"os"
 	"path/filepath"
 	"testing"
@@ -54,3 +55,24 @@ func TestSocketPath_ReturnsEmptyForTCPHost(t *testing.T) {
 
 	assert.Equal(t, "", rt.SocketPath())
 }
+
+func TestWindowsDockerStartCommand_DockerAvailable(t *testing.T) {
+	lookPath := func(string) (string, error) { return "/usr/bin/docker", nil }
+	assert.Equal(t, "docker desktop start", windowsDockerStartCommand(func(string) string { return "" }, lookPath))
+}
+
+func TestWindowsDockerStartCommand_PowerShellFallback(t *testing.T) {
+	lookPath := func(string) (string, error) { return "", errors.New("not found") }
+	getenv := func(key string) string {
+		if key == "PSModulePath" {
+			return `C:\Windows\System32\WindowsPowerShell\v1.0\Modules`
+		}
+		return ""
+	}
+	assert.Equal(t, `& 'C:\Program Files\Docker\Docker\Docker Desktop.exe'`, windowsDockerStartCommand(getenv, lookPath))
+}
+
+func TestWindowsDockerStartCommand_CmdFallback(t *testing.T) {
+	lookPath := func(string) (string, error) { return "", errors.New("not found") }
+	assert.Equal(t, `"C:\Program Files\Docker\Docker\Docker Desktop.exe"`, windowsDockerStartCommand(func(string) string { return "" }, lookPath))
+}

test/integration/docker_windows_test.go

@@ -0,0 +1,42 @@
+package integration_test
+
+import (
+	"runtime"
+	"testing"
+
+	"github.com/localstack/lstk/test/integration/env"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// windowsDockerErrorEnv returns an Environ with an invalid DOCKER_HOST and no PSModulePath.
+func windowsDockerErrorEnv() env.Environ {
+	return env.Without(env.Key("PSModulePath"), env.Key("DOCKER_HOST")).
+		With(env.AuthToken, "fake-token").
+		With(env.Key("DOCKER_HOST"), "tcp://localhost:1")
+}
+
+// Verifies that when docker is in PATH, lstk suggests "docker desktop start".
+func TestWindowsDockerErrorShowsDockerCLICommand(t *testing.T) {
+	if runtime.GOOS != "windows" {
+		t.Skip("Windows-only test")
+	}
+
+	stdout, _, err := runLstk(t, testContext(t), "", windowsDockerErrorEnv(), "start")
+	require.Error(t, err)
+	requireExitCode(t, 1, err)
+	assert.Contains(t, stdout, "docker desktop start")
+}
+
+// Verifies that the verbose Docker error message is suppressed on Windows.
+func TestWindowsDockerErrorOmitsVerboseSummary(t *testing.T) {
+	if runtime.GOOS != "windows" {
+		t.Skip("Windows-only test")
+	}
+
+	stdout, _, err := runLstk(t, testContext(t), "", windowsDockerErrorEnv(), "start")
+	require.Error(t, err)
+	requireExitCode(t, 1, err)
+	assert.Contains(t, stdout, "Docker is not available")
+	assert.NotContains(t, stdout, "cannot connect to Docker daemon")
+}