fix stdout/stderr printing and related tests

Author: itaysk

cmd/cmd.go

@@ -33,14 +33,16 @@ var inputFile *string
 func init() {
 	outputFormat = rootCmd.PersistentFlags().StringP("output", "o", "yaml", "output format: yaml or json")
 	inputFile = rootCmd.Flags().StringP("file", "f", "-", "file path to neat, or - to read from stdin")
+	rootCmd.SetOut(os.Stdout)
+	rootCmd.SetErr(os.Stderr)
 	rootCmd.MarkFlagFilename("file")
 	rootCmd.AddCommand(getCmd)
 }
 
 // Execute is the entry point for the command package
 func Execute() {
 	if err := rootCmd.Execute(); err != nil {
-		fmt.Println(err)
+		rootCmd.PrintErr(err) // can't use PrintErrln or PrintErrf due to a bug https://github.com/spf13/cobra/pull/894
 		os.Exit(1)
 	}
 }

test/bats-workaround.bash

@@ -0,0 +1,22 @@
+# run2 reimplements the "run" helper function from bats in order to make it handle stdout and stderr seperately
+# issue tracked: https://github.com/bats-core/bats-core/issues/47
+# original function: https://github.com/bats-core/bats-core/blob/90ce85884ca89b48960194b3d3bf6b816285e053/lib/bats-core/test_functions.bash#L32:L45
+function run2() {
+    local origFlags="$-"
+    set +eETx
+    local origIFS="$IFS"
+    # 'output', 'status', 'lines' are global variables available to tests.
+    local tmperr=$(mktemp)
+    stdout="$("$@" 2>"$tmperr")"
+    # shellcheck disable=SC2034
+    status="$?"
+    # shellcheck disable=SC2034
+    stderr="$(cat <"$tmperr")"
+    rm "$tmperr"
+    # shellcheck disable=SC2034,SC2206
+    IFS=$'\n' stdoutLines=($stdout)
+    # shellcheck disable=SC2034,SC2206
+    IFS=$'\n' stderrLines=($stderr)
+    IFS="$origIFS"
+    set "-$origFlags"
+}

test/bats-workaround_test.bats

@@ -0,0 +1,22 @@
+#!/usr/bin/env bats
+
+load bats-workaround.bash
+
+function exercise_run2() {
+  echo "out1"
+  echo "err1" >&2
+  echo "out2"
+  echo "err2" >&2
+  return 42
+}
+
+@test "run2" {
+  run2 exercise_run2
+  [[ "$status" -eq 42 ]]
+  [[ "$stdout" == "out1
+out2" ]]
+  [[ "$stderr" == "err1
+err2" ]]
+  [[ "${stdoutLines[1]}" == "out2" ]]
+  [[ "${stderrLines[1]}" == "err2" ]] 
+}

test/e2e-cli.bats

@@ -1,28 +1,30 @@
 #!/usr/bin/env bats
+load bats-workaround
 runtime_os=$(uname -s | tr '[:upper:]' '[:lower:]') 
-exe="./kubectl-neat_${runtime_os}"
+exe="dist/kubectl-neat_${runtime_os}"
 rootDir="./test/fixtures"
 
 @test "invalid args 1" {
-    run "$exe" -foo
+    echo $exe >&3
+    run2 "$exe" --foo
     [ $status -eq 1 ]
-    [[ "$output" == "Error"* ]]
+    [[ "$stderr" == "unknown flag: --foo" ]]
 }
 
 @test "invalid args 2" {
-    run "$exe" get -foo
+    run2 "$exe" get --foo
     [ $status -eq 1 ]
-    [[ "$output" == "Error"* ]]
+    [[ "$stderr" == "Error invoking kubectl"* ]]
 }
 
 @test "invalid args 3" {
-    run "$exe" foo
+    run2 "$exe" foo
     [ $status -eq 1 ]
-    [[ "$output" == "Error"* ]]
+    [[ "$stderr" == 'unknown command "foo" for "kubectl-neat"' ]]
 }
 
 @test "local file" {
-    run "$exe" -f - <"$rootDir/pod1-raw.yaml"
+    run2 "$exe" -f - <"$rootDir/pod1-raw.yaml"
     [ $status -eq 0 ]
-    [[ "$output" == "apiVersion"* ]]
+    [[ "$stdout" == "apiVersion"* ]]
 }

test/e2e-krew.bats

@@ -1,4 +1,5 @@
 #!/usr/bin/env bats
+load bats-workaround
 
 function setup() {
     dir="dist"
@@ -13,7 +14,7 @@ function teardown() {
 }
 
 @test "krew install" {
-    run kubectl "$plugin" get svc kubernetes -oyaml
-    [ "$status"  -eq 0 ]
-    [ "${lines[1]}" = "kind: Service" ]
+    run2 kubectl "$plugin" get svc kubernetes -n default
+    [ "$status" -eq 0 ]
+    [ "${stdoutLines[1]}" = "kind: Service" ]
 }

test/e2e-kubectl.bats

@@ -1,12 +1,14 @@
 #!/usr/bin/env bats
+load bats-workaround
 
 function setup() {
     runtime_os=$(uname -s | tr '[:upper:]' '[:lower:]')
     tmpdir=$(mktemp -d)
     # rename the plugin to avoid conflicts with existing installation
     plugin_name="neat2"
     plugin="$tmpdir"/kubectl-"$plugin_name"
-    ln -s "$(pwd)/kubectl-neat_${runtime_os}" "$plugin"
+    exe="$PWD/$(find dist -path \*dist/kubectl-neat_$runtime_os\*/kubectl-neat)"
+    ln -s "$exe" "$plugin"
     # PATH modification here has no external affect since bats runs in a subshell
     PATH="$PATH":"$tmpdir"
 }
@@ -16,13 +18,13 @@ function teardown() {
 }
 
 @test "plugin - json" {
-    run kubectl "$plugin_name" get svc kubernetes -o json
+    run2 kubectl "$plugin_name" get -o json svc kubernetes -n default
     [ "$status" -eq 0 ]
-    [[ $output == "{"* ]]
+    [[ $stdout == "{"* ]]
 }
 
 @test "plugin - yaml" {
-    run kubectl "$plugin_name" get svc kubernetes -o yaml
+    run2 kubectl "$plugin_name" get svc kubernetes -n default -o yaml
     [ "$status" -eq 0 ]
-    [[ $output == "apiVersion"* ]]
+    [[ $stdout == "apiVersion"* ]]
 }