feat: add gh org list
This commit is contained in:
Josh Kraft
parent
82927b0cc2
commit
37970f4863
6 changed files with 517 additions and 0 deletions
87
pkg/cmd/org/list/http.go
Normal file
87
pkg/cmd/org/list/http.go
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
package list
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/cli/cli/v2/api"
|
||||
)
|
||||
|
||||
type Organization struct {
|
||||
Login string
|
||||
}
|
||||
|
||||
func listOrgs(httpClient *http.Client, hostname string, limit int) (*[]Organization, error) {
|
||||
type response struct {
|
||||
User struct {
|
||||
Login string
|
||||
Organizations struct {
|
||||
Nodes []Organization
|
||||
PageInfo struct {
|
||||
HasNextPage bool
|
||||
EndCursor string
|
||||
}
|
||||
} `graphql:"organizations(first: $limit, after: $endCursor)"`
|
||||
}
|
||||
}
|
||||
|
||||
query := `query OrganizationList($user: String!, $limit: Int!, $endCursor: String) {
|
||||
user(login: $user) {
|
||||
login
|
||||
organizations(first: $limit, after: $endCursor) {
|
||||
nodes {
|
||||
login
|
||||
}
|
||||
pageInfo {
|
||||
hasNextPage
|
||||
endCursor
|
||||
}
|
||||
}
|
||||
}
|
||||
}`
|
||||
|
||||
client := api.NewClientFromHTTP(httpClient)
|
||||
|
||||
user, err := api.CurrentLoginName(client, hostname)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
orgs := []Organization{}
|
||||
pageLimit := min(limit, 100)
|
||||
variables := map[string]interface{}{
|
||||
"user": user,
|
||||
}
|
||||
|
||||
loop:
|
||||
for {
|
||||
variables["limit"] = pageLimit
|
||||
var data response
|
||||
err := client.GraphQL(hostname, query, variables, &data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
for _, org := range data.User.Organizations.Nodes {
|
||||
orgs = append(orgs, org)
|
||||
if len(orgs) == limit {
|
||||
break loop
|
||||
}
|
||||
}
|
||||
|
||||
if data.User.Organizations.PageInfo.HasNextPage {
|
||||
variables["endCursor"] = data.User.Organizations.PageInfo.EndCursor
|
||||
pageLimit = min(pageLimit, limit-len(orgs))
|
||||
} else {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
return &orgs, nil
|
||||
}
|
||||
|
||||
func min(a, b int) int {
|
||||
if a < b {
|
||||
return a
|
||||
}
|
||||
return b
|
||||
}
|
||||
83
pkg/cmd/org/list/http_test.go
Normal file
83
pkg/cmd/org/list/http_test.go
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
package list
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/cli/cli/v2/pkg/httpmock"
|
||||
)
|
||||
|
||||
func Test_listOrgs(t *testing.T) {
|
||||
type args struct {
|
||||
limit int
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
httpStub func(*testing.T, *httpmock.Registry)
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "default",
|
||||
args: args{
|
||||
limit: 30,
|
||||
},
|
||||
httpStub: func(t *testing.T, reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.GraphQLQuery(`{"data":{}}`, func(query string, vars map[string]interface{}) {
|
||||
want := map[string]interface{}{
|
||||
"user": "octocat",
|
||||
"limit": float64(30),
|
||||
}
|
||||
if !reflect.DeepEqual(vars, want) {
|
||||
t.Errorf("got GraphQL variables %#v, want %#v", vars, want)
|
||||
}
|
||||
}))
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with limit",
|
||||
args: args{
|
||||
limit: 1,
|
||||
},
|
||||
httpStub: func(t *testing.T, r *httpmock.Registry) {
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.GraphQLQuery(`{"data":{}}`, func(query string, vars map[string]interface{}) {
|
||||
want := map[string]interface{}{
|
||||
"user": "octocat",
|
||||
"limit": float64(1),
|
||||
}
|
||||
if !reflect.DeepEqual(vars, want) {
|
||||
t.Errorf("got GraphQL variables %#v, want %#v", vars, want)
|
||||
}
|
||||
}))
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
reg := &httpmock.Registry{}
|
||||
if tt.httpStub != nil {
|
||||
tt.httpStub(t, reg)
|
||||
}
|
||||
httpClient := &http.Client{Transport: reg}
|
||||
|
||||
_, err := listOrgs(httpClient, "octocat", tt.args.limit)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("listOrgs() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
94
pkg/cmd/org/list/list.go
Normal file
94
pkg/cmd/org/list/list.go
Normal file
|
|
@ -0,0 +1,94 @@
|
|||
package list
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
"github.com/cli/cli/v2/internal/config"
|
||||
"github.com/cli/cli/v2/internal/tableprinter"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/iostreams"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
type ListOptions struct {
|
||||
IO *iostreams.IOStreams
|
||||
Config func() (config.Config, error)
|
||||
HttpClient func() (*http.Client, error)
|
||||
|
||||
Limit int
|
||||
}
|
||||
|
||||
func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command {
|
||||
opts := ListOptions{
|
||||
IO: f.IOStreams,
|
||||
Config: f.Config,
|
||||
HttpClient: f.HttpClient,
|
||||
}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "list",
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
Short: "List organizations for the authenticated user.",
|
||||
Example: heredoc.Doc(`
|
||||
# List the first 30 organizations
|
||||
$ gh org list
|
||||
|
||||
# List more organizations
|
||||
$ gh org list --limit 100
|
||||
`),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if opts.Limit < 1 {
|
||||
return cmdutil.FlagErrorf("invalid limit: %v", opts.Limit)
|
||||
}
|
||||
|
||||
if runF != nil {
|
||||
return runF(&opts)
|
||||
}
|
||||
return listRun(&opts)
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 30, "Maximum number of organizations to list")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
func listRun(opts *ListOptions) error {
|
||||
httpClient, err := opts.HttpClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
cfg, err := opts.Config()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
host, _ := cfg.Authentication().DefaultHost()
|
||||
|
||||
listResult, err := listOrgs(httpClient, host, opts.Limit)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := opts.IO.StartPager(); err != nil {
|
||||
fmt.Fprintf(opts.IO.ErrOut, "error starting pager: %v\n", err)
|
||||
}
|
||||
defer opts.IO.StopPager()
|
||||
|
||||
table := tableprinter.New(opts.IO)
|
||||
table.HeaderRow("Name")
|
||||
for _, org := range *listResult {
|
||||
table.AddField(org.Login)
|
||||
table.EndRow()
|
||||
}
|
||||
|
||||
err = table.Render()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
227
pkg/cmd/org/list/list_test.go
Normal file
227
pkg/cmd/org/list/list_test.go
Normal file
|
|
@ -0,0 +1,227 @@
|
|||
package list
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/cli/cli/v2/internal/config"
|
||||
"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 TestNewCmdList(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
cli string
|
||||
wants ListOptions
|
||||
wantsErr string
|
||||
}{
|
||||
{
|
||||
name: "no arguments",
|
||||
cli: "",
|
||||
wants: ListOptions{
|
||||
Limit: 30,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with limit",
|
||||
cli: "-L 101",
|
||||
wants: ListOptions{
|
||||
Limit: 101,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "too many arguments",
|
||||
cli: "123 456",
|
||||
wantsErr: "accepts at most 1 arg(s), received 2",
|
||||
},
|
||||
{
|
||||
name: "invalid limit",
|
||||
cli: "-L 0",
|
||||
wantsErr: "invalid limit: 0",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
f := &cmdutil.Factory{}
|
||||
|
||||
argv, err := shlex.Split(tt.cli)
|
||||
assert.NoError(t, err)
|
||||
|
||||
var gotOpts *ListOptions
|
||||
cmd := NewCmdList(f, func(opts *ListOptions) 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.wantsErr != "" {
|
||||
assert.EqualError(t, err, tt.wantsErr)
|
||||
return
|
||||
}
|
||||
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.wants.Limit, gotOpts.Limit)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestListRun(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
opts ListOptions
|
||||
isTTY bool
|
||||
wantOut []string
|
||||
}{
|
||||
{
|
||||
name: "no organizations found",
|
||||
opts: ListOptions{HttpClient: func() (*http.Client, error) {
|
||||
r := &httpmock.Registry{}
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.StringResponse(`
|
||||
{ "data": { "user": {
|
||||
"organizations": { "nodes": [] }
|
||||
} } }`,
|
||||
),
|
||||
)
|
||||
|
||||
return &http.Client{Transport: r}, nil
|
||||
}},
|
||||
isTTY: true,
|
||||
wantOut: []string{
|
||||
"NAME",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "default behavior",
|
||||
opts: ListOptions{HttpClient: func() (*http.Client, error) {
|
||||
r := &httpmock.Registry{}
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.StringResponse(`
|
||||
{ "data": { "user": { "organizations": { "nodes": [
|
||||
{
|
||||
"login": "github"
|
||||
},
|
||||
{
|
||||
"login": "cli"
|
||||
}
|
||||
] } } } }`,
|
||||
),
|
||||
)
|
||||
|
||||
return &http.Client{Transport: r}, nil
|
||||
}},
|
||||
isTTY: true,
|
||||
wantOut: []string{
|
||||
"NAME",
|
||||
"github",
|
||||
"cli",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with limit",
|
||||
opts: ListOptions{Limit: 1, HttpClient: func() (*http.Client, error) {
|
||||
r := &httpmock.Registry{}
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.StringResponse(`
|
||||
{ "data": { "user": { "organizations": { "nodes": [
|
||||
{
|
||||
"login": "github"
|
||||
},
|
||||
{
|
||||
"login": "cli"
|
||||
}
|
||||
] } } } }`,
|
||||
),
|
||||
)
|
||||
|
||||
return &http.Client{Transport: r}, nil
|
||||
}},
|
||||
isTTY: true,
|
||||
wantOut: []string{
|
||||
"NAME",
|
||||
"github",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "nontty output",
|
||||
opts: ListOptions{HttpClient: func() (*http.Client, error) {
|
||||
r := &httpmock.Registry{}
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query UserCurrent\b`),
|
||||
httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))
|
||||
|
||||
r.Register(
|
||||
httpmock.GraphQL(`query OrganizationList\b`),
|
||||
httpmock.StringResponse(`
|
||||
{ "data": { "user": { "organizations": { "nodes": [
|
||||
{
|
||||
"login": "github"
|
||||
},
|
||||
{
|
||||
"login": "cli"
|
||||
}
|
||||
] } } } }`,
|
||||
),
|
||||
)
|
||||
return &http.Client{Transport: r}, nil
|
||||
}},
|
||||
isTTY: false,
|
||||
wantOut: []string{
|
||||
"github",
|
||||
"cli",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ios, _, stdout, _ := iostreams.Test()
|
||||
|
||||
ios.SetStdoutTTY(tt.isTTY)
|
||||
ios.SetStdinTTY(tt.isTTY)
|
||||
ios.SetStderrTTY(tt.isTTY)
|
||||
|
||||
tt.opts.IO = ios
|
||||
tt.opts.Config = func() (config.Config, error) {
|
||||
return config.NewBlankConfig(), nil
|
||||
}
|
||||
|
||||
err := listRun(&tt.opts)
|
||||
assert.NoError(t, err)
|
||||
|
||||
expected := fmt.Sprintf("%s\n", strings.Join(tt.wantOut, "\n"))
|
||||
assert.Equal(t, expected, stdout.String())
|
||||
})
|
||||
}
|
||||
}
|
||||
24
pkg/cmd/org/org.go
Normal file
24
pkg/cmd/org/org.go
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
package org
|
||||
|
||||
import (
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
orgListCmd "github.com/cli/cli/v2/pkg/cmd/org/list"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func NewCmdOrg(f *cmdutil.Factory) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "org <command>",
|
||||
Short: "Manage organizations",
|
||||
Long: "Work with Github organizations.",
|
||||
Example: heredoc.Doc(`
|
||||
$ gh org list
|
||||
`),
|
||||
GroupID: "core",
|
||||
}
|
||||
|
||||
cmdutil.AddGroup(cmd, "General commands", orgListCmd.NewCmdList(f, nil))
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
@ -22,6 +22,7 @@ import (
|
|||
gpgKeyCmd "github.com/cli/cli/v2/pkg/cmd/gpg-key"
|
||||
issueCmd "github.com/cli/cli/v2/pkg/cmd/issue"
|
||||
labelCmd "github.com/cli/cli/v2/pkg/cmd/label"
|
||||
orgCmd "github.com/cli/cli/v2/pkg/cmd/org"
|
||||
prCmd "github.com/cli/cli/v2/pkg/cmd/pr"
|
||||
releaseCmd "github.com/cli/cli/v2/pkg/cmd/release"
|
||||
repoCmd "github.com/cli/cli/v2/pkg/cmd/repo"
|
||||
|
|
@ -115,6 +116,7 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command {
|
|||
|
||||
cmd.AddCommand(browseCmd.NewCmdBrowse(&repoResolvingCmdFactory, nil))
|
||||
cmd.AddCommand(prCmd.NewCmdPR(&repoResolvingCmdFactory))
|
||||
cmd.AddCommand(orgCmd.NewCmdOrg(&repoResolvingCmdFactory))
|
||||
cmd.AddCommand(issueCmd.NewCmdIssue(&repoResolvingCmdFactory))
|
||||
cmd.AddCommand(releaseCmd.NewCmdRelease(&repoResolvingCmdFactory))
|
||||
cmd.AddCommand(repoCmd.NewCmdRepo(&repoResolvingCmdFactory))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue