Merge pull request #214 from wttech/196-jmespath-integration

#196 Add JMESPath output querying

cmd/aem/cli.go

@@ -3,9 +3,11 @@ package main
 import (
 	"bufio"
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"github.com/fatih/color"
 	"github.com/iancoleman/strcase"
+	"github.com/jmespath-community/go-jmespath"
 	"github.com/samber/lo"
 	"github.com/segmentio/textio"
 	log "github.com/sirupsen/logrus"
@@ -45,6 +47,7 @@ type CLI struct {
 	outputLogFile  string
 	outputLogMode  string
 	outputResponse *OutputResponse
+	outputQuery    string
 	outputWriter   io.Writer
 	outputNoColor  bool
 
@@ -105,6 +108,7 @@ func (c *CLI) onStart() {
 	c.outputResponse = outputResponseDefault()
 	c.outputValue = cv.GetString("output.value")
 	c.outputFormat = strings.ReplaceAll(cv.GetString("output.format"), "yaml", "yml")
+	c.outputQuery = cv.GetString("output.query")
 	c.outputLogFile = cv.GetString("output.log.file")
 	c.outputLogMode = cv.GetString("output.log.mode")
 
@@ -295,26 +299,61 @@ func (c *CLI) printOutputDataIndented(writer *textio.PrefixWriter, value any, ke
 }
 
 func (c *CLI) printOutputMarshaled() {
+	if c.outputValue == common.OutputValueNone {
+		return
+	}
+
+	if c.outputQuery == "" {
+		c.printOutputMarshaledValue(c.outputResponse)
+		return
+	}
+
+	// JMESPath bug workaround, see: https://github.com/jmespath/go-jmespath/issues/32)
+	cloned, err := c.outputResponse.Clone()
+	if err != nil {
+		log.Fatalf("cannot clone CLI output data: %s", err)
+	}
+	queried, err := jmespath.Search(c.outputQuery, cloned)
+	if err != nil {
+		log.Fatalf("cannot perform query '%s' on CLI output data: %s", c.outputQuery, err)
+	}
+
+	c.printOutputMarshaledValue(queried)
+}
+
+func (c *CLI) printOutputMarshaledValue(value any) {
 	switch c.outputFormat {
 	case fmtx.JSON:
-		json, err := fmtx.MarshalJSON(c.outputResponse)
+		jsonValue, err := fmtx.MarshalJSON(value)
 		if err != nil {
-			log.Fatalf("cannot serialize CLI output to to target JSON format!")
+			log.Fatalf("cannot serialize CLI output to target JSON format!")
 		}
-		fmt.Println(json)
+		fmt.Println(jsonValue)
 		break
 	case fmtx.YML:
-		yml, err := fmtx.MarshalYML(c.outputResponse)
+		ymlValue, err := fmtx.MarshalYML(value)
 		if err != nil {
-			log.Fatalf("cannot serialize CLI output to to target YML format!")
+			log.Fatalf("cannot serialize CLI output to target YML format!")
 		}
-		fmt.Println(yml)
+		fmt.Println(ymlValue)
 		break
 	default:
 		log.Fatalf("cannot serialize CLI output to unsupported format '%s'", c.outputFormat)
 	}
 }
 
+func (c *OutputResponse) Clone() (*OutputResponse, error) {
+	var clone OutputResponse
+	marshalled, err := json.Marshal(c)
+	if err != nil {
+		return nil, err
+	}
+	if err = json.Unmarshal(marshalled, &clone); err != nil {
+		return nil, err
+	}
+	return &clone, nil
+}
+
 func (c *CLI) Ok(message string) {
 	c.Success(message, false)
 }

cmd/aem/root.go

@@ -55,6 +55,9 @@ func (c *CLI) rootFlags(cmd *cobra.Command) {
 	cmd.PersistentFlags().String("output-format", cv.GetString("output.format"), "Controls output format ("+strings.Join(cfg.OutputFormats(), "|")+")")
 	_ = cv.BindPFlag("output.format", cmd.PersistentFlags().Lookup("output-format"))
 
+	cmd.PersistentFlags().String("output-query", cv.GetString("output.query"), "Filters output using JMESPath query (only JSON and YML formats)")
+	_ = cv.BindPFlag("output.query", cmd.PersistentFlags().Lookup("output-query"))
+
 	cmd.PersistentFlags().String("output-log-file", cv.GetString("output.log.file"), "Controls output file path")
 	_ = cv.BindPFlag("output.log.file", cmd.PersistentFlags().Lookup("output-log-file"))
 

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/google/go-cmp v0.6.0
 	github.com/hashicorp/go-version v1.6.0
 	github.com/iancoleman/strcase v0.3.0
+	github.com/jmespath-community/go-jmespath v1.1.1
 	github.com/joho/godotenv v1.5.1
 	github.com/magiconair/properties v1.8.7
 	github.com/olekukonko/tablewriter v0.0.5

go.sum

@@ -64,6 +64,8 @@ github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4=
 github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/jmespath-community/go-jmespath v1.1.1 h1:bFikPhsi/FdmlZhVgSCd2jj1e7G/rw+zyQfyg5UF+L4=
+github.com/jmespath-community/go-jmespath v1.1.1/go.mod h1:4gOyFJsR/Gk+05RgTKYrifT7tBPWD8Lubtb5jRrfy9I=
 github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
 github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/klauspost/compress v1.4.1/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=

pkg/cfg/defaults.go

@@ -29,6 +29,7 @@ func (c *Config) setDefaults() {
 	v.SetDefault("output.value", common.OutputValueAll)
 	v.SetDefault("output.log.file", common.LogFile)
 	v.SetDefault("output.log.mode", OutputLogConsole)
+	v.SetDefault("output.query", "")
 
 	v.SetDefault("java.home_dir", "")
 	v.SetDefault("java.version_constraints", ">= 11, < 12")