create and set timeouts globally via a flag (#43)

Signed-off-by: Joe Lanford <[email protected]>

Author: joelanford

internal/cmd/catalog_add.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"context"
 	"io/ioutil"
 	"time"
 
@@ -16,7 +15,6 @@ import (
 )
 
 func newCatalogAddCmd(cfg *action.Configuration) *cobra.Command {
-	var timeout time.Duration
 	a := internalaction.NewCatalogAdd(cfg)
 	a.Logf = log.Printf
 
@@ -32,29 +30,25 @@ func newCatalogAddCmd(cfg *action.Configuration) *cobra.Command {
 			}
 		},
 		Run: func(cmd *cobra.Command, args []string) {
-			ctx, cancel := context.WithTimeout(cmd.Context(), timeout)
-			defer cancel()
-
 			a.CatalogSourceName = args[0]
 			a.IndexImage = args[1]
 
-			cs, err := a.Run(ctx)
+			cs, err := a.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to add catalog: %v", err)
 			}
 			log.Printf("created catalogsource %q\n", cs.Name)
 		},
 	}
 	bindCatalogAddFlags(cmd.Flags(), a)
-	cmd.Flags().DurationVarP(&timeout, "timeout", "t", time.Minute, "the amount of time to wait before cancelling the catalog addition")
 
 	return cmd
 }
 
 func bindCatalogAddFlags(fs *pflag.FlagSet, a *internalaction.CatalogAdd) {
 	fs.StringVarP(&a.DisplayName, "display-name", "d", "", "display name of the index")
 	fs.StringVarP(&a.Publisher, "publisher", "p", "", "publisher of the index")
-	fs.DurationVar(&a.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount to time to wait before cancelling cleanup")
+	fs.DurationVar(&a.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount of time to wait before cancelling cleanup")
 
 	fs.StringArrayVarP(&a.InjectBundles, "inject-bundles", "b", nil, "inject extra bundles into the index at runtime")
 	fs.StringVarP(&a.InjectBundleMode, "inject-bundle-mode", "m", "", "mode to use to inject bundles")

internal/cmd/operator_install.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"context"
 	"fmt"
 	"time"
 
@@ -15,7 +14,6 @@ import (
 )
 
 func newOperatorInstallCmd(cfg *action.Configuration) *cobra.Command {
-	var timeout time.Duration
 	i := internalaction.NewOperatorInstall(cfg)
 	i.Logf = log.Printf
 
@@ -25,17 +23,14 @@ func newOperatorInstallCmd(cfg *action.Configuration) *cobra.Command {
 		Args:  cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			i.Package = args[0]
-			ctx, cancel := context.WithTimeout(cmd.Context(), timeout)
-			defer cancel()
-			csv, err := i.Run(ctx)
+			csv, err := i.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to install operator: %v", err)
 			}
 			log.Printf("operator %q installed; installed csv is %q", i.Package, csv.Name)
 		},
 	}
 	bindOperatorInstallFlags(cmd.Flags(), i)
-	cmd.Flags().DurationVarP(&timeout, "timeout", "t", time.Minute, "the amount of time to wait before cancelling the install")
 
 	return cmd
 }
@@ -45,7 +40,7 @@ func bindOperatorInstallFlags(fs *pflag.FlagSet, i *internalaction.OperatorInsta
 	fs.VarP(&i.Approval, "approval", "a", fmt.Sprintf("approval (%s or %s)", v1alpha1.ApprovalManual, v1alpha1.ApprovalAutomatic))
 	fs.StringVarP(&i.Version, "version", "v", "", "install specific version for operator (default latest)")
 	fs.StringSliceVarP(&i.WatchNamespaces, "watch", "w", []string{}, "namespaces to watch")
-	fs.DurationVar(&i.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount to time to wait before cancelling cleanup")
+	fs.DurationVar(&i.CleanupTimeout, "cleanup-timeout", time.Minute, "the amount of time to wait before cancelling cleanup")
 	fs.BoolVarP(&i.CreateOperatorGroup, "create-operator-group", "C", false, "create operator group if necessary")
 
 	fs.VarP(&i.InstallMode, "install-mode", "i", "install mode")

internal/cmd/operator_upgrade.go

@@ -1,9 +1,6 @@
 package cmd
 
 import (
-	"context"
-	"time"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
@@ -13,25 +10,21 @@ import (
 )
 
 func newOperatorUpgradeCmd(cfg *action.Configuration) *cobra.Command {
-	var timeout time.Duration
 	u := internalaction.NewOperatorUpgrade(cfg)
 	cmd := &cobra.Command{
 		Use:   "upgrade <operator>",
 		Short: "Upgrade an operator",
 		Args:  cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			u.Package = args[0]
-			ctx, cancel := context.WithTimeout(cmd.Context(), timeout)
-			defer cancel()
-			csv, err := u.Run(ctx)
+			csv, err := u.Run(cmd.Context())
 			if err != nil {
 				log.Fatalf("failed to upgrade operator: %v", err)
 			}
 			log.Printf("operator %q upgraded; installed csv is %q", u.Package, csv.Name)
 		},
 	}
 	bindOperatorUpgradeFlags(cmd.Flags(), u)
-	cmd.Flags().DurationVarP(&timeout, "timeout", "t", time.Minute, "the amount of time to wait before cancelling the upgrade")
 	return cmd
 }
 

internal/cmd/root.go

@@ -1,6 +1,11 @@
 package cmd
 
 import (
+	"context"
+	"reflect"
+	"time"
+	"unsafe"
+
 	"github.com/spf13/cobra"
 
 	"github.com/operator-framework/kubectl-operator/internal/cmd/internal/log"
@@ -24,14 +29,30 @@ operators available for installation, and install and uninstall
 operators from the installed catalogs.`,
 	}
 
-	flags := cmd.PersistentFlags()
+	var (
+		cfg     action.Configuration
+		timeout time.Duration
+		cancel  context.CancelFunc
+	)
 
-	var cfg action.Configuration
+	flags := cmd.PersistentFlags()
 	cfg.BindFlags(flags)
+	flags.DurationVar(&timeout, "timeout", 1*time.Minute, "The amount of time to wait before giving up on an operation.")
+
+	cmd.PersistentPreRunE = func(cmd *cobra.Command, _ []string) error {
+		var ctx context.Context
+		ctx, cancel = context.WithTimeout(cmd.Context(), timeout)
+
+		// This sets the unexported cmd.ctx value using unsafe. If
+		// https://github.com/spf13/cobra/pull/1118 gets merged, we
+		// should use cmd.SetContext() instead.
+		setContext(cmd, ctx)
 
-	cmd.PersistentPreRunE = func(*cobra.Command, []string) error {
 		return cfg.Load()
 	}
+	cmd.PersistentPostRun = func(command *cobra.Command, _ []string) {
+		cancel()
+	}
 
 	cmd.AddCommand(
 		newCatalogCmd(&cfg),
@@ -47,3 +68,10 @@ operators from the installed catalogs.`,
 
 	return cmd
 }
+
+func setContext(cmd *cobra.Command, ctx context.Context) { //nolint:golint
+	rs := reflect.ValueOf(cmd).Elem()
+	rf := rs.FieldByName("ctx")
+	rf = reflect.NewAt(rf.Type(), unsafe.Pointer(rf.UnsafeAddr())).Elem()
+	rf.Set(reflect.ValueOf(ctx))
+}