From 5a8ebc8a06a8a4585a8e7f1b09de6f667ed4e354 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sun, 18 Oct 2026 02:15:54 -0600 Subject: [PATCH] refactor(pro): share host command wiring --- cmd/pro/check_update.go | 42 ++------ cmd/pro/cluster/list.go | 19 +--- cmd/pro/daemon/netcheck.go | 52 +--------- cmd/pro/daemon/start.go | 35 +------ cmd/pro/daemon/status.go | 52 +--------- cmd/pro/health.go | 42 ++------ cmd/pro/project/list.go | 21 +--- cmd/pro/proutil/proutil.go | 88 +++++++++++++++++ cmd/pro/proutil/proutil_test.go | 167 ++++++++++++++++++++++++++++++++ cmd/pro/self.go | 21 +--- cmd/pro/template/list.go | 19 +--- cmd/pro/update_provider.go | 7 +- cmd/pro/version.go | 21 +--- 13 files changed, 293 insertions(+), 293 deletions(-) create mode 100644 cmd/pro/proutil/proutil_test.go diff --git a/cmd/pro/check_update.go b/cmd/pro/check_update.go index 290ebb63d4..a32b2e743e 100644 --- a/cmd/pro/check_update.go +++ b/cmd/pro/check_update.go @@ -8,8 +8,6 @@ import ( "github.com/devsy-org/devsy/cmd/pro/flags" "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/platform" "github.com/devsy-org/devsy/pkg/provider" "github.com/devsy-org/devsy/pkg/telemetry" @@ -25,45 +23,19 @@ type CheckUpdateCmd struct { } // NewCheckUpdateCmd creates a new command. -// -//nolint:dupl // structurally similar to NewHealthCmd; intentional sibling factory func NewCheckUpdateCmd(globalFlags *flags.GlobalFlags) *cobra.Command { cmd := &CheckUpdateCmd{ GlobalFlags: globalFlags, } c := &cobra.Command{ - Use: "check-update", - Short: "Check platform provider update", - Hidden: true, - Annotations: telemetry.SkipInUIAnnotation(), - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, - PersistentPreRun: func(cmd *cobra.Command, args []string) { - root := cmd.Root() - if root == nil { - return - } - if root.Annotations == nil { - root.Annotations = map[string]string{} - } - root.Annotations[config.AgentExecutedAnnotation] = "true" //nolint:goconst - }, + Use: "check-update", + Short: "Check platform provider update", + Hidden: true, + Annotations: telemetry.SkipInUIAnnotation(), + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), + PersistentPreRun: proutil.MarkAgentExecuted, } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c } diff --git a/cmd/pro/cluster/list.go b/cmd/pro/cluster/list.go index 23fa33b037..863fa5b640 100644 --- a/cmd/pro/cluster/list.go +++ b/cmd/pro/cluster/list.go @@ -34,24 +34,9 @@ func NewListCmd(globalFlags *flags.GlobalFlags) *cobra.Command { Use: "list", Short: "List clusters", Hidden: true, - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) cliflags.Add(c, cliflags.String(&cmd.Project, names.Project, "", "The project to use")) _ = c.MarkFlagRequired(names.Project) flags.BindEnv(c.Flags(), names.Project) diff --git a/cmd/pro/daemon/netcheck.go b/cmd/pro/daemon/netcheck.go index ea593fb072..21376785f7 100644 --- a/cmd/pro/daemon/netcheck.go +++ b/cmd/pro/daemon/netcheck.go @@ -5,13 +5,10 @@ import ( "fmt" "strconv" - "github.com/devsy-org/devsy/cmd/pro/completion" proflags "github.com/devsy-org/devsy/cmd/pro/flags" "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/config" daemon "github.com/devsy-org/devsy/pkg/daemon/platform" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" providerpkg "github.com/devsy-org/devsy/pkg/provider" "github.com/devsy-org/devsy/pkg/table" "github.com/spf13/cobra" @@ -27,56 +24,17 @@ type NetcheckCmd struct { } // NewNetcheckCmd creates a new command. -// -//nolint:dupl // structurally similar to NewStatusCmd; intentional sibling factory func NewNetcheckCmd(flags *proflags.GlobalFlags) *cobra.Command { cmd := &NetcheckCmd{ GlobalFlags: flags, } c := &cobra.Command{ - Use: "netcheck", - Short: "Get the status of the current network", - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, - PersistentPreRun: func(cmd *cobra.Command, args []string) { - root := cmd.Root() - if root == nil { - return - } - if root.Annotations == nil { - root.Annotations = map[string]string{} - } - root.Annotations[config.AgentExecutedAnnotation] = "true" - }, + Use: "netcheck", + Short: "Get the status of the current network", + RunE: proutil.HostRunE(flags, &cmd.Host, cmd.Run), + PersistentPreRun: proutil.MarkAgentExecuted, } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - proflags.BindEnv(c.Flags(), names.Host) - _ = c.RegisterFlagCompletionFunc( - names.Host, - func(rootCmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { - return completion.GetPlatformHostSuggestions( - rootCmd, - cmd.Context, - cmd.Provider, - args, - toComplete, - cmd.Owner, - ) - }, - ) + proutil.AddHostFlag(c, &cmd.Host, proutil.WithHostCompletion(flags)) return c } diff --git a/cmd/pro/daemon/start.go b/cmd/pro/daemon/start.go index 136bb4f563..b3c2fbb14a 100644 --- a/cmd/pro/daemon/start.go +++ b/cmd/pro/daemon/start.go @@ -10,13 +10,10 @@ import ( "syscall" managementv1 "github.com/devsy-org/api/pkg/apis/management/v1" - "github.com/devsy-org/devsy/cmd/pro/completion" proflags "github.com/devsy-org/devsy/cmd/pro/flags" "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/config" daemon "github.com/devsy-org/devsy/pkg/daemon/platform" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/log" "github.com/devsy-org/devsy/pkg/platform/client" providerpkg "github.com/devsy-org/devsy/pkg/provider" @@ -38,37 +35,9 @@ func NewStartCmd(flags *proflags.GlobalFlags) *cobra.Command { c := &cobra.Command{ Use: "start", Short: "Start the client daemon", - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(flags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - proflags.BindEnv(c.Flags(), names.Host) - _ = c.RegisterFlagCompletionFunc( - names.Host, - func(rootCmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { - return completion.GetPlatformHostSuggestions( - rootCmd, - cmd.Context, - cmd.Provider, - args, - toComplete, - cmd.Owner, - ) - }, - ) + proutil.AddHostFlag(c, &cmd.Host, proutil.WithHostCompletion(flags)) return c } diff --git a/cmd/pro/daemon/status.go b/cmd/pro/daemon/status.go index c23f272f4f..75d32d67ac 100644 --- a/cmd/pro/daemon/status.go +++ b/cmd/pro/daemon/status.go @@ -5,13 +5,10 @@ import ( "encoding/json" "fmt" - "github.com/devsy-org/devsy/cmd/pro/completion" proflags "github.com/devsy-org/devsy/cmd/pro/flags" "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/config" platformdaemon "github.com/devsy-org/devsy/pkg/daemon/platform" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" providerpkg "github.com/devsy-org/devsy/pkg/provider" "github.com/spf13/cobra" ) @@ -24,56 +21,17 @@ type StatusCmd struct { } // NewStatusCmd creates a new command. -// -//nolint:dupl // structurally similar to NewNetcheckCmd; intentional sibling factory func NewStatusCmd(flags *proflags.GlobalFlags) *cobra.Command { cmd := &StatusCmd{ GlobalFlags: flags, } c := &cobra.Command{ - Use: "status", - Short: "Get the status of the daemon", - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, - PersistentPreRun: func(cmd *cobra.Command, args []string) { - root := cmd.Root() - if root == nil { - return - } - if root.Annotations == nil { - root.Annotations = map[string]string{} - } - root.Annotations[config.AgentExecutedAnnotation] = "true" - }, + Use: "status", + Short: "Get the status of the daemon", + RunE: proutil.HostRunE(flags, &cmd.Host, cmd.Run), + PersistentPreRun: proutil.MarkAgentExecuted, } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - proflags.BindEnv(c.Flags(), names.Host) - _ = c.RegisterFlagCompletionFunc( - names.Host, - func(rootCmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { - return completion.GetPlatformHostSuggestions( - rootCmd, - cmd.Context, - cmd.Provider, - args, - toComplete, - cmd.Owner, - ) - }, - ) + proutil.AddHostFlag(c, &cmd.Host, proutil.WithHostCompletion(flags)) return c } diff --git a/cmd/pro/health.go b/cmd/pro/health.go index d8468e6eb8..e9ab5364f9 100644 --- a/cmd/pro/health.go +++ b/cmd/pro/health.go @@ -7,8 +7,6 @@ import ( "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/client/proxycmd" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/provider" "github.com/devsy-org/devsy/pkg/telemetry" "github.com/spf13/cobra" @@ -22,45 +20,19 @@ type HealthCmd struct { } // NewHealthCmd creates a new command. -// -//nolint:dupl // structurally similar to NewCheckUpdateCmd; intentional sibling factory func NewHealthCmd(globalFlags *flags.GlobalFlags) *cobra.Command { cmd := &HealthCmd{ GlobalFlags: globalFlags, } c := &cobra.Command{ - Use: "health", - Short: "Check platform health", - Hidden: true, - Annotations: telemetry.SkipInUIAnnotation(), - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, - PersistentPreRun: func(cmd *cobra.Command, args []string) { - root := cmd.Root() - if root == nil { - return - } - if root.Annotations == nil { - root.Annotations = map[string]string{} - } - root.Annotations[config.AgentExecutedAnnotation] = "true" //nolint:goconst - }, + Use: "health", + Short: "Check platform health", + Hidden: true, + Annotations: telemetry.SkipInUIAnnotation(), + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), + PersistentPreRun: proutil.MarkAgentExecuted, } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c } diff --git a/cmd/pro/project/list.go b/cmd/pro/project/list.go index df80b9f006..b60aa3d573 100644 --- a/cmd/pro/project/list.go +++ b/cmd/pro/project/list.go @@ -9,8 +9,6 @@ import ( "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/client/proxycmd" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/provider" "github.com/spf13/cobra" ) @@ -31,24 +29,9 @@ func NewListCmd(globalFlags *flags.GlobalFlags) *cobra.Command { Use: "list", Short: "List projects", Hidden: true, - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c } diff --git a/cmd/pro/proutil/proutil.go b/cmd/pro/proutil/proutil.go index e630d855da..468ded2889 100644 --- a/cmd/pro/proutil/proutil.go +++ b/cmd/pro/proutil/proutil.go @@ -7,9 +7,14 @@ import ( "context" "fmt" + "github.com/devsy-org/devsy/cmd/pro/completion" + proflags "github.com/devsy-org/devsy/cmd/pro/flags" "github.com/devsy-org/devsy/pkg/config" + cliflags "github.com/devsy-org/devsy/pkg/flags" + "github.com/devsy-org/devsy/pkg/flags/names" providerpkg "github.com/devsy-org/devsy/pkg/provider" "github.com/devsy-org/devsy/pkg/workspace" + "github.com/spf13/cobra" ) // Shared table headers used across pro resource listings. @@ -36,3 +41,86 @@ func FindProProvider( return devsyConfig, pCfg, nil } + +// HostRunFunc runs a host-scoped pro command with its resolved devsy config and +// provider. +type HostRunFunc func( + ctx context.Context, + devsyConfig *config.Config, + provider *providerpkg.ProviderConfig, +) error + +// findProProviderFn is FindProProvider behind a variable so HostRunE tests can +// stub provider resolution. +var findProProviderFn = FindProProvider + +// HostRunE returns a RunE that resolves the provider for *host and passes it to +// run. *host is read when the command runs, after flag parsing. +func HostRunE( + globalFlags *proflags.GlobalFlags, + host *string, + run HostRunFunc, +) func(*cobra.Command, []string) error { + return func(cobraCmd *cobra.Command, _ []string) error { + ctx := cobraCmd.Context() + devsyConfig, pCfg, err := findProProviderFn( + ctx, + globalFlags.Context, + globalFlags.Provider, + *host, + ) + if err != nil { + return err + } + return run(ctx, devsyConfig, pCfg) + } +} + +type hostFlagOptions struct { + completionFlags *proflags.GlobalFlags +} + +// HostFlagOption configures AddHostFlag. +type HostFlagOption func(*hostFlagOptions) + +// WithHostCompletion registers shell completion for --host listing pro instances. +func WithHostCompletion(globalFlags *proflags.GlobalFlags) HostFlagOption { + return func(o *hostFlagOptions) { o.completionFlags = globalFlags } +} + +// AddHostFlag registers the required --host flag, binds its env var, and +// applies opts. +func AddHostFlag(c *cobra.Command, dest *string, opts ...HostFlagOption) { + var o hostFlagOptions + for _, opt := range opts { + opt(&o) + } + + cliflags.Add(c, cliflags.String(dest, names.Host, "", "The pro instance to use")) + _ = c.MarkFlagRequired(names.Host) + cliflags.BindEnv(c.Flags(), names.Host) + + gf := o.completionFlags + if gf == nil { + return + } + _ = c.RegisterFlagCompletionFunc(names.Host, func( + rootCmd *cobra.Command, + args []string, + toComplete string, + ) ([]string, cobra.ShellCompDirective) { + return completion.GetPlatformHostSuggestions( + rootCmd, gf.Context, gf.Provider, args, toComplete, gf.Owner, + ) + }) +} + +// MarkAgentExecuted flags the root command as executed by an agent. Use it as a +// PersistentPreRun. +func MarkAgentExecuted(cmd *cobra.Command, _ []string) { + root := cmd.Root() + if root.Annotations == nil { + root.Annotations = map[string]string{} + } + root.Annotations[config.AgentExecutedAnnotation] = "true" +} diff --git a/cmd/pro/proutil/proutil_test.go b/cmd/pro/proutil/proutil_test.go new file mode 100644 index 0000000000..c55a85f051 --- /dev/null +++ b/cmd/pro/proutil/proutil_test.go @@ -0,0 +1,167 @@ +package proutil + +import ( + "context" + "errors" + "io" + "testing" + + rootflags "github.com/devsy-org/devsy/cmd/flags" + proflags "github.com/devsy-org/devsy/cmd/pro/flags" + "github.com/devsy-org/devsy/pkg/config" + cliflags "github.com/devsy-org/devsy/pkg/flags" + "github.com/devsy-org/devsy/pkg/flags/names" + providerpkg "github.com/devsy-org/devsy/pkg/provider" + "github.com/spf13/cobra" + "github.com/stretchr/testify/suite" +) + +const testCmdName = "test" + +type hostFlagSuite struct { + suite.Suite +} + +func TestHostFlagSuite(t *testing.T) { + suite.Run(t, new(hostFlagSuite)) +} + +func newHostTestCmd(dest *string) *cobra.Command { + c := &cobra.Command{ + Use: testCmdName, + RunE: func(*cobra.Command, []string) error { return nil }, + } + c.SetOut(io.Discard) + c.SetErr(io.Discard) + AddHostFlag(c, dest) + return c +} + +func (s *hostFlagSuite) TestRequiredWhenNeitherFlagNorEnvSet() { + s.T().Setenv(cliflags.EnvName(names.Host), "") + + var host string + c := newHostTestCmd(&host) + c.SetArgs([]string{}) + + s.EqualError(c.Execute(), `required flag(s) "host" not set`) +} + +func (s *hostFlagSuite) TestEnvSatisfiesRequiredAndSetsDest() { + s.T().Setenv(cliflags.EnvName(names.Host), "env-host") + + var host string + c := newHostTestCmd(&host) + c.SetArgs([]string{}) + + s.NoError(c.Execute()) + s.Equal("env-host", host) +} + +func (s *hostFlagSuite) TestFlagValueSetsDest() { + s.T().Setenv(cliflags.EnvName(names.Host), "") + + var host string + c := newHostTestCmd(&host) + c.SetArgs([]string{"--" + names.Host, "flag-host"}) + + s.NoError(c.Execute()) + s.Equal("flag-host", host) +} + +func (s *hostFlagSuite) TestHostRunEResolvesHostAtRunTime() { + orig := findProProviderFn + s.T().Cleanup(func() { findProProviderFn = orig }) + + var gotContext, gotProvider, gotHost string + devsyConfig := &config.Config{} + pCfg := &providerpkg.ProviderConfig{Name: "p"} + findProProviderFn = func( + _ context.Context, + ctxName, providerName, host string, + ) (*config.Config, *providerpkg.ProviderConfig, error) { + gotContext, gotProvider, gotHost = ctxName, providerName, host + return devsyConfig, pCfg, nil + } + + gf := &proflags.GlobalFlags{ + GlobalFlags: &rootflags.GlobalFlags{Context: "ctx-a", Provider: "prov-b"}, + } + var host string + var ranConfig *config.Config + var ranProvider *providerpkg.ProviderConfig + run := func(_ context.Context, dc *config.Config, pc *providerpkg.ProviderConfig) error { + ranConfig, ranProvider = dc, pc + return nil + } + + c := &cobra.Command{Use: testCmdName, RunE: HostRunE(gf, &host, run)} + c.SetOut(io.Discard) + c.SetErr(io.Discard) + AddHostFlag(c, &host) + c.SetArgs([]string{"--" + names.Host, "late-host"}) + + s.Require().NoError(c.Execute()) + s.Equal("ctx-a", gotContext) + s.Equal("prov-b", gotProvider) + s.Equal("late-host", gotHost) + s.Same(devsyConfig, ranConfig) + s.Same(pCfg, ranProvider) +} + +func (s *hostFlagSuite) TestHostRunEPropagatesResolveErrorWithoutRunning() { + orig := findProProviderFn + s.T().Cleanup(func() { findProProviderFn = orig }) + + boom := errors.New("resolve failed") + findProProviderFn = func( + context.Context, + string, string, string, + ) (*config.Config, *providerpkg.ProviderConfig, error) { + return nil, nil, boom + } + + ran := false + run := func(context.Context, *config.Config, *providerpkg.ProviderConfig) error { + ran = true + return nil + } + + var host string + gf := &proflags.GlobalFlags{GlobalFlags: &rootflags.GlobalFlags{}} + c := &cobra.Command{Use: testCmdName, RunE: HostRunE(gf, &host, run)} + c.SetOut(io.Discard) + c.SetErr(io.Discard) + AddHostFlag(c, &host) + c.SetArgs([]string{"--" + names.Host, "h"}) + + s.ErrorIs(c.Execute(), boom) + s.False(ran) +} + +func (s *hostFlagSuite) TestMarkAgentExecutedSetsRootAnnotation() { + root := &cobra.Command{Use: "root", PersistentPreRun: MarkAgentExecuted} + child := &cobra.Command{ + Use: "child", + RunE: func(*cobra.Command, []string) error { + return nil + }, + } + root.AddCommand(child) + root.SetOut(io.Discard) + root.SetErr(io.Discard) + root.SetArgs([]string{"child"}) + + s.Require().NoError(root.Execute()) + s.Equal("true", root.Annotations[config.AgentExecutedAnnotation]) +} + +func (s *hostFlagSuite) TestMarkAgentExecutedKeepsExistingRootAnnotations() { + root := &cobra.Command{Use: "root"} + root.Annotations = map[string]string{"other": "value"} + + MarkAgentExecuted(root, nil) + + s.Equal("true", root.Annotations[config.AgentExecutedAnnotation]) + s.Equal("value", root.Annotations["other"]) +} diff --git a/cmd/pro/self.go b/cmd/pro/self.go index 3a51ad82ba..e93cff2e22 100644 --- a/cmd/pro/self.go +++ b/cmd/pro/self.go @@ -7,8 +7,6 @@ import ( "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/client/proxycmd" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/provider" "github.com/spf13/cobra" ) @@ -29,24 +27,9 @@ func NewSelfCmd(globalFlags *flags.GlobalFlags) *cobra.Command { Use: "self", Short: "Get self", Hidden: true, - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c } diff --git a/cmd/pro/template/list.go b/cmd/pro/template/list.go index 20d996a989..22b3f13332 100644 --- a/cmd/pro/template/list.go +++ b/cmd/pro/template/list.go @@ -33,24 +33,9 @@ func NewListCmd(globalFlags *flags.GlobalFlags) *cobra.Command { Use: "list", Short: "List templates", Hidden: true, - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) cliflags.Add(c, cliflags.String(&cmd.Project, names.Project, "", "The project to use")) _ = c.MarkFlagRequired(names.Project) flags.BindEnv(c.Flags(), names.Project) diff --git a/cmd/pro/update_provider.go b/cmd/pro/update_provider.go index 07ad9a55b5..c3e5e97caa 100644 --- a/cmd/pro/update_provider.go +++ b/cmd/pro/update_provider.go @@ -6,10 +6,9 @@ import ( "strings" "github.com/devsy-org/devsy/cmd/pro/flags" + "github.com/devsy-org/devsy/cmd/pro/proutil" providercmd "github.com/devsy-org/devsy/cmd/provider" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" provider2 "github.com/devsy-org/devsy/pkg/provider" "github.com/devsy-org/devsy/pkg/workspace" "github.com/spf13/cobra" @@ -37,9 +36,7 @@ func NewUpdateProviderCmd(globalFlags *flags.GlobalFlags) *cobra.Command { }, } - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c } diff --git a/cmd/pro/version.go b/cmd/pro/version.go index 5b54681882..9dbad9084d 100644 --- a/cmd/pro/version.go +++ b/cmd/pro/version.go @@ -7,8 +7,6 @@ import ( "github.com/devsy-org/devsy/cmd/pro/proutil" "github.com/devsy-org/devsy/pkg/client/proxycmd" "github.com/devsy-org/devsy/pkg/config" - cliflags "github.com/devsy-org/devsy/pkg/flags" - "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/provider" "github.com/spf13/cobra" ) @@ -29,24 +27,9 @@ func NewVersionCmd(globalFlags *flags.GlobalFlags) *cobra.Command { Use: "version", Short: "Get version", Hidden: true, - RunE: func(cobraCmd *cobra.Command, args []string) error { - devsyConfig, provider, err := proutil.FindProProvider( - cobraCmd.Context(), - cmd.Context, - cmd.Provider, - cmd.Host, - ) - if err != nil { - return err - } - - return cmd.Run(cobraCmd.Context(), devsyConfig, provider) - }, + RunE: proutil.HostRunE(globalFlags, &cmd.Host, cmd.Run), } - - cliflags.Add(c, cliflags.String(&cmd.Host, names.Host, "", "The pro instance to use")) - _ = c.MarkFlagRequired(names.Host) - flags.BindEnv(c.Flags(), names.Host) + proutil.AddHostFlag(c, &cmd.Host) return c }