fix get subcommand

Author: itaysk

Readme.md

@@ -59,8 +59,8 @@ This mode is invoked by calling the `get` subcommand, i.e `kubectl neat get ...`
 
 Examples:
 ```bash
-kubectl neat get pod mypod -oyaml
-kubectl neat get svc -n default myservice --output json
+kubectl neat get -- pod mypod -oyaml
+kubectl neat get -- svc -n default myservice --output json
 ```
 
 # How it works

cmd/cmd.go

@@ -83,22 +83,42 @@ var kubectl string = "kubectl"
 
 var getCmd = &cobra.Command{
 	Use: "get",
-	Example: `kubectl neat get pod mypod -oyaml
-kubectl neat get svc -n default myservice --output json`,
-	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true}, //don't validate kubectl get's flags
+	Example: `kubectl neat get -- pod mypod -oyaml
+kubectl neat get -- svc -n default myservice --output json`,
+	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true}, //don't try to validate kubectl get's flags
 	RunE: func(cmd *cobra.Command, args []string) error {
-		var in, out []byte
+		var out []byte
 		var err error
-		cmdArgs := append([]string{"get", "-o"}, *outputFormat)
-		cmdArgs = append(cmdArgs, args...)
+		//reset defaults
+		//there are two output settings in this subcommand: kubectl get's and kubectl-neat's
+		//any combination of those can be provided by using the output flag in either side of the --
+		//the most efficient is kubectl: json, kubectl-neat: yaml
+		//0--0->Y--J #choose what's best for us
+		//0--Y->Y--Y #user did specify output in kubectl, so respect that
+		//0--J->J--J #user did specify output in kubectl, so respect that
+		//Y--0->Y--J #user doesn't care about kubectl so use json but convert back
+		//J--0->J--J #user expects json so use it for foth
+		//if the user specified both side we can't touch it
+
+		//the desired kubectl get output is always json, unless it was explicitly set by the user to yaml in which case the arg is overriden when concatenating the args later
+		cmdArgs := append([]string{"get", "-o", "json"}, args...)
 		kubectlCmd := exec.Command(kubectl, cmdArgs...)
 		kres, err := kubectlCmd.CombinedOutput()
 		if err != nil {
-			return err
+			return fmt.Errorf("Error invoking kubectl as %v %v", kubectlCmd.Args, err)
 		}
-		in = kres
-
-		out, err = NeatYAMLOrJSON(in, *outputFormat)
+		//handle the case of 0--J->J--J
+		outFormat := *outputFormat
+		kubeout := "yaml"
+		for _, arg := range args {
+			if arg == "json" || arg == "ojson" {
+				outFormat = "json"
+			}
+		}
+		if !cmd.Flag("output").Changed && kubeout == "json" {
+			outFormat = "json"
+		}
+		out, err = NeatYAMLOrJSON(kres, outFormat)
 		if err != nil {
 			return err
 		}
@@ -107,12 +127,14 @@ kubectl neat get svc -n default myservice --output json`,
 	},
 }
 
+func isJSON(s []byte) bool {
+	return bytes.HasPrefix(bytes.TrimLeftFunc(s, unicode.IsSpace), []byte{'{'})
+}
+
 // NeatYAMLOrJSON converts 'in' to json if needed, invokes neat, and converts back if needed according the the outputFormat argument: yaml/json/same
 func NeatYAMLOrJSON(in []byte, outputFormat string) (out []byte, err error) {
 	var injson, outjson string
-
-	// detect if 'in' is yaml or json
-	itsYaml := !bytes.HasPrefix(bytes.TrimLeftFunc(in, unicode.IsSpace), []byte{'{'})
+	itsYaml := !isJSON(in)
 	if itsYaml {
 		injsonbytes, err := yaml.YAMLToJSON(in)
 		if err != nil {

cmd/cmd_test.go

@@ -134,7 +134,7 @@ func TestGetCmd(t *testing.T) {
 		{
 			args: []string{""},
 			assertError: func(err error) bool {
-				return fmt.Sprintf("%T", err) == "*exec.ExitError"
+				return strings.HasPrefix(err.Error(), "Error invoking kubectl")
 			},
 			expOut: "",
 			expErr: "",

krew-template.yaml

@@ -12,7 +12,7 @@ spec:
     removing default values, runtime information, and other internal fields.
     Examples:
     `$ kubectl get pod mypod -o yaml | kubectl neat`
-    `$ kubectl neat get pod mypod -o yaml`
+    `$ kubectl neat get -- pod mypod -o yaml`
   platforms:
     - selector:
         matchLabels:

test/e2e-krew.bats

@@ -14,7 +14,7 @@ function teardown() {
 }
 
 @test "krew install" {
-    run2 kubectl "$plugin" get svc kubernetes -n default
+    run2 kubectl "$plugin" get -- svc kubernetes -n default
     [ "$status" -eq 0 ]
     [ "${stdoutLines[1]}" = "kind: Service" ]
 }

test/e2e-kubectl.bats

@@ -18,13 +18,13 @@ function teardown() {
 }
 
 @test "plugin - json" {
-    run2 kubectl "$plugin_name" get -o json svc kubernetes -n default
+    run2 kubectl "$plugin_name" get -o json -- svc kubernetes -n default
     [ "$status" -eq 0 ]
     [[ $stdout == "{"* ]]
 }
 
 @test "plugin - yaml" {
-    run2 kubectl "$plugin_name" get svc kubernetes -n default -o yaml
+    run2 kubectl "$plugin_name" get -- svc kubernetes -n default
     [ "$status" -eq 0 ]
     [[ $stdout == "apiVersion"* ]]
 }