Misc

Author: hupe1980

.vscode/settings.json

@@ -2,5 +2,8 @@
     "go.lintTool": "golangci-lint",
     "go.lintFlags": [
         "--fast"
-    ]
+    ],
+    "gopls.env": {
+        "GOFLAGS": "-tags=darwin",
+    }
 }

cmd/ec2/ec2.go

@@ -55,7 +55,7 @@ func chooseInstance(instances []ec2.Instance) (*ec2.Instance, error) {
 	templates := &promptui.SelectTemplates{
 		Active:   fmt.Sprintf(`%s {{ .Name | cyan | bold }} ({{ .ID }})`, promptui.IconSelect),
 		Inactive: `   {{ .Name | cyan }} ({{ .ID }})`,
-		Selected: fmt.Sprintf(`%s {{ "Instance" | bold }}: {{ .Name | cyan }} ({{ .ID }})`, promptui.IconGood),
+		Selected: fmt.Sprintf(`%s {{ "Instance" }}: {{ .Name | cyan }} ({{ .ID }})`, promptui.IconGood),
 	}
 
 	searcher := func(input string, index int) bool {

cmd/ecs/ecs.go

@@ -51,7 +51,7 @@ func chooseContainer(containers []ecs.Container) (string, string, error) {
 	templates := &promptui.SelectTemplates{
 		Active:   fmt.Sprintf(`%s {{ .Name | cyan | bold }} ({{ .Task }})`, promptui.IconSelect),
 		Inactive: `   {{ .Name | cyan }} ({{ .Task }})`,
-		Selected: fmt.Sprintf(`%s {{ "Container" | bold }}: {{ .Name | cyan }} ({{ .Task }})`, promptui.IconGood),
+		Selected: fmt.Sprintf(`%s {{ "Container" }}: {{ .Name | cyan }} ({{ .Task }})`, promptui.IconGood),
 	}
 
 	searcher := func(input string, index int) bool {

cmd/eks/eks.go

@@ -49,7 +49,7 @@ func chooseCluster(clusters []eks.Cluster) (*eks.Cluster, error) {
 	templates := &promptui.SelectTemplates{
 		Active:   fmt.Sprintf(`%s {{ .Name | cyan | bold }} ({{ .Version }})`, promptui.IconSelect),
 		Inactive: `   {{ .Name | cyan }} ({{ .Version }})`,
-		Selected: fmt.Sprintf(`%s {{ "Cluster" | bold }}: {{ .Name | cyan }} ({{ .Version }})`, promptui.IconGood),
+		Selected: fmt.Sprintf(`%s {{ "Cluster" }}: {{ .Name | cyan }} ({{ .Version }})`, promptui.IconGood),
 	}
 
 	searcher := func(input string, index int) bool {
@@ -84,7 +84,7 @@ func findPod(cfg *config.Config, cluster *eks.Cluster, role, namespace, podName,
 
 	if podName != "" {
 		if namespace == "" {
-			internal.PrintInfo("No namspespace was specified. Set namespace to \"default\"")
+			internal.PrintInfo("No namespace was specified. Set namespace to \"default\"")
 
 			namespace = "default"
 		}
@@ -108,17 +108,15 @@ func findPod(cfg *config.Config, cluster *eks.Cluster, role, namespace, podName,
 		return nil, err
 	}
 
-	fmt.Println(pods)
-
 	return choosePod(pods)
 }
 
 // nolint: dupl // ok
 func choosePod(pods []eks.Pod) (*eks.Pod, error) {
 	templates := &promptui.SelectTemplates{
-		Active:   fmt.Sprintf(`%s {{ .Name | cyan | bold }} [{{ .Container }} ({{ .Namespace }})]`, promptui.IconSelect),
-		Inactive: `   {{ .Name | cyan }} [{{ .Container }} ({{ .Namespace }})]`,
-		Selected: fmt.Sprintf(`%s {{ "Pod" | bold }}: {{ .Name | cyan }} [{{ .Container }} ({{ .Namespace }})]`, promptui.IconGood),
+		Active:   fmt.Sprintf(`%s {{ "pod" | cyan | bold }}/{{ .Name | cyan | bold }}/{{ .Container | cyan | bold }} ({{ .Namespace }})`, promptui.IconSelect),
+		Inactive: `   {{ "pod" | cyan }}/{{ .Name | cyan }}/{{ .Container | cyan }} ({{ .Namespace }})`,
+		Selected: fmt.Sprintf(`%s {{ "Pod" }}: {{ "pod" | cyan }}/{{ .Name | cyan }}/{{ .Container | cyan }} ({{ .Namespace }})`, promptui.IconGood),
 	}
 
 	searcher := func(input string, index int) bool {

cmd/eks/update_kubeconfig.go

@@ -40,7 +40,7 @@ func newUpdateKubeconfigCmd() *cobra.Command {
 				opts.alias = cluster.ARN
 			}
 
-			kubeconfig.Update(cfg, cluster, opts.role, opts.alias)
+			kubeconfig.Update(cfg, opts.alias, cluster, eks.NewExecConfig(cfg, cluster.Name, opts.role))
 
 			if err := kubeconfig.WriteToDisk(); err != nil {
 				return err

go.mod

@@ -17,6 +17,7 @@ require (
 
 require (
 	github.com/aws/aws-sdk-go-v2/service/sts v1.16.6
+	github.com/golang/mock v1.5.0
 	k8s.io/api v0.24.1
 	k8s.io/apimachinery v0.24.1
 )

go.sum

@@ -0,0 +1,62 @@
+package exec
+
+import (
+	"io"
+	"os"
+	"os/exec"
+)
+
+// CmdOption is a type alias to configure a command.
+type CmdOption func(cmd *exec.Cmd)
+
+// Stdin sets the internal *exec.Cmd's Stdin field.
+func Stdin(r io.Reader) CmdOption {
+	return func(c *exec.Cmd) {
+		c.Stdin = r
+	}
+}
+
+// Stdout sets the internal *exec.Cmd's Stdout field.
+func Stdout(writer io.Writer) CmdOption {
+	return func(c *exec.Cmd) {
+		c.Stdout = writer
+	}
+}
+
+// Stderr sets the internal *exec.Cmd's Stderr field.
+func Stderr(writer io.Writer) CmdOption {
+	return func(c *exec.Cmd) {
+		c.Stderr = writer
+	}
+}
+
+type cmdRunner interface {
+	Run() error
+}
+
+// Cmd runs external commands, it wraps the exec.Command function from the stdlib so that
+// running external commands can be unit tested.
+type Cmd struct {
+	command func(name string, args []string, opts ...CmdOption) cmdRunner
+}
+
+// NewCmd returns a Cmd that can run external commands.
+func NewCmd() *Cmd {
+	return &Cmd{
+		command: func(name string, args []string, opts ...CmdOption) cmdRunner {
+			cmd := exec.Command(name, args...)
+			cmd.Stdout = os.Stdout
+			cmd.Stderr = os.Stderr
+			for _, opt := range opts {
+				opt(cmd)
+			}
+			return cmd
+		},
+	}
+}
+
+// Run starts the named command and waits until it finishes.
+func (c *Cmd) Run(name string, args []string, opts ...CmdOption) error {
+	cmd := c.command(name, args, opts...)
+	return cmd.Run()
+}

internal/exec/cmd.go

@@ -0,0 +1,31 @@
+package exec
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/golang/mock/gomock"
+)
+
+func TestRun(t *testing.T) {
+	t.Run("should delegate to exec and call Run", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		cmd := &Cmd{
+			command: func(name string, args []string, opts ...CmdOption) cmdRunner {
+				assert.Equal(t, "date", name)
+
+				m := NewMockcmdRunner(ctrl)
+				m.EXPECT().Run().Return(nil)
+
+				return m
+			},
+		}
+
+		err := cmd.Run("date", nil)
+
+		assert.NoError(t, err)
+	})
+}

internal/exec/cmd_mock.go

@@ -0,0 +1,20 @@
+//go:build !windows
+// +build !windows
+
+package exec
+
+import (
+	"os"
+	"os/signal"
+)
+
+// InteractiveRun runs the input command that starts a child process.
+func (c *Cmd) InteractiveRun(name string, args ...string) error {
+	// Ignore interrupt signal otherwise the program exits.
+	signal.Ignore(os.Interrupt)
+	defer signal.Reset(os.Interrupt)
+
+	cmd := c.command(name, args, Stdout(os.Stdout), Stdin(os.Stdin), Stderr(os.Stderr))
+
+	return cmd.Run()
+}

internal/exec/cmd_test.go

@@ -0,0 +1,45 @@
+package exec
+
+import (
+	"os"
+	"os/exec"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInteractiveRun(t *testing.T) {
+	t.Run("should enable default stdin, stdout, and stderr before running the command", func(t *testing.T) {
+		// GIVEN
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		cmd := &Cmd{
+			command: func(name string, args []string, opts ...CmdOption) cmdRunner {
+				assert.Equal(t, "date", name)
+
+				// Make sure that the options applied are what we expect.
+				cmd := &exec.Cmd{}
+				for _, opt := range opts {
+					opt(cmd)
+				}
+
+				assert.Equal(t, os.Stdin, cmd.Stdin)
+				assert.Equal(t, os.Stdout, cmd.Stdout)
+				assert.Equal(t, os.Stderr, cmd.Stderr)
+
+				m := NewMockcmdRunner(ctrl)
+				m.EXPECT().Run().Return(nil)
+
+				return m
+			},
+		}
+
+		// WHEN
+		err := cmd.InteractiveRun("date")
+
+		// THEN
+		assert.NoError(t, err)
+	})
+}

internal/exec/interactive_run.go

@@ -0,0 +1,22 @@
+//go:build windows
+// +build windows
+
+package exec
+
+import (
+	"os"
+	"os/signal"
+)
+
+// InteractiveRun runs the input command that starts a child process.
+func (c *Cmd) InteractiveRun(name string, args ...string) error {
+	sig := make(chan os.Signal, 1)
+
+	// See https://golang.org/pkg/os/signal/#hdr-Windows
+	signal.Notify(sig, os.Interrupt)
+	defer signal.Reset(os.Interrupt)
+
+	cmd := c.command(name, args, Stdout(os.Stdout), Stdin(os.Stdin), Stderr(os.Stderr))
+
+	return cmd.Run()
+}

internal/exec/interactive_run_test.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 
 	aws_ssm "github.com/aws/aws-sdk-go-v2/service/ssm"
-	"github.com/hupe1980/gotoaws/internal"
+	"github.com/hupe1980/gotoaws/internal/exec"
 	"github.com/hupe1980/gotoaws/pkg/config"
 	"github.com/hupe1980/gotoaws/pkg/ssm"
 )
@@ -94,11 +94,9 @@ func (sess *session) RunSSH(input *RunSSHInput) error {
 		}
 	}
 
-	if err := internal.RunSubprocess("ssh", args...); err != nil {
-		return err
-	}
+	cmd := exec.NewCmd()
 
-	return nil
+	return cmd.InteractiveRun("ssh", args...)
 }
 
 func (sess *session) RunSCP(input *RunSCPInput) error {
@@ -115,13 +113,9 @@ func (sess *session) RunSCP(input *RunSCPInput) error {
 		}
 	}
 
-	fmt.Println(strings.Join(args, " "))
-
-	if err := internal.RunSubprocess("scp", args...); err != nil {
-		return err
-	}
+	cmd := exec.NewCmd()
 
-	return nil
+	return cmd.InteractiveRun("scp", args...)
 }
 
 func sshArgs(input *RunSSHInput) string {