From 7efa40b3b4df7ffa596cfbbcd1844d532042d576 Mon Sep 17 00:00:00 2001
From: Emily <tao.emily@yahoo.ca>
Date: Tue, 30 Nov 2021 13:45:56 -0500
Subject: [PATCH] cmd/inspect: Update inspect to pretty print by default
 (#4021)

Inspect previously pretty printed only when -f pretty was specified. This change ensures that inspect pretty prints by default, and a user can specify --format=json to avoid relying on implicit default behaviour.

Fixes: #4021

Signed-off-by: Emily Tao
<tao.emily@yahoo.ca>
Signed-off-by: Emily Tao <tao.emily@yahoo.ca>
---
 cmd/inspect.go      | 10 +++++-----
 cmd/inspect_test.go | 24 +++++++++---------------
 2 files changed, 14 insertions(+), 20 deletions(-)

diff --git a/cmd/inspect.go b/cmd/inspect.go
index f618c1225a..df6ecbd02f 100644
--- a/cmd/inspect.go
+++ b/cmd/inspect.go
@@ -30,7 +30,7 @@ type inspectCommandParams struct {
 
 func newInspectCommandParams() inspectCommandParams {
 	return inspectCommandParams{
-		outputFormat: util.NewEnumFlag(evalJSONOutput, []string{
+		outputFormat: util.NewEnumFlag(evalPrettyOutput, []string{
 			evalJSONOutput,
 			evalPrettyOutput,
 		}),
@@ -89,7 +89,10 @@ func doInspect(params inspectCommandParams, path string, out io.Writer) error {
 	}
 
 	switch params.outputFormat.String() {
-	case evalPrettyOutput:
+	case evalJSONOutput:
+		return pr.JSON(out, info)
+
+	default:
 		if info.Manifest.Revision != "" || len(*info.Manifest.Roots) != 0 || len(info.Manifest.Metadata) != 0 {
 			if err := populateManifest(out, info.Manifest); err != nil {
 				return err
@@ -102,9 +105,6 @@ func doInspect(params inspectCommandParams, path string, out io.Writer) error {
 			}
 		}
 		return nil
-
-	default:
-		return pr.JSON(out, info)
 	}
 }
 
diff --git a/cmd/inspect_test.go b/cmd/inspect_test.go
index 41db4d6c41..ccb9c65f8e 100644
--- a/cmd/inspect_test.go
+++ b/cmd/inspect_test.go
@@ -43,7 +43,13 @@ func TestDoInspect(t *testing.T) {
 		}
 
 		var out bytes.Buffer
-		err = doInspect(newInspectCommandParams(), bundleFile, &out)
+		params := newInspectCommandParams()
+		err = params.outputFormat.Set(evalJSONOutput)
+		if err != nil {
+			t.Fatalf("Unexpected error: %s", err)
+		}
+
+		err = doInspect(params, bundleFile, &out)
 		if err != nil {
 			t.Fatalf("Unexpected error %v", err)
 		}
@@ -100,13 +106,7 @@ func TestDoInspectPretty(t *testing.T) {
 		}
 
 		var out bytes.Buffer
-		params := newInspectCommandParams()
-		err = params.outputFormat.Set(evalPrettyOutput)
-		if err != nil {
-			t.Fatalf("Unexpected error: %s", err)
-		}
-
-		err = doInspect(params, bundleFile, &out)
+		err = doInspect(newInspectCommandParams(), bundleFile, &out)
 		if err != nil {
 			t.Fatalf("Unexpected error %v", err)
 		}
@@ -176,13 +176,7 @@ func TestDoInspectPrettyManifestOnlySingleRoot(t *testing.T) {
 		}
 
 		var out bytes.Buffer
-		params := newInspectCommandParams()
-		err = params.outputFormat.Set(evalPrettyOutput)
-		if err != nil {
-			t.Fatalf("Unexpected error: %s", err)
-		}
-
-		err = doInspect(params, bundleFile, &out)
+		err = doInspect(newInspectCommandParams(), bundleFile, &out)
 		if err != nil {
 			t.Fatalf("Unexpected error %v", err)
 		}