Merge pull request #7954 from siketyan/feat/cache-list-json

feat(cache): Add JSON exporting support for cache list

pkg/cmd/cache/list/list.go

@@ -21,6 +21,7 @@ type ListOptions struct {
 	BaseRepo   func() (ghrepo.Interface, error)
 	HttpClient func() (*http.Client, error)
 	IO         *iostreams.IOStreams
+	Exporter   cmdutil.Exporter
 	Now        time.Time
 
 	Limit int
@@ -68,6 +69,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
 	cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 30, "Maximum number of caches to fetch")
 	cmdutil.StringEnumFlag(cmd, &opts.Order, "order", "O", "desc", []string{"asc", "desc"}, "Order of caches returned")
 	cmdutil.StringEnumFlag(cmd, &opts.Sort, "sort", "S", "last_accessed_at", []string{"created_at", "last_accessed_at", "size_in_bytes"}, "Sort fetched caches")
+	cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.CacheFields)
 
 	return cmd
 }
@@ -101,6 +103,10 @@ func listRun(opts *ListOptions) error {
 		fmt.Fprintf(opts.IO.Out, "Failed to start pager: %v\n", err)
 	}
 
+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IO, result.ActionsCaches)
+	}
+
 	if opts.IO.IsStdoutTTY() {
 		fmt.Fprintf(opts.IO.Out, "\nShowing %d of %s in %s\n\n", len(result.ActionsCaches), text.Pluralize(result.TotalCount, "cache"), ghrepo.FullName(repo))
 	}

pkg/cmd/cache/shared/shared.go

@@ -2,12 +2,24 @@ package shared
 
 import (
 	"fmt"
+	"reflect"
+	"strings"
 	"time"
 
 	"github.com/cli/cli/v2/api"
 	"github.com/cli/cli/v2/internal/ghrepo"
 )
 
+var CacheFields = []string{
+	"createdAt",
+	"id",
+	"key",
+	"lastAccessedAt",
+	"ref",
+	"sizeInBytes",
+	"version",
+}
+
 type Cache struct {
 	CreatedAt      time.Time `json:"created_at"`
 	Id             int       `json:"id"`
@@ -71,3 +83,19 @@ pagination:
 
 	return result, nil
 }
+
+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
+}

pkg/cmd/cache/shared/shared_test.go

@@ -1,13 +1,19 @@
 package shared
 
 import (
+	"bytes"
+	"encoding/json"
 	"net/http"
+	"strings"
 	"testing"
 
+	"github.com/MakeNowJust/heredoc"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	"github.com/cli/cli/v2/api"
 	"github.com/cli/cli/v2/internal/ghrepo"
 	"github.com/cli/cli/v2/pkg/httpmock"
-	"github.com/stretchr/testify/assert"
 )
 
 func TestGetCaches(t *testing.T) {
@@ -66,3 +72,74 @@ func TestGetCaches(t *testing.T) {
 		})
 	}
 }
+
+func TestCache_ExportData(t *testing.T) {
+	src := heredoc.Doc(
+		`
+		{
+			"id": 505,
+			"ref": "refs/heads/main",
+			"key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
+			"version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0",
+			"last_accessed_at": "2019-01-24T22:45:36.000Z",
+			"created_at": "2019-01-24T22:45:36.000Z",
+			"size_in_bytes": 1024
+		}
+	`,
+	)
+
+	tests := []struct {
+		name       string
+		fields     []string
+		inputJSON  string
+		outputJSON string
+	}{
+		{
+			name:      "basic",
+			fields:    []string{"id", "key"},
+			inputJSON: src,
+			outputJSON: heredoc.Doc(
+				`
+				{
+					"id": 505,
+					"key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"
+				}
+			`,
+			),
+		},
+		{
+			name:      "full",
+			fields:    []string{"id", "ref", "key", "version", "lastAccessedAt", "createdAt", "sizeInBytes"},
+			inputJSON: src,
+			outputJSON: heredoc.Doc(
+				`
+				{
+					"createdAt": "2019-01-24T22:45:36Z",
+					"id": 505,
+					"key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
+					"lastAccessedAt": "2019-01-24T22:45:36Z",
+					"ref": "refs/heads/main",
+					"sizeInBytes": 1024,
+					"version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0"
+				}
+			`,
+			),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var cache Cache
+			dec := json.NewDecoder(strings.NewReader(tt.inputJSON))
+			require.NoError(t, dec.Decode(&cache))
+
+			exported := cache.ExportData(tt.fields)
+
+			buf := bytes.Buffer{}
+			enc := json.NewEncoder(&buf)
+			enc.SetIndent("", "\t")
+			require.NoError(t, enc.Encode(exported))
+			assert.Equal(t, tt.outputJSON, buf.String())
+		})
+	}
+}