group common flags

Signed-off-by: Ankita Thomas <[email protected]>

Author: ankitathomas

go.mod

@@ -22,6 +22,7 @@ require (
 	k8s.io/apimachinery v0.33.4
 	k8s.io/cli-runtime v0.33.3
 	k8s.io/client-go v0.33.4
+	k8s.io/utils v0.0.0-20250604170112-4c0f3b243397
 	sigs.k8s.io/controller-runtime v0.21.0
 	sigs.k8s.io/yaml v1.6.0
 )
@@ -136,7 +137,6 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20250610211856-8b98d1ed966a // indirect
-	k8s.io/utils v0.0.0-20250604170112-4c0f3b243397 // indirect
 	sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
 	sigs.k8s.io/randfill v1.0.0 // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.7.0 // indirect

internal/cmd/internal/olmv1/catalog_create.go

@@ -12,12 +12,19 @@ import (
 
 	olmv1 "github.com/operator-framework/operator-controller/api/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/errors"
 )
 
+type catalogCreateOptions struct {
+	mutableCatalogOptions
+	dryRunOptions
+}
+
 // NewCatalogCreateCmd allows creating a new catalog
 func NewCatalogCreateCmd(cfg *action.Configuration) *cobra.Command {
 	i := v1action.NewCatalogCreate(cfg)
 	i.Logf = log.Printf
+	var opts catalogCreateOptions
 
 	cmd := &cobra.Command{
 		Use:     "catalog <catalog_name> <image_source_ref>",
@@ -27,10 +34,12 @@ func NewCatalogCreateCmd(cfg *action.Configuration) *cobra.Command {
 		Run: func(cmd *cobra.Command, args []string) {
 			i.CatalogName = args[0]
 			i.ImageSourceRef = args[1]
-			if len(i.DryRun) > 0 && i.DryRun != v1action.DryRunAll {
-				log.Fatalf("invalid value for `--dry-run` %s, must be one of (%s)\n", i.DryRun, v1action.DryRunAll)
+			opts.Image = i.ImageSourceRef
+			if err := opts.validate(); err != nil {
+				log.Fatalf("failed to parse flags: %s", err.Error())
 			}
-
+			i.DryRun = opts.DryRun
+			i.Output = opts.Output
 			catalogObj, err := i.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to create catalog %q: %v\n", i.CatalogName, err)
@@ -50,17 +59,23 @@ func NewCatalogCreateCmd(cfg *action.Configuration) *cobra.Command {
 		},
 	}
 	bindCatalogCreateFlags(cmd.Flags(), i)
+	bindMutableCatalogFlags(cmd.Flags(), &opts.mutableCatalogOptions)
+	bindDryRunFlags(cmd.Flags(), &opts.dryRunOptions)
 
 	return cmd
 }
 
 func bindCatalogCreateFlags(fs *pflag.FlagSet, i *v1action.CatalogCreate) {
-	fs.Int32Var(&i.Priority, "priority", 0, "priority determines the likelihood of a catalog being selected in conflict scenarios")
-	fs.BoolVar(&i.Available, "available", true, "determines whether a catalog should be active and serving data. default: true, meaning new catalogs serve their contents by default.")
-	fs.IntVar(&i.PollIntervalMinutes, "source-poll-interval-minutes", 10, "catalog source polling interval [in minutes]")
-	fs.StringToStringVar(&i.Labels, "labels", map[string]string{}, "labels to add to the new catalog")
-	fs.DurationVar(&i.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount of time to wait before cancelling cleanup after a failed creation attempt")
-	// sigs.k8s.io/controller-runtime/pkg/client supported dry-run values only.
-	fs.StringVar(&i.DryRun, "dry-run", "", "display the object that would be sent on a request without applying it if non-empty. One of: (All)")
-	fs.StringVarP(&i.Output, "output", "o", "", "output format for dry-run manifests. One of: (json, yaml)")
+	fs.DurationVar(&i.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount of time to wait before cancelling cleanup after a failed creation attempt.")
+}
+
+func (o *catalogCreateOptions) validate() error {
+	var errs []error
+	if err := o.dryRunOptions.validate(); err != nil {
+		errs = append(errs, err)
+	}
+	if err := o.mutableCatalogOptions.validate(); err != nil {
+		errs = append(errs, err)
+	}
+	return errors.NewAggregate(errs)
 }

internal/cmd/internal/olmv1/catalog_delete.go

@@ -12,11 +12,16 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
 )
 
+type catalogDeleteOptions struct {
+	dryRunOptions
+}
+
 // NewCatalogDeleteCmd allows deleting either a single or all
 // existing catalogs
 func NewCatalogDeleteCmd(cfg *action.Configuration) *cobra.Command {
-	d := v1action.NewCatalogDelete(cfg)
-	d.Logf = log.Printf
+	i := v1action.NewCatalogDelete(cfg)
+	i.Logf = log.Printf
+	var opts catalogDeleteOptions
 
 	cmd := &cobra.Command{
 		Use:     "catalog [catalog_name]",
@@ -25,46 +30,46 @@ func NewCatalogDeleteCmd(cfg *action.Configuration) *cobra.Command {
 		Short:   "Delete either a single or all of the existing catalogs",
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) > 0 {
-				if d.DeleteAll {
+				if i.DeleteAll {
 					log.Fatalf("failed to delete catalog: cannot specify both --all and a catalog name")
 				}
-				d.CatalogName = args[0]
+				i.CatalogName = args[0]
+			}
+			if err := opts.validate(); err != nil {
+				log.Fatalf("failed to parse flags: %s", err.Error())
 			}
-			catalogs, err := d.Run(cmd.Context())
+			i.DryRun = opts.DryRun
+			i.Output = opts.Output
+			catalogs, err := i.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to delete catalog(s): %v", err)
 			}
-
-			if len(d.DryRun) == 0 {
+			if len(i.DryRun) == 0 {
 				for _, catn := range catalogs {
 					log.Printf("catalog %s deleted", catn.Name)
 				}
 				return
 			}
-			if len(d.Output) == 0 {
+			if len(i.Output) == 0 {
 				for _, catn := range catalogs {
 					log.Printf("catalog %s deleted (dry run)\n", catn.Name)
 				}
 				return
 			}
 
-			for _, i := range catalogs {
-				i.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{Group: olmv1.GroupVersion.Group,
+			for _, c := range catalogs {
+				c.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{Group: olmv1.GroupVersion.Group,
 					Version: olmv1.GroupVersion.Version, Kind: "ClusterCatalog"})
 			}
-			printFormattedCatalogs(d.Output, catalogs...)
-			for _, catalog := range catalogs {
-				log.Printf("catalog %q deleted", catalog.Name)
-			}
+			printFormattedCatalogs(i.Output, catalogs...)
 		},
 	}
-	bindCatalogDeleteFlags(cmd.Flags(), d)
+	bindCatalogDeleteFlags(cmd.Flags(), i)
+	bindDryRunFlags(cmd.Flags(), &opts.dryRunOptions)
 
 	return cmd
 }
 
 func bindCatalogDeleteFlags(fs *pflag.FlagSet, d *v1action.CatalogDelete) {
 	fs.BoolVarP(&d.DeleteAll, "all", "a", false, "delete all catalogs")
-	fs.StringVar(&d.DryRun, "dry-run", "", "display the object that would be sent on a request without applying it. One of: (All)")
-	fs.StringVarP(&d.Output, "output", "o", "", "output format for dry-run manifests. One of: (json, yaml)")
 }

internal/cmd/internal/olmv1/catalog_search.go

@@ -26,7 +26,7 @@ func NewCatalogSearchCmd(cfg *action.Configuration) *cobra.Command {
 		Use:     "catalog",
 		Aliases: []string{"catalogs"},
 		Args:    cobra.RangeArgs(0, 1),
-		Short:   "Search catalogs for installable operators matching parameters",
+		Short:   "Search catalogs for installable packages matching parameters",
 		Run: func(cmd *cobra.Command, args []string) {
 			catalogContents, err := i.Run(cmd.Context())
 			if err != nil {
@@ -40,7 +40,7 @@ func NewCatalogSearchCmd(cfg *action.Configuration) *cobra.Command {
 			case "yaml":
 				printDeclCfgYAML(os.Stdout, catalogContents)
 			default:
-				log.Fatalf("unsupported output format %s: allwed formats are (json|yaml|table)", i.OutputFormat)
+				log.Fatalf("unsupported output format %s: allowed formats are (json|yaml|table)", i.OutputFormat)
 			}
 		},
 	}
@@ -50,13 +50,11 @@ func NewCatalogSearchCmd(cfg *action.Configuration) *cobra.Command {
 }
 
 func bindCatalogSearchFlags(fs *pflag.FlagSet, i *v1action.CatalogSearch) {
-	fs.StringVar(&i.CatalogName, "catalog", "", "Catalog to search on. If not provided, all available catalogs are searched.")
-	fs.StringVarP(&i.Selector, "selector", "l", "", "Selector (label query) to filter catalogs on, supports '=', '==', and '!='")
+	fs.StringVar(&i.CatalogName, "catalog", "", "name of the catalog to search. If not provided, all available catalogs are searched.")
+	fs.StringVarP(&i.Selector, "selector", "l", "", "selector (label query) to filter catalogs on, supports '=', '==', and '!='")
 	fs.StringVarP(&i.OutputFormat, "output", "o", "", "output format. One of: (yaml|json)")
-	fs.BoolVar(&i.ListVersions, "list-versions", false, "List all versions available for each package")
-	fs.StringVar(&i.Package, "package", "", "Search for package by name. If empty, all available packages will be listed")
-	fs.StringVar(&i.CatalogdNamespace, "catalogd-namespace", "olmv1-system", "Namespace for the catalogd controller")
-	fs.StringVar(&i.Timeout, "timeout", "5m", "Timeout for fetching catalog contents")
-	//	installable vs uninstallable, all versions, channels
-	//	fs.StringVar(&i.showAll, "image", "", "Image reference for the catalog source. Leave unset to retain the current image.")
+	fs.BoolVar(&i.ListVersions, "list-versions", false, "list all versions available for each package")
+	fs.StringVar(&i.Package, "package", "", "search for package by name. If empty, all available packages will be listed")
+	fs.StringVar(&i.CatalogdNamespace, "catalogd-namespace", "olmv1-system", "namespace for the catalogd controller")
+	fs.StringVar(&i.Timeout, "timeout", "5m", "timeout for fetching catalog contents")
 }

internal/cmd/internal/olmv1/catalog_update.go

@@ -2,53 +2,49 @@ package olmv1
 
 import (
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"github.com/operator-framework/kubectl-operator/internal/cmd/internal/log"
 	v1action "github.com/operator-framework/kubectl-operator/internal/pkg/v1/action"
 	"github.com/operator-framework/kubectl-operator/pkg/action"
 
 	olmv1 "github.com/operator-framework/operator-controller/api/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/errors"
 )
 
+type catalogUpdateOptions struct {
+	mutableCatalogOptions
+	dryRunOptions
+}
+
 // NewCatalogUpdateCmd allows updating a selected clustercatalog
 func NewCatalogUpdateCmd(cfg *action.Configuration) *cobra.Command {
 	i := v1action.NewCatalogUpdate(cfg)
 	i.Logf = log.Printf
-
-	var priority int32
-	var pollInterval int
-	var labels map[string]string
-	var available string
+	var opts catalogUpdateOptions
 
 	cmd := &cobra.Command{
 		Use:   "catalog <catalog>",
 		Short: "Update a catalog",
 		Args:  cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			i.CatalogName = args[0]
+			if err := opts.validate(); err != nil {
+				log.Fatalf("failed to parse flags: %s", err.Error())
+			}
 			if cmd.Flags().Changed("priority") {
-				i.Priority = &priority
+				i.Priority = &opts.Priority
 			}
 			if cmd.Flags().Changed("source-poll-interval-minutes") {
-				i.PollIntervalMinutes = &pollInterval
+				i.PollIntervalMinutes = &opts.PollIntervalMinutes
 			}
 			if cmd.Flags().Changed("labels") {
-				i.Labels = labels
-			}
-			if len(available) > 0 {
-				switch available {
-				case "true":
-					i.AvailabilityMode = "Available"
-				case "false":
-					i.AvailabilityMode = "Unavailable"
-				default:
-					log.Fatalf("invalid value for `--available` %s; must be one of (true, false)\n", available)
-				}
-			}
-			if len(i.DryRun) > 0 && i.DryRun != v1action.DryRunAll {
-				log.Fatalf("invalid value for `--dry-run` %s, must be one of (%s)\n", i.DryRun, v1action.DryRunAll)
+				i.Labels = opts.Labels
 			}
+			i.AvailabilityMode = opts.AvailabilityMode
+			i.DryRun = opts.DryRun
+			i.Output = opts.Output
 			catalogObj, err := i.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to update catalog: %v", err)
@@ -68,14 +64,25 @@ func NewCatalogUpdateCmd(cfg *action.Configuration) *cobra.Command {
 			printFormattedCatalogs(i.Output, *catalogObj)
 		},
 	}
-	cmd.Flags().Int32Var(&priority, "priority", 0, "priority determines the likelihood of a catalog being selected in conflict scenarios")
-	cmd.Flags().StringVar(&available, "available", "", "determines whether a catalog should be active and serving data. default: true, meaning new catalogs serve their contents by default.")
-	cmd.Flags().IntVar(&pollInterval, "source-poll-interval-minutes", 5, "catalog source polling interval [in minutes]. Set to 0 or -1 to remove the polling interval.")
-	cmd.Flags().StringToStringVar(&labels, "labels", map[string]string{}, "labels that will be added to the catalog")
-	cmd.Flags().StringVar(&i.ImageRef, "image", "", "Image reference for the catalog source. Leave unset to retain the current image.")
-	cmd.Flags().BoolVar(&i.IgnoreUnset, "ignore-unset", true, "when enabled, any unset flag value will not be changed. Disabling means that for each unset value a default will be used instead")
-	cmd.Flags().StringVar(&i.DryRun, "dry-run", "", "display the object that would be sent on a request without applying it if non-empty. One of: (All)")
-	cmd.Flags().StringVarP(&i.Output, "output", "o", "", "output format for dry-run manifests. One of: (json, yaml)")
+	bindCatalogUpdateFlags(cmd.Flags(), i)
+	bindMutableCatalogFlags(cmd.Flags(), &opts.mutableCatalogOptions)
+	bindDryRunFlags(cmd.Flags(), &opts.dryRunOptions)
 
 	return cmd
 }
+
+func bindCatalogUpdateFlags(fs *pflag.FlagSet, i *v1action.CatalogUpdate) {
+	fs.StringVar(&i.ImageRef, "image", "", "image reference for the catalog source. Leave unset to retain the current image.")
+	fs.BoolVar(&i.IgnoreUnset, "ignore-unset", true, "set to false to revert all values not specifically set with flags in the command to their default as defined by the clustercatalog customresoucedefinition.")
+}
+
+func (o *catalogUpdateOptions) validate() error {
+	var errs []error
+	if err := o.dryRunOptions.validate(); err != nil {
+		errs = append(errs, err)
+	}
+	if err := o.mutableCatalogOptions.validate(); err != nil {
+		errs = append(errs, err)
+	}
+	return errors.NewAggregate(errs)
+}

internal/cmd/internal/olmv1/extension_delete.go

@@ -12,9 +12,14 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
 )
 
+type extensionDeleteOptions struct {
+	dryRunOptions
+}
+
 func NewExtensionDeleteCmd(cfg *action.Configuration) *cobra.Command {
-	e := v1action.NewExtensionDelete(cfg)
-	e.Logf = log.Printf
+	i := v1action.NewExtensionDelete(cfg)
+	i.Logf = log.Printf
+	var opts extensionDeleteOptions
 
 	cmd := &cobra.Command{
 		Use:     "extension [extension_name]",
@@ -25,42 +30,46 @@ func NewExtensionDeleteCmd(cfg *action.Configuration) *cobra.Command {
 		 cascades to the deletion of all operands.`,
 		Args: cobra.RangeArgs(0, 1),
 		Run: func(cmd *cobra.Command, args []string) {
-			if len(e.DryRun) > 0 && e.DryRun != v1action.DryRunAll {
-				log.Fatalf("invalid value for `--dry-run` %s, must be one of (%s)\n", e.DryRun, v1action.DryRunAll)
+			if len(args) > 0 {
+				if i.DeleteAll {
+					log.Fatalf("failed to delete extension: cannot specify both --all and an extension name")
+				}
+				i.ExtensionName = args[0]
 			}
-			if len(args) != 0 {
-				e.ExtensionName = args[0]
+			if err := opts.validate(); err != nil {
+				log.Fatalf("failed to parse flags: %s", err.Error())
 			}
-			extensions, err := e.Run(cmd.Context())
+			i.DryRun = opts.DryRun
+			i.Output = opts.Output
+			extensions, err := i.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to delete extension: %v", err)
 			}
-			if len(e.DryRun) == 0 {
+			if len(i.DryRun) == 0 {
 				for _, extn := range extensions {
 					log.Printf("extension %s deleted", extn.Name)
 				}
 				return
 			}
-			if len(e.Output) == 0 {
+			if len(i.Output) == 0 {
 				for _, extn := range extensions {
 					log.Printf("extension %s deleted (dry run)\n", extn.Name)
 				}
 				return
 			}
 
-			for _, i := range extensions {
-				i.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{Group: olmv1.GroupVersion.Group,
+			for _, e := range extensions {
+				e.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{Group: olmv1.GroupVersion.Group,
 					Version: olmv1.GroupVersion.Version, Kind: olmv1.ClusterExtensionKind})
 			}
-			printFormattedExtensions(e.Output, extensions...)
+			printFormattedExtensions(i.Output, extensions...)
 		},
 	}
-	bindExtensionDeleteFlags(cmd.Flags(), e)
+	bindExtensionDeleteFlags(cmd.Flags(), i)
+	bindDryRunFlags(cmd.Flags(), &opts.dryRunOptions)
 	return cmd
 }
 
 func bindExtensionDeleteFlags(fs *pflag.FlagSet, e *v1action.ExtensionDeletion) {
 	fs.BoolVarP(&e.DeleteAll, "all", "a", false, "delete all extensions")
-	fs.StringVar(&e.DryRun, "dry-run", "", "display the object that would be sent on a request without applying it. One of: (All)")
-	fs.StringVarP(&e.Output, "output", "o", "", "output format for dry-run manifests. One of: (json, yaml)")
 }