refactor: remove names on devspace print

Author: FabianKramm

cmd/init.go

@@ -159,9 +159,8 @@ func (cmd *InitCmd) Run(f factory.Factory) error {
 	} else {
 		err = cmd.initDevspace(f, configLoader)
 	}
-
 	if err != nil {
-		panic(err)
+		return err
 	}
 
 	cmd.log.WriteString(logrus.InfoLevel, "\n")
@@ -434,7 +433,7 @@ func (cmd *InitCmd) initDevspace(f factory.Factory, configLoader loader.ConfigLo
 
 		config.Commands["migrate-db"] = &latest.CommandConfig{
 			Command: `echo 'This is a cross-platform, shared command that can be used to codify any kind of dev task.'
-	echo 'Anyone using this project can invoke it via "devspace run migrate-db"'`,
+echo 'Anyone using this project can invoke it via "devspace run migrate-db"'`,
 		}
 	}
 
@@ -453,8 +452,7 @@ start_dev ` + imageName + `                     # 3. Start dev mode "` + imageNa
 	config.Pipelines["deploy"] = &latest.Pipeline{
 		Run: `run_dependency_pipelines --all                    # 1. Deploy any projects this project needs (see "dependencies")
 build_images --all -t $(git describe --always)    # 2. Build, tag (git commit hash) and push all images (see "images")
-create_deployments --all \                        # 3. Deploy Helm charts and manifests specfied as "deployments"
-  --set updateImageTags=true                      #    + make sure to update all image tags to the one from step 2`,
+create_deployments --all                          # 3. Deploy Helm charts and manifests specfied as "deployments"`,
 	}
 
 	// Save config

cmd/print.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"github.com/loft-sh/devspace/pkg/devspace/config"
+	"github.com/loft-sh/devspace/pkg/devspace/config/versions/latest"
 	devspacecontext "github.com/loft-sh/devspace/pkg/devspace/context"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency"
 	"github.com/loft-sh/devspace/pkg/devspace/dependency/types"
@@ -27,8 +28,9 @@ import (
 type PrintCmd struct {
 	*flags.GlobalFlags
 
-	Out      io.Writer
-	SkipInfo bool
+	Out        io.Writer
+	StripNames bool
+	SkipInfo   bool
 
 	Dependency string
 }
@@ -37,6 +39,7 @@ type PrintCmd struct {
 func NewPrintCmd(f factory.Factory, globalFlags *flags.GlobalFlags) *cobra.Command {
 	cmd := &PrintCmd{
 		GlobalFlags: globalFlags,
+		StripNames:  true,
 		Out:         os.Stdout,
 	}
 
@@ -117,7 +120,7 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 		ctx = ctx.AsDependency(dep)
 	}
 
-	bsConfig, err := yaml.Marshal(ctx.Config().Config())
+	bsConfig, err := marshalConfig(ctx.Config().Config(), cmd.StripNames)
 	if err != nil {
 		return err
 	}
@@ -141,6 +144,41 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 	return nil
 }
 
+func marshalConfig(config *latest.Config, stripNames bool) ([]byte, error) {
+	// remove the auto generated names
+	if stripNames {
+		for k := range config.Images {
+			config.Images[k].Name = ""
+		}
+		for k := range config.Deployments {
+			config.Deployments[k].Name = ""
+		}
+		for k := range config.Dependencies {
+			config.Dependencies[k].Name = ""
+		}
+		for k := range config.Pipelines {
+			config.Pipelines[k].Name = ""
+		}
+		for k := range config.Dev {
+			config.Dev[k].Name = ""
+			for c := range config.Dev[k].Containers {
+				config.Dev[k].Containers[c].Container = ""
+			}
+		}
+		for k := range config.Vars {
+			config.Vars[k].Name = ""
+		}
+		for k := range config.PullSecrets {
+			config.PullSecrets[k].Name = ""
+		}
+		for k := range config.Commands {
+			config.Commands[k].Name = ""
+		}
+	}
+
+	return yaml.Marshal(config)
+}
+
 func printExtraInfo(config config.Config, dependencies []types.Dependency, log logger.Logger) error {
 	log.WriteString(logrus.InfoLevel, "\n-------------------\n\nVars:\n")
 

cmd/run_pipeline.go

@@ -64,7 +64,7 @@ type RunPipelineCmd struct {
 	// used for testing to allow interruption
 	Ctx          context.Context
 	RenderWriter io.Writer
-	log          log.Logger
+	Log          log.Logger
 }
 
 func (cmd *RunPipelineCmd) AddPipelineFlags(f factory.Factory, command *cobra.Command, pipeline *latest.Pipeline) {
@@ -227,16 +227,16 @@ func (cmd *RunPipelineCmd) Run(cobraCmd *cobra.Command, args []string, f factory
 		cmd.Pipeline = args[0]
 	}
 
-	if cmd.log == nil {
-		cmd.log = f.GetLog()
+	if cmd.Log == nil {
+		cmd.Log = f.GetLog()
 	}
 	if cmd.Silent {
-		cmd.log.SetLevel(logrus.FatalLevel)
+		cmd.Log.SetLevel(logrus.FatalLevel)
 	}
 
 	// Print upgrade message if new version available
 	if !cmd.Render {
-		upgrade.PrintUpgradeMessage(cmd.log)
+		upgrade.PrintUpgradeMessage(cmd.Log)
 	} else if cmd.RenderWriter == nil {
 		cmd.RenderWriter = os.Stdout
 	}
@@ -256,7 +256,7 @@ func (cmd *RunPipelineCmd) Run(cobraCmd *cobra.Command, args []string, f factory
 		cmd.Ctx = values.WithFlags(cmd.Ctx, cobraCmd.Flags())
 	}
 	options := cmd.BuildOptions(cmd.ToConfigOptions())
-	ctx, err := initialize(cmd.Ctx, f, false, options, cmd.log)
+	ctx, err := initialize(cmd.Ctx, f, false, options, cmd.Log)
 	if err != nil {
 		return err
 	}

e2e/tests/init/init.go

@@ -3,6 +3,8 @@ package init
 import (
 	"bytes"
 	"fmt"
+	"github.com/loft-sh/devspace/pkg/util/log"
+	"github.com/sirupsen/logrus"
 	"os"
 	"path/filepath"
 	"strings"
@@ -125,19 +127,15 @@ var _ = DevSpaceDescribe("init", func() {
 		framework.ExpectNoError(err)
 		defer framework.ExpectDeleteNamespace(kubeClient, ns)
 
-		done := make(chan error)
-		go func() {
-			devCmd := &cmd.RunPipelineCmd{
-				GlobalFlags: &flags.GlobalFlags{
-					NoWarn:    true,
-					Namespace: ns,
-				},
-				Pipeline: "dev",
-			}
-			done <- devCmd.RunDefault(f)
-		}()
-
-		err = <-done
+		devCmd := &cmd.RunPipelineCmd{
+			GlobalFlags: &flags.GlobalFlags{
+				NoWarn:    true,
+				Namespace: ns,
+			},
+			Pipeline: "dev",
+			Log:      log.GetInstance().WithLevel(logrus.DebugLevel),
+		}
+		err = devCmd.RunDefault(f)
 		framework.ExpectNoError(err)
 	})
 

pkg/devspace/config/versions/adjust.go

@@ -32,6 +32,7 @@ func adjustConfig(config *latest.Config) error {
 		newObjs := map[string]*latest.Image{}
 		for k, v := range config.Images {
 			if v != nil {
+				v.Name = k
 				image, tag, err := dockerfile.GetStrippedDockerImageName(v.Image)
 				if err != nil {
 					return errors.Errorf("error parsing images.%s.image: '%s': %v", k, v.Image, err)

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

@@ -232,6 +232,9 @@ type RequireCommand struct {
 
 // Image defines the image specification
 type Image struct {
+	// Name of the image, will be filled automatically
+	Name string `yaml:"name,omitempty" json:"name,omitempty"`
+
 	// Image is the complete image name including registry and repository
 	// for example myregistry.com/mynamespace/myimage
 	Image string `yaml:"image" json:"image"`

pkg/devspace/configure/image.go

@@ -75,8 +75,12 @@ func (m *manager) AddImage(imageName, image, projectNamespace, dockerfile string
 	} else {
 		if buildMethod != skip && buildMethod != rootLevelDockerfile {
 			imageConfig.Dockerfile, err = m.log.Question(&survey.QuestionOptions{
-				Question: "Please enter the path to this Dockerfile",
+				Question: "Please enter the path to this Dockerfile: (Enter to skip)",
 				ValidationFunc: func(value string) error {
+					if value == "" {
+						return nil
+					}
+
 					stat, err := os.Stat(value)
 					if err == nil && !stat.IsDir() {
 						return nil
@@ -88,24 +92,28 @@ func (m *manager) AddImage(imageName, image, projectNamespace, dockerfile string
 				return err
 			}
 
-			imageConfig.Context, err = m.log.Question(&survey.QuestionOptions{
-				Question:     "What is the build context for building this image?",
-				DefaultValue: path.Dir(imageConfig.Dockerfile) + "/",
-				ValidationFunc: func(value string) error {
-					stat, err := os.Stat(value)
-					if err != nil && !stat.IsDir() {
-						return errors.New("Context path does not exist or is not a directory")
-					}
-					return nil
-				},
-			})
-			if err != nil {
-				return err
+			if imageConfig.Dockerfile != "" {
+				imageConfig.Context, err = m.log.Question(&survey.QuestionOptions{
+					Question:     "What is the build context for building this image?",
+					DefaultValue: path.Dir(imageConfig.Dockerfile) + "/",
+					ValidationFunc: func(value string) error {
+						stat, err := os.Stat(value)
+						if err != nil && !stat.IsDir() {
+							return errors.New("Context path does not exist or is not a directory")
+						}
+						return nil
+					},
+				})
+				if err != nil {
+					return err
+				}
+			} else {
+				buildMethod = skip
 			}
 		}
 	}
 
-	if image == "" {
+	if image == "" && buildMethod != skip {
 		// Ignore error as context may not be a Space
 		kubeContext, err := m.factory.NewKubeConfigLoader().GetCurrentContext()
 		if err != nil {
@@ -200,8 +208,12 @@ func (m *manager) AddImage(imageName, image, projectNamespace, dockerfile string
 		}
 	}
 
-	m.config.Images[imageName] = imageConfig
+	if buildMethod == skip {
+		imageConfig.Image = "username/app"
+		imageConfig.Dockerfile = "./Dockerfile"
+	}
 
+	m.config.Images[imageName] = imageConfig
 	return nil
 }