STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add new commands issue pin and issue unpin (#5597)

Browse source
This commit is contained in:
ffalor 2022-08-31 05:16:45 -05:00 • committed by GitHub
parent 8cd9641284
commit 665e4e3446
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 609 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
api/queries_issue.go
View file

@ -38,6 +38,7 @@ type Issue struct {
ProjectCards ProjectCards
Milestone *Milestone
ReactionGroups ReactionGroups
IsPinned bool
}
func (i Issue) IsPullRequest() bool {

17
api/query_builder.go
View file

@ -3,6 +3,8 @@ package api
import (
"fmt"
"strings"
"github.com/cli/cli/v2/pkg/set"
)
func squeeze(r rune) rune {
@ -208,9 +210,8 @@ var PullRequestFields = append(IssueFields,
"statusCheckRollup",
)
// PullRequestGraphQL constructs a GraphQL query fragment for a set of pull request fields. Since GitHub
// pull requests are also technically issues, this function can be used to query issues as well.
func PullRequestGraphQL(fields []string) string {
// IssueGraphQL constructs a GraphQL query fragment for a set of issue fields.
func IssueGraphQL(fields []string) string {
var q []string
for _, field := range fields {
switch field {
@ -265,6 +266,16 @@ func PullRequestGraphQL(fields []string) string {
return strings.Join(q, ",")
}
// PullRequestGraphQL constructs a GraphQL query fragment for a set of pull request fields.
// It will try to sanitize the fields to just those available on pull request.
func PullRequestGraphQL(fields []string) string {
invalidFields := []string{"isPinned"}
s := set.NewStringSet()
s.AddValues(fields)
s.RemoveValues(invalidFields)
return IssueGraphQL(s.ToSlice())
}
var RepositoryFields = []string{
"id",
"name",

41
api/query_builder_test.go
View file

@ -28,6 +28,11 @@ func TestPullRequestGraphQL(t *testing.T) {
fields: []string{"files"},
want: "files(first: 100) {nodes {additions,deletions,path}}",
},
{
name: "invalid fields",
fields: []string{"isPinned", "number"},
want: "number",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@ -37,3 +42,39 @@ func TestPullRequestGraphQL(t *testing.T) {
})
}
}
func TestIssueGraphQL(t *testing.T) {
tests := []struct {
name string
fields []string
want string
}{
{
name: "empty",
fields: []string(nil),
want: "",
},
{
name: "simple fields",
fields: []string{"number", "title"},
want: "number,title",
},
{
name: "fields with nested structures",
fields: []string{"author", "assignees"},
want: "author{login},assignees(first:100){nodes{id,login,name},totalCount}",
},
{
name: "compressed query",
fields: []string{"files"},
want: "files(first: 100) {nodes {additions,deletions,path}}",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IssueGraphQL(tt.fields); got != tt.want {
t.Errorf("IssueGraphQL() = %v, want %v", got, tt.want)
}
})
}
}

2
go.mod
View file

@ -29,7 +29,7 @@ require (
github.com/muesli/termenv v0.12.0
github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38
github.com/opentracing/opentracing-go v1.1.0
github.com/shurcooL/githubv4 v0.0.0-20200928013246-d292edc3691b
github.com/shurcooL/githubv4 v0.0.0-20220115235240-a14260e6f8a2
github.com/sourcegraph/jsonrpc2 v0.1.0
github.com/spf13/cobra v1.4.0
github.com/spf13/pflag v1.0.5

4
go.sum
View file

@ -224,8 +224,8 @@ github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/shurcooL/githubv4 v0.0.0-20200928013246-d292edc3691b h1:0/ecDXh/HTHRtSDSFnD2/Ta1yQ5J76ZspVY4u0/jGFk=
github.com/shurcooL/githubv4 v0.0.0-20200928013246-d292edc3691b/go.mod h1:hAF0iLZy4td2EX+/8Tw+4nodhlMrwN3HupfaXj3zkGo=
github.com/shurcooL/githubv4 v0.0.0-20220115235240-a14260e6f8a2 h1:82EIpiGB79OIPgSGa63Oj4Ipf+YAX1c6A9qjmEYoRXc=
github.com/shurcooL/githubv4 v0.0.0-20220115235240-a14260e6f8a2/go.mod h1:hAF0iLZy4td2EX+/8Tw+4nodhlMrwN3HupfaXj3zkGo=
github.com/shurcooL/graphql v0.0.0-20200928012149-18c5c3165e3a h1:KikTa6HtAK8cS1qjvUvvq4QO21QnwC+EfvB+OAuZ/ZU=
github.com/shurcooL/graphql v0.0.0-20200928012149-18c5c3165e3a/go.mod h1:AuYgA5Kyo4c7HfUmvRGs/6rGlMMV/6B1bVnB9JxJEEg=
github.com/sourcegraph/jsonrpc2 v0.1.0 h1:ohJHjZ+PcaLxDUjqk2NC3tIGsVa5bXThe1ZheSXOjuk=

4
pkg/cmd/issue/issue.go
View file

@ -8,9 +8,11 @@ import (
cmdDelete "github.com/cli/cli/v2/pkg/cmd/issue/delete"
cmdEdit "github.com/cli/cli/v2/pkg/cmd/issue/edit"
cmdList "github.com/cli/cli/v2/pkg/cmd/issue/list"
cmdPin "github.com/cli/cli/v2/pkg/cmd/issue/pin"
cmdReopen "github.com/cli/cli/v2/pkg/cmd/issue/reopen"
cmdStatus "github.com/cli/cli/v2/pkg/cmd/issue/status"
cmdTransfer "github.com/cli/cli/v2/pkg/cmd/issue/transfer"
cmdUnpin "github.com/cli/cli/v2/pkg/cmd/issue/unpin"
cmdView "github.com/cli/cli/v2/pkg/cmd/issue/view"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/spf13/cobra"
@ -48,6 +50,8 @@ func NewCmdIssue(f *cmdutil.Factory) *cobra.Command {
cmd.AddCommand(cmdDelete.NewCmdDelete(f, nil))
cmd.AddCommand(cmdEdit.NewCmdEdit(f, nil))
cmd.AddCommand(cmdTransfer.NewCmdTransfer(f, nil))
cmd.AddCommand(cmdPin.NewCmdPin(f, nil))
cmd.AddCommand(cmdUnpin.NewCmdUnpin(f, nil))
return cmd
}

114
pkg/cmd/issue/pin/pin.go Normal file
View file

@ -0,0 +1,114 @@
package pin
import (
"fmt"
"net/http"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/issue/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/shurcooL/githubv4"
"github.com/spf13/cobra"
)
type PinOptions struct {
HttpClient func() (*http.Client, error)
Config func() (config.Config, error)
IO *iostreams.IOStreams
BaseRepo func() (ghrepo.Interface, error)
SelectorArg string
}
func NewCmdPin(f *cmdutil.Factory, runF func(*PinOptions) error) *cobra.Command {
opts := &PinOptions{
IO: f.IOStreams,
HttpClient: f.HttpClient,
Config: f.Config,
BaseRepo: f.BaseRepo,
}
cmd := &cobra.Command{
Use: "pin {<number> | <url>}",
Short: "Pin a issue",
Long: heredoc.Doc(`
Pin an issue to a repository.
The issue can be specified by issue number or URL.
`),
Example: heredoc.Doc(`
# Pin an issue to the current repository
$ gh issue pin 23
# Pin an issue by URL
$ gh issue pin https://github.com/owner/repo/issues/23
# Pin an issue to specific repository
$ gh issue pin 23 --repo owner/repo
`),
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
opts.BaseRepo = f.BaseRepo
opts.SelectorArg = args[0]
if runF != nil {
return runF(opts)
}
return pinRun(opts)
},
}
return cmd
}
func pinRun(opts *PinOptions) error {
cs := opts.IO.ColorScheme()
httpClient, err := opts.HttpClient()
if err != nil {
return err
}
issue, baseRepo, err := shared.IssueFromArgWithFields(httpClient, opts.BaseRepo, opts.SelectorArg, []string{"id", "number", "title", "isPinned"})
if err != nil {
return err
}
if issue.IsPinned {
fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is already pinned to %s\n", cs.Yellow("!"), issue.Number, issue.Title, ghrepo.FullName(baseRepo))
return nil
}
err = pinIssue(httpClient, baseRepo, issue)
if err != nil {
return err
}
fmt.Fprintf(opts.IO.ErrOut, "%s Pinned issue #%d (%s) to %s\n", cs.SuccessIcon(), issue.Number, issue.Title, ghrepo.FullName(baseRepo))
return nil
}
func pinIssue(httpClient *http.Client, repo ghrepo.Interface, issue *api.Issue) error {
var mutation struct {
PinIssue struct {
Issue struct {
ID githubv4.ID
}
} `graphql:"pinIssue(input: $input)"`
}
variables := map[string]interface{}{
"input": githubv4.PinIssueInput{
IssueID: issue.ID,
},
}
gql := api.NewClientFromHTTP(httpClient)
return gql.Mutate(repo.RepoHost(), "IssuePin", &mutation, variables)
}

158
pkg/cmd/issue/pin/pin_test.go Normal file
View file

@ -0,0 +1,158 @@
package pin
import (
"bytes"
"net/http"
"testing"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/httpmock"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/google/shlex"
"github.com/stretchr/testify/assert"
)
func TestNewCmdPin(t *testing.T) {
tests := []struct {
name string
input string
output PinOptions
wantErr bool
errMsg string
}{
{
name: "no argument",
input: "",
wantErr: true,
errMsg: "accepts 1 arg(s), received 0",
},
{
name: "issue number",
input: "6",
output: PinOptions{
SelectorArg: "6",
},
},
{
name: "issue url",
input: "https://github.com/cli/cli/6",
output: PinOptions{
SelectorArg: "https://github.com/cli/cli/6",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ios, _, _, _ := iostreams.Test()
ios.SetStdinTTY(true)
ios.SetStdoutTTY(true)
f := &cmdutil.Factory{
IOStreams: ios,
}
argv, err := shlex.Split(tt.input)
assert.NoError(t, err)
var gotOpts *PinOptions
cmd := NewCmdPin(f, func(opts *PinOptions) error {
gotOpts = opts
return nil
})
cmd.SetArgs(argv)
cmd.SetIn(&bytes.Buffer{})
cmd.SetOut(&bytes.Buffer{})
cmd.SetErr(&bytes.Buffer{})
_, err = cmd.ExecuteC()
if tt.wantErr {
assert.Error(t, err)
assert.Equal(t, tt.errMsg, err.Error())
return
}
assert.NoError(t, err)
assert.Equal(t, tt.output.SelectorArg, gotOpts.SelectorArg)
})
}
}
func TestPinRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *PinOptions
httpStubs func(*httpmock.Registry)
wantStdout string
wantStderr string
}{
{
name: "pin issue",
tty: true,
opts: &PinOptions{SelectorArg: "20"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query IssueByNumber\b`),
httpmock.StringResponse(`
{ "data": { "repository": {
"issue": { "id": "ISSUE-ID", "number": 20, "title": "Issue Title", "isPinned": false}
} } }`),
)
reg.Register(
httpmock.GraphQL(`mutation IssuePin\b`),
httpmock.GraphQLMutation(`{"id": "ISSUE-ID"}`,
func(inputs map[string]interface{}) {
assert.Equal(t, inputs["issueId"], "ISSUE-ID")
},
),
)
},
wantStdout: "",
wantStderr: "✓ Pinned issue #20 (Issue Title) to OWNER/REPO\n",
},
{
name: "issue already pinned",
tty: true,
opts: &PinOptions{SelectorArg: "20"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query IssueByNumber\b`),
httpmock.StringResponse(`
{ "data": { "repository": {
"issue": { "id": "ISSUE-ID", "number": 20, "title": "Issue Title", "isPinned": true}
} } }`),
)
},
wantStderr: "! Issue #20 (Issue Title) is already pinned to OWNER/REPO\n",
},
}
for _, tt := range tests {
reg := &httpmock.Registry{}
if tt.httpStubs != nil {
tt.httpStubs(reg)
}
tt.opts.HttpClient = func() (*http.Client, error) {
return &http.Client{Transport: reg}, nil
}
ios, _, stdout, stderr := iostreams.Test()
ios.SetStdinTTY(tt.tty)
ios.SetStdoutTTY(tt.tty)
tt.opts.IO = ios
tt.opts.Config = func() (config.Config, error) {
return config.NewBlankConfig(), nil
}
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
return ghrepo.New("OWNER", "REPO"), nil
}
t.Run(tt.name, func(t *testing.T) {
defer reg.Verify(t)
err := pinRun(tt.opts)
assert.NoError(t, err)
assert.Equal(t, tt.wantStdout, stdout.String())
assert.Equal(t, tt.wantStderr, stderr.String())
})
}
}

4
pkg/cmd/issue/shared/lookup.go
View file

@ -79,10 +79,10 @@ func findIssueOrPR(httpClient *http.Client, repo ghrepo.Interface, number int, f
issue: issueOrPullRequest(number: $number) {
__typename
...on Issue{%[1]s}
...on PullRequest{%[1]s}
...on PullRequest{%[2]s}
}
}
}`, api.PullRequestGraphQL(fields))
}`, api.IssueGraphQL(fields), api.PullRequestGraphQL(fields))
variables := map[string]interface{}{
"owner": repo.RepoOwner(),

114
pkg/cmd/issue/unpin/unpin.go Normal file
View file

@ -0,0 +1,114 @@
package unpin
import (
"fmt"
"net/http"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/issue/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/shurcooL/githubv4"
"github.com/spf13/cobra"
)
type UnpinOptions struct {
HttpClient func() (*http.Client, error)
Config func() (config.Config, error)
IO *iostreams.IOStreams
BaseRepo func() (ghrepo.Interface, error)
SelectorArg string
}
func NewCmdUnpin(f *cmdutil.Factory, runF func(*UnpinOptions) error) *cobra.Command {
opts := &UnpinOptions{
IO: f.IOStreams,
HttpClient: f.HttpClient,
Config: f.Config,
BaseRepo: f.BaseRepo,
}
cmd := &cobra.Command{
Use: "unpin {<number> | <url>}",
Short: "Unpin a issue",
Long: heredoc.Doc(`
Unpin an issue from a repository.
The issue can be specified by issue number or URL.
`),
Example: heredoc.Doc(`
# Unpin issue from the current repository
$ gh issue unpin 23
# Unpin issue by URL
$ gh issue unpin https://github.com/owner/repo/issues/23
# Unpin an issue from specific repository
$ gh issue unpin 23 --repo owner/repo
`),
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
opts.BaseRepo = f.BaseRepo
opts.SelectorArg = args[0]
if runF != nil {
return runF(opts)
}
return unpinRun(opts)
},
}
return cmd
}
func unpinRun(opts *UnpinOptions) error {
cs := opts.IO.ColorScheme()
httpClient, err := opts.HttpClient()
if err != nil {
return err
}
issue, baseRepo, err := shared.IssueFromArgWithFields(httpClient, opts.BaseRepo, opts.SelectorArg, []string{"id", "number", "title", "isPinned"})
if err != nil {
return err
}
if !issue.IsPinned {
fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is not pinned to %s\n", cs.Yellow("!"), issue.Number, issue.Title, ghrepo.FullName(baseRepo))
return nil
}
err = unpinIssue(httpClient, baseRepo, issue)
if err != nil {
return err
}
fmt.Fprintf(opts.IO.ErrOut, "%s Unpinned issue #%d (%s) from %s\n", cs.SuccessIconWithColor(cs.Red), issue.Number, issue.Title, ghrepo.FullName(baseRepo))
return nil
}
func unpinIssue(httpClient *http.Client, repo ghrepo.Interface, issue *api.Issue) error {
var mutation struct {
UnpinIssue struct {
Issue struct {
ID githubv4.ID
}
} `graphql:"unpinIssue(input: $input)"`
}
variables := map[string]interface{}{
"input": githubv4.UnpinIssueInput{
IssueID: issue.ID,
},
}
gql := api.NewClientFromHTTP(httpClient)
return gql.Mutate(repo.RepoHost(), "IssueUnpin", &mutation, variables)
}

158
pkg/cmd/issue/unpin/unpin_test.go Normal file
View file

@ -0,0 +1,158 @@
package unpin
import (
"bytes"
"net/http"
"testing"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/httpmock"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/google/shlex"
"github.com/stretchr/testify/assert"
)
func TestNewCmdPin(t *testing.T) {
tests := []struct {
name string
input string
output UnpinOptions
wantErr bool
errMsg string
}{
{
name: "no argument",
input: "",
wantErr: true,
errMsg: "accepts 1 arg(s), received 0",
},
{
name: "issue number",
input: "6",
output: UnpinOptions{
SelectorArg: "6",
},
},
{
name: "issue url",
input: "https://github.com/cli/cli/6",
output: UnpinOptions{
SelectorArg: "https://github.com/cli/cli/6",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ios, _, _, _ := iostreams.Test()
ios.SetStdinTTY(true)
ios.SetStdoutTTY(true)
f := &cmdutil.Factory{
IOStreams: ios,
}
argv, err := shlex.Split(tt.input)
assert.NoError(t, err)
var gotOpts *UnpinOptions
cmd := NewCmdUnpin(f, func(opts *UnpinOptions) error {
gotOpts = opts
return nil
})
cmd.SetArgs(argv)
cmd.SetIn(&bytes.Buffer{})
cmd.SetOut(&bytes.Buffer{})
cmd.SetErr(&bytes.Buffer{})
_, err = cmd.ExecuteC()
if tt.wantErr {
assert.Error(t, err)
assert.Equal(t, tt.errMsg, err.Error())
return
}
assert.NoError(t, err)
assert.Equal(t, tt.output.SelectorArg, gotOpts.SelectorArg)
})
}
}
func TestUnpinRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *UnpinOptions
httpStubs func(*httpmock.Registry)
wantStdout string
wantStderr string
}{
{
name: "unpin issue",
tty: true,
opts: &UnpinOptions{SelectorArg: "20"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query IssueByNumber\b`),
httpmock.StringResponse(`
{ "data": { "repository": {
"issue": { "id": "ISSUE-ID", "number": 20, "title": "Issue Title", "isPinned": true}
} } }`),
)
reg.Register(
httpmock.GraphQL(`mutation IssueUnpin\b`),
httpmock.GraphQLMutation(`{"id": "ISSUE-ID"}`,
func(inputs map[string]interface{}) {
assert.Equal(t, inputs["issueId"], "ISSUE-ID")
},
),
)
},
wantStdout: "",
wantStderr: "✓ Unpinned issue #20 (Issue Title) from OWNER/REPO\n",
},
{
name: "issue not pinned",
tty: true,
opts: &UnpinOptions{SelectorArg: "20"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query IssueByNumber\b`),
httpmock.StringResponse(`
{ "data": { "repository": {
"issue": { "id": "ISSUE-ID", "number": 20, "title": "Issue Title", "isPinned": false}
} } }`),
)
},
wantStderr: "! Issue #20 (Issue Title) is not pinned to OWNER/REPO\n",
},
}
for _, tt := range tests {
reg := &httpmock.Registry{}
if tt.httpStubs != nil {
tt.httpStubs(reg)
}
tt.opts.HttpClient = func() (*http.Client, error) {
return &http.Client{Transport: reg}, nil
}
ios, _, stdout, stderr := iostreams.Test()
ios.SetStdinTTY(tt.tty)
ios.SetStdoutTTY(tt.tty)
tt.opts.IO = ios
tt.opts.Config = func() (config.Config, error) {
return config.NewBlankConfig(), nil
}
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
return ghrepo.New("OWNER", "REPO"), nil
}
t.Run(tt.name, func(t *testing.T) {
defer reg.Verify(t)
err := unpinRun(tt.opts)
assert.NoError(t, err)
assert.Equal(t, tt.wantStdout, stdout.String())
assert.Equal(t, tt.wantStderr, stderr.String())
})
}
}