feat: task wait command support -f argument (#535)

* feat: task wait command support -f argument

* enhance table format

* fix test fail

* refactor

* tidy

Author: HuyPhanNguyen

pkg/cmd/task/wait/wait.go

@@ -9,6 +9,7 @@ import (
 	"github.com/OctopusDeploy/cli/pkg/cmd"
 	"github.com/OctopusDeploy/cli/pkg/constants"
 	"github.com/OctopusDeploy/cli/pkg/factory"
+	"github.com/OctopusDeploy/cli/pkg/output"
 	"github.com/OctopusDeploy/cli/pkg/util"
 	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client"
 	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/tasks"
@@ -34,12 +35,23 @@ type WaitOptions struct {
 	PollInterval              int
 	CancelOnTimeout           bool
 	ShowProgress              bool
+	Command                   *cobra.Command
 }
 
 type ServerTasksCallback func([]string) ([]*tasks.Task, error)
 type TaskDetailsCallback func(string) (*tasks.TaskDetailsResource, error)
 
-func NewWaitOps(dependencies *cmd.Dependencies, taskIDs []string, timeout int, pollInterval int, cancelOnTimeout bool, showProgress bool) *WaitOptions {
+type TaskAsJson struct {
+	Id                   string     `json:"Id"`
+	Description          string     `json:"Description"`
+	State                string     `json:"State"`
+	StartTime            *time.Time `json:"StartTime"`
+	CompletedTime        *time.Time `json:"CompletedTime"`
+	Duration             string     `json:"Duration"`
+	FinishedSuccessfully *bool      `json:"FinishedSuccessfully"`
+}
+
+func NewWaitOps(dependencies *cmd.Dependencies, taskIDs []string, timeout int, pollInterval int, cancelOnTimeout bool, showProgress bool, cmd *cobra.Command) *WaitOptions {
 	return &WaitOptions{
 		Dependencies:              dependencies,
 		TaskIDs:                   taskIDs,
@@ -50,6 +62,7 @@ func NewWaitOps(dependencies *cmd.Dependencies, taskIDs []string, timeout int, p
 		PollInterval:              pollInterval,
 		CancelOnTimeout:           cancelOnTimeout,
 		ShowProgress:              showProgress,
+		Command:                   cmd,
 	}
 }
 
@@ -70,7 +83,7 @@ func NewCmdWait(f factory.Factory) *cobra.Command {
 
 			taskIDs = append(taskIDs, util.ReadValuesFromPipe()...)
 			dependencies := cmd.NewDependencies(f, c)
-			opts := NewWaitOps(dependencies, taskIDs, timeout, pollInterval, cancelOnTimeout, showProgress)
+			opts := NewWaitOps(dependencies, taskIDs, timeout, pollInterval, cancelOnTimeout, showProgress, c)
 
 			return WaitRun(opts)
 		},
@@ -106,6 +119,7 @@ func WaitRun(opts *WaitOptions) error {
 	pendingTaskIDs := make([]string, 0)
 	failedTaskIDs := make([]string, 0)
 	formatter := NewTaskOutputFormatter(opts.Out)
+	tableHeaderPrinted := false
 
 	for _, t := range serverTasks {
 		if t.IsCompleted == nil || !*t.IsCompleted {
@@ -115,7 +129,11 @@ func WaitRun(opts *WaitOptions) error {
 			failedTaskIDs = append(failedTaskIDs, t.ID)
 		}
 
-		formatter.PrintTaskInfo(t)
+		if shouldUseCustomOutputFormat(opts, t) {
+			printTaskWithCustomFormat(opts, t, &tableHeaderPrinted)
+		} else {
+			formatter.PrintTaskInfo(t)
+		}
 	}
 
 	if len(pendingTaskIDs) == 0 {
@@ -156,7 +174,13 @@ func WaitRun(opts *WaitOptions) error {
 					if t.FinishedSuccessfully != nil && !*t.FinishedSuccessfully {
 						failedTaskIDs = append(failedTaskIDs, t.ID)
 					}
-					formatter.PrintTaskInfo(t)
+
+					if shouldUseCustomOutputFormat(opts, t) {
+						printTaskWithCustomFormat(opts, t, &tableHeaderPrinted)
+					} else {
+						formatter.PrintTaskInfo(t)
+					}
+
 					pendingTaskIDs = removeTaskID(pendingTaskIDs, t.ID)
 				}
 			}
@@ -235,3 +259,79 @@ func removeTaskID(taskIDs []string, taskID string) []string {
 	}
 	return taskIDs
 }
+
+func getTaskMappers() output.Mappers[*tasks.Task] {
+	return output.Mappers[*tasks.Task]{
+		Json: func(task *tasks.Task) any {
+			var duration string
+			if task.StartTime != nil && task.CompletedTime != nil {
+				duration = task.CompletedTime.Sub(*task.StartTime).Round(time.Second).String()
+			}
+			return TaskAsJson{
+				Id:                   task.ID,
+				Description:          task.Description,
+				State:                task.State,
+				StartTime:            task.StartTime,
+				CompletedTime:        task.CompletedTime,
+				Duration:             duration,
+				FinishedSuccessfully: task.FinishedSuccessfully,
+			}
+		},
+		Table: output.TableDefinition[*tasks.Task]{
+			Header: []string{"ID", "DESCRIPTION", "STATE", "STARTED", "COMPLETED", "DURATION"},
+			Row: func(task *tasks.Task) []string {
+				var startTime, completedTime, duration string
+				if task.StartTime != nil {
+					startTime = task.StartTime.Format("02-01-2006 15:04:05")
+				}
+				if task.CompletedTime != nil {
+					completedTime = task.CompletedTime.Format("02-01-2006 15:04:05")
+				}
+				if task.StartTime != nil && task.CompletedTime != nil {
+					duration = task.CompletedTime.Sub(*task.StartTime).Round(time.Second).String()
+				}
+
+				state := task.State
+				switch task.State {
+				case "Failed", "TimedOut":
+					state = output.Red(task.State)
+				case "Success":
+					state = output.Green(task.State)
+				case "Queued", "Executing", "Cancelling", "Canceled":
+					state = output.Yellow(task.State)
+				}
+
+				return []string{task.ID, task.Description, state, startTime, completedTime, duration}
+			},
+		},
+		Basic: nil, // Not used - we use the existing formatter for basic output
+	}
+}
+
+func shouldUseCustomOutputFormat(opts *WaitOptions, t *tasks.Task) bool {
+	if opts.Command == nil {
+		return false
+	}
+
+	outputFormat, _ := opts.Command.Flags().GetString(constants.FlagOutputFormat)
+	isFormatSpecified := opts.Command.Flags().Changed(constants.FlagOutputFormat)
+	isJsonOrTable := outputFormat == constants.OutputFormatJson || outputFormat == constants.OutputFormatTable
+	isTaskReady := !opts.ShowProgress || (t.IsCompleted != nil && *t.IsCompleted)
+
+	return isFormatSpecified && isJsonOrTable && isTaskReady
+}
+
+func printTaskWithCustomFormat(opts *WaitOptions, t *tasks.Task, tableHeaderPrinted *bool) {
+	outputFormat, _ := opts.Command.Flags().GetString(constants.FlagOutputFormat)
+
+	if outputFormat == constants.OutputFormatJson {
+		_ = output.PrintResource(t, opts.Command, getTaskMappers())
+	} else if outputFormat == constants.OutputFormatTable {
+		mappers := getTaskMappers()
+		if *tableHeaderPrinted {
+			mappers.Table.Header = nil // Don't print header for subsequent updates
+		}
+		_ = output.PrintResource(t, opts.Command, mappers)
+		*tableHeaderPrinted = true
+	}
+}