add -o short option for argo cli get command (#5533)

argoproj · Apr 7, 2021 · 2baae1d · 2baae1d
1 parent 0edd32b
commit 2baae1d
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/cmd/argo/commands/get.go b/cmd/argo/commands/get.go
@@ -84,7 +84,7 @@ func NewGetCommand() *cobra.Command {
 		},
 	}
 
-	command.Flags().StringVarP(&getArgs.output, "output", "o", "", "Output format. One of: json|yaml|wide")
+	command.Flags().StringVarP(&getArgs.output, "output", "o", "", "Output format. One of: json|yaml|short|wide")
 	command.Flags().BoolVar(&noColor, "no-color", false, "Disable colorized output")
 	command.Flags().BoolVar(&noUtf8, "no-utf8", false, "Use plain 7-bits ascii characters")
 	command.Flags().StringVar(&getArgs.status, "status", "", "Filter by status (Pending, Running, Succeeded, Skipped, Failed, Error)")
@@ -106,7 +106,7 @@ func printWorkflow(wf *wfv1.Workflow, getArgs getFlags) {
 	case "yaml":
 		outBytes, _ := yaml.Marshal(wf)
 		fmt.Print(string(outBytes))
-	case "wide", "":
+	case "short", "wide", "":
 		fmt.Print(printWorkflowHelper(wf, getArgs))
 	default:
 		log.Fatalf("Unknown output format: %s", getArgs.output)
@@ -189,6 +189,8 @@ func printWorkflowHelper(wf *wfv1.Workflow, getArgs getFlags) string {
 		// apply a dummy FgDefault format to align tab writer with the rest of the columns
 		if getArgs.output == "wide" {
 			_, _ = fmt.Fprintf(w, "%s\tTEMPLATE\tPODNAME\tDURATION\tARTIFACTS\tMESSAGE\tRESOURCESDURATION\tNODENAME\n", ansiFormat("STEP", FgDefault))
+		} else if getArgs.output == "short" {
+			_, _ = fmt.Fprintf(w, "%s\tTEMPLATE\tPODNAME\tDURATION\tMESSAGE\tNODENAME\n", ansiFormat("STEP", FgDefault))
 		} else {
 			_, _ = fmt.Fprintf(w, "%s\tTEMPLATE\tPODNAME\tDURATION\tMESSAGE\n", ansiFormat("STEP", FgDefault))
 		}
@@ -209,7 +211,11 @@ func printWorkflowHelper(wf *wfv1.Workflow, getArgs getFlags) string {
 			onExitRoot.renderNodes(w, wf, 0, " ", " ", getArgs)
 		}
 		_ = w.Flush()
-		out += writerBuffer.String()
+		if getArgs.output == "short" {
+			out = writerBuffer.String()
+		} else {
+			out += writerBuffer.String()
+		}
 	}
 	writerBuffer := new(bytes.Buffer)
 	printer.PrintSecurityNudges(*wf, writerBuffer)
@@ -539,6 +545,11 @@ func printNode(w *tabwriter.Writer, node wfv1.NodeStatus, nodePrefix string, get
 			args[len(args)-1] = node.HostNodeName
 		}
 		_, _ = fmt.Fprintf(w, "%s%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\n", args...)
+	} else if getArgs.output == "short" {
+		if node.Type == wfv1.NodeTypePod {
+			args[len(args)-1] = node.HostNodeName
+		}
+		_, _ = fmt.Fprintf(w, "%s%s\t%s\t%s\t%s\t%s\t%s\n", args...)
 	} else {
 		_, _ = fmt.Fprintf(w, "%s%s\t%s\t%s\t%s\t%s\t%s\n", args...)
 	}

diff --git a/cmd/argo/commands/get_test.go b/cmd/argo/commands/get_test.go
@@ -99,6 +99,9 @@ func TestPrintNode(t *testing.T) {
 	node.Type = wfv1.NodeTypePod
 	testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\t%s\t%s\n", jobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateRefName, nodeTemplateRefName, nodeID, "0s", getArtifactsString(node), nodeMessage, "", kubernetesNodeName), node, getArgs)
 
+	getArgs.output = "short"
+	testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\n", nodeTypeIconMap[wfv1.NodeTypeSuspend], nodeName, nodeTemplateRefName, nodeTemplateRefName, nodeID, "0s", nodeMessage, kubernetesNodeName), node, getArgs)
+
 	getArgs.status = "foobar"
 	testPrintNodeImpl(t, "", node, getArgs)
 }

diff --git a/docs/cli/argo_get.md b/docs/cli/argo_get.md
@@ -29,7 +29,7 @@ argo get WORKFLOW... [flags]
       --no-color                     Disable colorized output
       --no-utf8                      Use plain 7-bits ascii characters
       --node-field-selector string   selector of node to display, eg: --node-field-selector phase=abc
-  -o, --output string                Output format. One of: json|yaml|wide
+  -o, --output string                Output format. One of: json|yaml|short|wide
       --status string                Filter by status (Pending, Running, Succeeded, Skipped, Failed, Error)
 ```