feat: refactor restart helper options & force purge

Author: FabianKramm

cmd/reset/pods.go

@@ -3,6 +3,7 @@ package reset
 import (
 	"context"
 	devspacecontext "github.com/loft-sh/devspace/pkg/devspace/context"
+	"github.com/loft-sh/devspace/pkg/devspace/deploy"
 	"github.com/loft-sh/devspace/pkg/devspace/kubectl"
 
 	"github.com/loft-sh/devspace/cmd/flags"
@@ -18,6 +19,8 @@ import (
 type podsCmd struct {
 	*flags.GlobalFlags
 
+	Force bool
+
 	log log.Logger
 }
 
@@ -45,6 +48,7 @@ devspace reset pods
 			return cmd.RunResetPods(f, cobraCmd, args)
 		}}
 
+	podsCmd.Flags().BoolVar(&cmd.Force, "force", false, "If true will force resetting pods even though they might be still used by other DevSpace projects")
 	return podsCmd
 }
 
@@ -102,32 +106,32 @@ func (cmd *podsCmd) RunResetPods(f factory.Factory, cobraCmd *cobra.Command, arg
 	ctx = ctx.WithDependencies(dependencies)
 
 	// reset the pods
-	ResetPods(ctx, true)
+	ResetPods(ctx, true, cmd.Force)
 	return nil
 }
 
 // ResetPods deletes the pods created by dev.replacePods
-func ResetPods(ctx *devspacecontext.Context, dependencies bool) {
-	resetted := ResetPodsRecursive(ctx, dependencies)
+func ResetPods(ctx *devspacecontext.Context, dependencies, force bool) {
+	resetted := ResetPodsRecursive(ctx, dependencies, force)
 	if resetted == 0 {
 		ctx.Log.Info("No dev pods to reset found")
 	} else {
 		ctx.Log.Donef("Successfully reset %d pods", resetted)
 	}
 }
 
-func ResetPodsRecursive(ctx *devspacecontext.Context, dependencies bool) int {
+func ResetPodsRecursive(ctx *devspacecontext.Context, dependencies, force bool) int {
 	resetted := 0
 	if dependencies {
 		for _, d := range ctx.Dependencies {
-			resetted += ResetPodsRecursive(ctx.AsDependency(d), dependencies)
+			resetted += ResetPodsRecursive(ctx.AsDependency(d), dependencies, force)
 		}
 	}
 
 	// create pod replacer
 	podReplacer := podreplace.NewPodReplacer()
 	for _, replacePodCache := range ctx.Config.RemoteCache().ListDevPods() {
-		deleted, err := podReplacer.RevertReplacePod(ctx, &replacePodCache)
+		deleted, err := podReplacer.RevertReplacePod(ctx, &replacePodCache, &deploy.PurgeOptions{ForcePurge: force})
 		if err != nil {
 			ctx.Log.Warnf("Error resetting replaced pod: %v", err)
 		} else if deleted {

cmd/run_pipeline.go

@@ -58,6 +58,8 @@ type RunPipelineCmd struct {
 	BuildSequential     bool
 	MaxConcurrentBuilds int
 
+	ForcePurge bool
+
 	ForceDeploy bool
 	SkipDeploy  bool
 
@@ -83,6 +85,7 @@ func (cmd *RunPipelineCmd) AddFlags(command *cobra.Command) {
 	command.Flags().IntVar(&cmd.MaxConcurrentBuilds, "max-concurrent-builds", cmd.MaxConcurrentBuilds, "The maximum number of image builds built in parallel (0 for infinite)")
 	command.Flags().BoolVar(&cmd.Render, "render", cmd.Render, "If true will render manifests and print them instead of actually deploying them")
 
+	command.Flags().BoolVar(&cmd.ForcePurge, "force-purge", cmd.ForcePurge, "Forces to purge every deployment even though it might be in use by another DevSpace project")
 	command.Flags().BoolVarP(&cmd.ForceDeploy, "force-deploy", "d", cmd.ForceDeploy, "Forces to deploy every deployment")
 	command.Flags().BoolVar(&cmd.SkipDeploy, "skip-deploy", cmd.SkipDeploy, "If enabled will skip deploying")
 	command.Flags().StringVar(&cmd.Pipeline, "pipeline", cmd.Pipeline, "The pipeline to execute")
@@ -224,6 +227,9 @@ func (cmd *RunPipelineCmd) BuildOptions(configOptions *loader.ConfigOptions) *Pi
 				RenderWriter: cmd.RenderWriter,
 				SkipDeploy:   cmd.SkipDeploy,
 			},
+			PurgeOptions: deploy.PurgeOptions{
+				ForcePurge: cmd.ForcePurge,
+			},
 			DependencyOptions: types.DependencyOptions{
 				Exclude: cmd.SkipDependency,
 				Only:    cmd.Dependency,
@@ -300,6 +306,9 @@ func (cmd *RunPipelineCmd) prepare(ctx context.Context, f factory.Factory, confi
 		return nil, err
 	}
 
+	// add root name to context
+	ctx = values.WithRootName(ctx, configInterface.Config().Name)
+
 	// adjust config
 	err = cmd.adjustConfig(configInterface)
 	if err != nil {

e2e/tests/dependencies/dependencies.go

@@ -41,6 +41,109 @@ var _ = DevSpaceDescribe("dependencies", func() {
 		kubeClient, err = kube.NewKubeHelper()
 	})
 
+	ginkgo.It("should not purge common dependency", func() {
+		tempDir, err := framework.CopyToTempDir("tests/dependencies/testdata/purge")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("dependencies")
+		framework.ExpectNoError(err)
+		defer func() {
+			err := kubeClient.DeleteNamespace(ns)
+			framework.ExpectNoError(err)
+		}()
+
+		// create a new dev command and start it
+		devCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "project1.yaml",
+			},
+			Pipeline: "dev",
+		}
+		err = devCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// make sure the dependencies are correctly deployed
+		deploy, err := kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "my-deployment", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(deploy.Spec.Template.Spec.Containers[0].Image, "alpine")
+
+		// check if replica set exists & pod got replaced correctly
+		list, err := kubeClient.Client().KubeClient().AppsV1().Deployments(ns).List(context.TODO(), metav1.ListOptions{LabelSelector: selector.ReplacedLabel + "=true"})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(len(list.Items), 1)
+		framework.ExpectEqual(list.Items[0].Spec.Template.Spec.Containers[0].Command, []string{"sleep"})
+
+		// run second dev command
+		devCmd = &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "project2.yaml",
+			},
+			Pipeline: "dev",
+		}
+		err = devCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// make sure the dependencies are correctly deployed
+		deploy, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "my-deployment", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(deploy.Spec.Template.Spec.Containers[0].Image, "alpine")
+
+		// check if replica set exists & pod got replaced correctly
+		list, err = kubeClient.Client().KubeClient().AppsV1().Deployments(ns).List(context.TODO(), metav1.ListOptions{LabelSelector: selector.ReplacedLabel + "=true"})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(len(list.Items), 1)
+		framework.ExpectEqual(list.Items[0].Spec.Template.Spec.Containers[0].Command, []string{"sleep"})
+
+		// purge project 1
+		purgeCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "project1.yaml",
+			},
+			Pipeline: "purge",
+		}
+		err = purgeCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// make sure the dependencies are correctly deployed
+		deploy, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "my-deployment", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(deploy.Spec.Template.Spec.Containers[0].Image, "alpine")
+
+		// check if replica set exists & pod got replaced correctly
+		list, err = kubeClient.Client().KubeClient().AppsV1().Deployments(ns).List(context.TODO(), metav1.ListOptions{LabelSelector: selector.ReplacedLabel + "=true"})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(len(list.Items), 1)
+		framework.ExpectEqual(list.Items[0].Spec.Template.Spec.Containers[0].Command, []string{"sleep"})
+
+		// purge project 2
+		purgeCmd = &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "project2.yaml",
+			},
+			Pipeline: "purge",
+		}
+		err = purgeCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// make sure the dependencies are correctly deployed
+		deploy, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "my-deployment", metav1.GetOptions{})
+		framework.ExpectError(err)
+
+		// check if replica set exists & pod got replaced correctly
+		list, err = kubeClient.Client().KubeClient().AppsV1().Deployments(ns).List(context.TODO(), metav1.ListOptions{LabelSelector: selector.ReplacedLabel + "=true"})
+		framework.ExpectNoError(err)
+		framework.ExpectEqual(len(list.Items), 0)
+	})
+
 	ginkgo.It("should deploy git dependency", func() {
 		tempDir, err := framework.CopyToTempDir("tests/dependencies/testdata/git")
 		framework.ExpectNoError(err)

e2e/tests/dependencies/testdata/purge/dependency.yaml

@@ -0,0 +1,15 @@
+version: v2beta1
+name: dependency
+
+deployments:
+  my-deployment:
+    helm:
+      values:
+        containers:
+          - image: alpine
+
+dev:
+  my-dev:
+    imageSelector: alpine
+    command: ["sleep"]
+    args: ["1000000"]

e2e/tests/dependencies/testdata/purge/project1.yaml

@@ -0,0 +1,8 @@
+version: v2beta1
+name: project1
+
+dependencies:
+  dependency:
+    path: dependency.yaml
+    pipeline: dev
+

e2e/tests/dependencies/testdata/purge/project2.yaml

@@ -0,0 +1,8 @@
+version: v2beta1
+name: project2
+
+dependencies:
+  dependency:
+    path: dependency.yaml
+    pipeline: dev
+

helper/cmd/sync/upstream.go

@@ -91,7 +91,7 @@ func ensurePath(args []string) (string, error) {
 	}
 
 	if absolutePath == "/" && path != "/" {
-		return "", fmt.Errorf("you are trying to sync the complete container root (/). By default this is not allowed, because this usually leads to unwanted behaviour. Please specify the correct container directory via the `--container-path` flag or `.containerPath` option")
+		return "", fmt.Errorf("you are trying to sync the complete container root (/). By default this is not allowed, because this usually leads to unwanted behaviour. Please specify the correct container directory via the `--path` flag or `.path: localPath:/remotePath` option")
 	}
 
 	return absolutePath, nil

pkg/devspace/config/remotecache/schema.go

@@ -65,6 +65,9 @@ type DevPodCache struct {
 	// Name is the name of the dev pod
 	Name string `yaml:"name,omitempty"`
 
+	// Projects are the top level projects that have started this dev configuration
+	Projects []string `yaml:"projects,omitempty"`
+
 	// Namespace is the namespace where the replace happened
 	Namespace string `yaml:"namespace,omitempty"`
 
@@ -82,6 +85,9 @@ type DevPodCache struct {
 type DeploymentCache struct {
 	Name string `yaml:"name,omitempty"`
 
+	// Projects are the top level projects that have deployed this deployment
+	Projects []string `yaml:"projects,omitempty"`
+
 	// DeploymentConfigHash is the deployment config hashed
 	DeploymentConfigHash string `yaml:"deploymentConfigHash,omitempty"`
 

pkg/devspace/config/versions/latest/schema.go

@@ -818,6 +818,9 @@ type DevContainer struct {
 	// Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
 	// devspace tries to find out the architecture by itself by looking at the node this container runs on.
 	Arch ContainerArchitecture `yaml:"arch,omitempty" json:"arch,omitempty"`
+	// RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
+	// the container and restarting it and is injected via an annotation in the replaced pod.
+	RestartHelper *RestartHelper `yaml:"restartHelper,omitempty" json:"restartHelper,omitempty"`
 
 	// ReversePorts are port mappings to make local ports available inside the container
 	ReversePorts []*PortMapping `yaml:"reversePorts,omitempty" json:"reversePorts,omitempty"`
@@ -832,11 +835,6 @@ type DevContainer struct {
 	// Env can be used to add environment variables to the container. DevSpace will
 	// not replace existing environment variables if an environment variable is defined here.
 	Env []EnvVar `yaml:"env,omitempty" json:"env,omitempty"`
-	// RestartHelperPath defines the path to the restart helper that might be used if certain config
-	// options are enabled
-	RestartHelperPath string `yaml:"restartHelperPath,omitempty" json:"restartHelperPath,omitempty"`
-	// DisableRestartHelper signals DevSpace to not inject the restart helper
-	DisableRestartHelper bool `yaml:"disableRestartHelper,omitempty" json:"disableRestartHelper,omitempty"`
 
 	// Terminal allows you to tell DevSpace to open a terminal with screen support to this container
 	Terminal *Terminal `yaml:"terminal,omitempty" json:"terminal,omitempty"`
@@ -854,6 +852,14 @@ type DevContainer struct {
 	ProxyCommands []*ProxyCommand `yaml:"proxyCommands,omitempty" json:"proxyCommands,omitempty"`
 }
 
+type RestartHelper struct {
+	// Path defines the path to the restart helper that might be used if certain config
+	// options are enabled
+	Path string `yaml:"path,omitempty" json:"path,omitempty"`
+	// Disable signals DevSpace to not inject the restart helper
+	Disable bool `yaml:"disable,omitempty" json:"disable,omitempty"`
+}
+
 type ProxyCommand struct {
 	// Command is the name of the command that should be available in the remote container. DevSpace
 	// will create a small script for that inside the container that redirect command execution to

pkg/devspace/config/versions/v1beta11/upgrade.go

@@ -771,7 +771,10 @@ func (c *Config) mergeDevConfig(log log.Logger) (map[string]*next.DevPod, error)
 	// disable sync replace
 	for k := range devPods {
 		for i := range devPods[k].Containers {
-			devPods[k].Containers[i].DisableRestartHelper = true
+			if devPods[k].Containers[i].RestartHelper == nil {
+				devPods[k].Containers[i].RestartHelper = &next.RestartHelper{}
+			}
+			devPods[k].Containers[i].RestartHelper.Disable = true
 		}
 	}
 
@@ -792,7 +795,13 @@ func (c *Config) mergeDevConfig(log log.Logger) (map[string]*next.DevPod, error)
 func getMatchingDevContainer(devPod *next.DevPod, containerName string) *next.DevContainer {
 	for key, container := range devPod.Containers {
 		if container.Container == containerName || container.Container == "" {
-			devPod.Containers[key].Container = containerName
+			if container.Container == "" && containerName != "" {
+				devContainer := container
+				devContainer.Container = containerName
+				delete(devPod.Containers, key)
+				devPod.Containers[containerName] = devContainer
+				return devPod.Containers[containerName]
+			}
 			return devPod.Containers[key]
 		} else if containerName == "" {
 			return devPod.Containers[key]