refactor: make devspace context an interface

Author: FabianKramm

cmd/attach.go

@@ -96,11 +96,7 @@ func (cmd *AttachCmd) Run(f factory.Factory, cobraCmd *cobra.Command, args []str
 	}
 
 	// create the context
-	ctx := &devspacecontext.Context{
-		Context:    context.Background(),
-		KubeClient: client,
-		Log:        log,
-	}
+	ctx := devspacecontext.NewContext(context.Background(), nil, log).WithKubeClient(client)
 
 	// Execute plugin hook
 	err = hook.ExecuteHooks(ctx, nil, "attach")

cmd/enter.go

@@ -123,11 +123,7 @@ func (cmd *EnterCmd) Run(f factory.Factory, args []string) error {
 	}
 
 	// create the context
-	ctx := &devspacecontext.Context{
-		Context:    context.Background(),
-		KubeClient: client,
-		Log:        logger,
-	}
+	ctx := devspacecontext.NewContext(context.Background(), nil, logger).WithKubeClient(client)
 
 	// Execute plugin hook
 	err = hook.ExecuteHooks(ctx, nil, "enter")

cmd/flags/flags.go

@@ -51,7 +51,6 @@ func SetGlobalFlags(flags *flag.FlagSet) *GlobalFlags {
 	flags.BoolVar(&globalFlags.Debug, "debug", false, "Prints the stack trace if an error occurs")
 	flags.BoolVar(&globalFlags.Silent, "silent", false, "Run in silent mode and prevents any devspace log output except panics & fatals")
 
-	flags.StringVar(&globalFlags.ConfigPath, "config", "", "The devspace config file to use")
 	flags.StringSliceVarP(&globalFlags.Profiles, "profile", "p", []string{}, "The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified")
 	flags.BoolVar(&globalFlags.ProfileRefresh, "profile-refresh", false, "If true will pull and re-download profile parent sources")
 	flags.BoolVar(&globalFlags.DisableProfileActivation, "disable-profile-activation", false, "If true will ignore all profile activations")
@@ -61,5 +60,28 @@ func SetGlobalFlags(flags *flag.FlagSet) *GlobalFlags {
 	flags.StringSliceVar(&globalFlags.Vars, "var", []string{}, "Variables to override during execution (e.g. --var=MYVAR=MYVALUE)")
 
 	flags.IntVar(&globalFlags.InactivityTimeout, "inactivity-timeout", 0, "Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems")
+	flags.AddFlag(&flag.Flag{
+		Name:   "config",
+		Usage:  "DEPRECATED: please use the DEVSPACE_CONFIG environment variable instead",
+		Hidden: true,
+		Value:  NewStringValue("", &globalFlags.ConfigPath),
+	})
 	return globalFlags
 }
+
+type StringValue string
+
+func NewStringValue(val string, p *string) *StringValue {
+	*p = val
+	return (*StringValue)(p)
+}
+
+func (s *StringValue) Set(val string) error {
+	*s = StringValue(val)
+	return nil
+}
+func (s *StringValue) Type() string {
+	return "string"
+}
+
+func (s *StringValue) String() string { return string(*s) }

cmd/list/deployments.go

@@ -92,7 +92,7 @@ func (cmd *deploymentsCmd) RunDeploymentsStatus(f factory.Factory, cobraCmd *cob
 	}
 
 	// Create conext
-	ctx := devspacecontext.NewContext(context.Background(), logger).
+	ctx := devspacecontext.NewContext(context.Background(), configInterface.Variables(), logger).
 		WithConfig(configInterface).
 		WithKubeClient(client)
 
@@ -103,8 +103,8 @@ func (cmd *deploymentsCmd) RunDeploymentsStatus(f factory.Factory, cobraCmd *cob
 	}
 	ctx = ctx.WithDependencies(dependencies)
 
-	if ctx.Config.Config().Deployments != nil {
-		for _, deployConfig := range ctx.Config.Config().Deployments {
+	if ctx.Config().Config().Deployments != nil {
+		for _, deployConfig := range ctx.Config().Config().Deployments {
 			var deployClient deployer.Interface
 
 			// Delete kubectl engine

cmd/logs.go

@@ -113,11 +113,7 @@ func (cmd *LogsCmd) RunLogs(f factory.Factory) error {
 	}
 
 	// create the context
-	ctx := &devspacecontext.Context{
-		Context:    context.Background(),
-		KubeClient: client,
-		Log:        log,
-	}
+	ctx := devspacecontext.NewContext(context.Background(), nil, log).WithKubeClient(client)
 
 	// Execute plugin hook
 	err = hook.ExecuteHooks(ctx, nil, "logs")
@@ -149,7 +145,7 @@ func (cmd *LogsCmd) RunLogs(f factory.Factory) error {
 	return nil
 }
 
-func getImageSelector(ctx *devspacecontext.Context, configLoader loader.ConfigLoader, configOptions *loader.ConfigOptions, imageSelector string) ([]string, error) {
+func getImageSelector(ctx devspacecontext.Context, configLoader loader.ConfigLoader, configOptions *loader.ConfigOptions, imageSelector string) ([]string, error) {
 	var imageSelectors []string
 	if imageSelector != "" {
 		var (
@@ -160,19 +156,19 @@ func getImageSelector(ctx *devspacecontext.Context, configLoader loader.ConfigLo
 		if !configLoader.Exists() {
 			config = config2.Ensure(nil)
 		} else {
-			config, err = configLoader.Load(ctx.Context, ctx.KubeClient, configOptions, ctx.Log)
+			config, err = configLoader.Load(ctx.Context(), ctx.KubeClient(), configOptions, ctx.Log())
 			if err != nil {
 				return nil, err
 			}
 
 			ctx = ctx.WithConfig(config)
 			dependencies, err = dependency.NewManager(ctx, configOptions).ResolveAll(ctx, dependency.ResolveOptions{})
 			if err != nil {
-				ctx.Log.Warnf("Error resolving dependencies: %v", err)
+				ctx.Log().Warnf("Error resolving dependencies: %v", err)
 			}
 		}
 
-		resolved, err := runtimevar.NewRuntimeResolver(".", true).FillRuntimeVariablesAsImageSelector(ctx.Context, imageSelector, config, dependencies)
+		resolved, err := runtimevar.NewRuntimeResolver(".", true).FillRuntimeVariablesAsImageSelector(ctx.Context(), imageSelector, config, dependencies)
 		if err != nil {
 			return nil, err
 		}

cmd/open.go

@@ -134,7 +134,7 @@ func (cmd *OpenCmd) RunOpen(f factory.Factory) error {
 	}
 
 	// create devspace context
-	ctx := devspacecontext.NewContext(context.Background(), cmd.log).
+	ctx := devspacecontext.NewContext(context.Background(), nil, cmd.log).
 		WithKubeClient(client)
 
 	// Execute plugin hook
@@ -282,8 +282,8 @@ func openURL(url string, kubectlClient kubectl.Client, analyzeNamespace string,
 	return nil
 }
 
-func (cmd *OpenCmd) openLocal(ctx *devspacecontext.Context, domain string) error {
-	_, servicePort, serviceLabels, err := cmd.getService(ctx.KubeClient, ctx.KubeClient.Namespace(), domain, true)
+func (cmd *OpenCmd) openLocal(ctx devspacecontext.Context, domain string) error {
+	_, servicePort, serviceLabels, err := cmd.getService(ctx.KubeClient(), ctx.KubeClient().Namespace(), domain, true)
 	if err != nil {
 		return errors.Errorf("Unable to get service: %v", err)
 	}

cmd/overwrite_command.go

@@ -46,11 +46,10 @@ func NewOverwriteCmd(f factory.Factory, globalFlags *flags.GlobalFlags, command
 	}
 
 	runCmd := &cobra.Command{
-		Use:                command.Name,
-		DisableFlagParsing: true,
-		Short:              description,
-		Long:               longDescription,
-		Args:               cobra.ArbitraryArgs,
+		Use:   command.Name,
+		Short: description,
+		Long:  longDescription,
+		Args:  cobra.ArbitraryArgs,
 		RunE: func(cobraCmd *cobra.Command, _ []string) error {
 			args, err := ParseArgs(cobraCmd, cmd.GlobalFlags, f.GetLog())
 			if err != nil {
@@ -61,10 +60,11 @@ func NewOverwriteCmd(f factory.Factory, globalFlags *flags.GlobalFlags, command
 			return cmd.Run(f, args)
 		},
 	}
+	runCmd.DisableFlagParsing = true
 	return runCmd
 }
 
 func (cmd *OverwriteCmd) Run(f factory.Factory, args []string) error {
-	devCtx := devspacecontext.NewContext(context.Background(), f.GetLog())
-	return executeCommandWithAfter(devCtx.Context, cmd.Command, args, cmd.Variables, devCtx.WorkingDir, cmd.Stdout, cmd.Stderr, os.Stdin, devCtx.Log)
+	devCtx := devspacecontext.NewContext(context.Background(), cmd.Variables, f.GetLog())
+	return executeCommandWithAfter(devCtx.Context(), cmd.Command, args, cmd.Variables, devCtx.WorkingDir(), cmd.Stdout, cmd.Stderr, os.Stdin, devCtx.Log())
 }

cmd/print.go

@@ -91,7 +91,7 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 	}
 
 	// create devspace context
-	ctx := devspacecontext.NewContext(context.Background(), log).
+	ctx := devspacecontext.NewContext(context.Background(), config.Variables(), log).
 		WithConfig(config).
 		WithKubeClient(client)
 
@@ -117,13 +117,13 @@ func (cmd *PrintCmd) Run(f factory.Factory) error {
 		ctx = ctx.AsDependency(dep)
 	}
 
-	bsConfig, err := yaml.Marshal(ctx.Config.Config())
+	bsConfig, err := yaml.Marshal(ctx.Config().Config())
 	if err != nil {
 		return err
 	}
 
 	if !cmd.SkipInfo {
-		err = printExtraInfo(ctx.Config, dependencies, log)
+		err = printExtraInfo(ctx.Config(), dependencies, log)
 		if err != nil {
 			return err
 		}

cmd/reset/pods.go

@@ -94,7 +94,7 @@ func (cmd *podsCmd) RunResetPods(f factory.Factory, cobraCmd *cobra.Command, arg
 	}
 
 	// create devspace context
-	ctx := devspacecontext.NewContext(context.Background(), cmd.log).
+	ctx := devspacecontext.NewContext(context.Background(), conf.Variables(), cmd.log).
 		WithConfig(conf).
 		WithKubeClient(client)
 
@@ -111,29 +111,29 @@ func (cmd *podsCmd) RunResetPods(f factory.Factory, cobraCmd *cobra.Command, arg
 }
 
 // ResetPods deletes the pods created by dev.replacePods
-func ResetPods(ctx *devspacecontext.Context, dependencies, force bool) {
+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")
+		ctx.Log().Info("No dev pods to reset found")
 	} else {
-		ctx.Log.Donef("Successfully reset %d pods", resetted)
+		ctx.Log().Donef("Successfully reset %d pods", resetted)
 	}
 }
 
-func ResetPodsRecursive(ctx *devspacecontext.Context, dependencies, force bool) int {
+func ResetPodsRecursive(ctx devspacecontext.Context, dependencies, force bool) int {
 	resetted := 0
 	if dependencies {
-		for _, d := range ctx.Dependencies {
+		for _, d := range ctx.Dependencies() {
 			resetted += ResetPodsRecursive(ctx.AsDependency(d), dependencies, force)
 		}
 	}
 
 	// create pod replacer
 	podReplacer := podreplace.NewPodReplacer()
-	for _, replacePodCache := range ctx.Config.RemoteCache().ListDevPods() {
+	for _, replacePodCache := range ctx.Config().RemoteCache().ListDevPods() {
 		deleted, err := podReplacer.RevertReplacePod(ctx, &replacePodCache, &deploy.PurgeOptions{ForcePurge: force})
 		if err != nil {
-			ctx.Log.Warnf("Error resetting replaced pod: %v", err)
+			ctx.Log().Warnf("Error resetting replaced pod: %v", err)
 		} else if deleted {
 			resetted++
 		}

cmd/restart.go

@@ -88,7 +88,7 @@ func (cmd *RestartCmd) Run(f factory.Factory) error {
 		}
 
 		// Create context
-		ctx := devspacecontext.NewContext(context.Background(), cmd.log).
+		ctx := devspacecontext.NewContext(context.Background(), nil, cmd.log).
 			WithKubeClient(client)
 
 		return restartContainer(ctx, targetselector.NewOptionsFromFlags(cmd.Container, cmd.LabelSelector, nil, cmd.Namespace, cmd.Pod).WithPick(cmd.Pick))
@@ -120,7 +120,7 @@ func (cmd *RestartCmd) Run(f factory.Factory) error {
 	}
 
 	// Create context
-	ctx := devspacecontext.NewContext(context.Background(), cmd.log).
+	ctx := devspacecontext.NewContext(context.Background(), config.Variables(), cmd.log).
 		WithConfig(config).
 		WithKubeClient(client)
 
@@ -139,7 +139,7 @@ func (cmd *RestartCmd) Run(f factory.Factory) error {
 
 	// restart containers
 	restarts := 0
-	for _, devPod := range ctx.Config.Config().Dev {
+	for _, devPod := range ctx.Config().Config().Dev {
 		if cmd.Name != "" && devPod.Name != cmd.Name {
 			continue
 		}
@@ -167,7 +167,7 @@ func (cmd *RestartCmd) Run(f factory.Factory) error {
 		// create target selector options
 		var imageSelector []string
 		if devPod.ImageSelector != "" {
-			imageSelectorObject, err := runtimevar.NewRuntimeResolver(ctx.WorkingDir, true).FillRuntimeVariablesAsImageSelector(ctx.Context, devPod.ImageSelector, ctx.Config, ctx.Dependencies)
+			imageSelectorObject, err := runtimevar.NewRuntimeResolver(ctx.WorkingDir(), true).FillRuntimeVariablesAsImageSelector(ctx.Context(), devPod.ImageSelector, ctx.Config(), ctx.Dependencies())
 			if err != nil {
 				return err
 			}
@@ -191,23 +191,23 @@ func (cmd *RestartCmd) Run(f factory.Factory) error {
 	return nil
 }
 
-func restartContainer(ctx *devspacecontext.Context, options targetselector.Options) error {
+func restartContainer(ctx devspacecontext.Context, options targetselector.Options) error {
 	options = options.WithWait(false)
-	container, err := targetselector.NewTargetSelector(options).SelectSingleContainer(ctx.Context, ctx.KubeClient, ctx.Log)
+	container, err := targetselector.NewTargetSelector(options).SelectSingleContainer(ctx.Context(), ctx.KubeClient(), ctx.Log())
 	if err != nil {
 		return errors.Errorf("Error selecting pod: %v", err)
 	}
 
-	err = inject.InjectDevSpaceHelper(ctx.Context, ctx.KubeClient, container.Pod, container.Container.Name, "", ctx.Log)
+	err = inject.InjectDevSpaceHelper(ctx.Context(), ctx.KubeClient(), container.Pod, container.Container.Name, "", ctx.Log())
 	if err != nil {
 		return errors.Wrap(err, "inject devspace helper")
 	}
 
-	stdOut, stdErr, err := ctx.KubeClient.ExecBuffered(ctx.Context, container.Pod, container.Container.Name, []string{inject.DevSpaceHelperContainerPath, "restart"}, nil)
+	stdOut, stdErr, err := ctx.KubeClient().ExecBuffered(ctx.Context(), container.Pod, container.Container.Name, []string{inject.DevSpaceHelperContainerPath, "restart"}, nil)
 	if err != nil {
 		return fmt.Errorf("error restarting container %s in pod %s/%s: %s %s => %v", container.Container.Name, container.Pod.Namespace, container.Pod.Name, string(stdOut), string(stdErr), err)
 	}
 
-	ctx.Log.Donef("Successfully restarted container %s in pod %s/%s", container.Container.Name, container.Pod.Namespace, container.Pod.Name)
+	ctx.Log().Donef("Successfully restarted container %s in pod %s/%s", container.Container.Name, container.Pod.Namespace, container.Pod.Name)
 	return nil
 }