tests: add test for attach & restart helper

Author: FabianKramm

cmd/attach.go

@@ -105,5 +105,5 @@ func (cmd *AttachCmd) Run(f factory.Factory, cobraCmd *cobra.Command, args []str
 		WithQuestion("Which pod do you want to attach to?")
 
 	// Start attach
-	return attach.StartAttach(ctx, targetselector.NewTargetSelector(options))
+	return attach.StartAttachFromCMD(ctx, targetselector.NewTargetSelector(options))
 }

cmd/deploy.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"github.com/loft-sh/devspace/cmd/flags"
-	"github.com/loft-sh/devspace/pkg/devspace/analyze"
 	"github.com/loft-sh/devspace/pkg/devspace/build"
 	"github.com/loft-sh/devspace/pkg/devspace/config/loader"
 	"github.com/loft-sh/devspace/pkg/devspace/config/versions/latest"
@@ -51,9 +50,6 @@ type DeployCmd struct {
 	Dependency              []string
 	SkipDependency          []string
 
-	Wait    bool
-	Timeout int
-
 	log logpkg.Logger
 
 	Ctx context.Context
@@ -106,9 +102,6 @@ devspace deploy --kube-context=deploy-context
 	deployCmd.Flags().StringSliceVar(&cmd.SkipDependency, "skip-dependency", []string{}, "Skips deploying the following dependencies")
 	deployCmd.Flags().StringSliceVar(&cmd.Dependency, "dependency", []string{}, "Deploys only the specific named dependencies")
 
-	deployCmd.Flags().BoolVar(&cmd.Wait, "wait", false, "If true will wait for pods to be running or fails after given timeout")
-	deployCmd.Flags().IntVar(&cmd.Timeout, "timeout", 120, "Timeout until deploy should stop waiting")
-
 	return deployCmd
 }
 
@@ -158,8 +151,6 @@ func (cmd *DeployCmd) runCommand(ctx *devspacecontext.Context, f factory.Factory
 		ConfigOptions: configOptions,
 		Only:          cmd.Dependency,
 		Pipeline:      cmd.Pipeline,
-		Wait:          cmd.Wait,
-		Timeout:       cmd.Timeout,
 	})
 }
 
@@ -230,8 +221,6 @@ type PipelineOptions struct {
 	ConfigOptions *loader.ConfigOptions
 	Only          []string
 	Pipeline      string
-	Wait          bool
-	Timeout       int
 	ShowUI        bool
 	UIPort        int
 }
@@ -323,17 +312,5 @@ func runPipeline(ctx *devspacecontext.Context, f factory.Factory, forceLeader bo
 	// wait for dev
 	pipe.WaitDev()
 
-	// wait if necessary
-	if options.Wait {
-		report, err := f.NewAnalyzer(ctx.KubeClient, f.GetLog()).CreateReport(ctx.KubeClient.Namespace(), analyze.Options{Wait: true, Patient: true, Timeout: options.Timeout, IgnorePodRestarts: true})
-		if err != nil {
-			return errors.Wrap(err, "analyze")
-		}
-
-		if len(report) > 0 {
-			return errors.Errorf(analyze.ReportToString(report))
-		}
-	}
-
 	return nil
 }

cmd/dev.go

@@ -34,7 +34,6 @@ type DevCmd struct {
 
 	SkipPush                bool
 	SkipPushLocalKubernetes bool
-	Open                    bool
 
 	Dependency     []string
 	SkipDependency []string
@@ -47,18 +46,16 @@ type DevCmd struct {
 	ForceDeploy bool
 	SkipDeploy  bool
 
-	UI     bool
 	UIPort int
 
 	Terminal         bool
 	WorkingDirectory string
 	Pipeline         string
 
-	Sync           bool
-	Portforwarding bool
-
-	Wait    bool
-	Timeout int
+	DisableUI             bool
+	DisableOpen           bool
+	DisableSync           bool
+	DisablePortForwarding bool
 
 	configLoader loader.ConfigLoader
 	log          log.Logger
@@ -114,20 +111,17 @@ Open terminal instead of logs:
 	devCmd.Flags().BoolVar(&cmd.SkipPush, "skip-push", false, "Skips image pushing, useful for minikube deployment")
 	devCmd.Flags().BoolVar(&cmd.SkipPushLocalKubernetes, "skip-push-local-kube", true, "Skips image pushing, if a local kubernetes environment is detected")
 
-	devCmd.Flags().BoolVar(&cmd.Sync, "sync", true, "Enable code synchronization")
-	devCmd.Flags().BoolVar(&cmd.Portforwarding, "portforwarding", true, "Enable port forwarding")
+	devCmd.Flags().BoolVar(&cmd.DisableSync, "disable-sync", false, "Disable code synchronization")
+	devCmd.Flags().BoolVar(&cmd.DisablePortForwarding, "disable-port-forwarding", false, "Disable port forwarding")
+	devCmd.Flags().BoolVar(&cmd.DisableUI, "disable-ui", false, "Disables the ui server")
+	devCmd.Flags().BoolVar(&cmd.DisableOpen, "disable-open", false, "Open defined URLs in the browser, if defined")
 
-	devCmd.Flags().BoolVar(&cmd.UI, "ui", true, "Start the ui server")
 	devCmd.Flags().IntVar(&cmd.UIPort, "ui-port", 0, "The port to use when opening the ui server")
-	devCmd.Flags().BoolVar(&cmd.Open, "open", true, "Open defined URLs in the browser, if defined")
 	devCmd.Flags().StringVar(&cmd.Pipeline, "pipeline", "", "The pipeline to execute")
 
 	devCmd.Flags().BoolVarP(&cmd.Terminal, "terminal", "t", false, "Open a terminal instead of showing logs")
 	devCmd.Flags().StringVar(&cmd.WorkingDirectory, "workdir", "", "The working directory where to open the terminal or execute the command")
 
-	devCmd.Flags().BoolVar(&cmd.Wait, "wait", false, "If true will wait first for pods to be running or fails after given timeout")
-	devCmd.Flags().IntVar(&cmd.Timeout, "timeout", 120, "Timeout until dev should stop waiting and fail")
-
 	return devCmd
 }
 
@@ -185,17 +179,16 @@ func (cmd *DevCmd) runCommand(ctx *devspacecontext.Context, f factory.Factory, c
 				Exclude: cmd.SkipDependency,
 			},
 			DevOptions: devpod.Options{
-				DisableSync:           !cmd.Sync,
-				DisablePortForwarding: !cmd.Portforwarding,
+				DisableSync:           cmd.DisableSync,
+				DisablePortForwarding: cmd.DisablePortForwarding,
+				DisableOpen:           cmd.DisableOpen,
 			},
 		},
 		ConfigOptions: configOptions,
 		Only:          cmd.Dependency,
 		Pipeline:      cmd.Pipeline,
-		ShowUI:        cmd.UI,
+		ShowUI:        !cmd.DisableUI,
 		UIPort:        cmd.UIPort,
-		Wait:          cmd.Wait,
-		Timeout:       cmd.Timeout,
 	})
 }
 

e2e/tests/dependencies/dependencies.go

@@ -203,9 +203,7 @@ var _ = DevSpaceDescribe("dependencies", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
-			Ctx:            cancelCtx,
+			Ctx: cancelCtx,
 		}
 		err = devCmd.Run(f)
 		framework.ExpectNoError(err)

e2e/tests/hooks/hooks.go

@@ -131,9 +131,7 @@ var _ = DevSpaceDescribe("hooks", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
-			Ctx:            cancelCtx1,
+			Ctx: cancelCtx1,
 		}
 
 		// start the command
@@ -180,9 +178,7 @@ var _ = DevSpaceDescribe("hooks", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
-			Ctx:            cancelCtx2,
+			Ctx: cancelCtx2,
 		}
 
 		// start the command

e2e/tests/replacepods/replacepods.go

@@ -38,6 +38,52 @@ var _ = DevSpaceDescribe("replacepods", func() {
 		framework.ExpectNoError(err)
 	})
 
+	ginkgo.FIt("should inject restart helper and restart container", func() {
+		tempDir, err := framework.CopyToTempDir("tests/replacepods/testdata/restart-helper")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("replacepods")
+		framework.ExpectNoError(err)
+		defer framework.ExpectDeleteNamespace(kubeClient, ns)
+
+		// create a new dev command and start it
+		done := make(chan error)
+		cancelCtx, cancel := context.WithCancel(context.Background())
+		defer cancel()
+		go func() {
+			devCmd := &cmd.DevCmd{
+				GlobalFlags: &flags.GlobalFlags{
+					NoWarn:    true,
+					Namespace: ns,
+				},
+				Ctx: cancelCtx,
+			}
+			err := devCmd.Run(f)
+			if err != nil {
+				f.GetLog().Errorf("error: %v", err)
+			}
+			done <- err
+		}()
+
+		// check if file is there
+		framework.ExpectRemoteFileContents("ubuntu", ns, "/test.txt", "Hello World\n")
+
+		// upload a file and restart the container
+		err = ioutil.WriteFile("test1.txt", []byte("Hello World2!"), 0777)
+		framework.ExpectNoError(err)
+
+		// wait for uploaded
+		framework.ExpectRemoteFileContents("ubuntu", ns, "/app/test1.txt", "Hello World2!")
+
+		// wait for restarted
+		framework.ExpectRemoteFileContents("ubuntu", ns, "/test.txt", "Hello World\nHello World\n")
+
+		cancel()
+		err = <-done
+		framework.ExpectNoError(err)
+	})
+
 	ginkgo.It("should replace statefulset pod", func() {
 		tempDir, err := framework.CopyToTempDir("tests/replacepods/testdata/statefulset")
 		framework.ExpectNoError(err)
@@ -53,8 +99,6 @@ var _ = DevSpaceDescribe("replacepods", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
 		}
 		err = devCmd.Run(f)
 		framework.ExpectNoError(err)
@@ -96,8 +140,6 @@ var _ = DevSpaceDescribe("replacepods", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
 		}
 		err = devCmd.Run(f)
 		framework.ExpectNoError(err)
@@ -161,8 +203,6 @@ var _ = DevSpaceDescribe("replacepods", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
 		}
 		err = devCmd.Run(f)
 		framework.ExpectNoError(err)
@@ -199,8 +239,6 @@ var _ = DevSpaceDescribe("replacepods", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
 		}
 		err = devCmd.Run(f)
 		framework.ExpectNoError(err)

e2e/tests/replacepods/testdata/restart-helper/devspace.yaml

@@ -0,0 +1,15 @@
+version: v2beta1
+name: attach
+
+pipelines:
+  dev:
+    steps:
+      - run: |-
+          create_deployments test --set helm.values.containers[0].image=ubuntu
+          
+          start_dev test --set imageSelector=ubuntu \
+                         --set 'command={sh,-c,echo Hello World >> /test.txt; sleep 100000}' \
+                         --set logs.enabled=true \
+                         --set sync[0].path=.:/app \
+                         --set sync[0].onUpload.restartContainer=true \
+                         --set sync[0].excludePaths[0]=devspace.yaml

e2e/tests/sync/sync.go

@@ -193,9 +193,7 @@ var _ = DevSpaceDescribe("sync", func() {
 				NoWarn:    true,
 				Namespace: ns,
 			},
-			Portforwarding: true,
-			Sync:           true,
-			Ctx:            cancelCtx,
+			Ctx: cancelCtx,
 		}
 
 		// start the command

e2e/tests/terminal/terminal.go

@@ -39,6 +39,55 @@ var _ = DevSpaceDescribe("terminal", func() {
 		framework.ExpectNoError(err)
 	})
 
+	ginkgo.It("should attach", func() {
+		tempDir, err := framework.CopyToTempDir("tests/terminal/testdata/attach")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("attach")
+		framework.ExpectNoError(err)
+		defer framework.ExpectDeleteNamespace(kubeClient, ns)
+
+		buffer := &bytes.Buffer{}
+		devpod.DefaultTerminalStdout = buffer
+		devpod.DefaultTerminalStderr = buffer
+		devpod.DefaultTerminalStdin = strings.NewReader(`mkdir -p /test/devspace
+echo "Hello World!" > /test/devspace/test.txt
+sleep 1000000
+`)
+		defer func() {
+			devpod.DefaultTerminalStdout = os.Stdout
+			devpod.DefaultTerminalStderr = os.Stderr
+			devpod.DefaultTerminalStdin = os.Stdin
+		}()
+
+		// create a new dev command and start it
+		done := make(chan error)
+		cancelCtx, cancel := context.WithCancel(context.Background())
+		defer cancel()
+		go func() {
+			devCmd := &cmd.DevCmd{
+				GlobalFlags: &flags.GlobalFlags{
+					NoWarn:    true,
+					Namespace: ns,
+				},
+				Ctx: cancelCtx,
+			}
+			err := devCmd.Run(f)
+			if err != nil {
+				f.GetLog().Errorf("error: %v", err)
+			}
+			done <- err
+		}()
+
+		// check if file is there
+		framework.ExpectRemoteFileContents("ubuntu", ns, "/test/devspace/test.txt", "Hello World!\n")
+
+		cancel()
+		err = <-done
+		framework.ExpectNoError(err)
+	})
+
 	ginkgo.It("should restart terminal", func() {
 		tempDir, err := framework.CopyToTempDir("tests/terminal/testdata/restart")
 		framework.ExpectNoError(err)

e2e/tests/terminal/testdata/attach/devspace.yaml

@@ -0,0 +1,13 @@
+version: v2beta1
+name: attach
+
+pipelines:
+  dev:
+    steps:
+      - run: |-
+          create_deployments test --set helm.values.containers[0].image=ubuntu
+          
+          start_dev test --set imageSelector=ubuntu \
+                         --set attach.enabled=true \
+                         --set attach.disableTTY=true  
+