[Antctl] Add an output format to better display multi-line string res…

…ponses. Current output formatters (table, json, and yaml) of Antctl are not good at displaying multi-line string responses. Added a new output formatter called "raw" whose output is similar to fmt.Print(responseString) which directly lets user redirect the output into a file and apply it afterwards. Fixes antrea-io#3426 Signed-off-by: Kumar Atish <atish.iaf@gmail.com>
dreamtalen · May 10, 2022 · fd80385 · fd80385
1 parent 45e4745
commit fd80385
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/pkg/antctl/command_definition.go b/pkg/antctl/command_definition.go
@@ -41,6 +41,7 @@ const (
 	jsonFormatter  formatterType = "json"
 	yamlFormatter  formatterType = "yaml"
 	tableFormatter formatterType = "table"
+	rawFormatter   formatterType = "raw"
 )
 
 const (
@@ -540,6 +541,8 @@ func (cd *commandDefinition) output(resp io.Reader, writer io.Writer, ft formatt
 		} else {
 			return output.TableOutput(obj, writer)
 		}
+	case rawFormatter:
+		return output.RawOutput(obj, writer)
 	default:
 		return fmt.Errorf("unsupported format type: %v", ft)
 	}

diff --git a/pkg/antctl/output/output.go b/pkg/antctl/output/output.go
@@ -148,6 +148,16 @@ func YamlOutput(obj interface{}, writer io.Writer) error {
 	return nil
 }
 
+// RawOutput is an output formatter whose output is similar to fmt.Print(responseString)
+// to better display multiple-line string responses.
+func RawOutput(obj interface{}, writer io.Writer) error {
+	_, err := fmt.Fprintf(writer, "%v", obj)
+	if err != nil {
+		return fmt.Errorf("error when outputing in raw format: %w", err)
+	}
+	return nil
+}
+
 // tableOutputForGetCommands formats the table output for "get" commands.
 func TableOutputForGetCommands(obj interface{}, writer io.Writer) error {
 	var list []common.TableOutput