Move error rendering out of cmd

gtsiolis · gtsiolis · commit fe0887094694 · 2026-02-24T14:18:31.000+02:00
diff --git a/cmd/error_output.go b/cmd/error_output.go
diff --git a/cmd/root.go b/cmd/root.go
@@ -26,11 +26,11 @@ var rootCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		rt, err := newRuntime(cmd.Context())
 		if err != nil {
-			exitWithStartError(err)
+			ui.ExitWithStartError(err)
 		}
 
 		if err := runStart(cmd.Context(), rt); err != nil {
-			exitWithStartError(err)
+			ui.ExitWithStartError(err)
 		}
 	},
 }
diff --git a/cmd/start.go b/cmd/start.go
@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/localstack/lstk/internal/ui"
 	"github.com/spf13/cobra"
 )
 
@@ -12,11 +13,11 @@ var startCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		rt, err := newRuntime(cmd.Context())
 		if err != nil {
-			exitWithStartError(err)
+			ui.ExitWithStartError(err)
 		}
 
 		if err := runStart(cmd.Context(), rt); err != nil {
-			exitWithStartError(err)
+			ui.ExitWithStartError(err)
 		}
 	},
 }
diff --git a/internal/runtime/engine_check_test.go b/internal/runtime/engine_check_test.go
@@ -3,24 +3,20 @@ package runtime
 import (
 	"context"
 	"errors"
-	"io"
 	"strings"
 	"testing"
+
+	"go.uber.org/mock/gomock"
 )
 
-type fakeRuntime struct {
+type runtimeWithChecker struct {
+	Runtime
 	err error
 }
 
-func (f *fakeRuntime) PullImage(context.Context, string, chan<- PullProgress) error { return nil }
-func (f *fakeRuntime) Start(context.Context, ContainerConfig) (string, error)       { return "", nil }
-func (f *fakeRuntime) Stop(context.Context, string) error                           { return nil }
-func (f *fakeRuntime) Remove(context.Context, string) error                         { return nil }
-func (f *fakeRuntime) IsRunning(context.Context, string) (bool, error)              { return false, nil }
-func (f *fakeRuntime) Logs(context.Context, string, int) (string, error)            { return "", nil }
-func (f *fakeRuntime) StreamLogs(context.Context, string, io.Writer) error          { return nil }
-func (f *fakeRuntime) GetImageVersion(context.Context, string) (string, error)      { return "", nil }
-func (f *fakeRuntime) CheckConnection(context.Context) error                        { return f.err }
+func (r *runtimeWithChecker) CheckConnection(context.Context) error {
+	return r.err
+}
 
 func TestFormatDockerConnectionErrorFriendly(t *testing.T) {
 	endpoint := "unix:///Users/geo/.docker/run/docker.sock"
@@ -73,8 +69,12 @@ func TestFormatDockerConnectionErrorPermission(t *testing.T) {
 }
 
 func TestCheckContainerEngineUsesChecker(t *testing.T) {
+	ctrl := gomock.NewController(t)
 	expected := errors.New("boom")
-	rt := &fakeRuntime{err: expected}
+	rt := &runtimeWithChecker{
+		Runtime: NewMockRuntime(ctrl),
+		err:     expected,
+	}
 
 	err := CheckContainerEngine(context.Background(), rt)
 	if !errors.Is(err, expected) {
diff --git a/internal/runtime/mock_runtime_test.go b/internal/runtime/mock_runtime_test.go
diff --git a/internal/runtime/runtime.go b/internal/runtime/runtime.go
@@ -5,6 +5,8 @@ import (
 	"io"
 )
 
+//go:generate mockgen -source=runtime.go -destination=mock_runtime_test.go -package=runtime
+
 type ContainerConfig struct {
 	Image       string
 	Name        string
diff --git a/internal/ui/error_output.go b/internal/ui/error_output.go
@@ -0,0 +1,57 @@
+package ui
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"strings"
+
+	"github.com/charmbracelet/lipgloss"
+	"github.com/localstack/lstk/internal/runtime"
+	"github.com/localstack/lstk/internal/ui/styles"
+)
+
+func ExitWithStartError(err error) {
+	if runtimeErr, ok := runtime.AsRuntimeUnavailableError(err); ok {
+		fmt.Fprintln(os.Stderr, styles.ErrorTitle.Render("✗ Could not start LocalStack"))
+		fmt.Fprintln(os.Stderr, styles.ErrorSummaryPrefix.Render("> ")+styles.ErrorBody.Render("No container runtime detected."))
+		printIndentedStyled(os.Stderr, summarizeRuntimeDetail(runtimeErr.Detail), "  ", styles.ErrorNote)
+		fmt.Fprintln(os.Stderr)
+		printActionLine(os.Stderr, "Install Docker:", "https://docs.docker.com/get-started", styles.ErrorBody)
+		printActionLine(os.Stderr, "Using Podman? Run", "`lstk configure podman`", styles.ErrorActionText)
+		printActionLine(os.Stderr, "Deploying in Kubernetes?", "https://www.localstack.cloud/demo", styles.ErrorK8s)
+		os.Exit(1)
+	}
+
+	fmt.Fprintf(os.Stderr, "Error: %v\n", err)
+	os.Exit(1)
+}
+
+func printIndentedStyled(out io.Writer, text, indent string, style lipgloss.Style) {
+	lines := strings.Split(text, "\n")
+	for i, line := range lines {
+		lineIndent := indent
+		if i > 0 {
+			lineIndent += "  "
+		}
+		fmt.Fprintln(out, lineIndent+style.Render(line))
+	}
+}
+
+func printActionLine(out io.Writer, label, value string, labelStyle lipgloss.Style) {
+	fmt.Fprintln(
+		out,
+		styles.ErrorActionArrow.Render("⇒")+" "+
+			labelStyle.Render(label)+" "+
+			styles.ErrorLink.Render(value),
+	)
+}
+
+func summarizeRuntimeDetail(detail string) string {
+	msg := strings.ToLower(detail)
+	if strings.Contains(msg, "cannot connect to the docker daemon") &&
+		strings.Contains(msg, "is the docker daemon running") {
+		return "Cannot connect to Docker daemon."
+	}
+	return detail
+}
diff --git a/internal/ui/error_output_test.go b/internal/ui/error_output_test.go
@@ -1,4 +1,4 @@
-package cmd
+package ui
 
 import "testing"
 
diff --git a/internal/ui/styles/styles.go b/internal/ui/styles/styles.go

Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,11 @@ var rootCmd = &cobra.Command{`
`26`	`26`	`Run: func(cmd *cobra.Command, args []string) {`
`27`	`27`	`rt, err := newRuntime(cmd.Context())`
`28`	`28`	`if err != nil {`
`29`		`- exitWithStartError(err)`
	`29`	`+ ui.ExitWithStartError(err)`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`if err := runStart(cmd.Context(), rt); err != nil {`
`33`		`- exitWithStartError(err)`
	`33`	`+ ui.ExitWithStartError(err)`
`34`	`34`	`}`
`35`	`35`	`},`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package cmd`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "github.com/localstack/lstk/internal/ui"`
`4`	`5`	`"github.com/spf13/cobra"`
`5`	`6`	`)`
`6`	`7`
`@@ -12,11 +13,11 @@ var startCmd = &cobra.Command{`
`12`	`13`	`Run: func(cmd *cobra.Command, args []string) {`
`13`	`14`	`rt, err := newRuntime(cmd.Context())`
`14`	`15`	`if err != nil {`
`15`		`- exitWithStartError(err)`
	`16`	`+ ui.ExitWithStartError(err)`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`if err := runStart(cmd.Context(), rt); err != nil {`
`19`		`- exitWithStartError(err)`
	`20`	`+ ui.ExitWithStartError(err)`
`20`	`21`	`}`
`21`	`22`	`},`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@ import (`
`5`	`5`	`"io"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+//go:generate mockgen -source=runtime.go -destination=mock_runtime_test.go -package=runtime`
	`9`	`+`
`8`	`10`	`type ContainerConfig struct {`
`9`	`11`	`Image string`
`10`	`12`	`Name string`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package cmd`
	`1`	`+package ui`
`2`	`2`
`3`	`3`	`import "testing"`
`4`	`4`