Merge pull request #2613 from lizardruss/helm-dependency-update

fix: use 'helm dependency update' command because --dependency-update…

Author: FabianKramm

e2e/tests/deploy/deploy.go

@@ -1,11 +1,16 @@
 package deploy
 
 import (
+	"bytes"
 	"context"
 	"os"
 	"path/filepath"
 	"strings"
 
+	"github.com/loft-sh/devspace/pkg/util/log"
+	"github.com/onsi/gomega"
+	"github.com/sirupsen/logrus"
+
 	"github.com/onsi/ginkgo/v2"
 
 	"github.com/loft-sh/devspace/cmd"
@@ -679,4 +684,72 @@ var _ = DevSpaceDescribe("deploy", func() {
 		framework.ExpectEqual(out2, "test")
 		framework.ExpectEqual(out3, "test")
 	})
+
+	ginkgo.It("should run helm dependency update on dependency's local chart name", func() {
+		tempDir, err := framework.CopyToTempDir("tests/deploy/testdata/helm_git_dependency_with_local_chart")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("deploy")
+		framework.ExpectNoError(err)
+		defer func() {
+			err := kubeClient.DeleteNamespace(ns)
+			framework.ExpectNoError(err)
+		}()
+
+		// create a new dev command
+		output := &bytes.Buffer{}
+		deployCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "devspace-name.yaml",
+			},
+			Pipeline: "deploy",
+			Log:      log.NewStreamLogger(output, output, logrus.DebugLevel),
+		}
+
+		// run the command
+		err = deployCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// Expect helm dependency update to be run.
+		gomega.Expect(output.String()).To(
+			gomega.ContainSubstring("helm dependency update"),
+		)
+	})
+
+	ginkgo.It("should run helm dependency update on dependency's local chart name and path", func() {
+		tempDir, err := framework.CopyToTempDir("tests/deploy/testdata/helm_git_dependency_with_local_chart")
+		framework.ExpectNoError(err)
+		defer framework.CleanupTempDir(initialDir, tempDir)
+
+		ns, err := kubeClient.CreateNamespace("deploy")
+		framework.ExpectNoError(err)
+		defer func() {
+			err := kubeClient.DeleteNamespace(ns)
+			framework.ExpectNoError(err)
+		}()
+
+		// create a new dev command
+		output := &bytes.Buffer{}
+		deployCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:     true,
+				Namespace:  ns,
+				ConfigPath: "devspace-path.yaml",
+			},
+			Pipeline: "deploy",
+			Log:      log.NewStreamLogger(output, output, logrus.DebugLevel),
+		}
+
+		// run the command
+		err = deployCmd.RunDefault(f)
+		framework.ExpectNoError(err)
+
+		// Expect helm dependency update to be run.
+		gomega.Expect(output.String()).To(
+			gomega.ContainSubstring("helm dependency update"),
+		)
+	})
 })

e2e/tests/deploy/testdata/helm_git_dependency_with_local_chart/devspace-name.yaml

@@ -0,0 +1,6 @@
+version: v2beta1
+
+dependencies:
+  dependency:
+    git: https://github.com/loft-sh/e2e-test-dependency.git
+    branch: helm-with-local-chart

e2e/tests/deploy/testdata/helm_git_dependency_with_local_chart/devspace-path.yaml

@@ -0,0 +1,7 @@
+version: v2beta1
+
+dependencies:
+  dependency:
+    git: https://github.com/loft-sh/e2e-test-dependency.git
+    branch: helm-with-local-chart
+    subPath: config-with-path

pkg/devspace/helm/generic/generic.go

@@ -3,11 +3,12 @@ package generic
 import (
 	"context"
 	"fmt"
+	"os"
+	"strings"
+
 	"github.com/loft-sh/devspace/pkg/devspace/config/constants"
 	devspacecontext "github.com/loft-sh/devspace/pkg/devspace/context"
 	"github.com/loft-sh/utils/pkg/command"
-	"os"
-	"strings"
 
 	"gopkg.in/yaml.v3"
 
@@ -76,7 +77,7 @@ func (c *client) Exec(ctx devspacecontext.Context, args []string) ([]byte, error
 
 	// disable log for list, because it prints same command multiple times if we've multiple deployments.
 	if args[0] != "list" && args[0] != "registry" && (len(args) == 1 || args[1] != "login") {
-		c.log.Debugf("Execute '%s %s'", c.helmPath, strings.Join(args, " "))
+		c.log.Debugf("Execute '%s %s' in directory %s", c.helmPath, strings.Join(args, " "), ctx.WorkingDir())
 	}
 
 	result, err := command.Output(ctx.Context(), ctx.WorkingDir(), ctx.Environ(), c.helmPath, args...)

pkg/devspace/helm/v3/client.go

@@ -111,7 +111,12 @@ func (c *client) InstallChart(ctx devspacecontext.Context, releaseName string, r
 	if helmConfig.DisableDependencyUpdate == nil || (helmConfig.DisableDependencyUpdate != nil && !*helmConfig.DisableDependencyUpdate) {
 		stat, err := os.Stat(chartPath)
 		if err == nil && stat.IsDir() {
-			args = append(args, "--dependency-update")
+			// Do not use --dependency-update because it will not update dependencies when the Chart.yaml is updated:
+			// https://github.com/helm/helm/issues/9545
+			_, err := c.genericHelm.Exec(ctx.WithWorkingDir(chartPath), []string{"dependency", "update"})
+			if err != nil {
+				ctx.Log().Warnf("error running helm dependency update: %v", err)
+			}
 		}
 	}
 	// Upgrade options
@@ -194,7 +199,12 @@ func (c *client) Template(ctx devspacecontext.Context, releaseName, releaseNames
 	if helmConfig.DisableDependencyUpdate == nil || (helmConfig.DisableDependencyUpdate != nil && !*helmConfig.DisableDependencyUpdate) {
 		stat, err := os.Stat(chartPath)
 		if err == nil && stat.IsDir() {
-			args = append(args, "--dependency-update")
+			// Do not use --dependency-update because it will not update dependencies when the Chart.yaml is updated:
+			// https://github.com/helm/helm/issues/9545
+			_, err := c.genericHelm.Exec(ctx.WithWorkingDir(chartPath), []string{"dependency", "update"})
+			if err != nil {
+				ctx.Log().Warnf("error running helm dependency update: %v", err)
+			}
 		}
 	}
 	args = append(args, helmConfig.TemplateArgs...)