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

Add JSON output flags to workflow list command (#7902)

Browse source
This commit is contained in:
Raj Hawaldar 2023-08-31 01:49:18 +05:30 • committed by GitHub
parent 7c2e5fd595
commit 330ad32c31
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 106 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -6,10 +6,10 @@ import (
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/internal/tableprinter"
"github.com/cli/cli/v2/pkg/cmd/workflow/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/cli/v2/utils"
"github.com/spf13/cobra"
)
@ -19,13 +19,19 @@ type ListOptions struct {
IO *iostreams.IOStreams
HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
PlainOutput bool
Exporter cmdutil.Exporter
All bool
Limit int
}
var workflowFields = []string{
"id",
"name",
"path",
"state",
}
func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command {
opts := &ListOptions{
IO: f.IOStreams,
@ -42,9 +48,6 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
// support `-R, --repo` override
opts.BaseRepo = f.BaseRepo
terminal := opts.IO.IsStdoutTTY() && opts.IO.IsStdinTTY()
opts.PlainOutput = !terminal
if opts.Limit < 1 {
return cmdutil.FlagErrorf("invalid limit: %v", opts.Limit)
}
@ -58,8 +61,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
}
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", defaultLimit, "Maximum number of workflows to fetch")
cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Also show disabled workflows")
cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Include disabled workflows")
cmdutil.AddJSONFlags(cmd, &opts.Exporter, workflowFields)
return cmd
}
@ -82,7 +85,18 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("could not get workflows: %w", err)
}
if len(workflows) == 0 {
var filteredWorkflows []shared.Workflow
if opts.All {
filteredWorkflows = workflows
} else {
for _, workflow := range workflows {
if !workflow.Disabled() {
filteredWorkflows = append(filteredWorkflows, workflow)
}
}
}
if len(filteredWorkflows) == 0 {
return cmdutil.NewNoResultsError("no workflows found")
}
@ -92,17 +106,18 @@ func listRun(opts *ListOptions) error {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
//nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter
tp := utils.NewTablePrinter(opts.IO)
cs := opts.IO.ColorScheme()
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, filteredWorkflows)
}
for _, workflow := range workflows {
if workflow.Disabled() && !opts.All {
continue
}
tp.AddField(workflow.Name, nil, cs.Bold)
tp.AddField(string(workflow.State), nil, nil)
tp.AddField(fmt.Sprintf("%d", workflow.ID), nil, cs.Cyan)
cs := opts.IO.ColorScheme()
tp := tableprinter.New(opts.IO)
tp.HeaderRow("Name", "State", "ID")
for _, workflow := range filteredWorkflows {
tp.AddField(workflow.Name)
tp.AddField(string(workflow.State))
tp.AddField(fmt.Sprintf("%d", workflow.ID), tableprinter.WithColor(cs.Cyan))
tp.EndRow()
}

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

@ -16,48 +16,37 @@ import (
"github.com/stretchr/testify/assert"
)
func Test_NewCmdList(t *testing.T) {
func TestNewCmdList(t *testing.T) {
tests := []struct {
name string
cli string
tty bool
wants ListOptions
wantsErr bool
}{
{
name: "blank tty",
tty: true,
name: "no arguments",
wants: ListOptions{
Limit: defaultLimit,
},
},
{
name: "blank nontty",
wants: ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
},
{
name: "all",
name: "all flag",
cli: "--all",
wants: ListOptions{
Limit: defaultLimit,
PlainOutput: true,
All: true,
Limit: defaultLimit,
All: true,
},
},
{
name: "limit",
name: "limit flag",
cli: "--limit 100",
wants: ListOptions{
Limit: 100,
PlainOutput: true,
Limit: 100,
},
},
{
name: "bad limit",
cli: "--limit hi",
name: "invalid limit flag",
cli: "--limit 0",
wantsErr: true,
},
}
@ -65,8 +54,6 @@ func Test_NewCmdList(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ios, _, _, _ := iostreams.Test()
ios.SetStdinTTY(tt.tty)
ios.SetStdoutTTY(tt.tty)
f := &cmdutil.Factory{
IOStreams: ios,
@ -80,6 +67,7 @@ func Test_NewCmdList(t *testing.T) {
gotOpts = opts
return nil
})
cmd.SetArgs(argv)
cmd.SetIn(&bytes.Buffer{})
cmd.SetOut(io.Discard)
@ -91,8 +79,9 @@ func Test_NewCmdList(t *testing.T) {
return
}
assert.NoError(t, err)
assert.Equal(t, tt.wants.Limit, gotOpts.Limit)
assert.Equal(t, tt.wants.PlainOutput, gotOpts.PlainOutput)
assert.Equal(t, tt.wants.All, gotOpts.All)
})
}
}
@ -127,23 +116,52 @@ func TestListRun(t *testing.T) {
tty bool
}{
{
name: "blank tty",
tty: true,
name: "lists worrkflows nontty",
opts: &ListOptions{
Limit: defaultLimit,
},
wantOut: "Go active 707\nLinter active 666\n",
},
{
name: "blank nontty",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
wantOut: "Go\tactive\t707\nLinter\tactive\t666\n",
},
{
name: "pagination",
name: "lists workflows tty",
opts: &ListOptions{
Limit: defaultLimit,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\nLinter active 666\n",
},
{
name: "lists workflows with limit tty",
opts: &ListOptions{
Limit: 1,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\n",
},
{
name: "show all workflows tty",
opts: &ListOptions{
Limit: defaultLimit,
All: true,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\nLinter active 666\nRelease disabled_manually 451\n",
},
{
name: "no results nontty",
opts: &ListOptions{
Limit: defaultLimit,
},
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantErr: true,
},
{
name: "paginates workflows nontty",
opts: &ListOptions{
Limit: 101,
},
@ -170,38 +188,6 @@ func TestListRun(t *testing.T) {
},
wantOut: longOutput,
},
{
name: "no results",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantErr: true,
},
{
name: "show all workflows",
opts: &ListOptions{
Limit: defaultLimit,
All: true,
},
tty: true,
wantOut: "Go active 707\nLinter active 666\nRelease disabled_manually 451\n",
},
{
name: "respects limit",
opts: &ListOptions{
Limit: 1,
All: true,
},
tty: true,
wantOut: "Go active 707\n",
},
}
for _, tt := range tests {
@ -224,6 +210,7 @@ func TestListRun(t *testing.T) {
ios, _, stdout, stderr := iostreams.Test()
ios.SetStdoutTTY(tt.tty)
tt.opts.IO = ios
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
return ghrepo.FromFullName("OWNER/REPO")
}

19
pkg/cmd/workflow/shared/shared.go
View file

@ -8,6 +8,7 @@ import (
"io"
"net/url"
"path"
"reflect"
"strconv"
"strings"
@ -49,6 +50,24 @@ func (w *Workflow) Base() string {
return path.Base(w.Path)
}
func (w *Workflow) ExportData(fields []string) map[string]interface{} {
fieldByName := func(v reflect.Value, field string) reflect.Value {
return v.FieldByNameFunc(func(s string) bool {
return strings.EqualFold(field, s)
})
}
v := reflect.ValueOf(w).Elem()
data := map[string]interface{}{}
for _, f := range fields {
switch f {
default:
sf := fieldByName(v, f)
data[f] = sf.Interface()
}
}
return data
}
func GetWorkflows(client *api.Client, repo ghrepo.Interface, limit int) ([]Workflow, error) {
perPage := limit
page := 1