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

Add json export flags to variable list command (#8516)

Browse source
This commit is contained in:
w1mvy 2024-01-18 03:09:09 +09:00 • committed by GitHub
parent 8cfe7572de
commit 9dd5805f9c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 218 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

17
pkg/cmd/cache/shared/shared.go vendored
View file

@ -2,12 +2,11 @@ package shared
import (
"fmt"
"reflect"
"strings"
"time"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmdutil"
)
var CacheFields = []string{
@ -85,17 +84,5 @@ pagination:
}
func (c *Cache) ExportData(fields []string) map[string]interface{} {
v := reflect.ValueOf(c).Elem()
fieldByName := func(v reflect.Value, field string) reflect.Value {
return v.FieldByNameFunc(func(s string) bool {
return strings.EqualFold(field, s)
})
}
data := map[string]interface{}{}
for _, f := range fields {
data[f] = fieldByName(v, f).Interface()
}
return data
return cmdutil.StructExportData(c, fields)
}

26
pkg/cmd/label/shared.go
View file

@ -1,9 +1,9 @@
package label
import (
"reflect"
"strings"
"time"
"github.com/cli/cli/v2/pkg/cmdutil"
)
var labelFields = []string{
@ -21,31 +21,13 @@ type label struct {
Color string `json:"color"`
CreatedAt time.Time `json:"createdAt"`
Description string `json:"description"`
ID string `json:"node_id"`
ID string `json:"id"`
IsDefault bool `json:"isDefault"`
Name string `json:"name"`
URL string `json:"url"`
UpdatedAt time.Time `json:"updatedAt"`
}
// ExportData implements cmdutil.exportable
func (l *label) ExportData(fields []string) map[string]interface{} {
v := reflect.ValueOf(l).Elem()
data := map[string]interface{}{}
for _, f := range fields {
switch f {
default:
sf := fieldByName(v, f)
data[f] = sf.Interface()
}
}
return data
}
func fieldByName(v reflect.Value, field string) reflect.Value {
return v.FieldByNameFunc(func(s string) bool {
return strings.EqualFold(field, s)
})
return cmdutil.StructExportData(l, fields)
}

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

@ -144,7 +144,7 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("failed to get secrets: %w", err)
}
if len(secrets) == 0 {
if len(secrets) == 0 && opts.Exporter == nil {
return cmdutil.NewNoResultsError("no secrets found")
}
@ -195,6 +195,10 @@ type Secret struct {
NumSelectedRepos int `json:"num_selected_repos"`
}
func (s *Secret) ExportData(fields []string) map[string]interface{} {
return cmdutil.StructExportData(s, fields)
}
func fmtVisibility(s Secret) string {
switch s.Visibility {
case shared.All:

19
pkg/cmd/secret/list/list_test.go
View file

@ -17,6 +17,7 @@ import (
"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) {
@ -408,3 +409,21 @@ func Test_getSecrets_pagination(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, 4, len(secrets))
}
func TestExportSecrets(t *testing.T) {
ios, _, stdout, _ := iostreams.Test()
tf, _ := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z")
ss := []Secret{{
Name: "s1",
UpdatedAt: tf,
Visibility: shared.All,
SelectedReposURL: "https://someurl.com",
NumSelectedRepos: 1,
}}
exporter := cmdutil.NewJSONExporter()
exporter.SetFields(secretFields)
require.NoError(t, exporter.Write(ios, ss))
require.JSONEq(t,
`[{"name":"s1","numSelectedRepos":1,"selectedReposURL":"https://someurl.com","updatedAt":"2024-01-01T00:00:00Z","visibility":"all"}]`,
stdout.String())
}

34
pkg/cmd/variable/list/list.go
View file

@ -24,10 +24,21 @@ type ListOptions struct {
BaseRepo func() (ghrepo.Interface, error)
Now func() time.Time
Exporter cmdutil.Exporter
OrgName string
EnvName string
}
var variableFields = []string{
"name",
"value",
"visibility",
"updatedAt",
"numSelectedRepos",
"selectedReposURL",
}
func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command {
opts := &ListOptions{
IO: f.IOStreams,
@ -65,6 +76,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
cmd.Flags().StringVarP(&opts.OrgName, "org", "o", "", "List variables for an organization")
cmd.Flags().StringVarP(&opts.EnvName, "env", "e", "", "List variables for an environment")
cmdutil.AddJSONFlags(cmd, &opts.Exporter, variableFields)
return cmd
}
@ -114,7 +126,7 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("failed to get variables: %w", err)
}
if len(variables) == 0 {
if len(variables) == 0 && opts.Exporter == nil {
return cmdutil.NewNoResultsError("no variables found")
}
@ -124,6 +136,10 @@ func listRun(opts *ListOptions) error {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, variables)
}
var headers []string
if variableEntity == shared.Organization {
headers = []string{"Name", "Value", "Updated", "Visibility"}
@ -155,12 +171,16 @@ func listRun(opts *ListOptions) error {
}
type Variable struct {
Name string
Value string
UpdatedAt time.Time `json:"updated_at"`
Visibility shared.Visibility
SelectedReposURL string `json:"selected_repositories_url"`
NumSelectedRepos int
Name string `json:"name"`
Value string `json:"value"`
UpdatedAt time.Time `json:"updated_at"`
Visibility shared.Visibility `json:"visibility"`
SelectedReposURL string `json:"selected_repositories_url"`
NumSelectedRepos int `json:"num_selected_repos"`
}
func (v *Variable) ExportData(fields []string) map[string]interface{} {
return cmdutil.StructExportData(v, fields)
}
func fmtVisibility(s Variable) string {

20
pkg/cmd/variable/list/list_test.go
View file

@ -17,6 +17,7 @@ import (
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/google/shlex"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestNewCmdList(t *testing.T) {
@ -273,3 +274,22 @@ func Test_getVariables_pagination(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, 4, len(variables))
}
func TestExportVariables(t *testing.T) {
ios, _, stdout, _ := iostreams.Test()
tf, _ := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z")
vs := []Variable{{
Name: "v1",
Value: "test1",
UpdatedAt: tf,
Visibility: shared.All,
SelectedReposURL: "https://someurl.com",
NumSelectedRepos: 1,
}}
exporter := cmdutil.NewJSONExporter()
exporter.SetFields(variableFields)
require.NoError(t, exporter.Write(ios, vs))
require.JSONEq(t,
`[{"name":"v1","numSelectedRepos":1,"selectedReposURL":"https://someurl.com","updatedAt":"2024-01-01T00:00:00Z","value":"test1","visibility":"all"}]`,
stdout.String())
}

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

@ -8,12 +8,12 @@ import (
"io"
"net/url"
"path"
"reflect"
"strconv"
"strings"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/go-gh/v2/pkg/asciisanitizer"
"golang.org/x/text/transform"
@ -51,21 +51,7 @@ func (w *Workflow) Base() string {
}
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
return cmdutil.StructExportData(w, fields)
}
func GetWorkflows(client *api.Client, repo ghrepo.Interface, limit int) ([]Workflow, error) {

38
pkg/cmdutil/json_flags.go
View file

@ -174,7 +174,7 @@ type jsonExporter struct {
}
// NewJSONExporter returns an Exporter to emit JSON.
func NewJSONExporter() Exporter {
func NewJSONExporter() *jsonExporter {
return &jsonExporter{}
}
@ -182,6 +182,10 @@ func (e *jsonExporter) Fields() []string {
return e.fields
}
func (e *jsonExporter) SetFields(fields []string) {
e.fields = fields
}
// Write serializes data into JSON output written to w. If the object passed as data implements exportable,
// or if data is a map or slice of exportable object, ExportData() will be called on each object to obtain
// raw data for serialization.
@ -259,3 +263,35 @@ type exportable interface {
var exportableType = reflect.TypeOf((*exportable)(nil)).Elem()
var sliceOfEmptyInterface []interface{}
var emptyInterfaceType = reflect.TypeOf(sliceOfEmptyInterface).Elem()
// Basic function that can be used with structs that need to implement
// the exportable interface. It has numerous limitations so verify
// that it works as expected with the struct and fields you want to export.
// If it does not, then implementing a custom ExportData method is necessary.
// Perhaps this should be moved up into exportData for the case when
// a struct does not implement the exportable interface, but for now it will
// need to be explicitly used.
func StructExportData(s interface{}, fields []string) map[string]interface{} {
v := reflect.ValueOf(s)
if v.Kind() == reflect.Ptr {
v = v.Elem()
}
if v.Kind() != reflect.Struct {
// If s is not a struct or pointer to a struct return nil.
return nil
}
data := make(map[string]interface{}, len(fields))
for _, f := range fields {
sf := fieldByName(v, f)
if sf.IsValid() && sf.CanInterface() {
data[f] = sf.Interface()
}
}
return data
}
func fieldByName(v reflect.Value, field string) reflect.Value {
return v.FieldByNameFunc(func(s string) bool {
return strings.EqualFold(field, s)
})
}

99
pkg/cmdutil/json_flags_test.go
View file

@ -1,9 +1,12 @@
package cmdutil
import (
"bytes"
"encoding/json"
"fmt"
"io"
"testing"
"time"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/spf13/cobra"
@ -310,3 +313,99 @@ func (e *exportableItem) ExportData(fields []string) map[string]interface{} {
}
return m
}
func TestStructExportData(t *testing.T) {
tf, _ := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z")
type s struct {
StringField string
IntField int
BoolField bool
TimeField time.Time
SliceField []int
MapField map[string]int
StructField struct {
A string
B int
c bool
}
unexportedField int
}
export := s{
StringField: "test",
IntField: 1,
BoolField: true,
TimeField: tf,
SliceField: []int{1, 2, 3},
MapField: map[string]int{
"one": 1,
"two": 2,
"three": 3,
},
StructField: struct {
A string
B int
c bool
}{
A: "a",
B: 1,
c: true,
},
unexportedField: 4,
}
fields := []string{"stringField", "intField", "boolField", "sliceField", "mapField", "structField"}
tests := []struct {
name string
export interface{}
fields []string
wantOut string
}{
{
name: "serializes struct types",
export: export,
fields: fields,
wantOut: `{"boolField":true,"intField":1,"mapField":{"one":1,"three":3,"two":2},"sliceField":[1,2,3],"stringField":"test","structField":{"A":"a","B":1}}`,
},
{
name: "serializes pointer to struct types",
export: &export,
fields: fields,
wantOut: `{"boolField":true,"intField":1,"mapField":{"one":1,"three":3,"two":2},"sliceField":[1,2,3],"stringField":"test","structField":{"A":"a","B":1}}`,
},
{
name: "does not serialize non-struct types",
export: map[string]string{
"test": "test",
},
fields: nil,
wantOut: `null`,
},
{
name: "ignores unknown fields",
export: export,
fields: []string{"stringField", "unknownField"},
wantOut: `{"stringField":"test"}`,
},
{
name: "ignores unexported fields",
export: export,
fields: []string{"stringField", "unexportedField"},
wantOut: `{"stringField":"test"}`,
},
{
name: "field matching is case insensitive but casing impacts JSON output",
export: export,
fields: []string{"STRINGfield"},
wantOut: `{"STRINGfield":"test"}`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
buf := bytes.Buffer{}
encoder := json.NewEncoder(&buf)
encoder.SetEscapeHTML(false)
out := StructExportData(tt.export, tt.fields)
require.NoError(t, encoder.Encode(out))
require.JSONEq(t, tt.wantOut, buf.String())
})
}
}

13
pkg/search/result.go
View file

@ -5,6 +5,8 @@ import (
"reflect"
"strings"
"time"
"github.com/cli/cli/v2/pkg/cmdutil"
)
var CodeFields = []string{
@ -293,16 +295,7 @@ func (code Code) ExportData(fields []string) map[string]interface{} {
}
func (textMatch TextMatch) ExportData(fields []string) map[string]interface{} {
v := reflect.ValueOf(textMatch)
data := map[string]interface{}{}
for _, f := range fields {
switch f {
default:
sf := fieldByName(v, f)
data[f] = sf.Interface()
}
}
return data
return cmdutil.StructExportData(textMatch, fields)
}
func (commit Commit) ExportData(fields []string) map[string]interface{} {