Implement devspace enter (#247)

Author: FabianKramm

cmd/enter.go

@@ -0,0 +1,112 @@
+package cmd
+
+import (
+	helmClient "github.com/covexo/devspace/pkg/devspace/clients/helm"
+	"github.com/covexo/devspace/pkg/devspace/clients/kubectl"
+	"github.com/covexo/devspace/pkg/devspace/config/configutil"
+	"github.com/covexo/devspace/pkg/util/log"
+	"github.com/spf13/cobra"
+	k8sv1 "k8s.io/api/core/v1"
+	"k8s.io/client-go/kubernetes"
+	kubectlExec "k8s.io/client-go/util/exec"
+)
+
+// EnterCmd is a struct that defines a command call for "enter"
+type EnterCmd struct {
+	flags   *EnterCmdFlags
+	helm    *helmClient.HelmClientWrapper
+	kubectl *kubernetes.Clientset
+	pod     *k8sv1.Pod
+}
+
+// EnterCmdFlags are the flags available for the enter-command
+type EnterCmdFlags struct {
+	container string
+}
+
+func init() {
+	cmd := &EnterCmd{
+		flags: &EnterCmdFlags{},
+	}
+
+	cobraCmd := &cobra.Command{
+		Use:   "enter",
+		Short: "Enter your DevSpace",
+		Long: `
+#######################################################
+################## devspace enter #####################
+#######################################################
+Execute a command or start a new terminal in your 
+devspace:
+
+devspace enter
+devspace enter bash
+devspace enter -c myContainer
+#######################################################`,
+		Run: cmd.Run,
+	}
+	rootCmd.AddCommand(cobraCmd)
+
+	cobraCmd.Flags().StringVarP(&cmd.flags.container, "container", "c", "", "Container name within pod where to execute command")
+}
+
+// Run executes the command logic
+func (cmd *EnterCmd) Run(cobraCmd *cobra.Command, args []string) {
+	var err error
+	log.StartFileLogging()
+
+	cmd.kubectl, err = kubectl.NewClient()
+	if err != nil {
+		log.Fatalf("Unable to create new kubectl client: %v", err)
+	}
+
+	log.StartWait("Initializing helm client")
+	cmd.helm, err = helmClient.NewClient(cmd.kubectl, false)
+	log.StopWait()
+	if err != nil {
+		log.Fatalf("Error initializing helm client: %s", err.Error())
+	}
+
+	// Check if we find a running release pod
+	pod, err := getRunningDevSpacePod(cmd.helm, cmd.kubectl)
+	if err != nil {
+		log.Fatal("Cannot find a running devspace pod")
+	}
+
+	enterTerminal(cmd.kubectl, pod, cmd.flags.container, args)
+}
+
+func enterTerminal(client *kubernetes.Clientset, pod *k8sv1.Pod, containerNameOverride string, args []string) {
+	var command []string
+	config := configutil.GetConfig(false)
+
+	if len(args) == 0 && (config.DevSpace.Terminal.Command == nil || len(*config.DevSpace.Terminal.Command) == 0) {
+		command = []string{
+			"sh",
+			"-c",
+			"command -v bash >/dev/null 2>&1 && exec bash || exec sh",
+		}
+	} else {
+		if len(args) > 0 {
+			command = args
+		} else {
+			for _, cmd := range *config.DevSpace.Terminal.Command {
+				command = append(command, *cmd)
+			}
+		}
+	}
+
+	containerName := pod.Spec.Containers[0].Name
+	if containerNameOverride != "" {
+		containerName = containerNameOverride
+	} else if config.DevSpace.Terminal.ContainerName != nil {
+		containerName = *config.DevSpace.Terminal.ContainerName
+	}
+
+	_, _, _, terminalErr := kubectl.Exec(client, pod, containerName, command, true, nil)
+	if terminalErr != nil {
+		if _, ok := terminalErr.(kubectlExec.CodeExitError); ok == false {
+			log.Fatalf("Unable to start terminal session: %v", terminalErr)
+		}
+	}
+}

cmd/up.go

@@ -38,7 +38,6 @@ import (
 	k8sv1 "k8s.io/api/core/v1"
 	k8sv1beta1 "k8s.io/api/rbac/v1beta1"
 	"k8s.io/client-go/kubernetes"
-	kubectlExec "k8s.io/client-go/util/exec"
 )
 
 // UpCmd is a struct that defines a command call for "up"
@@ -181,7 +180,7 @@ func (cmd *UpCmd) Run(cobraCmd *cobra.Command, args []string) {
 		}()
 	}
 
-	cmd.enterTerminal(args)
+	enterTerminal(cmd.kubectl, cmd.pod, cmd.flags.container, args)
 }
 
 func (cmd *UpCmd) ensureNamespace() error {
@@ -795,41 +794,6 @@ func (cmd *UpCmd) startPortForwarding() {
 	}
 }
 
-func (cmd *UpCmd) enterTerminal(args []string) {
-	var command []string
-	config := configutil.GetConfig(false)
-
-	if len(args) == 0 && (config.DevSpace.Terminal.Command == nil || len(*config.DevSpace.Terminal.Command) == 0) {
-		command = []string{
-			"sh",
-			"-c",
-			"command -v bash >/dev/null 2>&1 && exec bash || exec sh",
-		}
-	} else {
-		if len(args) > 0 {
-			command = args
-		} else {
-			for _, cmd := range *config.DevSpace.Terminal.Command {
-				command = append(command, *cmd)
-			}
-		}
-	}
-
-	containerName := cmd.pod.Spec.Containers[0].Name
-	if cmd.flags.container != "" {
-		containerName = cmd.flags.container
-	} else if config.DevSpace.Terminal.ContainerName != nil {
-		containerName = *config.DevSpace.Terminal.ContainerName
-	}
-
-	_, _, _, terminalErr := kubectl.Exec(cmd.kubectl, cmd.pod, containerName, command, true, nil)
-	if terminalErr != nil {
-		if _, ok := terminalErr.(kubectlExec.CodeExitError); ok == false {
-			log.Fatalf("Unable to start terminal session: %v", terminalErr)
-		}
-	}
-}
-
 func waitForPodReady(kubectl *kubernetes.Clientset, pod *k8sv1.Pod, maxWaitTime time.Duration, checkInterval time.Duration) error {
 	for maxWaitTime > 0 {
 		pod, err := kubectl.Core().Pods(pod.Namespace).Get(pod.Name, metav1.GetOptions{})

docs/docs/cli/enter.md

@@ -0,0 +1,20 @@
+---
+title: devspace enter
+---
+
+Execute a command or start a new terminal in your devspace.  
+
+```bash
+Usage:
+  devspace enter [flags]
+
+Flags:
+  -c, --container string   Container name within pod where to execute command
+  -h, --help               help for enter
+
+Examples: 
+devspace enter
+devspace enter bash
+devspace enter echo 123
+devspace enter -c myContainer
+```