feat(cli): Workflow run can receive a status flag (#723)

Signed-off-by: Javier Rodriguez <[email protected]>

Author: javirln

app/cli/cmd/workflow_workflow_run_list.go

@@ -30,7 +30,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 		DefaultLimit: 20,
 	}
 
-	var workflowID string
+	var workflowID, status string
 
 	cmd := &cobra.Command{
 		Use:     "list",
@@ -44,6 +44,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 						Limit:      paginationOpts.Limit,
 						NextCursor: paginationOpts.NextCursor,
 					},
+					Status: status,
 				},
 			)
 			if err != nil {
@@ -71,6 +72,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 
 	cmd.Flags().StringVar(&workflowID, "workflow", "", "workflow ID")
 	cmd.Flags().BoolVar(&full, "full", false, "full report")
+	cmd.Flags().StringVar(&status, "status", "", fmt.Sprintf("filter by workflow run status: %v", listAvailableWorkflowStatusFlag()))
 	// Add pagination flags
 	paginationOpts.AddFlags(cmd)
 
@@ -108,3 +110,14 @@ func workflowRunListTableOutput(runs []*action.WorkflowRunItem) error {
 
 	return nil
 }
+
+// listAvailableWorkflowStatusFlag returns a list of available workflow status flags
+func listAvailableWorkflowStatusFlag() []string {
+	m := action.WorkflowRunStatus()
+	r := make([]string, 0, len(m))
+	for k := range m {
+		r = append(r, k)
+	}
+
+	return r
+}

app/cli/internal/action/workflow_run_list.go

@@ -17,12 +17,24 @@ package action
 
 import (
 	"context"
+	"strings"
 	"time"
 
 	pb "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1"
 	v1 "github.com/chainloop-dev/chainloop/app/controlplane/api/workflowcontract/v1"
 )
 
+// WorkflowRunStatus represents the status of a workflow run
+var WorkflowRunStatus = func() map[string]pb.RunStatus {
+	res := make(map[string]pb.RunStatus)
+	for k, v := range pb.RunStatus_value {
+		if k != "RUN_STATUS_UNSPECIFIED" {
+			res[strings.Replace(k, "RUN_STATUS_", "", 1)] = pb.RunStatus(v)
+		}
+	}
+	return res
+}
+
 type WorkflowRunList struct {
 	cfg *ActionsOpts
 }
@@ -53,6 +65,7 @@ func NewWorkflowRunList(cfg *ActionsOpts) *WorkflowRunList {
 type WorkflowRunListOpts struct {
 	WorkflowID string
 	Pagination *PaginationOpts
+	Status     string
 }
 type PaginationOpts struct {
 	Limit      int
@@ -61,14 +74,19 @@ type PaginationOpts struct {
 
 func (action *WorkflowRunList) Run(opts *WorkflowRunListOpts) (*PaginatedWorkflowRunItem, error) {
 	client := pb.NewWorkflowRunServiceClient(action.cfg.CPConnection)
-	resp, err := client.List(context.Background(),
-		&pb.WorkflowRunServiceListRequest{
-			WorkflowId: opts.WorkflowID,
-			Pagination: &pb.CursorPaginationRequest{
-				Limit:  int32(opts.Pagination.Limit),
-				Cursor: opts.Pagination.NextCursor,
-			},
-		})
+	req := &pb.WorkflowRunServiceListRequest{
+		WorkflowId: opts.WorkflowID,
+		Pagination: &pb.CursorPaginationRequest{
+			Limit:  int32(opts.Pagination.Limit),
+			Cursor: opts.Pagination.NextCursor,
+		},
+	}
+
+	if v, ok := WorkflowRunStatus()[opts.Status]; ok {
+		req.Status = v
+	}
+
+	resp, err := client.List(context.Background(), req)
 	if err != nil {
 		return nil, err
 	}

app/cli/internal/action/workflow_run_list_test.go

@@ -79,7 +79,7 @@ func (s *workflowRunListSuite) TestHumanizedRunnerType() {
 	)
 
 	for _, testCase := range testCases {
-		s.T().Run(testCase.name, func(t *testing.T) {
+		s.Run(testCase.name, func() {
 			result := humanizedRunnerType(testCase.testInput)
 			s.Equal(testCase.expectedOutput, result)
 		})