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

Don't error on list commands when no results found (#5479)

Browse source 
Co-authored-by: Mislav Marohnić <mislav@github.com>
This commit is contained in:
Roshan Padaki 2022-04-25 13:55:52 -04:00 • committed by GitHub
parent adc9abd5ee
commit 13342cb272
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
33 changed files with 178 additions and 201 deletions
Download patch file Download diff file Expand all files Collapse all files

7
cmd/gh/main.go
View file

@ -203,6 +203,7 @@ func mainRun() exitCode {
if cmd, err := rootCmd.ExecuteC(); err != nil {
var pagerPipeError *iostreams.ErrClosedPagerPipe
var noResultsError cmdutil.NoResultsError
if err == cmdutil.SilentError {
return exitError
} else if cmdutil.IsUserCancellation(err) {
@ -216,6 +217,12 @@ func mainRun() exitCode {
} else if errors.As(err, &pagerPipeError) {
// ignore the error raised when piping to a closed pager
return exitOK
} else if errors.As(err, &noResultsError) {
if cmdFactory.IOStreams.IsStdoutTTY() {
fmt.Fprintln(stderr, noResultsError.Error())
}
// no results is not a command failure
return exitOK
}
printError(stderr, err, cmd, hasDebug)

5
pkg/cmd/alias/list/list.go
View file

@ -54,10 +54,7 @@ func listRun(opts *ListOptions) error {
}
if aliasCfg.Empty() {
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.ErrOut, "no aliases configured\n")
}
return nil
return cmdutil.NewNoResultsError("no aliases configured")
}
tp := utils.NewTablePrinter(opts.IO)

10
pkg/cmd/alias/list/list_test.go
View file

@ -18,6 +18,7 @@ func TestAliasList(t *testing.T) {
name string
config string
isTTY bool
wantErr bool
wantStdout string
wantStderr string
}{
@ -25,8 +26,9 @@ func TestAliasList(t *testing.T) {
name: "empty",
config: "",
isTTY: true,
wantErr: true,
wantStdout: "",
wantStderr: "no aliases configured\n",
wantStderr: "",
},
{
name: "some",
@ -68,7 +70,11 @@ func TestAliasList(t *testing.T) {
cmd.SetErr(ioutil.Discard)
_, err := cmd.ExecuteC()
require.NoError(t, err)
if tt.wantErr {
require.Error(t, err)
} else {
require.NoError(t, err)
}
assert.Equal(t, tt.wantStdout, stdout.String())
assert.Equal(t, tt.wantStderr, stderr.String())

4
pkg/cmd/codespace/list.go
View file

@ -60,6 +60,10 @@ func (a *App) List(ctx context.Context, limit int, exporter cmdutil.Exporter) er
return exporter.Write(a.io, codespaces)
}
if len(codespaces) == 0 {
return cmdutil.NewNoResultsError("no codespaces found")
}
tp := utils.NewTablePrinter(a.io)
if tp.IsTTY() {
tp.AddField("NAME", nil, nil)

7
pkg/cmd/extension/command.go
View file

@ -47,9 +47,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error {
cmds := m.List()
if len(cmds) == 0 {
cs := io.ColorScheme()
fmt.Fprintf(io.ErrOut, "%s No installed extensions found\n", cs.WarningIcon())
return nil
return cmdutil.NewNoResultsError("no installed extensions found")
}
cs := io.ColorScheme()
t := utils.NewTablePrinter(io)
@ -175,8 +173,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
if name != "" {
fmt.Fprintf(io.ErrOut, "%s Failed upgrading extension %s: %s\n", cs.FailureIcon(), name, err)
} else if errors.Is(err, noExtensionsInstalledError) {
fmt.Fprintf(io.ErrOut, "%s No installed extensions found\n", cs.WarningIcon())
return nil
return cmdutil.NewNoResultsError("no installed extensions found")
} else {
fmt.Fprintf(io.ErrOut, "%s Failed upgrading extensions\n", cs.FailureIcon())
}

5
pkg/cmd/extension/command_test.go
View file

@ -273,8 +273,9 @@ func TestNewCmdExtension(t *testing.T) {
assert.Equal(t, "", calls[0].Name)
}
},
isTTY: true,
wantStderr: "! No installed extensions found\n",
isTTY: true,
wantErr: true,
errMsg: "no installed extensions found",
},
{
name: "upgrade all notty",

4
pkg/cmd/gist/list/list.go
View file

@ -86,6 +86,10 @@ func listRun(opts *ListOptions) error {
return err
}
if len(gists) == 0 {
return cmdutil.NewNoResultsError("no gists found")
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {

9
pkg/cmd/gist/list/list_test.go
View file

@ -106,6 +106,7 @@ func Test_listRun(t *testing.T) {
tests := []struct {
name string
opts *ListOptions
wantErr bool
wantOut string
stubs func(*httpmock.Registry)
nontty bool
@ -120,7 +121,7 @@ func Test_listRun(t *testing.T) {
"gists": { "nodes": [] }
} } }`))
},
wantOut: "",
wantErr: true,
},
{
name: "default behavior",
@ -377,7 +378,11 @@ func Test_listRun(t *testing.T) {
}
t.Run(tt.name, func(t *testing.T) {
err := listRun(tt.opts)
assert.NoError(t, err)
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
assert.Equal(t, tt.wantOut, stdout.String())
reg.Verify(t)

3
pkg/cmd/gpg-key/list/list.go
View file

@ -70,8 +70,7 @@ func listRun(opts *ListOptions) error {
}
if len(gpgKeys) == 0 {
fmt.Fprintln(opts.IO.ErrOut, "No GPG keys present in GitHub account.")
return cmdutil.SilentError
return cmdutil.NewNoResultsError("no GPG keys present in the GitHub account")
}
t := utils.NewTablePrinter(opts.IO)

3
pkg/cmd/gpg-key/list/list_test.go
View file

@ -48,8 +48,9 @@ func TestListRun(t *testing.T) {
},
},
wantStdout: "",
wantStderr: "No GPG keys present in GitHub account.\n",
wantStderr: "",
wantErr: true,
isTTY: true,
},
}

3
pkg/cmd/issue/list/list.go
View file

@ -187,6 +187,9 @@ func listRun(opts *ListOptions) error {
if listResult.SearchCapped {
fmt.Fprintln(opts.IO.ErrOut, "warning: this query uses the Search API which is capped at 1000 results maximum")
}
if len(listResult.Issues) == 0 {
return prShared.ListNoResults(ghrepo.FullName(baseRepo), "issue", !filterOptions.IsDefault())
}
if isTerminal {
title := prShared.ListHeader(ghrepo.FullName(baseRepo), "issue", len(listResult.Issues), listResult.TotalCount, !filterOptions.IsDefault())
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)

18
pkg/cmd/issue/list/list_test.go
View file

@ -125,15 +125,10 @@ func TestIssueList_tty_withFlags(t *testing.T) {
}))
output, err := runCommand(http, true, "-a probablyCher -s open -A foo --mention me")
if err != nil {
t.Errorf("error running command `issue list`: %v", err)
}
assert.EqualError(t, err, "no issues match your search in OWNER/REPO")
assert.Equal(t, "", output.String())
assert.Equal(t, "", output.Stderr())
assert.Equal(t, `
No issues match your search in OWNER/REPO
`, output.String())
}
func TestIssueList_tty_withAppFlag(t *testing.T) {
@ -151,15 +146,10 @@ func TestIssueList_tty_withAppFlag(t *testing.T) {
}))
output, err := runCommand(http, true, "--app dependabot")
if err != nil {
t.Errorf("error running command `issue list`: %v", err)
}
assert.EqualError(t, err, "no issues match your search in OWNER/REPO")
assert.Equal(t, "", output.String())
assert.Equal(t, "", output.Stderr())
assert.Equal(t, `
No issues match your search in OWNER/REPO
`, output.String())
}
func TestIssueList_withInvalidLimitFlag(t *testing.T) {

8
pkg/cmd/label/list/list.go
View file

@ -89,6 +89,10 @@ func listRun(opts *ListOptions) error {
return err
}
if len(labels) == 0 {
return cmdutil.NewNoResultsError(fmt.Sprintf("there are no labels in %s", ghrepo.FullName(baseRepo)))
}
if opts.IO.IsStdoutTTY() {
title := listHeader(ghrepo.FullName(baseRepo), len(labels), totalCount)
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)
@ -113,9 +117,5 @@ func printLabels(io *iostreams.IOStreams, labels []shared.Label) error {
}
func listHeader(repoName string, count int, totalCount int) string {
if totalCount == 0 {
return fmt.Sprintf("There are no %ss in %s", "label", repoName)
}
return fmt.Sprintf("Showing %d of %s in %s", count, utils.Pluralize(totalCount, "label"), repoName)
}

9
pkg/cmd/label/list/list_test.go
View file

@ -81,6 +81,7 @@ func TestListRun(t *testing.T) {
tty bool
opts *ListOptions
httpStubs func(*httpmock.Registry)
wantErr bool
wantStdout string
wantStderr string
}{
@ -172,7 +173,7 @@ func TestListRun(t *testing.T) {
),
)
},
wantStdout: "\nThere are no labels in OWNER/REPO\n\n",
wantErr: true,
},
{
name: "web mode",
@ -202,7 +203,11 @@ func TestListRun(t *testing.T) {
}
defer reg.Verify(t)
err := listRun(tt.opts)
assert.NoError(t, err)
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
assert.Equal(t, tt.wantStdout, stdout.String())
assert.Equal(t, tt.wantStderr, stderr.String())
})

3
pkg/cmd/pr/list/list.go
View file

@ -187,6 +187,9 @@ func listRun(opts *ListOptions) error {
if listResult.SearchCapped {
fmt.Fprintln(opts.IO.ErrOut, "warning: this query uses the Search API which is capped at 1000 results maximum")
}
if len(listResult.PullRequests) == 0 {
return shared.ListNoResults(ghrepo.FullName(baseRepo), "pull request", !filters.IsDefault())
}
if opts.IO.IsStdoutTTY() {
title := shared.ListHeader(ghrepo.FullName(baseRepo), "pull request", len(listResult.PullRequests), listResult.TotalCount, !filters.IsDefault())
fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title)

29
pkg/cmd/pr/list/list_test.go
View file

@ -112,15 +112,10 @@ func TestPRList_filtering(t *testing.T) {
}))
output, err := runCommand(http, true, `-s all`)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
assert.Equal(t, "", output.String())
assert.Equal(t, "", output.Stderr())
assert.Equal(t, `
No pull requests match your search in OWNER/REPO
`, output.String())
}
func TestPRList_filteringRemoveDuplicate(t *testing.T) {
@ -155,9 +150,7 @@ func TestPRList_filteringClosed(t *testing.T) {
}))
_, err := runCommand(http, true, `-s closed`)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
}
func TestPRList_filteringHeadBranch(t *testing.T) {
@ -171,9 +164,7 @@ func TestPRList_filteringHeadBranch(t *testing.T) {
}))
_, err := runCommand(http, true, `-H bug-fix`)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
}
func TestPRList_filteringAssignee(t *testing.T) {
@ -187,9 +178,7 @@ func TestPRList_filteringAssignee(t *testing.T) {
}))
_, err := runCommand(http, true, `-s merged -l "needs tests" -a hubot -B develop`)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
}
func TestPRList_filteringDraft(t *testing.T) {
@ -222,9 +211,7 @@ func TestPRList_filteringDraft(t *testing.T) {
}))
_, err := runCommand(http, true, test.cli)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
})
}
}
@ -269,9 +256,7 @@ func TestPRList_filteringAuthor(t *testing.T) {
}))
_, err := runCommand(http, true, test.cli)
if err != nil {
t.Fatal(err)
}
assert.Error(t, err)
})
}
}

13
pkg/cmd/pr/shared/display.go
View file

@ -5,6 +5,7 @@ import (
"strings"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/cli/v2/utils"
)
@ -53,14 +54,14 @@ func PrintMessage(io *iostreams.IOStreams, s string) {
fmt.Fprintln(io.Out, io.ColorScheme().Gray(s))
}
func ListHeader(repoName string, itemName string, matchCount int, totalMatchCount int, hasFilters bool) string {
if totalMatchCount == 0 {
if hasFilters {
return fmt.Sprintf("No %ss match your search in %s", itemName, repoName)
}
return fmt.Sprintf("There are no open %ss in %s", itemName, repoName)
func ListNoResults(repoName string, itemName string, hasFilters bool) error {
if hasFilters {
return cmdutil.NewNoResultsError(fmt.Sprintf("no %ss match your search in %s", itemName, repoName))
}
return cmdutil.NewNoResultsError(fmt.Sprintf("no open %ss in %s", itemName, repoName))
}
func ListHeader(repoName string, itemName string, matchCount int, totalMatchCount int, hasFilters bool) string {
if hasFilters {
matchVerb := "match"
if totalMatchCount == 1 {

22
pkg/cmd/pr/shared/display_test.go
View file

@ -15,28 +15,6 @@ func Test_listHeader(t *testing.T) {
args args
want string
}{
{
name: "no results",
args: args{
repoName: "REPO",
itemName: "table",
matchCount: 0,
totalMatchCount: 0,
hasFilters: false,
},
want: "There are no open tables in REPO",
},
{
name: "no matches after filters",
args: args{
repoName: "REPO",
itemName: "Luftballon",
matchCount: 0,
totalMatchCount: 0,
hasFilters: true,
},
want: "No Luftballons match your search in REPO",
},
{
name: "one result",
args: args{

4
pkg/cmd/release/list/list.go
View file

@ -64,6 +64,10 @@ func listRun(opts *ListOptions) error {
return err
}
if len(releases) == 0 {
return cmdutil.NewNoResultsError("no releases found")
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {

3
pkg/cmd/repo/deploy-key/list/list.go
View file

@ -60,8 +60,7 @@ func listRun(opts *ListOptions) error {
}
if len(deployKeys) == 0 {
fmt.Fprintf(opts.IO.ErrOut, "No deploy keys found in %s\n", ghrepo.FullName(repo))
return cmdutil.SilentError
return cmdutil.NewNoResultsError(fmt.Sprintf("no deploy keys found in %s", ghrepo.FullName(repo)))
}
t := utils.NewTablePrinter(opts.IO)

4
pkg/cmd/repo/deploy-key/list/list_test.go
View file

@ -86,14 +86,14 @@ func TestListRun(t *testing.T) {
},
{
name: "no keys",
isTTY: false,
isTTY: true,
httpStubs: func(t *testing.T, reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/keys"),
httpmock.StringResponse(`[]`))
},
wantStdout: "",
wantStderr: "No deploy keys found in OWNER/REPO\n",
wantStderr: "",
wantErr: true,
},
}

11
pkg/cmd/run/list/list.go
View file

@ -118,17 +118,14 @@ func listRun(opts *ListOptions) error {
return opts.Exporter.Write(opts.IO, runs)
}
if len(runs) == 0 {
return cmdutil.NewNoResultsError("no runs found")
}
tp := utils.NewTablePrinter(opts.IO)
cs := opts.IO.ColorScheme()
if len(runs) == 0 {
if !opts.PlainOutput {
fmt.Fprintln(opts.IO.ErrOut, "No runs found")
}
return nil
}
out := opts.IO.Out
if !opts.PlainOutput {

34
pkg/cmd/run/list/list_test.go
View file

@ -111,6 +111,7 @@ func TestListRun(t *testing.T) {
tests := []struct {
name string
opts *ListOptions
wantErr bool
wantOut string
wantErrOut string
stubs func(*httpmock.Registry)
@ -172,7 +173,7 @@ func TestListRun(t *testing.T) {
wantOut: longRunOutput,
},
{
name: "no results nontty",
name: "no results",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
@ -183,22 +184,7 @@ func TestListRun(t *testing.T) {
httpmock.JSONResponse(shared.RunsPayload{}),
)
},
nontty: true,
wantOut: "",
},
{
name: "no results tty",
opts: &ListOptions{
Limit: defaultLimit,
},
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
httpmock.JSONResponse(shared.RunsPayload{}),
)
},
wantOut: "",
wantErrOut: "No runs found\n",
wantErr: true,
},
{
name: "workflow selector",
@ -232,8 +218,7 @@ func TestListRun(t *testing.T) {
httpmock.JSONResponse(shared.RunsPayload{}),
)
},
wantOut: "",
wantErrOut: "No runs found\n",
wantErr: true,
},
{
name: "actor filter applied",
@ -249,14 +234,14 @@ func TestListRun(t *testing.T) {
httpmock.JSONResponse(shared.RunsPayload{}),
)
},
wantOut: "",
wantErrOut: "No runs found\n",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reg := &httpmock.Registry{}
defer reg.Verify(t)
tt.stubs(reg)
tt.opts.HttpClient = func() (*http.Client, error) {
@ -271,11 +256,14 @@ func TestListRun(t *testing.T) {
}
err := listRun(tt.opts)
assert.NoError(t, err)
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
assert.Equal(t, tt.wantOut, stdout.String())
assert.Equal(t, tt.wantErrOut, stderr.String())
reg.Verify(t)
})
}
}

9
pkg/cmd/search/repos/repos.go
View file

@ -141,6 +141,9 @@ func reposRun(opts *ReposOptions) error {
if opts.Exporter != nil {
return opts.Exporter.Write(io, result.Items)
}
if len(result.Items) == 0 {
return cmdutil.NewNoResultsError("no repositories matched your search")
}
return displayResults(io, result)
}
@ -171,11 +174,9 @@ func displayResults(io *iostreams.IOStreams, results search.RepositoriesResult)
}
tp.EndRow()
}
if io.IsStdoutTTY() {
header := "No repositories matched your search\n"
if len(results.Items) > 0 {
header = fmt.Sprintf("Showing %d of %d repositories\n\n", len(results.Items), results.Total)
}
header := fmt.Sprintf("Showing %d of %d repositories\n\n", len(results.Items), results.Total)
fmt.Fprintf(io.Out, "\n%s", header)
}
return tp.Render()

17
pkg/cmd/search/repos/repos_test.go
View file

@ -188,19 +188,6 @@ func TestReposRun(t *testing.T) {
tty: true,
wantStdout: "\nShowing 3 of 300 repositories\n\ntest/cli of course private, archived Feb 28, 2021\ntest/cliing wow public, fork Feb 28, 2021\ncli/cli so much internal Feb 28, 2021\n",
},
{
name: "displays no results tty",
opts: &ReposOptions{
Query: query,
Searcher: &search.SearcherMock{
RepositoriesFunc: func(query search.Query) (search.RepositoriesResult, error) {
return search.RepositoriesResult{}, nil
},
},
},
tty: true,
wantStdout: "\nNo repositories matched your search\n",
},
{
name: "displays results notty",
opts: &ReposOptions{
@ -222,7 +209,7 @@ func TestReposRun(t *testing.T) {
wantStdout: "test/cli\tof course\tprivate, archived\t2021-02-28T12:30:00Z\ntest/cliing\twow\tpublic, fork\t2021-02-28T12:30:00Z\ncli/cli\tso much\tinternal\t2021-02-28T12:30:00Z\n",
},
{
name: "displays no results notty",
name: "displays no results",
opts: &ReposOptions{
Query: query,
Searcher: &search.SearcherMock{
@ -231,6 +218,8 @@ func TestReposRun(t *testing.T) {
},
},
},
wantErr: true,
errMsg: "no repositories matched your search",
},
{
name: "displays search error",

42
pkg/cmd/search/shared/shared.go
View file

@ -66,14 +66,30 @@ func SearchIssues(opts *IssuesOptions) error {
if err != nil {
return err
}
if err := io.StartPager(); err == nil {
defer io.StopPager()
} else {
fmt.Fprintf(io.ErrOut, "failed to start pager: %v\n", err)
}
if opts.Exporter != nil {
return opts.Exporter.Write(io, result.Items)
}
if len(result.Items) == 0 {
var msg string
switch opts.Entity {
case Both:
msg = "no issues or pull requests matched your search"
case Issues:
msg = "no issues matched your search"
case PullRequests:
msg = "no pull requests matched your search"
}
return cmdutil.NewNoResultsError(msg)
}
return displayIssueResults(io, opts.Entity, result)
}
@ -114,26 +130,16 @@ func displayIssueResults(io *iostreams.IOStreams, et EntityType, results search.
}
tp.EndRow()
}
if io.IsStdoutTTY() {
var header string
if len(results.Items) == 0 {
switch et {
case Both:
header = "No issues or pull requests matched your search\n"
case Issues:
header = "No issues matched your search\n"
case PullRequests:
header = "No pull requests matched your search\n"
}
} else {
switch et {
case Both:
header = fmt.Sprintf("Showing %d of %d issues and pull requests\n\n", len(results.Items), results.Total)
case Issues:
header = fmt.Sprintf("Showing %d of %d issues\n\n", len(results.Items), results.Total)
case PullRequests:
header = fmt.Sprintf("Showing %d of %d pull requests\n\n", len(results.Items), results.Total)
}
switch et {
case Both:
header = fmt.Sprintf("Showing %d of %d issues and pull requests\n\n", len(results.Items), results.Total)
case Issues:
header = fmt.Sprintf("Showing %d of %d issues\n\n", len(results.Items), results.Total)
case PullRequests:
header = fmt.Sprintf("Showing %d of %d pull requests\n\n", len(results.Items), results.Total)
}
fmt.Fprintf(io.Out, "\n%s", header)
}

18
pkg/cmd/search/shared/shared_test.go
View file

@ -87,20 +87,6 @@ func TestSearchIssues(t *testing.T) {
tty: true,
wantStdout: "\nShowing 2 of 300 issues and pull requests\n\nissue test/cli #123 bug bug, p1 about 1 year ago\npr what/what #456 fix bug fix about 1 year ago\n",
},
{
name: "displays no results tty",
opts: &IssuesOptions{
Entity: Issues,
Query: query,
Searcher: &search.SearcherMock{
IssuesFunc: func(query search.Query) (search.IssuesResult, error) {
return search.IssuesResult{}, nil
},
},
},
tty: true,
wantStdout: "\nNo issues matched your search\n",
},
{
name: "displays results notty",
opts: &IssuesOptions{
@ -143,7 +129,7 @@ func TestSearchIssues(t *testing.T) {
wantStdout: "issue\ttest/cli\t123\topen\tbug\tbug, p1\t2021-02-28 12:30:00 +0000 UTC\npr\twhat/what\t456\topen\tfix bug\tfix\t2021-02-28 12:30:00 +0000 UTC\n",
},
{
name: "displays no results notty",
name: "displays no results",
opts: &IssuesOptions{
Entity: Issues,
Query: query,
@ -153,6 +139,8 @@ func TestSearchIssues(t *testing.T) {
},
},
},
wantErr: true,
errMsg: "no issues matched your search",
},
{
name: "displays search error",

4
pkg/cmd/secret/list/list.go
View file

@ -139,6 +139,10 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("failed to get secrets: %w", err)
}
if len(secrets) == 0 {
return cmdutil.NewNoResultsError("no secrets found")
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {

4
pkg/cmd/ssh-key/list/list.go
View file

@ -1,7 +1,6 @@
package list
import (
"fmt"
"net/http"
"time"
@ -63,8 +62,7 @@ func listRun(opts *ListOptions) error {
}
if len(sshKeys) == 0 {
fmt.Fprintln(opts.IO.ErrOut, "No SSH keys present in GitHub account.")
return cmdutil.SilentError
return cmdutil.NewNoResultsError("no SSH keys present in the GitHub account")
}
t := utils.NewTablePrinter(opts.IO)

22
pkg/cmd/ssh-key/list/list_test.go
View file

@ -88,7 +88,7 @@ func TestListRun(t *testing.T) {
wantStderr: "",
},
{
name: "no keys",
name: "no keys tty",
opts: ListOptions{
HTTPClient: func() (*http.Client, error) {
reg := &httpmock.Registry{}
@ -100,8 +100,26 @@ func TestListRun(t *testing.T) {
},
},
wantStdout: "",
wantStderr: "No SSH keys present in GitHub account.\n",
wantStderr: "",
wantErr: true,
isTTY: true,
},
{
name: "no keys non-tty",
opts: ListOptions{
HTTPClient: func() (*http.Client, error) {
reg := &httpmock.Registry{}
reg.Register(
httpmock.REST("GET", "user/keys"),
httpmock.StringResponse(`[]`),
)
return &http.Client{Transport: reg}, nil
},
},
wantStdout: "",
wantStderr: "",
wantErr: true,
isTTY: false,
},
}

5
pkg/cmd/workflow/list/list.go
View file

@ -83,10 +83,7 @@ func listRun(opts *ListOptions) error {
}
if len(workflows) == 0 {
if !opts.PlainOutput {
fmt.Fprintln(opts.IO.ErrOut, "No workflows found")
}
return nil
return cmdutil.NewNoResultsError("no workflows found")
}
if err := opts.IO.StartPager(); err == nil {

28
pkg/cmd/workflow/list/list_test.go
View file

@ -120,6 +120,7 @@ func TestListRun(t *testing.T) {
tests := []struct {
name string
opts *ListOptions
wantErr bool
wantOut string
wantErrOut string
stubs func(*httpmock.Registry)
@ -170,7 +171,7 @@ func TestListRun(t *testing.T) {
wantOut: longOutput,
},
{
name: "no results nontty",
name: "no results",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
@ -181,22 +182,7 @@ func TestListRun(t *testing.T) {
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantOut: "",
},
{
name: "no results tty",
opts: &ListOptions{
Limit: defaultLimit,
},
tty: true,
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantOut: "",
wantErrOut: "No workflows found\n",
wantErr: true,
},
{
name: "show all workflows",
@ -221,6 +207,7 @@ func TestListRun(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reg := &httpmock.Registry{}
defer reg.Verify(t)
if tt.stubs == nil {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
@ -242,11 +229,14 @@ func TestListRun(t *testing.T) {
}
err := listRun(tt.opts)
assert.NoError(t, err)
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
assert.Equal(t, tt.wantOut, stdout.String())
assert.Equal(t, tt.wantErrOut, stderr.String())
reg.Verify(t)
})
}
}

12
pkg/cmdutil/errors.go
View file

@ -53,3 +53,15 @@ func MutuallyExclusive(message string, conditions ...bool) error {
}
return nil
}
type NoResultsError struct {
message string
}
func (e NoResultsError) Error() string {
return e.message
}
func NewNoResultsError(message string) NoResultsError {
return NoResultsError{message: message}
}