Add an --output option to kepctl query

Signed-off-by: Nabarun Pal <[email protected]>

Author: palnabarun

cmd/kepctl/query.go

@@ -17,6 +17,8 @@ limitations under the License.
 package main
 
 import (
+	"fmt"
+
 	"github.com/spf13/cobra"
 
 	"k8s.io/enhancements/pkg/kepctl"
@@ -43,6 +45,7 @@ func buildQueryCommand(k *kepctl.Client) *cobra.Command {
 	f.StringSliceVar(&opts.Stage, "stage", nil, "Stage")
 	f.StringSliceVar(&opts.PRRApprover, "prr", nil, "Prod Readiness Approver")
 	f.BoolVar(&opts.IncludePRs, "include-prs", false, "Include PRs in the results")
+	f.StringVar(&opts.Output, "output", kepctl.DefaultOutputOpt, fmt.Sprintf("Output format. Can be %v", kepctl.SupportedOutputOpts))
 
 	addRepoPathFlag(f, &opts.CommonArgs)
 

pkg/kepctl/query.go

@@ -26,13 +26,26 @@ import (
 	"k8s.io/enhancements/pkg/kepval/keps/validations"
 )
 
+var (
+	// SupportedOutputOpts stores all allowed query output formats
+	SupportedOutputOpts = []string{
+		"table",
+		"json",
+		"yaml",
+	}
+
+	// DefaultOutputOpt is the default output format for kepctl query
+	DefaultOutputOpt = "table"
+)
+
 type QueryOpts struct {
 	CommonArgs
 	SIG         []string
 	Status      []string
 	Stage       []string
 	PRRApprover []string
 	IncludePRs  bool
+	Output      string
 }
 
 // Validate checks the args and cleans them up if needed
@@ -47,6 +60,12 @@ func (c *QueryOpts) Validate(args []string) error {
 		}
 		c.SIG = sigs
 	}
+
+	// check if the Output specified is one of "", "json" or "yaml"
+	if !sliceContains(SupportedOutputOpts, c.Output) {
+		return fmt.Errorf("unsupported output format: %s. Valid values: %v", c.Output, SupportedOutputOpts)
+	}
+
 	//TODO: check the valid values of stage, status, etc.
 	return nil
 }
@@ -111,6 +130,16 @@ func sliceToMap(s []string) map[string]bool {
 	return m
 }
 
+func sliceContains(s []string, e string) bool {
+	for _, k := range s {
+		if k == e {
+			return true
+		}
+	}
+
+	return false
+}
+
 // returns all strings in vals that match at least one
 // regexp in regexps
 func selectByRegexp(vals []string, regexps []string) ([]string, error) {