Merge pull request #211 from hugoh/display

Author: hugoh

go.mod

@@ -3,10 +3,9 @@ module github.com/hugoh/tmhi-cli
 go 1.25.0
 
 require (
-	atomicgo.dev/keyboard v0.2.9
 	github.com/go-playground/validator/v10 v10.30.2
-	github.com/hugoh/cellular-signal v1.1.2
-	github.com/hugoh/tmhi-gateway v1.1.0
+	github.com/hugoh/cellular-signal v1.1.3
+	github.com/hugoh/tmhi-gateway v1.1.1
 	github.com/pterm/pterm v0.12.83
 	github.com/stretchr/testify v1.11.1
 	github.com/urfave/cli-altsrc/v3 v3.1.0
@@ -17,6 +16,7 @@ require (
 
 require (
 	atomicgo.dev/cursor v0.2.0 // indirect
+	atomicgo.dev/keyboard v0.2.9 // indirect
 	atomicgo.dev/schedule v0.1.0 // indirect
 	github.com/BurntSushi/toml v1.6.0 // indirect
 	github.com/clipperhouse/uax29/v2 v2.7.0 // indirect

go.sum

@@ -45,10 +45,10 @@ github.com/gookit/color v1.4.2/go.mod h1:fqRyamkC1W8uxl+lxCQxOT09l/vYfZ+QeiX3rKQ
 github.com/gookit/color v1.5.0/go.mod h1:43aQb+Zerm/BWh2GnrgOQm7ffz7tvQXEKV6BFMl7wAo=
 github.com/gookit/color v1.6.0 h1:JjJXBTk1ETNyqyilJhkTXJYYigHG24TM9Xa2M1xAhRA=
 github.com/gookit/color v1.6.0/go.mod h1:9ACFc7/1IpHGBW8RwuDm/0YEnhg3dwwXpoMsmtyHfjs=
-github.com/hugoh/cellular-signal v1.1.2 h1:olGnf0ZyDf0dUMr8BI4wjFVClOvRzP6uc9JHilHiJHc=
-github.com/hugoh/cellular-signal v1.1.2/go.mod h1:UX0FKsxcPzK7YFM6Glu7LjZQA8m8TxXcRV64/N1rgZk=
-github.com/hugoh/tmhi-gateway v1.1.0 h1:cXwcF1nlRTeVEwq6BQ6xhZogerun62zbSQEO8iqCnMo=
-github.com/hugoh/tmhi-gateway v1.1.0/go.mod h1:QuYWc8UMULHcn6ZOe5zYiykdPs0uQKDHbao6fWOMzbo=
+github.com/hugoh/cellular-signal v1.1.3 h1:RBreCLAgY5zoeYbmUPVxMKVZVSuiirnrRHo6a6Dqgz4=
+github.com/hugoh/cellular-signal v1.1.3/go.mod h1:UX0FKsxcPzK7YFM6Glu7LjZQA8m8TxXcRV64/N1rgZk=
+github.com/hugoh/tmhi-gateway v1.1.1 h1:EKQ/Nx6H57G68gHylzUEyE6DKEjiGpvGhgt7N3cyYF8=
+github.com/hugoh/tmhi-gateway v1.1.1/go.mod h1:32TqX2vp5E4YdTe5ckfTiFc9onf+RaGE4+pIJaJpf5E=
 github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
 github.com/klauspost/cpuid/v2 v2.0.10/go.mod h1:g2LTdtYhdyuGPqyWyv7qRAmj1WBqxuObKfj5c0PQa7c=
 github.com/klauspost/cpuid/v2 v2.0.12/go.mod h1:g2LTdtYhdyuGPqyWyv7qRAmj1WBqxuObKfj5c0PQa7c=

internal/cmd.go

@@ -14,6 +14,60 @@ import (
 	"golang.org/x/term"
 )
 
+type spinner interface {
+	Fail(message ...any)
+	Success(message ...any)
+	Stop() error
+}
+
+// spinnerFunc creates a new spinner. Overridable for testing.
+//
+//nolint:gochecknoglobals
+var spinnerFunc = func(message string) (spinner, error) {
+	sp, err := pterm.DefaultSpinner.Start(message)
+	if err != nil {
+		return nil, fmt.Errorf("failed to start spinner: %w", err)
+	}
+
+	return &spinnerWrapper{spinnerPrinter: sp}, nil
+}
+
+// spinnerWrapper wraps pterm.SpinnerPrinter to implement the spinner interface.
+type spinnerWrapper struct {
+	spinnerPrinter *pterm.SpinnerPrinter
+}
+
+func (w *spinnerWrapper) Fail(message ...any) {
+	w.spinnerPrinter.Fail(message...)
+}
+
+func (w *spinnerWrapper) Success(message ...any) {
+	if message == nil {
+		_ = w.spinnerPrinter.WithRemoveWhenDone().Stop()
+
+		return
+	}
+
+	w.spinnerPrinter.Success(message...)
+}
+
+func (w *spinnerWrapper) Stop() error {
+	if err := w.spinnerPrinter.Stop(); err != nil {
+		return fmt.Errorf("failed to stop spinner: %w", err)
+	}
+
+	return nil
+}
+
+// confirmDialog prompts the user for confirmation. Overridable for testing.
+//
+//nolint:gochecknoglobals
+var confirmDialog = func(msg string, defaultVal bool) (bool, error) {
+	return pterm.DefaultInteractiveConfirm.
+		WithDefaultValue(defaultVal).
+		Show(msg)
+}
+
 // Gateway model constants.
 const (
 	ARCADYAN       string        = "ARCADYAN"
@@ -24,22 +78,34 @@ const (
 //nolint:gochecknoglobals
 var initGatewayFunc = initGateway
 
-// withSpinner runs an operation with a spinner, handling success/failure.
-// It starts a spinner with the given message, executes the function,
-// and properly stops the spinner on success or failure.
+// fetchWithFeedback runs an operation with a spinner, handling success/failure.
+// It starts a spinner with the given message, executes the fetch function,
+// displays the result using the display function, and properly stops the spinner.
 //
 //nolint:ireturn
-func withSpinner[T any](message string, fn func() (T, error)) (T, error) {
-	spinner, _ := pterm.DefaultSpinner.Start(message)
-
-	result, err := fn()
+func fetchWithFeedback[T any](
+	message string,
+	fetch func() (T, error),
+	display func(T),
+	successMessage ...any,
+) (T, error) {
+	spinnerInstance, err := spinnerFunc(message)
 	if err != nil {
-		spinner.Fail(fmt.Sprintf("%s: %v", message, err))
+		return *new(T), err
+	}
+
+	result, opErr := fetch()
+	if opErr != nil {
+		spinnerInstance.Fail(fmt.Sprintf("%s: %v", message, opErr))
 
-		return result, fmt.Errorf("%s: %w", message, err)
+		return result, fmt.Errorf("%s: %w", message, opErr)
 	}
 
-	_ = spinner.WithRemoveWhenDone().Stop()
+	spinnerInstance.Success(successMessage...)
+
+	if display != nil {
+		display(result)
+	}
 
 	return result, nil
 }
@@ -62,16 +128,9 @@ func login(_ context.Context, _ *cli.Command) error {
 		return err
 	}
 
-	result, err := withSpinner("Checking logging in...", func() (*tmhi.LoginResult, error) {
-		return gateway.Login()
-	})
-	if err != nil {
-		return err
-	}
-
-	displayLoginResult(result)
+	_, err = fetchWithFeedback("Checking logging in...", gateway.Login, displayLoginResult)
 
-	return nil
+	return err
 }
 
 func req(_ context.Context, cmd *cli.Command) error {
@@ -111,14 +170,9 @@ func info(_ context.Context, _ *cli.Command) error {
 		return err
 	}
 
-	result, err := gateway.Info()
-	if err != nil {
-		return fmt.Errorf("info command failed: %w", err)
-	}
-
-	displayInfoResult(result)
+	_, err = fetchWithFeedback("Fetching gateway info...", gateway.Info, displayInfoResult)
 
-	return nil
+	return err
 }
 
 func status(_ context.Context, _ *cli.Command) error {
@@ -127,16 +181,9 @@ func status(_ context.Context, _ *cli.Command) error {
 		return err
 	}
 
-	result, err := withSpinner("Checking gateway status...", func() (*tmhi.StatusResult, error) {
-		return gateway.Status()
-	})
-	if err != nil {
-		return err
-	}
-
-	displayStatusResult(result)
+	_, err = fetchWithFeedback("Checking gateway status...", gateway.Status, displayStatusResult)
 
-	return nil
+	return err
 }
 
 func signalCmd(_ context.Context, _ *cli.Command) error {
@@ -145,19 +192,13 @@ func signalCmd(_ context.Context, _ *cli.Command) error {
 		return err
 	}
 
-	result, err := withSpinner(
+	_, err = fetchWithFeedback(
 		"Fetching signal information...",
-		func() (*tmhi.SignalResult, error) {
-			return gateway.Signal()
-		},
+		gateway.Signal,
+		displaySignalResult,
 	)
-	if err != nil {
-		return err
-	}
 
-	displaySignalResult(result)
-
-	return nil
+	return err
 }
 
 func reboot(_ context.Context, cmd *cli.Command) error {
@@ -167,10 +208,15 @@ func reboot(_ context.Context, cmd *cli.Command) error {
 	}
 
 	if !cmd.Bool(ConfigAutoConfirm) {
-		confirm, _ := pterm.DefaultInteractiveConfirm.
-			WithDefaultValue(false).
-			Show("Are you sure you want to reboot the gateway?")
-		if !confirm {
+		confirmed, confirmErr := confirmDialog(
+			"Are you sure you want to reboot the gateway?",
+			false,
+		)
+		if confirmErr != nil {
+			return fmt.Errorf("confirmation failed: %w", confirmErr)
+		}
+
+		if !confirmed {
 			pterm.Warning.Println("Reboot cancelled")
 
 			return nil
@@ -183,18 +229,21 @@ func reboot(_ context.Context, cmd *cli.Command) error {
 		return nil
 	}
 
-	spinner, _ := pterm.DefaultSpinner.Start("Rebooting gateway...")
-
-	err = gateway.Reboot()
-	if err != nil {
-		spinner.Fail("Reboot failed")
-
-		return fmt.Errorf("could not reboot gateway: %w", err)
-	}
+	_, ret := fetchWithFeedback(
+		"Rebooting gateway...",
+		func() (*tmhi.SignalResult, error) {
+			rebootErr := gateway.Reboot()
+			if rebootErr != nil {
+				return nil, fmt.Errorf("Reboot failed: %w", rebootErr)
+			}
 
-	spinner.Success("Reboot command sent successfully")
+			return nil, nil //nolint:nilnil // no error to report
+		},
+		nil,
+		"Reboot command sent successfully",
+	)
 
-	return nil
+	return ret
 }
 
 func defaultConfigPath() string {

internal/cmd_handlers_test.go

@@ -6,8 +6,6 @@ import (
 	"testing"
 	"time"
 
-	"atomicgo.dev/keyboard"
-	"atomicgo.dev/keyboard/keys"
 	tmhi "github.com/hugoh/tmhi-gateway"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -115,7 +113,6 @@ func TestLogin_SuccessAndFailure(t *testing.T) {
 	})
 }
 
-//nolint:dupl
 func TestInfo_SuccessAndFailure(t *testing.T) {
 	original := initGatewayFunc
 
@@ -134,7 +131,8 @@ func TestInfo_SuccessAndFailure(t *testing.T) {
 		initGatewayFunc = func(_ *Config) (tmhi.Gateway, error) { return mg, nil }
 		err := info(context.Background(), nil)
 		require.Error(t, err)
-		assert.Contains(t, err.Error(), "info command failed")
+		assert.Contains(t, err.Error(), "Fetching gateway info")
+		assert.Contains(t, err.Error(), "info boom")
 		assert.True(t, mg.infoCalled)
 	})
 }
@@ -203,15 +201,15 @@ func TestReboot_ConfirmationDefaultsToNo(t *testing.T) {
 	}()
 
 	t.Run("enter accepts default no", func(t *testing.T) {
-		testRebootConfirmCancel(t, keys.Enter)
+		testRebootConfirmCancel(t)
 	})
 
 	t.Run("y confirms reboot", func(t *testing.T) {
-		testRebootConfirmProceed(t, 'y')
+		testRebootConfirmProceed(t)
 	})
 
 	t.Run("n cancels reboot", func(t *testing.T) {
-		testRebootConfirmCancel(t, 'n')
+		testRebootConfirmCancel(t)
 	})
 
 	t.Run("auto confirm skips prompt", func(t *testing.T) {
@@ -232,66 +230,64 @@ func TestReboot_ConfirmationDefaultsToNo(t *testing.T) {
 }
 
 //nolint:dupl
-func testRebootConfirmCancel(t *testing.T, key any) {
+func testRebootConfirmCancel(t *testing.T) {
 	t.Helper()
 
 	original := initGatewayFunc
 	originalConfig := appConfig
+	originalConfirm := confirmDialog
 
 	defer func() {
 		initGatewayFunc = original
 		appConfig = originalConfig
+		confirmDialog = originalConfirm
 	}()
 
 	appConfig = &Config{DryRun: false}
 	mg := &mockGateway{}
 	initGatewayFunc = func(_ *Config) (tmhi.Gateway, error) { return mg, nil }
+	confirmDialog = func(_ string, _ bool) (bool, error) {
+		return false, nil // Simulate user cancelling
+	}
 	cmd := &cli.Command{
 		Flags: []cli.Flag{
 			&cli.BoolFlag{Name: ConfigDryRun, Value: false},
 			&cli.BoolFlag{Name: ConfigAutoConfirm, Value: false},
 		},
 	}
 
-	go func() {
-		time.Sleep(50 * time.Millisecond)
-
-		_ = keyboard.SimulateKeyPress(key)
-	}()
-
 	err := reboot(context.Background(), cmd)
 	require.NoError(t, err)
 	assert.False(t, mg.rebootCalled, "reboot should be cancelled")
 }
 
 //nolint:dupl
-func testRebootConfirmProceed(t *testing.T, key any) {
+func testRebootConfirmProceed(t *testing.T) {
 	t.Helper()
 
 	original := initGatewayFunc
 	originalConfig := appConfig
+	originalConfirm := confirmDialog
 
 	defer func() {
 		initGatewayFunc = original
 		appConfig = originalConfig
+		confirmDialog = originalConfirm
 	}()
 
 	appConfig = &Config{DryRun: false}
 	mg := &mockGateway{}
 	initGatewayFunc = func(_ *Config) (tmhi.Gateway, error) { return mg, nil }
+	confirmDialog = func(_ string, _ bool) (bool, error) {
+		return true, nil // Simulate user confirming
+	}
 	cmd := &cli.Command{
 		Flags: []cli.Flag{
 			&cli.BoolFlag{Name: ConfigDryRun, Value: false},
 			&cli.BoolFlag{Name: ConfigAutoConfirm, Value: false},
 		},
 	}
 
-	go func() {
-		time.Sleep(50 * time.Millisecond)
-
-		_ = keyboard.SimulateKeyPress(key)
-	}()
-
 	err := reboot(context.Background(), cmd)
 	require.NoError(t, err)
 	assert.True(t, mg.rebootCalled, "reboot should proceed")