Add --json export flag for workflow runs (cli#3869)

cristiand391 · mislav · web-flow · commit ddaef8baa4a2 · 2021-12-17T15:55:45.000Z
Co-authored-by: Mislav Marohnić &lt;mislav@github.com&gt;
diff --git a/pkg/cmd/run/list/list.go b/pkg/cmd/run/list/list.go
@@ -25,6 +25,7 @@ type ListOptions struct {
 	BaseRepo   func() (ghrepo.Interface, error)
 
 	PlainOutput bool
+	Exporter    cmdutil.Exporter
 
 	Limit            int
 	WorkflowSelector string
@@ -61,6 +62,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
 
 	cmd.Flags().IntVarP(&opts.Limit, "limit", "L", defaultLimit, "Maximum number of runs to fetch")
 	cmd.Flags().StringVarP(&opts.WorkflowSelector, "workflow", "w", "", "Filter runs by workflow")
+	cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.RunFields)
 
 	return cmd
 }
@@ -96,6 +98,10 @@ func listRun(opts *ListOptions) error {
 		return fmt.Errorf("failed to get runs: %w", err)
 	}
 
+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IO, runs)
+	}
+
 	tp := utils.NewTablePrinter(opts.IO)
 
 	cs := opts.IO.ColorScheme()
diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"net/url"
+	"reflect"
 	"strings"
 	"time"
 
@@ -42,6 +43,20 @@ type Status string
 type Conclusion string
 type Level string
 
+var RunFields = []string{
+	"name",
+	"headBranch",
+	"headSha",
+	"createdAt",
+	"updatedAt",
+	"status",
+	"conclusion",
+	"event",
+	"databaseId",
+	"workflowDatabaseId",
+	"url",
+}
+
 type Run struct {
 	Name           string
 	CreatedAt      time.Time `json:"created_at"`
@@ -50,6 +65,7 @@ type Run struct {
 	Conclusion     Conclusion
 	Event          string
 	ID             int64
+	WorkflowID     int64  `json:"workflow_id"`
 	HeadBranch     string `json:"head_branch"`
 	JobsURL        string `json:"jobs_url"`
 	HeadCommit     Commit `json:"head_commit"`
@@ -78,6 +94,30 @@ func (r Run) CommitMsg() string {
 	}
 }
 
+func (r *Run) ExportData(fields []string) map[string]interface{} {
+	v := reflect.ValueOf(r).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 {
+		switch f {
+		case "databaseId":
+			data[f] = r.ID
+		case "workflowDatabaseId":
+			data[f] = r.WorkflowID
+		default:
+			sf := fieldByName(v, f)
+			data[f] = sf.Interface()
+		}
+	}
+
+	return data
+}
+
 type Job struct {
 	ID          int64
 	Status      Status
diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go
@@ -78,7 +78,8 @@ type ViewOptions struct {
 	LogFailed  bool
 	Web        bool
 
-	Prompt bool
+	Prompt   bool
+	Exporter cmdutil.Exporter
 
 	Now func() time.Time
 }
@@ -155,6 +156,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman
 	cmd.Flags().BoolVar(&opts.Log, "log", false, "View full log for either a run or specific job")
 	cmd.Flags().BoolVar(&opts.LogFailed, "log-failed", false, "View the log for any failed steps in a run or specific job")
 	cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open run in the browser")
+	cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.RunFields)
 
 	return cmd
 }
@@ -228,6 +230,10 @@ func runView(opts *ViewOptions) error {
 		}
 	}
 
+	if opts.Exporter != nil {
+		return opts.Exporter.Write(opts.IO, run)
+	}
+
 	if opts.Web {
 		url := run.URL
 		if selectedJob != nil {

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,8 @@ type ViewOptions struct {`
`78`	`78`	`LogFailed bool`
`79`	`79`	`Web bool`
`80`	`80`
`81`		`- Prompt bool`
	`81`	`+ Prompt bool`
	`82`	`+ Exporter cmdutil.Exporter`
`82`	`83`
`83`	`84`	`Now func() time.Time`
`84`	`85`	`}`
`@@ -155,6 +156,7 @@ func NewCmdView(f cmdutil.Factory, runF func(ViewOptions) error) *cobra.Comman`
`155`	`156`	`cmd.Flags().BoolVar(&opts.Log, "log", false, "View full log for either a run or specific job")`
`156`	`157`	`cmd.Flags().BoolVar(&opts.LogFailed, "log-failed", false, "View the log for any failed steps in a run or specific job")`
`157`	`158`	`cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open run in the browser")`
	`159`	`+ cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.RunFields)`
`158`	`160`
`159`	`161`	`return cmd`
`160`	`162`	`}`
`@@ -228,6 +230,10 @@ func runView(opts *ViewOptions) error {`
`228`	`230`	`}`
`229`	`231`	`}`
`230`	`232`
	`233`	`+ if opts.Exporter != nil {`
	`234`	`+ return opts.Exporter.Write(opts.IO, run)`
	`235`	`+ }`
	`236`	`+`
`231`	`237`	`if opts.Web {`
`232`	`238`	`url := run.URL`
`233`	`239`	`if selectedJob != nil {`