From 63c06bee7058064a2b2d0340f4b1ae7377524974 Mon Sep 17 00:00:00 2001
From: Graham Whaley <graham.whaley@intel.com>
Date: Fri, 6 Jul 2018 17:27:55 +0100
Subject: [PATCH] kata-env: Add ability to output as JSON

Having a direct JSON output for kata-env will help record
results in our CIs in some instances. Add that ability with
a kata-env command line extension.

Fixes: #474

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
---
 cli/kata-env.go      | 61 +++++++++++++++++++++++++++++++-------------
 cli/kata-env_test.go | 10 +++++++-
 2 files changed, 52 insertions(+), 19 deletions(-)

diff --git a/cli/kata-env.go b/cli/kata-env.go
index d0daf3490f..150b51ca7f 100644
--- a/cli/kata-env.go
+++ b/cli/kata-env.go
@@ -6,6 +6,7 @@
 package main
 
 import (
+	"encoding/json"
 	"errors"
 	"os"
 	"strings"
@@ -328,7 +329,34 @@ func getEnvInfo(configFile string, config oci.RuntimeConfig) (env EnvInfo, err e
 	return env, nil
 }
 
-func showSettings(env EnvInfo, file *os.File) error {
+func handleSettings(file *os.File, c *cli.Context) error {
+	if file == nil {
+		return errors.New("Invalid output file specified")
+	}
+
+	configFile, ok := c.App.Metadata["configFile"].(string)
+	if !ok {
+		return errors.New("cannot determine config file")
+	}
+
+	runtimeConfig, ok := c.App.Metadata["runtimeConfig"].(oci.RuntimeConfig)
+	if !ok {
+		return errors.New("cannot determine runtime config")
+	}
+
+	env, err := getEnvInfo(configFile, runtimeConfig)
+	if err != nil {
+		return err
+	}
+
+	if c.Bool("json") {
+		return writeJSONSettings(env, file)
+	}
+
+	return writeTOMLSettings(env, file)
+}
+
+func writeTOMLSettings(env EnvInfo, file *os.File) error {
 	encoder := toml.NewEncoder(file)
 
 	err := encoder.Encode(env)
@@ -339,33 +367,30 @@ func showSettings(env EnvInfo, file *os.File) error {
 	return nil
 }
 
-func handleSettings(file *os.File, metadata map[string]interface{}) error {
-	if file == nil {
-		return errors.New("Invalid output file specified")
-	}
+func writeJSONSettings(env EnvInfo, file *os.File) error {
+	encoder := json.NewEncoder(file)
 
-	configFile, ok := metadata["configFile"].(string)
-	if !ok {
-		return errors.New("cannot determine config file")
-	}
+	// Make it more human readable
+	encoder.SetIndent("", "  ")
 
-	runtimeConfig, ok := metadata["runtimeConfig"].(oci.RuntimeConfig)
-	if !ok {
-		return errors.New("cannot determine runtime config")
-	}
-
-	env, err := getEnvInfo(configFile, runtimeConfig)
+	err := encoder.Encode(env)
 	if err != nil {
 		return err
 	}
 
-	return showSettings(env, file)
+	return nil
 }
 
 var kataEnvCLICommand = cli.Command{
 	Name:  envCmd,
-	Usage: "display settings",
+	Usage: "display settings. Default to TOML",
+	Flags: []cli.Flag{
+		cli.BoolFlag{
+			Name:  "json",
+			Usage: "Format output as JSON",
+		},
+	},
 	Action: func(context *cli.Context) error {
-		return handleSettings(defaultOutputFile, context.App.Metadata)
+		return handleSettings(defaultOutputFile, context)
 	},
 }
diff --git a/cli/kata-env_test.go b/cli/kata-env_test.go
index d8a9100cd8..84971fd111 100644
--- a/cli/kata-env_test.go
+++ b/cli/kata-env_test.go
@@ -7,6 +7,7 @@ package main
 
 import (
 	"bytes"
+	"flag"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -717,7 +718,7 @@ func testEnvShowSettings(t *testing.T, tmpdir string, tmpfile *os.File) error {
 		Host:       expectedHostDetails,
 	}
 
-	err = showSettings(env, tmpfile)
+	err = writeTOMLSettings(env, tmpfile)
 	if err != nil {
 		return err
 	}
@@ -906,6 +907,13 @@ func TestEnvCLIFunction(t *testing.T) {
 
 	err = fn(ctx)
 	assert.NoError(t, err)
+
+	set := flag.NewFlagSet("", 0)
+	set.Bool("json", true, "")
+	ctx = cli.NewContext(app, set, nil)
+
+	err = fn(ctx)
+	assert.NoError(t, err)
 }
 
 func TestEnvCLIFunctionFail(t *testing.T) {