Merge "Add possibility to specify 0 timeout via CLI options"

cmd/phase/run.go

@@ -16,6 +16,7 @@ package phase
 
 import (
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"opendev.org/airship/airshipctl/pkg/config"
 	"opendev.org/airship/airshipctl/pkg/phase"
@@ -36,10 +37,8 @@ Run initinfra phase
 
 // NewRunCommand creates a command to run specific phase
 func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
-	p := &phase.RunCommand{
+	p := &phase.RunCommand{Factory: cfgFactory}
-		Factory: cfgFactory,
+	f := &phase.RunFlags{}
-		Options: phase.RunFlags{},
-	}
 
 	runCmd := &cobra.Command{
 		Use:     "run PHASE_NAME",
@@ -48,12 +47,22 @@ func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
 		Args:    cobra.ExactArgs(1),
 		Example: runExample,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			p.Options.PhaseID.Name = args[0]
+			p.PhaseID.Name = args[0]
+			// Go through all the flags that have been set
+			fn := func(flag *pflag.Flag) {
+				switch flag.Name {
+				case "dry-run":
+					p.Options.DryRun = f.DryRun
+				case "wait-timeout":
+					p.Options.Timeout = &f.Timeout
+				}
+			}
+			cmd.Flags().Visit(fn)
 			return p.RunE()
 		},
 	}
 	flags := runCmd.Flags()
-	flags.BoolVar(&p.Options.DryRun, "dry-run", false, "simulate phase execution")
+	flags.BoolVar(&f.DryRun, "dry-run", false, "simulate phase execution")
-	flags.DurationVar(&p.Options.Timeout, "wait-timeout", 0, "wait timeout")
+	flags.DurationVar(&f.Timeout, "wait-timeout", 0, "wait timeout")
 	return runCmd
 }

cmd/plan/run.go

@@ -16,6 +16,7 @@ package plan
 
 import (
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"opendev.org/airship/airshipctl/pkg/config"
 	"opendev.org/airship/airshipctl/pkg/phase"
@@ -37,10 +38,9 @@ Perform a dry run of a plan
 
 // NewRunCommand creates a command which execute a particular phase plan
 func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
-	r := &phase.PlanRunCommand{
+	r := &phase.PlanRunCommand{Factory: cfgFactory}
-		Factory: cfgFactory,
+	f := &phase.RunFlags{}
-		Options: phase.PlanRunFlags{},
+
-	}
 	runCmd := &cobra.Command{
 		Use:     "run PLAN_NAME",
 		Short:   "Airshipctl command to run plan",
@@ -48,13 +48,22 @@ func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
 		Example: runExample,
 		Args:    cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			r.Options.PlanID.Name = args[0]
+			r.PlanID.Name = args[0]
+			fn := func(flag *pflag.Flag) {
+				switch flag.Name {
+				case "dry-run":
+					r.Options.DryRun = f.DryRun
+				case "wait-timeout":
+					r.Options.Timeout = &f.Timeout
+				}
+			}
+			cmd.Flags().Visit(fn)
 			return r.RunE()
 		},
 	}
 
 	flags := runCmd.Flags()
-	flags.BoolVar(&r.Options.DryRun, "dry-run", false, "simulate phase execution")
+	flags.BoolVar(&f.DryRun, "dry-run", false, "simulate phase execution")
-	flags.DurationVar(&r.Options.Timeout, "wait-timeout", 0, "wait timeout")
+	flags.DurationVar(&f.Timeout, "wait-timeout", 0, "wait timeout")
 	return runCmd
 }

pkg/phase/command.go

@@ -45,12 +45,12 @@ type GenericRunFlags struct {
 // RunFlags options for phase run command
 type RunFlags struct {
 	GenericRunFlags
-	PhaseID ifc.ID
 }
 
 // RunCommand phase run command
 type RunCommand struct {
-	Options RunFlags
+	PhaseID ifc.ID
+	Options ifc.RunOptions
 	Factory config.Factory
 }
 
@@ -68,11 +68,11 @@ func (c *RunCommand) RunE() error {
 
 	client := NewClient(helper)
 
-	phase, err := client.PhaseByID(c.Options.PhaseID)
+	phase, err := client.PhaseByID(c.PhaseID)
 	if err != nil {
 		return err
 	}
-	return phase.Run(ifc.RunOptions{DryRun: c.Options.DryRun, Timeout: c.Options.Timeout})
+	return phase.Run(c.Options)
 }
 
 // ListCommand phase list command
@@ -205,12 +205,12 @@ func (c *PlanListCommand) RunE() error {
 // PlanRunFlags options for phase run command
 type PlanRunFlags struct {
 	GenericRunFlags
-	PlanID ifc.ID
 }
 
 // PlanRunCommand phase run command
 type PlanRunCommand struct {
-	Options PlanRunFlags
+	PlanID  ifc.ID
+	Options ifc.RunOptions
 	Factory config.Factory
 }
 
@@ -228,11 +228,11 @@ func (c *PlanRunCommand) RunE() error {
 
 	client := NewClient(helper)
 
-	plan, err := client.PlanByID(c.Options.PlanID)
+	plan, err := client.PlanByID(c.PlanID)
 	if err != nil {
 		return err
 	}
-	return plan.Run(ifc.RunOptions{DryRun: c.Options.DryRun, Timeout: c.Options.Timeout})
+	return plan.Run(c.Options)
 }
 
 // ClusterListCommand options for cluster list command

pkg/phase/command_test.go

@@ -43,7 +43,7 @@ func TestRunCommand(t *testing.T) {
 	tests := []struct {
 		name        string
 		errContains string
-		runFlags    phase.RunFlags
+		runFlags    ifc.RunOptions
 		factory     config.Factory
 	}{
 		{
@@ -492,13 +492,11 @@ func TestPlanRunCommand(t *testing.T) {
 		tt := tc
 		t.Run(tt.name, func(t *testing.T) {
 			cmd := phase.PlanRunCommand{
-				Options: phase.PlanRunFlags{
+				Options: ifc.RunOptions{
-					GenericRunFlags: phase.GenericRunFlags{
+					DryRun: true,
-						DryRun: true,
-					},
-					PlanID: tt.planID,
 				},
 				Factory: tt.factory,
+				PlanID:  tt.planID,
 			}
 			err := cmd.RunE()
 			if tt.expectedErr != "" {

pkg/phase/executors/baremetal_manager.go

@@ -125,8 +125,8 @@ func toCommandOptions(i inventoryifc.Inventory,
 	spec v1alpha1.BaremetalManagerSpec,
 	opts ifc.RunOptions) *inventory.CommandOptions {
 	timeout := time.Duration(spec.Timeout) * time.Second
-	if opts.Timeout != 0 {
+	if opts.Timeout != nil {
-		timeout = opts.Timeout
+		timeout = *opts.Timeout
 	}
 
 	return &inventory.CommandOptions{

pkg/phase/executors/baremetal_manager_test.go

@@ -19,6 +19,7 @@ import (
 	"errors"
 	"fmt"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -89,6 +90,7 @@ func TestNewBMHExecutor(t *testing.T) {
 }
 
 func TestBMHExecutorRun(t *testing.T) {
+	timeout := time.Duration(40)
 	tests := []struct {
 		name        string
 		expectedErr string
@@ -102,7 +104,7 @@ func TestBMHExecutorRun(t *testing.T) {
 			runOptions: ifc.RunOptions{
 				DryRun: true,
 				// any value but zero
-				Timeout: 40,
+				Timeout: &timeout,
 			},
 			execDoc:   executorDoc(t, fmt.Sprintf(bmhExecutorTemplate, "unknown", "")),
 			inventory: testBaremetalInventory(),

pkg/phase/executors/k8s_applier.go

@@ -92,8 +92,8 @@ func (e *KubeApplierExecutor) Run(ch chan events.Event, runOpts ifc.RunOptions)
 		dryRunStrategy = common.DryRunClient
 	}
 	timeout := time.Second * time.Duration(e.apiObject.Config.WaitOptions.Timeout)
-	if int64(runOpts.Timeout/time.Second) != 0 {
+	if runOpts.Timeout != nil {
-		timeout = runOpts.Timeout
+		timeout = *runOpts.Timeout
 	}
 
 	log.Debugf("WaitTimeout: %v", timeout)

pkg/phase/ifc/executor.go

@@ -39,10 +39,8 @@ type ExecutorStatus struct{}
 
 // RunOptions holds options for run method
 type RunOptions struct {
-	DryRun   bool
+	DryRun  bool
-	Progress bool
+	Timeout *time.Duration
-
-	Timeout time.Duration
 }
 
 // RenderOptions holds options for render method