Merge pull request #1847 from FabianKramm/master

Deduplicate dependencies & print dependency tree

Author: FabianKramm

cmd/print.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"github.com/loft-sh/devspace/pkg/devspace/config"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency"
+	"github.com/loft-sh/devspace/pkg/devspace/dependency/types"
 	"github.com/loft-sh/devspace/pkg/devspace/hook"
 	"github.com/loft-sh/devspace/pkg/devspace/plugin"
 	"io"
@@ -113,7 +114,7 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 	}
 
 	if !cmd.SkipInfo {
-		err = printExtraInfo(loadedConfig, log)
+		err = printExtraInfo(loadedConfig, dependencies, log)
 		if err != nil {
 			return err
 		}
@@ -131,7 +132,7 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 	return nil
 }
 
-func printExtraInfo(config config.Config, log logger.Logger) error {
+func printExtraInfo(config config.Config, dependencies []types.Dependency, log logger.Logger) error {
 	log.WriteString("\n-------------------\n\nVars:\n")
 
 	headerColumnNames := []string{"Name", "Value"}
@@ -151,5 +152,21 @@ func printExtraInfo(config config.Config, log logger.Logger) error {
 	}
 
 	log.WriteString("\n-------------------\n\nLoaded path: " + config.Path() + "\n\n-------------------\n\n")
+
+	if len(dependencies) > 0 {
+		log.WriteString("Dependency Tree:\n\n> Root\n")
+		for _, dep := range dependencies {
+			printDependencyRecursive("--", dep, log)
+		}
+		log.WriteString("\n-------------------\n\n")
+	}
+
 	return nil
 }
+
+func printDependencyRecursive(prefix string, dep types.Dependency, log logger.Logger) {
+	log.WriteString(prefix + "> " + dep.Name() + " (ID: " + dep.ID()[:5] + ")\n")
+	for _, child := range dep.Children() {
+		printDependencyRecursive(prefix+"--", child, log)
+	}
+}

e2e/tests/dependencies/dependencies.go

@@ -39,6 +39,41 @@ var _ = DevSpaceDescribe("dependencies", func() {
 		kubeClient, err = kube.NewKubeHelper()
 	})
 
+	ginkgo.It("should skip equal dependencies", func() {
+		tempDir, err := framework.CopyToTempDir("tests/dependencies/testdata/overlapping")
+		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
+		deployCmd := &cmd.DeployCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:    true,
+				Namespace: ns,
+			},
+		}
+
+		// run the command
+		err = deployCmd.Run(f)
+		framework.ExpectNoError(err)
+
+		// make sure the dependencies are correctly deployed
+		_, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "dep1", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		_, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "dep2", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		_, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "dep3", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+		_, err = kubeClient.RawClient().AppsV1().Deployments(ns).Get(context.TODO(), "dep4", metav1.GetOptions{})
+		framework.ExpectNoError(err)
+	})
+
 	ginkgo.It("should skip dependencies", func() {
 		tempDir, err := framework.CopyToTempDir("tests/dependencies/testdata/skip")
 		framework.ExpectNoError(err)

e2e/tests/dependencies/testdata/overlapping/dep1/devspace.yaml

@@ -0,0 +1,18 @@
+version: v1beta11
+
+dependencies:
+  - name: dep2
+    source:
+      path: ../dep2
+  - name: dep3
+    source:
+      path: ../dep3
+
+deployments:
+  - name: dep1
+    helm:
+      componentChart: true
+      values:
+        containers:
+          - image: alpine
+            command: ["sleep", "infinity"]

e2e/tests/dependencies/testdata/overlapping/dep2/devspace.yaml

@@ -0,0 +1,28 @@
+version: v1beta11
+
+dependencies:
+  - name: dep3
+    source:
+      path: ../dep3
+    vars:
+    - name: NAME
+      value: dep4
+
+hooks:
+  - events: ["before:deploy"]
+    command: |-
+      if [ -f "test.yaml" ]; then
+        echo File test.yaml already exists
+        exit 1
+      else
+        echo 123 > test.yaml
+      fi
+
+deployments:
+  - name: dep2
+    helm:
+      componentChart: true
+      values:
+        containers:
+          - image: alpine
+            command: ["sleep", "infinity"]

e2e/tests/dependencies/testdata/overlapping/dep3/devspace.yaml

@@ -0,0 +1,14 @@
+version: v1beta11
+
+vars:
+  - name: NAME
+    value: dep3
+
+deployments:
+  - name: ${NAME}
+    helm:
+      componentChart: true
+      values:
+        containers:
+          - image: alpine
+            command: ["sleep", "infinity"]

e2e/tests/dependencies/testdata/overlapping/devspace.yaml

@@ -0,0 +1,9 @@
+version: v1beta11
+
+dependencies:
+  - name: dep1
+    source:
+      path: dep1
+  - name: dep2
+    source:
+      path: dep2

pkg/devspace/dependency/dependency.go

@@ -232,7 +232,7 @@ func (m *manager) handleDependencies(skipDependencies, filterDependencies []stri
 		m.log.Infof("To display the complete dependency execution log run with the '--verbose-dependencies' flag")
 	}
 
-	executedDependencies, err := m.executeDependenciesRecursive("", dependencies, skipDependencies, filterDependencies, reverse, silent, verbose, actionName, action)
+	executedDependencies, err := m.executeDependenciesRecursive("", dependencies, skipDependencies, filterDependencies, reverse, silent, verbose, actionName, action, map[string]bool{})
 	if err != nil {
 		hooksErr := hook.ExecuteHooks(m.client, m.config, dependencies, map[string]interface{}{
 			"error": err,
@@ -252,7 +252,7 @@ func (m *manager) handleDependencies(skipDependencies, filterDependencies []stri
 	return executedDependencies, nil
 }
 
-func (m *manager) executeDependenciesRecursive(base string, dependencies []types.Dependency, skipDependencies, filterDependencies []string, reverse, silent, verbose bool, actionName string, action func(dependency *Dependency, log log.Logger) error) ([]types.Dependency, error) {
+func (m *manager) executeDependenciesRecursive(base string, dependencies []types.Dependency, skipDependencies, filterDependencies []string, reverse, silent, verbose bool, actionName string, action func(dependency *Dependency, log log.Logger) error, executedDependenciesIDs map[string]bool) ([]types.Dependency, error) {
 	// Execute all dependencies
 	i := 0
 	if reverse {
@@ -267,6 +267,22 @@ func (m *manager) executeDependenciesRecursive(base string, dependencies []types
 			dependencyLogger = m.log
 		)
 
+		// Increase / Decrease counter
+		if reverse {
+			i--
+		} else {
+			i++
+		}
+
+		// skip if dependency was executed already
+		if executedDependenciesIDs[dependency.ID()] {
+			executedDependencies = append(executedDependencies, dependency)
+			continue
+		}
+
+		// make sure we don't execute the dependency again
+		executedDependenciesIDs[dependency.ID()] = true
+
 		// get dependency name
 		dependencyName := dependency.Name()
 		if base != "" {
@@ -280,7 +296,7 @@ func (m *manager) executeDependenciesRecursive(base string, dependencies []types
 				return nil, hooksErr
 			}
 
-			_, err := m.executeDependenciesRecursive(dependencyName, dependency.Children(), skipDependencies, filterDependencies, reverse, silent, verbose, actionName, action)
+			_, err := m.executeDependenciesRecursive(dependencyName, dependency.Children(), skipDependencies, filterDependencies, reverse, silent, verbose, actionName, action, executedDependenciesIDs)
 			if err != nil {
 				hooksErr := hook.ExecuteHooks(dependency.KubeClient(), dependency.Config(), dependency.Children(), map[string]interface{}{
 					"error": err,
@@ -298,13 +314,6 @@ func (m *manager) executeDependenciesRecursive(base string, dependencies []types
 			}
 		}
 
-		// Increase / Decrease counter
-		if reverse {
-			i--
-		} else {
-			i++
-		}
-
 		// Check if we should act on this dependency
 		if !foundDependency(dependencyName, filterDependencies) {
 			continue