Move all usage of survey into uiutil

This makes it easier to replace the deprecated survey module
with another Text User Interface implementation, later on.

Signed-off-by: Anders F Björklund <[email protected]>

Author: afbjorklund

cmd/limactl/edit.go

@@ -7,14 +7,14 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/lima-vm/lima/cmd/limactl/editflags"
 	"github.com/lima-vm/lima/pkg/editutil"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	networks "github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/start"
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
+	"github.com/lima-vm/lima/pkg/uiutil"
 	"github.com/lima-vm/lima/pkg/yqutil"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -126,15 +126,8 @@ func editAction(cmd *cobra.Command, args []string) error {
 }
 
 func askWhetherToStart() (bool, error) {
-	ans := true
-	prompt := &survey.Confirm{
-		Message: "Do you want to start the instance now? ",
-		Default: true,
-	}
-	if err := survey.AskOne(prompt, &ans); err != nil {
-		return false, err
-	}
-	return ans, nil
+	message := "Do you want to start the instance now? "
+	return uiutil.Confirm(message, true)
 }
 
 func editBashComplete(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {

cmd/limactl/start.go

@@ -10,8 +10,6 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/AlecAivazis/survey/v2"
-	"github.com/AlecAivazis/survey/v2/terminal"
 	"github.com/containerd/containerd/identifiers"
 	"github.com/lima-vm/lima/cmd/limactl/editflags"
 	"github.com/lima-vm/lima/cmd/limactl/guessarg"
@@ -24,6 +22,7 @@ import (
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/lima-vm/lima/pkg/templatestore"
+	"github.com/lima-vm/lima/pkg/uiutil"
 	"github.com/lima-vm/lima/pkg/yqutil"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -366,27 +365,25 @@ func chooseNextCreatorState(st *creatorState, yq string) (*creatorState, error)
 			logrus.WithError(err).Warn("Failed to evaluate yq expression")
 			return st, err
 		}
-		var ans string
-		prompt := &survey.Select{
-			Message: fmt.Sprintf("Creating an instance %q", st.instName),
-			Options: []string{
-				"Proceed with the current configuration",
-				"Open an editor to review or modify the current configuration",
-				"Choose another template (docker, podman, archlinux, fedora, ...)",
-				"Exit",
-			},
+		message := fmt.Sprintf("Creating an instance %q", st.instName)
+		options := []string{
+			"Proceed with the current configuration",
+			"Open an editor to review or modify the current configuration",
+			"Choose another template (docker, podman, archlinux, fedora, ...)",
+			"Exit",
 		}
-		if err := survey.AskOne(prompt, &ans); err != nil {
-			if err == terminal.InterruptErr {
+		ans, err := uiutil.Select(message, options)
+		if err != nil {
+			if err == uiutil.InterruptErr {
 				logrus.Fatal("Interrupted by user")
 			}
 			logrus.WithError(err).Warn("Failed to open TUI")
 			return st, nil
 		}
 		switch ans {
-		case prompt.Options[0]: // "Proceed with the current configuration"
+		case 0: // "Proceed with the current configuration"
 			return st, nil
-		case prompt.Options[1]: // "Open an editor ..."
+		case 1: // "Open an editor ..."
 			hdr := fmt.Sprintf("# Review and modify the following configuration for Lima instance %q.\n", st.instName)
 			if st.instName == DefaultInstanceName {
 				hdr += "# - In most cases, you do not need to modify this file.\n"
@@ -405,20 +402,18 @@ func chooseNextCreatorState(st *creatorState, yq string) (*creatorState, error)
 				return st, errors.New("should not reach here")
 			}
 			return st, nil
-		case prompt.Options[2]: // "Choose another template..."
+		case 2: // "Choose another template..."
 			templates, err := templatestore.Templates()
 			if err != nil {
 				return st, err
 			}
-			var ansEx int
-			promptEx := &survey.Select{
-				Message: "Choose a template",
-				Options: make([]string, len(templates)),
-			}
+			message := "Choose a template"
+			options := make([]string, len(templates))
 			for i := range templates {
-				promptEx.Options[i] = templates[i].Name
+				options[i] = templates[i].Name
 			}
-			if err := survey.AskOne(promptEx, &ansEx); err != nil {
+			ansEx, err := uiutil.Select(message, options)
+			if err != nil {
 				return st, err
 			}
 			if ansEx > len(templates)-1 {
@@ -436,7 +431,7 @@ func chooseNextCreatorState(st *creatorState, yq string) (*creatorState, error)
 				return nil, err
 			}
 			continue
-		case prompt.Options[3]: // "Exit"
+		case 3: // "Exit"
 			os.Exit(0)
 			return st, errors.New("should not reach here")
 		default:

pkg/qemu/entitlementutil/entitlementutil.go

@@ -7,7 +7,8 @@ import (
 	"os/exec"
 	"strings"
 
-	"github.com/AlecAivazis/survey/v2"
+	"github.com/lima-vm/lima/pkg/uiutil"
+
 	"github.com/mattn/go-isatty"
 	"github.com/sirupsen/logrus"
 )
@@ -85,11 +86,10 @@ func AskToSignIfNotSignedProperly(qExe string) {
 		}
 		var ans bool
 		if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) {
-			prompt := &survey.Confirm{
-				Message: fmt.Sprintf("Try to sign %q with the \"com.apple.security.hypervisor\" entitlement?", qExe),
-				Default: true,
-			}
-			if askErr := survey.AskOne(prompt, &ans); askErr != nil {
+			message := fmt.Sprintf("Try to sign %q with the \"com.apple.security.hypervisor\" entitlement?", qExe)
+			var askErr error
+			ans, askErr = uiutil.Confirm(message, true)
+			if askErr != nil {
 				logrus.WithError(askErr).Warn("No answer was given")
 			}
 		}

pkg/uiutil/uiutil.go

@@ -0,0 +1,35 @@
+package uiutil
+
+import (
+	"github.com/AlecAivazis/survey/v2"
+	"github.com/AlecAivazis/survey/v2/terminal"
+)
+
+var InterruptErr = terminal.InterruptErr
+
+// Confirm is a regular text input that accept yes/no answers.
+func Confirm(message string, defaultParam bool) (bool, error) {
+	var ans bool
+	prompt := &survey.Confirm{
+		Message: message,
+		Default: defaultParam,
+	}
+	if err := survey.AskOne(prompt, &ans); err != nil {
+		return false, err
+	}
+	return ans, nil
+}
+
+// Select is a prompt that presents a list of various options
+// to the user for them to select using the arrow keys and enter.
+func Select(message string, options []string) (int, error) {
+	var ans int
+	prompt := &survey.Select{
+		Message: message,
+		Options: options,
+	}
+	if err := survey.AskOne(prompt, &ans); err != nil {
+		return -1, err
+	}
+	return ans, nil
+}