Merge pull request #1802 from FabianKramm/master

feat: new --dependency flag for devspace print

Author: FabianKramm

cmd/print.go

@@ -2,17 +2,14 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/loft-sh/devspace/pkg/devspace/hook"
-	"io"
-	"os"
-	"path/filepath"
-
 	"github.com/loft-sh/devspace/pkg/devspace/config"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency"
+	"github.com/loft-sh/devspace/pkg/devspace/hook"
 	"github.com/loft-sh/devspace/pkg/devspace/plugin"
+	"io"
+	"os"
 
 	"github.com/loft-sh/devspace/cmd/flags"
-	"github.com/loft-sh/devspace/pkg/devspace/config/loader"
 	"github.com/loft-sh/devspace/pkg/util/factory"
 	logger "github.com/loft-sh/devspace/pkg/util/log"
 	"github.com/loft-sh/devspace/pkg/util/message"
@@ -28,6 +25,8 @@ type PrintCmd struct {
 
 	Out      io.Writer
 	SkipInfo bool
+
+	Dependency string
 }
 
 // NewPrintCmd creates a new devspace print command
@@ -54,6 +53,7 @@ profile after all patching and variable substitution
 	}
 
 	printCmd.Flags().BoolVar(&cmd.SkipInfo, "skip-info", false, "When enabled, only prints the configuration without additional information")
+	printCmd.Flags().StringVar(&cmd.Dependency, "dependency", "", "The dependency to print the config from. Use dot to access nested dependencies (e.g. dep1.dep2)")
 
 	return printCmd
 }
@@ -98,13 +98,22 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 		return err
 	}
 
+	if cmd.Dependency != "" {
+		dep := dependency.GetDependencyByPath(dependencies, cmd.Dependency)
+		if dep == nil {
+			return fmt.Errorf("couldn't find dependency %s: make sure it gets loaded correctly", cmd.Dependency)
+		}
+
+		loadedConfig = dep.Config()
+	}
+
 	bsConfig, err := yaml.Marshal(loadedConfig.Config())
 	if err != nil {
 		return err
 	}
 
 	if !cmd.SkipInfo {
-		err = printExtraInfo(cmd.ConfigPath, loadedConfig, log)
+		err = printExtraInfo(loadedConfig, log)
 		if err != nil {
 			return err
 		}
@@ -122,12 +131,7 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 	return nil
 }
 
-func printExtraInfo(configPath string, config config.Config, log logger.Logger) error {
-	absPath, err := filepath.Abs(loader.ConfigPath(configPath))
-	if err != nil {
-		return err
-	}
-
+func printExtraInfo(config config.Config, log logger.Logger) error {
 	log.WriteString("\n-------------------\n\nVars:\n")
 
 	headerColumnNames := []string{"Name", "Value"}
@@ -146,7 +150,6 @@ func printExtraInfo(configPath string, config config.Config, log logger.Logger)
 		log.Info("No vars found")
 	}
 
-	log.WriteString("\n-------------------\n\nLoaded path: " + absPath + "\n\n-------------------\n\n")
-
+	log.WriteString("\n-------------------\n\nLoaded path: " + config.Path() + "\n\n-------------------\n\n")
 	return nil
 }

cmd/run.go

@@ -143,9 +143,9 @@ func (cmd *RunCmd) RunRun(f factory.Factory, args []string) error {
 
 	// check if dependency command
 	commandSplitted := strings.Split(args[0], ".")
-	if len(commandSplitted) == 2 {
-		cmd.Dependency = commandSplitted[0]
-		args[0] = commandSplitted[1]
+	if len(commandSplitted) > 1 {
+		cmd.Dependency = strings.Join(commandSplitted[:len(commandSplitted)-1], ".")
+		args[0] = commandSplitted[len(commandSplitted)-1]
 	}
 
 	// Execute plugin hook
@@ -161,11 +161,19 @@ func (cmd *RunCmd) RunRun(f factory.Factory, args []string) error {
 			return err
 		}
 
-		return f.NewDependencyManager(config, nil, configOptions, f.GetLog()).Command(dependency.CommandOptions{
-			Dependency: cmd.Dependency,
-			Command:    args[0],
-			Args:       args[1:],
+		dependencies, err := f.NewDependencyManager(config, nil, configOptions, f.GetLog()).ResolveAll(dependency.ResolveOptions{
+			Silent: true,
 		})
+		if err != nil {
+			return err
+		}
+
+		dep := dependency.GetDependencyByPath(dependencies, cmd.Dependency)
+		if dep == nil {
+			return fmt.Errorf("couldn't find dependency %s", cmd.Dependency)
+		}
+
+		return dep.Command(args[0], args[1:])
 	}
 
 	// load generated

pkg/devspace/dependency/dependency.go

@@ -51,9 +51,6 @@ type Manager interface {
 
 	// RenderAll renders all dependencies
 	RenderAll(options RenderOptions) ([]types.Dependency, error)
-
-	// Command executes a dependency command
-	Command(options CommandOptions) error
 }
 
 type manager struct {
@@ -114,40 +111,6 @@ func (m *manager) ResolveAll(options ResolveOptions) ([]types.Dependency, error)
 	return dependencies, nil
 }
 
-// CommandOptions has all options for executing a command from a dependency
-type CommandOptions struct {
-	Dependency         string
-	Command            string
-	Args               []string
-	UpdateDependencies bool
-	Verbose            bool
-}
-
-// Command will execute a dependency command
-func (m *manager) Command(options CommandOptions) error {
-	found := false
-	_, err := m.handleDependencies(nil, []string{options.Dependency}, false, options.UpdateDependencies, true, options.Verbose, "Command", func(dependency *Dependency, log log.Logger) error {
-		// Switch current working directory
-		currentWorkingDirectory, err := dependency.prepare(true)
-		if err != nil {
-			return err
-		} else if currentWorkingDirectory == "" {
-			return nil
-		}
-
-		// Change back to original working directory
-		defer func() { _ = os.Chdir(currentWorkingDirectory) }()
-
-		found = true
-		return ExecuteCommand(dependency.localConfig.Config().Commands, options.Command, options.Args, os.Stdout, os.Stderr)
-	})
-	if !found {
-		return fmt.Errorf("couldn't find dependency %s", options.Dependency)
-	}
-
-	return err
-}
-
 // ExecuteCommand executes a given command from the available commands
 func ExecuteCommand(commands []*latest.CommandConfig, cmd string, args []string, stdout io.Writer, stderr io.Writer) error {
 	err := command.ExecuteCommand(commands, cmd, args, stdout, stderr)
@@ -389,6 +352,32 @@ func (m *manager) handleDependencies(skipDependencies, filterDependencies []stri
 	return retDependencies, nil
 }
 
+func GetDependencyByPath(dependencies []types.Dependency, path string) types.Dependency {
+	splitted := strings.Split(path, ".")
+
+	var retDependency types.Dependency
+	searchDependencies := dependencies
+	for _, segment := range splitted {
+		var nextDependency types.Dependency
+		for _, dependency := range searchDependencies {
+			if dependency.Name() == segment {
+				nextDependency = dependency
+				break
+			}
+		}
+
+		// not found, exit here
+		if nextDependency == nil {
+			return nil
+		}
+
+		searchDependencies = nextDependency.Children()
+		retDependency = nextDependency
+	}
+
+	return retDependency
+}
+
 // Dependency holds the dependency config and has an id
 type Dependency struct {
 	id          string
@@ -429,6 +418,20 @@ func (d *Dependency) Root() bool { return d.root }
 
 func (d *Dependency) BuiltImages() map[string]string { return d.builtImages }
 
+func (d *Dependency) Command(command string, args []string) error {
+	// Switch current working directory
+	currentWorkingDirectory, err := d.prepare(true)
+	if err != nil {
+		return err
+	} else if currentWorkingDirectory == "" {
+		return nil
+	}
+
+	// Change back to original working directory
+	defer func() { _ = os.Chdir(currentWorkingDirectory) }()
+	return ExecuteCommand(d.localConfig.Config().Commands, command, args, os.Stdout, os.Stderr)
+}
+
 // Build builds and pushes all defined images
 func (d *Dependency) Build(forceDependencies bool, buildOptions *build.Options, log log.Logger) error {
 	// Switch current working directory

pkg/devspace/dependency/types/types.go

@@ -40,4 +40,7 @@ type Dependency interface {
 
 	// StartPortForwarding starts the dependency port-forwarding
 	StartPortForwarding(client kubectl.Client, interrupt chan error, logger log.Logger) error
+
+	// Command executes a command from the dependency config
+	Command(command string, args []string) error
 }