Add readable mode to results command

Signed-off-by: Andrew Yunt <[email protected]>

Error message fixes for results command

Signed-off-by: Andrew Yunt <[email protected]>

Update text module

Signed-off-by: Andrew Yunt <[email protected]>

Author: andrewyunt

cmd/sonobuoy/app/results.go

@@ -17,6 +17,7 @@ limitations under the License.
 package app
 
 import (
+	"bytes"
 	"compress/gzip"
 	"encoding/json"
 	"fmt"
@@ -47,6 +48,9 @@ const (
 	// resultModeDump will just copy the post-processed yaml file to stdout.
 	resultModeDump = "dump"
 
+	//resultModeReadable will copy the post-processed yaml file to stdout and replace \n and \t with new lines and tabs respectively.
+	resultModeReadable = "readable"
+
 	windowsSeperator = `\`
 
 	//Name of the "fake" plugin used to enable printing the health summary.
@@ -83,7 +87,7 @@ func NewCmdResults() *cobra.Command {
 	)
 	cmd.Flags().StringVarP(
 		&data.mode, "mode", "m", resultModeReport,
-		`Modifies the format of the output. Valid options are report, detailed, or dump.`,
+		`Modifies the format of the output. Valid options are report, detailed, readable, or dump.`,
 	)
 	cmd.Flags().StringVarP(
 		&data.node, "node", "n", "",
@@ -217,6 +221,15 @@ func printHealthSummary(input resultsInput, r *results.Reader) error {
 			return err
 		}
 		fmt.Println(string(data))
+	case resultModeReadable:
+		data, err = yaml.Marshal(clusterHealthSummary)
+		if err != nil {
+			return err
+		}
+		str := string(data)
+		str = strings.ReplaceAll(str, `\n`, "\n")
+		str = strings.ReplaceAll(str, `\t`, "	")
+		fmt.Println(str)
 	default:
 		err = printClusterHealthResultsSummary(clusterHealthSummary)
 		if err != nil {
@@ -226,6 +239,17 @@ func printHealthSummary(input resultsInput, r *results.Reader) error {
 	return nil
 }
 
+type humanReadableWriter struct {
+	w io.Writer
+}
+
+func (hw *humanReadableWriter) Write(b []byte) (int, error) {
+	newb := bytes.Replace(b, []byte(`\n`), []byte("\n"), -1)
+	newb = bytes.Replace(newb, []byte(`\t`), []byte("\t"), -1)
+	_, err := hw.w.Write(newb)
+	return len(b), err
+}
+
 func printSinglePlugin(input resultsInput, r *results.Reader) error {
 	// If we want to dump the whole file, don't decode to an Item object first.
 	if input.mode == resultModeDump {
@@ -235,6 +259,17 @@ func printSinglePlugin(input resultsInput, r *results.Reader) error {
 		}
 		_, err = io.Copy(os.Stdout, fReader)
 		return err
+	} else if input.mode == resultModeReadable {
+		fReader, err := r.PluginResultsReader(input.plugin)
+		if err != nil {
+			return errors.Wrapf(err, "failed to get results reader for plugin %v", input.plugin)
+		}
+		writer := &humanReadableWriter{os.Stdout}
+		_, err = io.Copy(writer, fReader)
+		if err != nil {
+			return errors.Wrapf(err, "failed to copy data for plugin %v", input.plugin)
+		}
+		return err
 	}
 
 	// For summary and detailed views, get the item as an object to iterate over.

cmd/sonobuoy/app/results_test.go

@@ -16,10 +16,97 @@ limitations under the License.
 package app
 
 import (
+	"bytes"
+	"fmt"
 	"path/filepath"
+	"strings"
 	"testing"
 )
 
+func TestHumanReadableWriter(t *testing.T) {
+	tcs := []struct {
+		desc     string
+		input    string
+		contains []string
+		expected bool
+	}{
+		{
+			desc:     "String with \\n does not contain `\\n`",
+			input:    "\nHello world",
+			contains: []string{`\n`},
+			expected: false,
+		},
+		{
+			desc:     "String with \\t does not contain `\\t`",
+			input:    "\tHello world",
+			contains: []string{`\t`},
+			expected: false,
+		},
+		{
+			desc:     "String with \\t and \n does not contain `\\n`",
+			input:    "\tHello\nworld",
+			contains: []string{`\n`},
+			expected: false,
+		},
+		{
+			desc:     "String with \\t and \\n does not contain `\\t`",
+			input:    "\tHello\nworld",
+			contains: []string{`\t`},
+			expected: false,
+		},
+		{
+			desc:     "String with \\t and \\n does not contain `\\n` or `\\t`",
+			input:    "\tHello\nworld",
+			contains: []string{`\n`, `\t`},
+			expected: false,
+		},
+		{
+			desc:     `String with \n contains "\n"`,
+			input:    "\nHello world",
+			contains: []string{"\n"},
+			expected: true,
+		},
+		{
+			desc:     `String with \t contains "\t"`,
+			input:    "\tHello world",
+			contains: []string{"\t"},
+			expected: true,
+		},
+		{
+			desc:     `String with \t and \n contains "\n"`,
+			input:    "\tHello\nworld",
+			contains: []string{"\n"},
+			expected: true,
+		},
+		{
+			desc:     `String with \t and \n contains "\t"`,
+			input:    "\tHello\nworld",
+			contains: []string{"\t"},
+			expected: true,
+		},
+		{
+			desc:     `String with \t and \n contains "\n" and "\t"`,
+			input:    "\tHello\nworld",
+			contains: []string{"\n", "\t"},
+			expected: true,
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.desc, func(t *testing.T) {
+			buffer := bytes.Buffer{}
+			writer := humanReadableWriter{&buffer}
+			fmt.Fprintf(&writer, tc.input)
+			for _, contains := range tc.contains {
+				out := strings.Contains(buffer.String(), contains)
+				if out != tc.expected {
+					t.Errorf("Expected output: %v", tc.expected)
+				}
+			}
+		})
+	}
+}
+
 func TestGetFileFromMeta(t *testing.T) {
 	tcs := []struct {
 		desc     string

go.mod

@@ -25,7 +25,7 @@ require (
 	golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 // indirect
 	golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9
 	golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b
-	golang.org/x/text v0.3.6
+	golang.org/x/text v0.3.7
 	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c
 	k8s.io/api v0.21.3

go.sum

@@ -444,8 +444,9 @@ golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
 golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=