342 lines
7.6 KiB
Go
342 lines
7.6 KiB
Go
package list
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/cli/cli/v2/internal/browser"
|
|
"github.com/cli/cli/v2/internal/ghrepo"
|
|
"github.com/cli/cli/v2/pkg/cmd/ruleset/shared"
|
|
"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"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func Test_NewCmdList(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
args string
|
|
isTTY bool
|
|
want ListOptions
|
|
wantErr string
|
|
}{
|
|
{
|
|
name: "no arguments",
|
|
args: "",
|
|
isTTY: true,
|
|
want: ListOptions{
|
|
Limit: 30,
|
|
IncludeParents: true,
|
|
WebMode: false,
|
|
Organization: "",
|
|
},
|
|
},
|
|
{
|
|
name: "limit",
|
|
args: "--limit 1",
|
|
isTTY: true,
|
|
want: ListOptions{
|
|
Limit: 1,
|
|
IncludeParents: true,
|
|
WebMode: false,
|
|
Organization: "",
|
|
},
|
|
},
|
|
{
|
|
name: "include parents",
|
|
args: "--parents=false",
|
|
isTTY: true,
|
|
want: ListOptions{
|
|
Limit: 30,
|
|
IncludeParents: false,
|
|
WebMode: false,
|
|
Organization: "",
|
|
},
|
|
},
|
|
{
|
|
name: "org",
|
|
args: "--org \"my-org\"",
|
|
isTTY: true,
|
|
want: ListOptions{
|
|
Limit: 30,
|
|
IncludeParents: true,
|
|
WebMode: false,
|
|
Organization: "my-org",
|
|
},
|
|
},
|
|
{
|
|
name: "web mode",
|
|
args: "--web",
|
|
isTTY: true,
|
|
want: ListOptions{
|
|
Limit: 30,
|
|
IncludeParents: true,
|
|
WebMode: true,
|
|
Organization: "",
|
|
},
|
|
},
|
|
{
|
|
name: "invalid limit",
|
|
args: "--limit 0",
|
|
isTTY: true,
|
|
wantErr: "invalid limit: 0",
|
|
},
|
|
{
|
|
name: "repo and org specified",
|
|
args: "--org \"my-org\" -R \"owner/repo\"",
|
|
isTTY: true,
|
|
wantErr: "only one of --repo and --org may be specified",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
ios, _, _, _ := iostreams.Test()
|
|
ios.SetStdoutTTY(tt.isTTY)
|
|
ios.SetStdinTTY(tt.isTTY)
|
|
ios.SetStderrTTY(tt.isTTY)
|
|
|
|
f := &cmdutil.Factory{
|
|
IOStreams: ios,
|
|
}
|
|
|
|
var opts *ListOptions
|
|
cmd := NewCmdList(f, func(o *ListOptions) error {
|
|
opts = o
|
|
return nil
|
|
})
|
|
cmd.PersistentFlags().StringP("repo", "R", "", "")
|
|
|
|
argv, err := shlex.Split(tt.args)
|
|
require.NoError(t, err)
|
|
cmd.SetArgs(argv)
|
|
|
|
cmd.SetIn(&bytes.Buffer{})
|
|
cmd.SetOut(io.Discard)
|
|
cmd.SetErr(io.Discard)
|
|
|
|
_, err = cmd.ExecuteC()
|
|
if tt.wantErr != "" {
|
|
require.EqualError(t, err, tt.wantErr)
|
|
return
|
|
} else {
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
assert.Equal(t, tt.want.Limit, opts.Limit)
|
|
assert.Equal(t, tt.want.WebMode, opts.WebMode)
|
|
assert.Equal(t, tt.want.Organization, opts.Organization)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_listRun(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
isTTY bool
|
|
opts ListOptions
|
|
httpStubs func(*httpmock.Registry)
|
|
wantErr string
|
|
wantStdout string
|
|
wantStderr string
|
|
wantBrowse string
|
|
}{
|
|
{
|
|
name: "list repo rulesets",
|
|
isTTY: true,
|
|
wantStdout: heredoc.Doc(`
|
|
|
|
Showing 3 of 3 rulesets in OWNER/REPO
|
|
|
|
ID NAME SOURCE STATUS RULES
|
|
4 test OWNER/REPO (repo) evaluate 1
|
|
42 asdf OWNER/REPO (repo) active 2
|
|
77 foobar Org-Name (org) disabled 4
|
|
`),
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query RepoRulesetList\b`),
|
|
httpmock.FileResponse("./fixtures/rulesetList.json"),
|
|
)
|
|
},
|
|
wantStderr: "",
|
|
wantBrowse: "",
|
|
},
|
|
{
|
|
name: "list org rulesets",
|
|
isTTY: true,
|
|
opts: ListOptions{
|
|
IncludeParents: true,
|
|
Organization: "my-org",
|
|
},
|
|
wantStdout: heredoc.Doc(`
|
|
|
|
Showing 3 of 3 rulesets in my-org and its parents
|
|
|
|
ID NAME SOURCE STATUS RULES
|
|
4 test OWNER/REPO (repo) evaluate 1
|
|
42 asdf OWNER/REPO (repo) active 2
|
|
77 foobar Org-Name (org) disabled 4
|
|
`),
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query OrgRulesetList\b`),
|
|
httpmock.FileResponse("./fixtures/rulesetList.json"),
|
|
)
|
|
},
|
|
wantStderr: "",
|
|
wantBrowse: "",
|
|
},
|
|
{
|
|
name: "list repo rulesets, no rulesets",
|
|
isTTY: true,
|
|
opts: ListOptions{
|
|
IncludeParents: true,
|
|
},
|
|
wantStdout: "",
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query RepoRulesetList\b`),
|
|
httpmock.JSONResponse(shared.RulesetList{
|
|
TotalCount: 0,
|
|
Rulesets: []shared.RulesetGraphQL{},
|
|
}),
|
|
)
|
|
},
|
|
wantErr: "no rulesets found in OWNER/REPO or its parents",
|
|
wantStderr: "",
|
|
wantBrowse: "",
|
|
},
|
|
{
|
|
name: "list org rulesets, no rulesets",
|
|
isTTY: true,
|
|
opts: ListOptions{
|
|
Organization: "my-org",
|
|
},
|
|
wantStdout: "",
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query OrgRulesetList\b`),
|
|
httpmock.JSONResponse(shared.RulesetList{
|
|
TotalCount: 0,
|
|
Rulesets: []shared.RulesetGraphQL{},
|
|
}),
|
|
)
|
|
},
|
|
wantErr: "no rulesets found in my-org",
|
|
wantBrowse: "",
|
|
},
|
|
{
|
|
name: "machine-readable",
|
|
isTTY: false,
|
|
wantStdout: heredoc.Doc(`
|
|
4 test OWNER/REPO (repo) evaluate 1
|
|
42 asdf OWNER/REPO (repo) active 2
|
|
77 foobar Org-Name (org) disabled 4
|
|
`),
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query RepoRulesetList\b`),
|
|
httpmock.FileResponse("./fixtures/rulesetList.json"),
|
|
)
|
|
},
|
|
wantStderr: "",
|
|
wantBrowse: "",
|
|
},
|
|
{
|
|
name: "repo web mode, TTY",
|
|
isTTY: true,
|
|
opts: ListOptions{
|
|
WebMode: true,
|
|
},
|
|
wantStdout: "Opening https://github.com/OWNER/REPO/rules in your browser.\n",
|
|
wantStderr: "",
|
|
wantBrowse: "https://github.com/OWNER/REPO/rules",
|
|
},
|
|
{
|
|
name: "org web mode, TTY",
|
|
isTTY: true,
|
|
opts: ListOptions{
|
|
WebMode: true,
|
|
Organization: "my-org",
|
|
},
|
|
wantStdout: "Opening https://github.com/organizations/my-org/settings/rules in your browser.\n",
|
|
wantStderr: "",
|
|
wantBrowse: "https://github.com/organizations/my-org/settings/rules",
|
|
},
|
|
{
|
|
name: "repo web mode, non-TTY",
|
|
isTTY: false,
|
|
opts: ListOptions{
|
|
WebMode: true,
|
|
},
|
|
wantStdout: "",
|
|
wantStderr: "",
|
|
wantBrowse: "https://github.com/OWNER/REPO/rules",
|
|
},
|
|
{
|
|
name: "org web mode, non-TTY",
|
|
isTTY: false,
|
|
opts: ListOptions{
|
|
WebMode: true,
|
|
Organization: "my-org",
|
|
},
|
|
wantStdout: "",
|
|
wantStderr: "",
|
|
wantBrowse: "https://github.com/organizations/my-org/settings/rules",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
ios, _, stdout, stderr := iostreams.Test()
|
|
ios.SetStdoutTTY(tt.isTTY)
|
|
ios.SetStdinTTY(tt.isTTY)
|
|
ios.SetStderrTTY(tt.isTTY)
|
|
|
|
reg := &httpmock.Registry{}
|
|
defer reg.Verify(t)
|
|
if tt.httpStubs != nil {
|
|
tt.httpStubs(reg)
|
|
}
|
|
|
|
tt.opts.IO = ios
|
|
tt.opts.HttpClient = func() (*http.Client, error) {
|
|
return &http.Client{Transport: reg}, nil
|
|
}
|
|
|
|
// only set this if org is not set, because the repo isn't needed if --org is provided and
|
|
// leaving it undefined will catch potential errors
|
|
if tt.opts.Organization == "" {
|
|
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
|
|
return ghrepo.FromFullName("OWNER/REPO")
|
|
}
|
|
}
|
|
|
|
browser := &browser.Stub{}
|
|
tt.opts.Browser = browser
|
|
|
|
err := listRun(&tt.opts)
|
|
|
|
if tt.wantErr != "" {
|
|
require.EqualError(t, err, tt.wantErr)
|
|
return
|
|
} else {
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
if tt.wantBrowse != "" {
|
|
browser.Verify(t, tt.wantBrowse)
|
|
}
|
|
|
|
assert.Equal(t, tt.wantStdout, stdout.String())
|
|
assert.Equal(t, tt.wantStderr, stderr.String())
|
|
})
|
|
}
|
|
}
|