Add label list sorting and delete command (#5503)
This commit is contained in:
Heath Stewart
GitHub
parent
b57746a878
commit
f0027fdfd9
11 changed files with 503 additions and 33 deletions
|
|
@ -107,7 +107,7 @@ func cloneRun(opts *cloneOptions) error {
|
|||
|
||||
func cloneLabels(client *http.Client, source, destination ghrepo.Interface, force bool) (successCount, totalCount int, err error) {
|
||||
successCount = 0
|
||||
labels, totalCount, err := listLabels(client, source, -1)
|
||||
labels, totalCount, err := listLabels(client, source, listQueryOptions{Limit: -1})
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Co
|
|||
Use: "create <name>",
|
||||
Short: "Create a new label",
|
||||
Long: heredoc.Doc(`
|
||||
Create a new label on GitHub.
|
||||
Create a new label on GitHub, or updates an existing one with --force.
|
||||
|
||||
Must specify name for the label. The description and color are optional.
|
||||
If a color isn't provided, a random one will be chosen.
|
||||
|
|
@ -68,7 +68,7 @@ func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Co
|
|||
Example: heredoc.Doc(`
|
||||
# create new bug label
|
||||
$ gh label create bug --description "Something isn't working" --color E99695
|
||||
`),
|
||||
`),
|
||||
Args: cmdutil.ExactArgs(1, "cannot create label: name argument required"),
|
||||
RunE: func(c *cobra.Command, args []string) error {
|
||||
opts.BaseRepo = f.BaseRepo
|
||||
|
|
|
|||
106
pkg/cmd/label/delete.go
Normal file
106
pkg/cmd/label/delete.go
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
package label
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/AlecAivazis/survey/v2"
|
||||
"github.com/cli/cli/v2/api"
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/iostreams"
|
||||
"github.com/cli/cli/v2/pkg/prompt"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
type deleteOptions struct {
|
||||
BaseRepo func() (ghrepo.Interface, error)
|
||||
HttpClient func() (*http.Client, error)
|
||||
IO *iostreams.IOStreams
|
||||
|
||||
Name string
|
||||
Confirmed bool
|
||||
}
|
||||
|
||||
func newCmdDelete(f *cmdutil.Factory, runF func(*deleteOptions) error) *cobra.Command {
|
||||
opts := deleteOptions{
|
||||
HttpClient: f.HttpClient,
|
||||
IO: f.IOStreams,
|
||||
}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "delete <name>",
|
||||
Short: "Delete a label from a repository",
|
||||
Args: cmdutil.ExactArgs(1, "cannot delete label: name argument required"),
|
||||
RunE: func(c *cobra.Command, args []string) error {
|
||||
// support `-R, --repo` override
|
||||
opts.BaseRepo = f.BaseRepo
|
||||
opts.Name = args[0]
|
||||
|
||||
if !opts.IO.CanPrompt() && !opts.Confirmed {
|
||||
return cmdutil.FlagErrorf("--confirm required when not running interactively")
|
||||
}
|
||||
|
||||
if runF != nil {
|
||||
return runF(&opts)
|
||||
}
|
||||
return deleteRun(&opts)
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().BoolVar(&opts.Confirmed, "confirm", false, "Confirm deletion without prompting")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
func deleteRun(opts *deleteOptions) error {
|
||||
httpClient, err := opts.HttpClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
baseRepo, err := opts.BaseRepo()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if !opts.Confirmed {
|
||||
var valid string
|
||||
err := prompt.SurveyAskOne(
|
||||
&survey.Input{Message: fmt.Sprintf("Type %s to confirm deletion:", opts.Name)},
|
||||
&valid,
|
||||
survey.WithValidator(
|
||||
func(val interface{}) error {
|
||||
if str := val.(string); !strings.EqualFold(str, opts.Name) {
|
||||
return fmt.Errorf("You entered %s", str)
|
||||
}
|
||||
return nil
|
||||
}))
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not prompt: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
opts.IO.StartProgressIndicator()
|
||||
err = deleteLabel(httpClient, baseRepo, opts.Name)
|
||||
opts.IO.StopProgressIndicator()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if opts.IO.IsStdoutTTY() {
|
||||
cs := opts.IO.ColorScheme()
|
||||
successMsg := fmt.Sprintf("%s Label %q deleted from %s\n", cs.SuccessIcon(), opts.Name, ghrepo.FullName(baseRepo))
|
||||
fmt.Fprint(opts.IO.Out, successMsg)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func deleteLabel(client *http.Client, repo ghrepo.Interface, name string) error {
|
||||
apiClient := api.NewClientFromHTTP(client)
|
||||
path := fmt.Sprintf("repos/%s/%s/labels/%s", repo.RepoOwner(), repo.RepoName(), name)
|
||||
|
||||
return apiClient.REST(repo.RepoHost(), "DELETE", path, nil, nil)
|
||||
}
|
||||
181
pkg/cmd/label/delete_test.go
Normal file
181
pkg/cmd/label/delete_test.go
Normal file
|
|
@ -0,0 +1,181 @@
|
|||
package label
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"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/cli/cli/v2/pkg/prompt"
|
||||
"github.com/google/shlex"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestNewCmdDelete(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
tty bool
|
||||
input string
|
||||
output deleteOptions
|
||||
wantErr bool
|
||||
wantErrMsg string
|
||||
}{
|
||||
{
|
||||
name: "no argument",
|
||||
input: "",
|
||||
wantErr: true,
|
||||
wantErrMsg: "cannot delete label: name argument required",
|
||||
},
|
||||
{
|
||||
name: "name argument",
|
||||
tty: true,
|
||||
input: "test",
|
||||
output: deleteOptions{Name: "test"},
|
||||
},
|
||||
{
|
||||
name: "confirm argument",
|
||||
input: "test --confirm",
|
||||
output: deleteOptions{Name: "test", Confirmed: true},
|
||||
},
|
||||
{
|
||||
name: "confirm no tty",
|
||||
input: "test",
|
||||
wantErr: true,
|
||||
wantErrMsg: "--confirm required when not running interactively",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
io, _, _, _ := iostreams.Test()
|
||||
f := &cmdutil.Factory{
|
||||
IOStreams: io,
|
||||
}
|
||||
io.SetStdinTTY(tt.tty)
|
||||
io.SetStdoutTTY(tt.tty)
|
||||
|
||||
argv, err := shlex.Split(tt.input)
|
||||
assert.NoError(t, err)
|
||||
var gotOpts *deleteOptions
|
||||
cmd := newCmdDelete(f, func(opts *deleteOptions) 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.EqualError(t, err, tt.wantErrMsg)
|
||||
return
|
||||
}
|
||||
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.output.Name, gotOpts.Name)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestDeleteRun(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
tty bool
|
||||
opts *deleteOptions
|
||||
httpStubs func(*httpmock.Registry)
|
||||
askStubs func(*prompt.AskStubber)
|
||||
wantStdout string
|
||||
wantErr bool
|
||||
errMsg string
|
||||
}{
|
||||
{
|
||||
name: "deletes label",
|
||||
tty: true,
|
||||
opts: &deleteOptions{Name: "test"},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.REST("DELETE", "repos/OWNER/REPO/labels/test"),
|
||||
httpmock.StatusStringResponse(204, "{}"),
|
||||
)
|
||||
},
|
||||
askStubs: func(as *prompt.AskStubber) {
|
||||
// TODO: survey stubber doesn't have WithValidator support
|
||||
// so this always passes regardless of prompt input
|
||||
as.StubPrompt("Type test to confirm deletion:").AnswerWith("test")
|
||||
},
|
||||
wantStdout: "✓ Label \"test\" deleted from OWNER/REPO\n",
|
||||
},
|
||||
{
|
||||
name: "deletes label notty",
|
||||
tty: false,
|
||||
opts: &deleteOptions{Name: "test", Confirmed: true},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.REST("DELETE", "repos/OWNER/REPO/labels/test"),
|
||||
httpmock.StatusStringResponse(204, "{}"),
|
||||
)
|
||||
},
|
||||
wantStdout: "",
|
||||
},
|
||||
{
|
||||
name: "missing label",
|
||||
tty: false,
|
||||
opts: &deleteOptions{Name: "missing", Confirmed: true},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.REST("DELETE", "repos/OWNER/REPO/labels/missing"),
|
||||
httpmock.WithHeader(
|
||||
httpmock.StatusStringResponse(422, `
|
||||
{
|
||||
"message":"Not Found"
|
||||
}`),
|
||||
"Content-Type",
|
||||
"application/json",
|
||||
),
|
||||
)
|
||||
},
|
||||
wantErr: true,
|
||||
errMsg: "HTTP 422: Not Found (https://api.github.com/repos/OWNER/REPO/labels/missing)",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
reg := &httpmock.Registry{}
|
||||
if tt.httpStubs != nil {
|
||||
tt.httpStubs(reg)
|
||||
}
|
||||
tt.opts.HttpClient = func() (*http.Client, error) {
|
||||
return &http.Client{Transport: reg}, nil
|
||||
}
|
||||
|
||||
as := prompt.NewAskStubber(t)
|
||||
if tt.askStubs != nil {
|
||||
tt.askStubs(as)
|
||||
}
|
||||
|
||||
io, _, stdout, _ := iostreams.Test()
|
||||
io.SetStdoutTTY(tt.tty)
|
||||
io.SetStdinTTY(tt.tty)
|
||||
io.SetStderrTTY(tt.tty)
|
||||
tt.opts.IO = io
|
||||
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
|
||||
return ghrepo.New("OWNER", "REPO"), nil
|
||||
}
|
||||
defer reg.Verify(t)
|
||||
err := deleteRun(tt.opts)
|
||||
|
||||
if tt.wantErr {
|
||||
assert.EqualError(t, err, tt.errMsg)
|
||||
return
|
||||
}
|
||||
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.wantStdout, stdout.String())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -47,7 +47,7 @@ func newCmdEdit(f *cmdutil.Factory, runF func(*editOptions) error) *cobra.Comman
|
|||
|
||||
# rename and edit the description of the bug label
|
||||
$ gh label edit bug --name big-bug --description "Bigger than normal bug"
|
||||
`),
|
||||
`),
|
||||
Args: cmdutil.ExactArgs(1, "cannot update label: name argument required"),
|
||||
RunE: func(c *cobra.Command, args []string) error {
|
||||
opts.BaseRepo = f.BaseRepo
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@ package label
|
|||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/cli/cli/v2/api"
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
|
|
@ -22,19 +23,38 @@ type listLabelsResponseData struct {
|
|||
}
|
||||
}
|
||||
|
||||
type listQueryOptions struct {
|
||||
Limit int
|
||||
Query string
|
||||
Order string
|
||||
Sort string
|
||||
}
|
||||
|
||||
func (opts listQueryOptions) OrderBy() map[string]string {
|
||||
field := strings.ToUpper(opts.Sort)
|
||||
if opts.Sort == "created" {
|
||||
field = "CREATED_AT"
|
||||
}
|
||||
return map[string]string{
|
||||
"direction": strings.ToUpper(opts.Order),
|
||||
"field": field,
|
||||
}
|
||||
}
|
||||
|
||||
// listLabels lists the labels in the given repo. Pass -1 for limit to list all labels;
|
||||
// otherwise, only that number of labels is returned for any number of pages.
|
||||
func listLabels(client *http.Client, repo ghrepo.Interface, limit int) ([]label, int, error) {
|
||||
func listLabels(client *http.Client, repo ghrepo.Interface, opts listQueryOptions) ([]label, int, error) {
|
||||
apiClient := api.NewClientFromHTTP(client)
|
||||
query := `
|
||||
query LabelList($owner: String!,$repo: String!, $limit: Int!, $endCursor: String) {
|
||||
query LabelList($owner: String!, $repo: String!, $limit: Int!, $endCursor: String, $query: String, $orderBy: LabelOrder) {
|
||||
repository(owner: $owner, name: $repo) {
|
||||
labels(first: $limit, after: $endCursor) {
|
||||
labels(first: $limit, after: $endCursor, query: $query, orderBy: $orderBy) {
|
||||
totalCount,
|
||||
nodes {
|
||||
name,
|
||||
color,
|
||||
description,
|
||||
color
|
||||
createdAt,
|
||||
}
|
||||
pageInfo {
|
||||
hasNextPage
|
||||
|
|
@ -45,8 +65,10 @@ func listLabels(client *http.Client, repo ghrepo.Interface, limit int) ([]label,
|
|||
}`
|
||||
|
||||
variables := map[string]interface{}{
|
||||
"owner": repo.RepoOwner(),
|
||||
"repo": repo.RepoName(),
|
||||
"owner": repo.RepoOwner(),
|
||||
"repo": repo.RepoName(),
|
||||
"orderBy": opts.OrderBy(),
|
||||
"query": opts.Query,
|
||||
}
|
||||
|
||||
var labels []label
|
||||
|
|
@ -55,7 +77,7 @@ func listLabels(client *http.Client, repo ghrepo.Interface, limit int) ([]label,
|
|||
loop:
|
||||
for {
|
||||
var response listLabelsResponseData
|
||||
variables["limit"] = determinePageSize(limit - len(labels))
|
||||
variables["limit"] = determinePageSize(opts.Limit - len(labels))
|
||||
err := apiClient.GraphQL(repo.RepoHost(), query, variables, &response)
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
|
|
@ -65,7 +87,7 @@ loop:
|
|||
|
||||
for _, label := range response.Repository.Labels.Nodes {
|
||||
labels = append(labels, label)
|
||||
if len(labels) == limit {
|
||||
if len(labels) == opts.Limit {
|
||||
break loop
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ func TestLabelList_pagination(t *testing.T) {
|
|||
)
|
||||
|
||||
repo := ghrepo.New("OWNER", "REPO")
|
||||
labels, totalCount, err := listLabels(client, repo, 10)
|
||||
labels, totalCount, err := listLabels(client, repo, listQueryOptions{Limit: 10})
|
||||
assert.NoError(t, err)
|
||||
|
||||
assert.Equal(t, 2, totalCount)
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ func NewCmdLabel(f *cmdutil.Factory) *cobra.Command {
|
|||
cmd.AddCommand(newCmdCreate(f, nil))
|
||||
cmd.AddCommand(newCmdClone(f, nil))
|
||||
cmd.AddCommand(newCmdEdit(f, nil))
|
||||
cmd.AddCommand(newCmdDelete(f, nil))
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ import (
|
|||
"fmt"
|
||||
"net/http"
|
||||
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/iostreams"
|
||||
|
|
@ -12,8 +13,6 @@ import (
|
|||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
const listLimit = 30
|
||||
|
||||
type browser interface {
|
||||
Browse(string) error
|
||||
}
|
||||
|
|
@ -24,7 +23,7 @@ type listOptions struct {
|
|||
HttpClient func() (*http.Client, error)
|
||||
IO *iostreams.IOStreams
|
||||
|
||||
Limit int
|
||||
Query listQueryOptions
|
||||
WebMode bool
|
||||
}
|
||||
|
||||
|
|
@ -36,17 +35,34 @@ func newCmdList(f *cmdutil.Factory, runF func(*listOptions) error) *cobra.Comman
|
|||
}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "List labels in a repository",
|
||||
Long: "Display labels in a GitHub repository.",
|
||||
Use: "list",
|
||||
Short: "List labels in a repository",
|
||||
Long: heredoc.Docf(`
|
||||
Display labels in a GitHub repository.
|
||||
|
||||
When using the %[1]s--search%[1]s flag results are sorted by best match of the query.
|
||||
This behavior cannot be configured with the %[1]s--order%[1]s or %[1]s--sort%[1]s flags.
|
||||
`, "`"),
|
||||
Example: heredoc.Doc(`
|
||||
# sort labels by name
|
||||
$ gh label list --sort name
|
||||
|
||||
# find labels with "bug" in the name or description
|
||||
$ gh label list --search bug
|
||||
`),
|
||||
Args: cobra.NoArgs,
|
||||
Aliases: []string{"ls"},
|
||||
RunE: func(c *cobra.Command, args []string) error {
|
||||
// support `-R, --repo` override
|
||||
opts.BaseRepo = f.BaseRepo
|
||||
|
||||
if opts.Limit < 1 {
|
||||
return cmdutil.FlagErrorf("invalid limit: %v", opts.Limit)
|
||||
if opts.Query.Limit < 1 {
|
||||
return cmdutil.FlagErrorf("invalid limit: %v", opts.Query.Limit)
|
||||
}
|
||||
|
||||
if opts.Query.Query != "" &&
|
||||
(c.Flags().Changed("order") || c.Flags().Changed("sort")) {
|
||||
return cmdutil.FlagErrorf("cannot specify `--order` or `--sort` with `--search`")
|
||||
}
|
||||
|
||||
if runF != nil {
|
||||
|
|
@ -57,7 +73,12 @@ func newCmdList(f *cmdutil.Factory, runF func(*listOptions) error) *cobra.Comman
|
|||
}
|
||||
|
||||
cmd.Flags().BoolVarP(&opts.WebMode, "web", "w", false, "List labels in the web browser")
|
||||
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", listLimit, "Maximum number of items to fetch")
|
||||
cmd.Flags().IntVarP(&opts.Query.Limit, "limit", "L", 30, "Maximum number of labels to fetch")
|
||||
cmd.Flags().StringVarP(&opts.Query.Query, "search", "S", "", "Search label names and descriptions")
|
||||
|
||||
// These defaults match the service behavior and, therefore, the initially release of `label list` behavior.
|
||||
cmdutil.StringEnumFlag(cmd, &opts.Query.Order, "order", "", "asc", []string{"asc", "desc"}, "Order of labels returned")
|
||||
cmdutil.StringEnumFlag(cmd, &opts.Query.Sort, "sort", "", "created", []string{"created", "name"}, "Sort fetched labels")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
@ -84,14 +105,17 @@ func listRun(opts *listOptions) error {
|
|||
}
|
||||
|
||||
opts.IO.StartProgressIndicator()
|
||||
labels, totalCount, err := listLabels(httpClient, baseRepo, opts.Limit)
|
||||
labels, totalCount, err := listLabels(httpClient, baseRepo, opts.Query)
|
||||
opts.IO.StopProgressIndicator()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(labels) == 0 {
|
||||
return cmdutil.NewNoResultsError(fmt.Sprintf("there are no labels in %s", ghrepo.FullName(baseRepo)))
|
||||
if opts.Query.Query != "" {
|
||||
return cmdutil.NewNoResultsError(fmt.Sprintf("no labels in %s matched your search", ghrepo.FullName(baseRepo)))
|
||||
}
|
||||
return cmdutil.NewNoResultsError(fmt.Sprintf("no labels found in %s", ghrepo.FullName(baseRepo)))
|
||||
}
|
||||
|
||||
if opts.IO.IsStdoutTTY() {
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ import (
|
|||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/httpmock"
|
||||
|
|
@ -24,12 +25,12 @@ func TestNewCmdList(t *testing.T) {
|
|||
{
|
||||
name: "no argument",
|
||||
input: "",
|
||||
output: listOptions{Limit: 30},
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "asc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "limit flag",
|
||||
input: "--limit 10",
|
||||
output: listOptions{Limit: 10},
|
||||
output: listOptions{Query: listQueryOptions{Limit: 10, Order: "asc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "invalid limit flag",
|
||||
|
|
@ -40,7 +41,62 @@ func TestNewCmdList(t *testing.T) {
|
|||
{
|
||||
name: "web flag",
|
||||
input: "--web",
|
||||
output: listOptions{Limit: 30, WebMode: true},
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "asc", Sort: "created"}, WebMode: true},
|
||||
},
|
||||
{
|
||||
name: "search flag",
|
||||
input: "--search core",
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Query: "core", Order: "asc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "sort name flag",
|
||||
input: "--sort name",
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "asc", Sort: "name"}},
|
||||
},
|
||||
{
|
||||
name: "sort created flag",
|
||||
input: "--sort created",
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "asc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "sort invalid flag",
|
||||
input: "--sort invalid",
|
||||
wantErr: true,
|
||||
errMsg: `invalid argument "invalid" for "--sort" flag: valid values are {created|name}`,
|
||||
},
|
||||
{
|
||||
name: "order asc flag",
|
||||
input: "--order asc",
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "asc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "order desc flag",
|
||||
input: "--order desc",
|
||||
output: listOptions{Query: listQueryOptions{Limit: 30, Order: "desc", Sort: "created"}},
|
||||
},
|
||||
{
|
||||
name: "order invalid flag",
|
||||
input: "--order invalid",
|
||||
wantErr: true,
|
||||
errMsg: `invalid argument "invalid" for "--order" flag: valid values are {asc|desc}`,
|
||||
},
|
||||
{
|
||||
name: "search flag with sort flag",
|
||||
input: "--search test --sort name",
|
||||
wantErr: true,
|
||||
errMsg: "cannot specify `--order` or `--sort` with `--search`",
|
||||
},
|
||||
{
|
||||
name: "search flag with order flag",
|
||||
input: "--search test --order asc",
|
||||
wantErr: true,
|
||||
errMsg: "cannot specify `--order` or `--sort` with `--search`",
|
||||
},
|
||||
{
|
||||
name: "search flag with order and sort flags",
|
||||
input: "--search test --order asc --sort name",
|
||||
wantErr: true,
|
||||
errMsg: "cannot specify `--order` or `--sort` with `--search`",
|
||||
},
|
||||
}
|
||||
|
||||
|
|
@ -69,7 +125,10 @@ func TestNewCmdList(t *testing.T) {
|
|||
}
|
||||
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.output.Limit, gotOpts.Limit)
|
||||
assert.Equal(t, tt.output.Query.Limit, gotOpts.Query.Limit)
|
||||
assert.Equal(t, tt.output.Query.Order, gotOpts.Query.Order)
|
||||
assert.Equal(t, tt.output.Query.Query, tt.output.Query.Query)
|
||||
assert.Equal(t, tt.output.Query.Sort, gotOpts.Query.Sort)
|
||||
assert.Equal(t, tt.output.WebMode, gotOpts.WebMode)
|
||||
})
|
||||
}
|
||||
|
|
@ -82,6 +141,7 @@ func TestListRun(t *testing.T) {
|
|||
opts *listOptions
|
||||
httpStubs func(*httpmock.Registry)
|
||||
wantErr bool
|
||||
wantErrMsg string
|
||||
wantStdout string
|
||||
wantStderr string
|
||||
}{
|
||||
|
|
@ -173,7 +233,23 @@ func TestListRun(t *testing.T) {
|
|||
),
|
||||
)
|
||||
},
|
||||
wantErr: true,
|
||||
wantErr: true,
|
||||
wantErrMsg: "no labels found in OWNER/REPO",
|
||||
},
|
||||
{
|
||||
name: "empty label list search",
|
||||
tty: true,
|
||||
opts: &listOptions{Query: listQueryOptions{Query: "test"}},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query LabelList\b`),
|
||||
httpmock.StringResponse(`
|
||||
{"data":{"repository":{"labels":{"totalCount":0,"nodes":[],"pageInfo":{"hasNextPage":false,"endCursor":null}}}}}`,
|
||||
),
|
||||
)
|
||||
},
|
||||
wantErr: true,
|
||||
wantErrMsg: "no labels in OWNER/REPO matched your search",
|
||||
},
|
||||
{
|
||||
name: "web mode",
|
||||
|
|
@ -181,6 +257,62 @@ func TestListRun(t *testing.T) {
|
|||
opts: &listOptions{WebMode: true},
|
||||
wantStderr: "Opening github.com/OWNER/REPO/labels in your browser.\n",
|
||||
},
|
||||
{
|
||||
name: "order by name ascending",
|
||||
tty: true,
|
||||
opts: &listOptions{
|
||||
Query: listQueryOptions{
|
||||
Limit: 30,
|
||||
Order: "asc",
|
||||
Sort: "name",
|
||||
},
|
||||
},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query LabelList\b`),
|
||||
httpmock.GraphQLQuery(`
|
||||
{
|
||||
"data": {
|
||||
"repository": {
|
||||
"labels": {
|
||||
"totalCount": 2,
|
||||
"nodes": [
|
||||
{
|
||||
"name": "bug",
|
||||
"color": "d73a4a",
|
||||
"description": "This is a bug label",
|
||||
"createdAt": "2022-04-20T06:17:50Z"
|
||||
},
|
||||
{
|
||||
"name": "docs",
|
||||
"color": "ffa8da",
|
||||
"description": "This is a docs label",
|
||||
"createdAt": "2022-04-20T06:17:49Z"
|
||||
}
|
||||
],
|
||||
"pageInfo": {
|
||||
"hasNextPage": false,
|
||||
"endCursor": "Y3Vyc29yOnYyOpK5MjAxOS0xMC0xMVQwMTozODowMyswODowMM5f3HZq"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}`, func(s string, m map[string]interface{}) {
|
||||
assert.Equal(t, "OWNER", m["owner"])
|
||||
assert.Equal(t, "REPO", m["repo"])
|
||||
assert.Equal(t, float64(30), m["limit"].(float64))
|
||||
assert.Equal(t, map[string]interface{}{"direction": "ASC", "field": "NAME"}, m["orderBy"])
|
||||
}),
|
||||
)
|
||||
},
|
||||
wantStdout: heredoc.Doc(`
|
||||
|
||||
Showing 2 of 2 labels in OWNER/REPO
|
||||
|
||||
bug This is a bug label #d73a4a
|
||||
docs This is a docs label #ffa8da
|
||||
`),
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
|
|
@ -204,7 +336,11 @@ func TestListRun(t *testing.T) {
|
|||
defer reg.Verify(t)
|
||||
err := listRun(tt.opts)
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
if tt.wantErrMsg != "" {
|
||||
assert.EqualError(t, err, tt.wantErrMsg)
|
||||
} else {
|
||||
assert.Error(t, err)
|
||||
}
|
||||
} else {
|
||||
assert.NoError(t, err)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
package label
|
||||
|
||||
type label struct {
|
||||
Name string
|
||||
Color string
|
||||
Description string
|
||||
Name string `json:"name"`
|
||||
Color string `json:"color"`
|
||||
Description string `json:"description,omitempty"`
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue