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

Add label clone command (#5452)

Browse source
This commit is contained in:
Heath Stewart 2022-04-25 11:13:22 -07:00 • committed by GitHub
parent 13342cb272
commit 19a852ae9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 737 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

5
api/queries_repo.go
View file

@ -215,6 +215,11 @@ func (r Repository) RepoHost() string {
return r.hostname
}
// String returns the OWNER/NAME of the repository
func (r Repository) String() string {
return fmt.Sprintf("%s/%s", r.Owner.Login, r.Name)
}
// ViewerCanPush is true when the requesting user has push access
func (r Repository) ViewerCanPush() bool {
switch r.ViewerPermission {

5
internal/ghrepo/repo.go
View file

@ -11,6 +11,7 @@ import (
// Interface describes an object that represents a GitHub repository
type Interface interface {
fmt.Stringer
RepoName() string
RepoOwner() string
RepoHost() string
@ -144,3 +145,7 @@ func (r ghRepo) RepoName() string {
func (r ghRepo) RepoHost() string {
return r.hostname
}
func (r ghRepo) String() string {
return fmt.Sprintf("%s/%s", r.owner, r.name)
}

5
internal/ghrepo/repo_test.go
View file

@ -217,6 +217,11 @@ func TestFromFullName(t *testing.T) {
if r.RepoName() != tt.wantName {
t.Errorf("expected name %q, got %q", tt.wantName, r.RepoName())
}
wantString := fmt.Sprintf("%s/%s", tt.wantOwner, tt.wantName)
if r.String() != wantString {
t.Errorf("String() expected %q, got %q", wantString, r.String())
}
})
}
}

136
pkg/cmd/label/clone.go Normal file
View file

@ -0,0 +1,136 @@
package label
import (
"errors"
"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"
"github.com/cli/cli/v2/utils"
"github.com/spf13/cobra"
)
type cloneOptions struct {
BaseRepo func() (ghrepo.Interface, error)
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
SourceRepo ghrepo.Interface
Force bool
}
func newCmdClone(f *cmdutil.Factory, runF func(*cloneOptions) error) *cobra.Command {
opts := cloneOptions{
HttpClient: f.HttpClient,
IO: f.IOStreams,
}
cmd := &cobra.Command{
Use: "clone <source-repository>",
Short: "Clones labels from one repository to another",
Long: heredoc.Doc(`
Clones labels from a source repository to a destination repository on GitHub.
By default, the destination repository is the current repository.
All labels from the source repository will be copied to the destination
repository. Labels in the destination repository that are not in the source
repository will not be deleted or modified.
Labels from the source repository that already exist in the destination
repository will be skipped. You can overwrite existing labels in the
destination repository using the --force flag.
`),
Example: heredoc.Doc(`
# clone and overwrite labels from cli/cli repository into the current repository
$ gh label clone cli/cli --force
# clone labels from cli/cli repository into a octocat/cli repository
$ gh label clone cli/cli --repo octocat/cli
`),
Args: cmdutil.ExactArgs(1, "cannot clone labels: source-repository argument required"),
RunE: func(c *cobra.Command, args []string) error {
var err error
opts.BaseRepo = f.BaseRepo
opts.SourceRepo, err = ghrepo.FromFullName(args[0])
if err != nil {
return err
}
if runF != nil {
return runF(&opts)
}
return cloneRun(&opts)
},
}
cmd.Flags().BoolVarP(&opts.Force, "force", "f", false, "Overwrite labels in the destination repository")
return cmd
}
func cloneRun(opts *cloneOptions) error {
httpClient, err := opts.HttpClient()
if err != nil {
return err
}
baseRepo, err := opts.BaseRepo()
if err != nil {
return err
}
opts.IO.StartProgressIndicator()
successCount, totalCount, err := cloneLabels(httpClient, opts.SourceRepo, baseRepo, opts.Force)
opts.IO.StopProgressIndicator()
if err != nil {
return err
}
if opts.IO.IsStdoutTTY() {
cs := opts.IO.ColorScheme()
pluralize := func(num int) string {
return utils.Pluralize(num, "label")
}
switch {
case successCount == totalCount:
fmt.Fprintf(opts.IO.Out, "%s Cloned %s from %s to %s\n", cs.SuccessIcon(), pluralize(successCount), opts.SourceRepo, ghrepo.FullName(baseRepo))
default:
fmt.Fprintf(opts.IO.Out, "%s Cloned %s of %d from %s to %s\n", cs.WarningIcon(), pluralize(successCount), totalCount, opts.SourceRepo, ghrepo.FullName(baseRepo))
}
}
return nil
}
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)
if err != nil {
return
}
createOpts := createOptions{
Force: force,
}
for _, label := range labels {
createOpts.Name = label.Name
createOpts.Description = label.Description
createOpts.Color = label.Color
createErr := createLabel(client, destination, &createOpts)
if createErr != nil {
if !errors.Is(createErr, errLabelAlreadyExists) {
err = createErr
return
}
} else {
successCount++
}
}
return
}

510
pkg/cmd/label/clone_test.go Normal file
View file

@ -0,0 +1,510 @@
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/google/shlex"
"github.com/stretchr/testify/assert"
)
func TestNewCmdClone(t *testing.T) {
tests := []struct {
name string
input string
output cloneOptions
wantErr bool
errMsg string
}{
{
name: "no argument",
input: "",
wantErr: true,
errMsg: "cannot clone labels: source-repository argument required",
},
{
name: "source-repository argument",
input: "OWNER/REPO",
output: cloneOptions{
SourceRepo: ghrepo.New("OWNER", "REPO"),
},
},
{
name: "force flag",
input: "OWNER/REPO --force",
output: cloneOptions{
SourceRepo: ghrepo.New("OWNER", "REPO"),
Force: true,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
io, _, _, _ := iostreams.Test()
f := &cmdutil.Factory{
IOStreams: io,
}
var gotOpts *cloneOptions
cmd := newCmdClone(f, func(opts *cloneOptions) error {
gotOpts = opts
return nil
})
argv, err := shlex.Split(tt.input)
assert.NoError(t, err)
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.errMsg)
return
}
assert.NoError(t, err)
assert.Equal(t, tt.output.SourceRepo, gotOpts.SourceRepo)
assert.Equal(t, tt.output.Force, gotOpts.Force)
})
}
}
func TestCloneRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *cloneOptions
httpStubs func(*httpmock.Registry)
wantStdout string
wantErr bool
wantErrMsg string
}{
{
name: "clones all labels",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli")},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.StringResponse(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "bug",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.StatusStringResponse(201, `
{
"name": "bug",
"color": "d73a4a",
"description": "Someting isn't working"
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.StatusStringResponse(201, `
{
"name": "docs",
"color": "6cafc9"
}`),
)
},
wantStdout: "✓ Cloned 2 labels from cli/cli to OWNER/REPO\n",
},
{
name: "clones some labels",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli")},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.StringResponse(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "bug",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.StatusStringResponse(201, `
{
"name": "bug",
"color": "d73a4a",
"description": "Someting isn't working"
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"already_exists","field":"name"}]}`),
"Content-Type",
"application/json",
),
)
},
wantStdout: "! Cloned 1 label of 2 from cli/cli to OWNER/REPO\n",
},
{
name: "clones no labels",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli")},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.StringResponse(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "bug",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"already_exists","field":"name"}]}`),
"Content-Type",
"application/json",
),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"already_exists","field":"name"}]}`),
"Content-Type",
"application/json",
),
)
},
wantStdout: "! Cloned 0 labels of 2 from cli/cli to OWNER/REPO\n",
},
{
name: "overwrites all labels",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli"), Force: true},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.StringResponse(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "bug",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"already_exists","field":"name"}]}`),
"Content-Type",
"application/json",
),
)
reg.Register(
httpmock.REST("PATCH", "repos/OWNER/REPO/labels/bug"),
httpmock.StatusStringResponse(201, `
{
"color": "d73a4a",
"description": "Someting isn't working"
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"already_exists","field":"name"}]}`),
"Content-Type",
"application/json",
),
)
reg.Register(
httpmock.REST("PATCH", "repos/OWNER/REPO/labels/docs"),
httpmock.StatusStringResponse(201, `
{
"color": "6cafc9"
}`),
)
},
wantStdout: "✓ Cloned 2 labels from cli/cli to OWNER/REPO\n",
},
{
name: "list error",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "invalid"), Force: true},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.WithHeader(
httpmock.StatusStringResponse(200, `
{
"data": {
"repository": null
},
"errors": [
{
"type": "NOT_FOUND",
"path": [
"repository"
],
"locations": [
{
"line": 3,
"column": 1
}
],
"message": "Could not resolve to a Repository with the name 'cli/invalid'."
}
]
}`),
"Content-Type",
"application/json",
),
)
},
wantErr: true,
wantErrMsg: "GraphQL: Could not resolve to a Repository with the name 'cli/invalid'. (repository)",
},
{
name: "create error",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli"), Force: true},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.StringResponse(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "bug",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.WithHeader(
httpmock.StatusStringResponse(422, `{"message":"Validation Failed","errors":[{"resource":"Label","code":"invalid","field":"color"}]}`),
"Content-Type",
"application/json",
),
)
},
wantErr: true,
wantErrMsg: "HTTP 422: Validation Failed (https://api.github.com/repos/OWNER/REPO/labels)\nLabel.color is invalid",
},
{
name: "clones pages of labels",
tty: true,
opts: &cloneOptions{SourceRepo: ghrepo.New("cli", "cli"), Force: true},
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": "Something isn't working"
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "abcd1234"
}
}
}
}
}`, func(s string, m map[string]interface{}) {
assert.Equal(t, "cli", m["owner"])
assert.Equal(t, "cli", m["repo"])
assert.Equal(t, float64(100), m["limit"].(float64))
}),
)
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
httpmock.GraphQLQuery(`
{
"data": {
"repository": {
"labels": {
"totalCount": 2,
"nodes": [
{
"name": "docs",
"color": "6cafc9"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "abcd1234"
}
}
}
}
}`, func(s string, m map[string]interface{}) {
assert.Equal(t, "cli", m["owner"])
assert.Equal(t, "cli", m["repo"])
assert.Equal(t, float64(100), m["limit"].(float64))
}),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.StatusStringResponse(201, `
{
"name": "bug",
"color": "d73a4a",
"description": "Someting isn't working"
}`),
)
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
httpmock.StatusStringResponse(201, `
{
"name": "docs",
"color": "6cafc9"
}`),
)
},
wantStdout: "✓ Cloned 2 labels from cli/cli to OWNER/REPO\n",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reg := &httpmock.Registry{}
defer reg.Verify(t)
if tt.httpStubs != nil {
tt.httpStubs(reg)
}
tt.opts.HttpClient = func() (*http.Client, error) {
return &http.Client{Transport: reg}, nil
}
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
}
err := cloneRun(tt.opts)
if tt.wantErr {
assert.EqualError(t, err, tt.wantErrMsg)
} else {
assert.NoError(t, err)
}
assert.Equal(t, tt.wantStdout, stdout.String())
})
}
}

21
pkg/cmd/label/create/create.go → pkg/cmd/label/create.go
View file

@ -1,4 +1,4 @@
package create
package label
import (
"bytes"
@ -13,7 +13,6 @@ import (
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/label/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/spf13/cobra"
@ -38,7 +37,7 @@ var randomColors = []string{
"D4C5F9",
}
type CreateOptions struct {
type createOptions struct {
BaseRepo func() (ghrepo.Interface, error)
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
@ -49,8 +48,8 @@ type CreateOptions struct {
Force bool
}
func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Command {
opts := CreateOptions{
func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Command {
opts := createOptions{
HttpClient: f.HttpClient,
IO: f.IOStreams,
}
@ -58,7 +57,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
cmd := &cobra.Command{
Use: "create <name>",
Short: "Create a new label",
Long: heredoc.Docf(`
Long: heredoc.Doc(`
Create a new label on GitHub.
Must specify name for the label, the description and color are optional.
@ -90,7 +89,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
var errLabelAlreadyExists = errors.New("label already exists")
func createRun(opts *CreateOptions) error {
func createRun(opts *createOptions) error {
httpClient, err := opts.HttpClient()
if err != nil {
return err
@ -125,7 +124,7 @@ func createRun(opts *CreateOptions) error {
return nil
}
func createLabel(client *http.Client, repo ghrepo.Interface, opts *CreateOptions) error {
func createLabel(client *http.Client, repo ghrepo.Interface, opts *createOptions) error {
apiClient := api.NewClientFromHTTP(client)
path := fmt.Sprintf("repos/%s/%s/labels", repo.RepoOwner(), repo.RepoName())
requestByte, err := json.Marshal(map[string]string{
@ -137,7 +136,7 @@ func createLabel(client *http.Client, repo ghrepo.Interface, opts *CreateOptions
return err
}
requestBody := bytes.NewReader(requestByte)
result := shared.Label{}
result := label{}
err = apiClient.REST(repo.RepoHost(), "POST", path, requestBody, &result)
if httpError, ok := err.(api.HTTPError); ok && isLabelAlreadyExistsError(httpError) {
@ -151,7 +150,7 @@ func createLabel(client *http.Client, repo ghrepo.Interface, opts *CreateOptions
return err
}
func updateLabel(apiClient *api.Client, repo ghrepo.Interface, opts *CreateOptions) error {
func updateLabel(apiClient *api.Client, repo ghrepo.Interface, opts *createOptions) error {
path := fmt.Sprintf("repos/%s/%s/labels/%s", repo.RepoOwner(), repo.RepoName(), opts.Name)
requestByte, err := json.Marshal(map[string]string{
"description": opts.Description,
@ -161,7 +160,7 @@ func updateLabel(apiClient *api.Client, repo ghrepo.Interface, opts *CreateOptio
return err
}
requestBody := bytes.NewReader(requestByte)
result := shared.Label{}
result := label{}
return apiClient.REST(repo.RepoHost(), "PATCH", path, requestBody, &result)
}

24
pkg/cmd/label/create/create_test.go → pkg/cmd/label/create_test.go
View file

@ -1,4 +1,4 @@
package create
package label
import (
"bytes"
@ -19,7 +19,7 @@ func TestNewCmdCreate(t *testing.T) {
tests := []struct {
name string
input string
output CreateOptions
output createOptions
wantErr bool
errMsg string
}{
@ -32,22 +32,22 @@ func TestNewCmdCreate(t *testing.T) {
{
name: "name argument",
input: "test",
output: CreateOptions{Name: "test"},
output: createOptions{Name: "test"},
},
{
name: "description flag",
input: "test --description 'some description'",
output: CreateOptions{Name: "test", Description: "some description"},
output: createOptions{Name: "test", Description: "some description"},
},
{
name: "color flag",
input: "test --color FFFFFF",
output: CreateOptions{Name: "test", Color: "FFFFFF"},
output: createOptions{Name: "test", Color: "FFFFFF"},
},
{
name: "color flag with pound sign",
input: "test --color '#AAAAAA'",
output: CreateOptions{Name: "test", Color: "AAAAAA"},
output: createOptions{Name: "test", Color: "AAAAAA"},
},
}
@ -59,8 +59,8 @@ func TestNewCmdCreate(t *testing.T) {
}
argv, err := shlex.Split(tt.input)
assert.NoError(t, err)
var gotOpts *CreateOptions
cmd := NewCmdCreate(f, func(opts *CreateOptions) error {
var gotOpts *createOptions
cmd := newCmdCreate(f, func(opts *createOptions) error {
gotOpts = opts
return nil
})
@ -87,14 +87,14 @@ func TestCreateRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *CreateOptions
opts *createOptions
httpStubs func(*httpmock.Registry)
wantStdout string
}{
{
name: "creates label",
tty: true,
opts: &CreateOptions{Name: "test", Description: "some description"},
opts: &createOptions{Name: "test", Description: "some description"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
@ -106,7 +106,7 @@ func TestCreateRun(t *testing.T) {
{
name: "creates label notty",
tty: false,
opts: &CreateOptions{Name: "test", Description: "some description"},
opts: &createOptions{Name: "test", Description: "some description"},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),
@ -117,7 +117,7 @@ func TestCreateRun(t *testing.T) {
},
{
name: "creates existing label",
opts: &CreateOptions{Name: "test", Description: "some description", Force: true},
opts: &createOptions{Name: "test", Description: "some description", Force: true},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("POST", "repos/OWNER/REPO/labels"),

53
pkg/cmd/label/list/http.go → pkg/cmd/label/http.go
View file

@ -1,14 +1,30 @@
package list
package label
import (
"net/http"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/label/shared"
)
func listLabels(client *http.Client, repo ghrepo.Interface, limit int) ([]shared.Label, int, error) {
const maxPageSize = 100
type listLabelsResponseData struct {
Repository struct {
Labels struct {
TotalCount int
Nodes []label
PageInfo struct {
HasNextPage bool
EndCursor string
}
}
}
}
// 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) {
apiClient := api.NewClientFromHTTP(client)
query := `
query LabelList($owner: String!,$repo: String!, $limit: Int!, $endCursor: String) {
@ -33,28 +49,13 @@ func listLabels(client *http.Client, repo ghrepo.Interface, limit int) ([]shared
"repo": repo.RepoName(),
}
type responseData struct {
Repository struct {
Labels struct {
TotalCount int
Nodes []shared.Label
PageInfo struct {
HasNextPage bool
EndCursor string
}
}
HasIssuesEnabled bool
}
}
var labels []shared.Label
var labels []label
var totalCount int
pageLimit := min(limit, 100)
loop:
for {
var response responseData
variables["limit"] = pageLimit
var response listLabelsResponseData
variables["limit"] = determinePageSize(limit - len(labels))
err := apiClient.GraphQL(repo.RepoHost(), query, variables, &response)
if err != nil {
return nil, 0, err
@ -71,7 +72,6 @@ loop:
if response.Repository.Labels.PageInfo.HasNextPage {
variables["endCursor"] = response.Repository.Labels.PageInfo.EndCursor
pageLimit = min(pageLimit, limit-len(labels))
} else {
break
}
@ -80,9 +80,10 @@ loop:
return labels, totalCount, nil
}
func min(a, b int) int {
if a < b {
return a
func determinePageSize(numRequestedItems int) int {
// If numRequestedItems is -1 then retrieve maxPageSize
if numRequestedItems < 0 || numRequestedItems > maxPageSize {
return maxPageSize
}
return b
return numRequestedItems
}

2
pkg/cmd/label/list/http_test.go → pkg/cmd/label/http_test.go
View file

@ -1,4 +1,4 @@
package list
package label
import (
"net/http"

7
pkg/cmd/label/label.go
View file

@ -1,8 +1,6 @@
package label
import (
labelCreateCmd "github.com/cli/cli/v2/pkg/cmd/label/create"
labelListCmd "github.com/cli/cli/v2/pkg/cmd/label/list"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/spf13/cobra"
)
@ -15,8 +13,9 @@ func NewCmdLabel(f *cmdutil.Factory) *cobra.Command {
}
cmdutil.EnableRepoOverride(cmd, f)
cmd.AddCommand(labelListCmd.NewCmdList(f, nil))
cmd.AddCommand(labelCreateCmd.NewCmdCreate(f, nil))
cmd.AddCommand(newCmdList(f, nil))
cmd.AddCommand(newCmdCreate(f, nil))
cmd.AddCommand(newCmdClone(f, nil))
return cmd
}

17
pkg/cmd/label/list/list.go → pkg/cmd/label/list.go
View file

@ -1,11 +1,10 @@
package list
package label
import (
"fmt"
"net/http"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/label/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/cli/v2/pkg/text"
@ -13,11 +12,13 @@ import (
"github.com/spf13/cobra"
)
const listLimit = 30
type browser interface {
Browse(string) error
}
type ListOptions struct {
type listOptions struct {
BaseRepo func() (ghrepo.Interface, error)
Browser browser
HttpClient func() (*http.Client, error)
@ -27,8 +28,8 @@ type ListOptions struct {
WebMode bool
}
func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command {
opts := ListOptions{
func newCmdList(f *cmdutil.Factory, runF func(*listOptions) error) *cobra.Command {
opts := listOptions{
Browser: f.Browser,
HttpClient: f.HttpClient,
IO: f.IOStreams,
@ -56,12 +57,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", 30, "Maximum number of items to fetch")
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", listLimit, "Maximum number of items to fetch")
return cmd
}
func listRun(opts *ListOptions) error {
func listRun(opts *listOptions) error {
httpClient, err := opts.HttpClient()
if err != nil {
return err
@ -101,7 +102,7 @@ func listRun(opts *ListOptions) error {
return printLabels(opts.IO, labels)
}
func printLabels(io *iostreams.IOStreams, labels []shared.Label) error {
func printLabels(io *iostreams.IOStreams, labels []label) error {
cs := io.ColorScheme()
table := utils.NewTablePrinter(io)

24
pkg/cmd/label/list/list_test.go → pkg/cmd/label/list_test.go
View file

@ -1,4 +1,4 @@
package list
package label
import (
"bytes"
@ -17,19 +17,19 @@ func TestNewCmdList(t *testing.T) {
tests := []struct {
name string
input string
output ListOptions
output listOptions
wantErr bool
errMsg string
}{
{
name: "no argument",
input: "",
output: ListOptions{Limit: 30},
output: listOptions{Limit: 30},
},
{
name: "limit flag",
input: "--limit 10",
output: ListOptions{Limit: 10},
output: listOptions{Limit: 10},
},
{
name: "invalid limit flag",
@ -40,7 +40,7 @@ func TestNewCmdList(t *testing.T) {
{
name: "web flag",
input: "--web",
output: ListOptions{Limit: 30, WebMode: true},
output: listOptions{Limit: 30, WebMode: true},
},
}
@ -52,8 +52,8 @@ func TestNewCmdList(t *testing.T) {
}
argv, err := shlex.Split(tt.input)
assert.NoError(t, err)
var gotOpts *ListOptions
cmd := NewCmdList(f, func(opts *ListOptions) error {
var gotOpts *listOptions
cmd := newCmdList(f, func(opts *listOptions) error {
gotOpts = opts
return nil
})
@ -79,7 +79,7 @@ func TestListRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *ListOptions
opts *listOptions
httpStubs func(*httpmock.Registry)
wantErr bool
wantStdout string
@ -88,7 +88,7 @@ func TestListRun(t *testing.T) {
{
name: "lists labels",
tty: true,
opts: &ListOptions{},
opts: &listOptions{},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
@ -126,7 +126,7 @@ func TestListRun(t *testing.T) {
{
name: "lists labels notty",
tty: false,
opts: &ListOptions{},
opts: &listOptions{},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
@ -164,7 +164,7 @@ func TestListRun(t *testing.T) {
{
name: "empty label list",
tty: true,
opts: &ListOptions{},
opts: &listOptions{},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`query LabelList\b`),
@ -178,7 +178,7 @@ func TestListRun(t *testing.T) {
{
name: "web mode",
tty: true,
opts: &ListOptions{WebMode: true},
opts: &listOptions{WebMode: true},
wantStderr: "Opening github.com/OWNER/REPO/labels in your browser.\n",
},
}

4
pkg/cmd/label/shared/shared.go → pkg/cmd/label/shared.go
View file

@ -1,6 +1,6 @@
package shared
package label
type Label struct {
type label struct {
Name string
Color string
Description string