Merge pull request #7249 from alex-petrov-vt/iss-7235

feat: allow filtering workflow runs by status

pkg/cmd/run/list/list.go

@@ -31,6 +31,7 @@ type ListOptions struct {
 	WorkflowSelector string
 	Branch           string
 	Actor            string
+	Status           string
 
 	now time.Time
 }
@@ -67,6 +68,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
 	cmd.Flags().StringVarP(&opts.WorkflowSelector, "workflow", "w", "", "Filter runs by workflow")
 	cmd.Flags().StringVarP(&opts.Branch, "branch", "b", "", "Filter runs by branch")
 	cmd.Flags().StringVarP(&opts.Actor, "user", "u", "", "Filter runs by user who triggered the run")
+	cmdutil.StringEnumFlag(cmd, &opts.Status, "status", "s", "", shared.AllStatuses, "Filter runs by status")
 	cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.RunFields)
 
 	_ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "branch")
@@ -89,6 +91,7 @@ func listRun(opts *ListOptions) error {
 	filters := &shared.FilterOptions{
 		Branch: opts.Branch,
 		Actor:  opts.Actor,
+		Status: opts.Status,
 	}
 
 	opts.IO.StartProgressIndicator()

pkg/cmd/run/list/list_test.go

@@ -69,6 +69,14 @@ func TestNewCmdList(t *testing.T) {
 				Actor: "bak1an",
 			},
 		},
+		{
+			name: "status",
+			cli:  "--status completed",
+			wants: ListOptions{
+				Limit:  defaultLimit,
+				Status: "completed",
+			},
+		},
 	}
 
 	for _, tt := range tests {
@@ -115,6 +123,7 @@ func TestListRun(t *testing.T) {
 		wantErr    bool
 		wantOut    string
 		wantErrOut string
+		wantErrMsg string
 		stubs      func(*httpmock.Registry)
 		isTTY      bool
 	}{
@@ -335,7 +344,8 @@ func TestListRun(t *testing.T) {
 					httpmock.JSONResponse(shared.RunsPayload{}),
 				)
 			},
-			wantErr: true,
+			wantErr:    true,
+			wantErrMsg: "no runs found",
 		},
 		{
 			name: "workflow selector",
@@ -376,7 +386,8 @@ func TestListRun(t *testing.T) {
 					httpmock.JSONResponse(shared.RunsPayload{}),
 				)
 			},
-			wantErr: true,
+			wantErr:    true,
+			wantErrMsg: "no runs found",
 		},
 		{
 			name: "actor filter applied",
@@ -392,7 +403,26 @@ func TestListRun(t *testing.T) {
 					httpmock.JSONResponse(shared.RunsPayload{}),
 				)
 			},
-			wantErr: true,
+			wantErr:    true,
+			wantErrMsg: "no runs found",
+		},
+		{
+			name: "status filter applied",
+			opts: &ListOptions{
+				Limit:  defaultLimit,
+				Status: "queued",
+			},
+			isTTY: true,
+			stubs: func(reg *httpmock.Registry) {
+				reg.Register(
+					httpmock.QueryMatcher("GET", "repos/OWNER/REPO/actions/runs", url.Values{
+						"status": []string{"queued"},
+					}),
+					httpmock.JSONResponse(shared.RunsPayload{}),
+				)
+			},
+			wantErr:    true,
+			wantErrMsg: "no runs found",
 		},
 	}
 
@@ -416,6 +446,7 @@ func TestListRun(t *testing.T) {
 			err := listRun(tt.opts)
 			if tt.wantErr {
 				assert.Error(t, err)
+				assert.Equal(t, tt.wantErrMsg, err.Error())
 			} else {
 				assert.NoError(t, err)
 			}

pkg/cmd/run/shared/shared.go

@@ -44,6 +44,23 @@ type Status string
 type Conclusion string
 type Level string
 
+var AllStatuses = []string{
+	"queued",
+	"completed",
+	"in_progress",
+	"requested",
+	"waiting",
+	"action_required",
+	"cancelled",
+	"failure",
+	"neutral",
+	"skipped",
+	"stale",
+	"startup_failure",
+	"success",
+	"timed_out",
+}
+
 var RunFields = []string{
 	"name",
 	"displayTitle",
@@ -284,6 +301,7 @@ type FilterOptions struct {
 	WorkflowID int64
 	// avoid loading workflow name separately and use the provided one
 	WorkflowName string
+	Status       string
 }
 
 // GetRunsWithFilter fetches 50 runs from the API and filters them in-memory
@@ -326,6 +344,9 @@ func GetRuns(client *api.Client, repo ghrepo.Interface, opts *FilterOptions, lim
 		if opts.Actor != "" {
 			path += fmt.Sprintf("&actor=%s", url.QueryEscape(opts.Actor))
 		}
+		if opts.Status != "" {
+			path += fmt.Sprintf("&status=%s", url.QueryEscape(opts.Status))
+		}
 	}
 
 	var result *RunsPayload