Merge pull request cli#4279 from SiarheiFedartsou/sf-pr-list-head-filter

mislav · web-flow · commit f6b33572fddc · 2021-10-14T20:54:56.000+02:00
Add `--head` filter to `gh pr list`
diff --git a/pkg/cmd/pr/list/http.go b/pkg/cmd/pr/list/http.go
@@ -40,12 +40,14 @@ func listPullRequests(httpClient *http.Client, repo ghrepo.Interface, filters pr
 			$limit: Int!,
 			$endCursor: String,
 			$baseBranch: String,
+			$headBranch: String,
 			$state: [PullRequestState!] = OPEN
 		) {
 			repository(owner: $owner, name: $repo) {
 				pullRequests(
 					states: $state,
 					baseRefName: $baseBranch,
+					headRefName: $headBranch,
 					first: $limit,
 					after: $endCursor,
 					orderBy: {field: CREATED_AT, direction: DESC}
@@ -84,6 +86,9 @@ func listPullRequests(httpClient *http.Client, repo ghrepo.Interface, filters pr
 	if filters.BaseBranch != "" {
 		variables["baseBranch"] = filters.BaseBranch
 	}
+	if filters.HeadBranch != "" {
+		variables["headBranch"] = filters.HeadBranch
+	}
 
 	res := api.PullRequestAndTotalCount{}
 	var check = make(map[int]struct{})
diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go
@@ -33,6 +33,7 @@ type ListOptions struct {
 
 	State      string
 	BaseBranch string
+	HeadBranch string
 	Labels     []string
 	Author     string
 	Assignee   string
@@ -95,6 +96,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
 		return []string{"open", "closed", "merged", "all"}, cobra.ShellCompDirectiveNoFileComp
 	})
 	cmd.Flags().StringVarP(&opts.BaseBranch, "base", "B", "", "Filter by base branch")
+	cmd.Flags().StringVarP(&opts.HeadBranch, "head", "H", "", "Filter by head branch")
 	cmd.Flags().StringSliceVarP(&opts.Labels, "label", "l", nil, "Filter by labels")
 	cmd.Flags().StringVarP(&opts.Author, "author", "A", "", "Filter by author")
 	cmd.Flags().StringVarP(&opts.Assignee, "assignee", "a", "", "Filter by assignee")
@@ -140,6 +142,7 @@ func listRun(opts *ListOptions) error {
 		Assignee:   opts.Assignee,
 		Labels:     opts.Labels,
 		BaseBranch: opts.BaseBranch,
+		HeadBranch: opts.HeadBranch,
 		Search:     opts.Search,
 		Draft:      opts.Draft,
 		Fields:     defaultFields,
diff --git a/pkg/cmd/pr/list/list_test.go b/pkg/cmd/pr/list/list_test.go
@@ -160,6 +160,22 @@ func TestPRList_filteringClosed(t *testing.T) {
 	}
 }
 
+func TestPRList_filteringHeadBranch(t *testing.T) {
+	http := initFakeHTTP()
+	defer http.Verify(t)
+
+	http.Register(
+		httpmock.GraphQL(`query PullRequestList\b`),
+		httpmock.GraphQLQuery(`{}`, func(_ string, params map[string]interface{}) {
+			assert.Equal(t, interface{}("bug-fix"), params["headBranch"])
+		}))
+
+	_, err := runCommand(http, true, `-H bug-fix`)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
 func TestPRList_filteringAssignee(t *testing.T) {
 	http := initFakeHTTP()
 	defer http.Verify(t)
diff --git a/pkg/cmd/pr/shared/params.go b/pkg/cmd/pr/shared/params.go
@@ -154,6 +154,7 @@ type FilterOptions struct {
 	Labels     []string
 	Author     string
 	BaseBranch string
+	HeadBranch string
 	Mention    string
 	Milestone  string
 	Search     string
@@ -177,6 +178,9 @@ func (opts *FilterOptions) IsDefault() bool {
 	if opts.BaseBranch != "" {
 		return false
 	}
+	if opts.HeadBranch != "" {
+		return false
+	}
 	if opts.Mention != "" {
 		return false
 	}
@@ -232,6 +236,9 @@ func SearchQueryBuild(options FilterOptions) string {
 	if options.BaseBranch != "" {
 		q.SetBaseBranch(options.BaseBranch)
 	}
+	if options.HeadBranch != "" {
+		q.SetHeadBranch(options.HeadBranch)
+	}
 	if options.Mention != "" {
 		q.Mentions(options.Mention)
 	}
diff --git a/pkg/cmd/pr/shared/params_test.go b/pkg/cmd/pr/shared/params_test.go
@@ -71,10 +71,11 @@ func Test_listURLWithQuery(t *testing.T) {
 					Assignee:   "bo",
 					Author:     "ka",
 					BaseBranch: "trunk",
+					HeadBranch: "bug-fix",
 					Mention:    "nu",
 				},
 			},
-			want:    "https://example.com/path?q=is%3Aissue+is%3Aopen+assignee%3Abo+author%3Aka+mentions%3Anu+base%3Atrunk",
+			want:    "https://example.com/path?q=is%3Aissue+is%3Aopen+assignee%3Abo+author%3Aka+mentions%3Anu+base%3Atrunk+head%3Abug-fix",
 			wantErr: false,
 		},
 		{
