Improve test output

Author: mernen

tests/completion-bundle/test.sh

@@ -9,6 +9,8 @@ _TEST_BINARIES=(ruby bundle rails)
 
 cd "$RAILS_TEST_APP_DIR"
 
+print-binary-versions
+
 begin-test 'should offer basic commands'
 (
     test-completion bundle ''
@@ -39,3 +41,5 @@ begin-test 'should trigger completion for subcommands: rails'
     reject install
 )
 end-test
+
+end-test-suite

tests/completion-gem/test.sh

@@ -5,6 +5,8 @@ source "$(dirname "$0")/../../completion-gem"
 _TEST_FN=__gem
 _TEST_BINARIES=(ruby gem)
 
+begin-test-suite
+
 begin-test 'should suggest options'
 (
     test-completion gem -
@@ -82,3 +84,5 @@ begin-test 'after unpack should suggest local .gem files'
     rm -f foo.rb foo.gem foo.gemspec
 )
 end-test
+
+end-test-suite

tests/completion-jruby/test.sh

@@ -5,6 +5,8 @@ source "$(dirname "$0")/../../completion-jruby"
 _TEST_FN=__jruby
 _TEST_BINARIES=(jruby)
 
+begin-test-suite
+
 begin-test 'should provide (limited) funcitonality when completion-ruby is not present'
 (
     test-completion jruby -
@@ -34,3 +36,5 @@ begin-test "after --disable should suggest features"
     expect did_you_mean gems rubyopt
 )
 end-test
+
+end-test-suite

tests/completion-rails/test.sh

@@ -5,6 +5,8 @@ source "$(dirname "$0")/../../completion-rails"
 _TEST_FN=__rails
 _TEST_BINARIES=(ruby rails)
 
+begin-test-suite
+
 begin-test 'when outside of a Rails project, should offer the command `new`'
 (
     test-completion rails ''
@@ -36,3 +38,5 @@ begin-test 'completion should work in subdirectories'
     expect controller generator helper model
 )
 end-test
+
+end-test-suite

tests/completion-rake/test.sh

@@ -8,6 +8,8 @@ _TEST_BINARIES=(ruby rake rails)
 
 cd "$RAILS_TEST_APP_DIR"
 
+begin-test-suite
+
 begin-test 'should offer commands from the Rakefile'
 (
     test-completion rake ''
@@ -32,3 +34,5 @@ begin-test 'should suggest options'
     expect --backtrace= '--help ' '--version '
 )
 end-test
+
+end-test-suite

tests/completion-ruby/test.sh

@@ -5,6 +5,8 @@ source "$(dirname "$0")/../../completion-ruby"
 _TEST_FN=__ruby
 _TEST_BINARIES=(ruby)
 
+begin-test-suite
+
 begin-test 'should suggest options'
 (
     test-completion ruby -
@@ -18,3 +20,5 @@ begin-test 'after -S should suggest commands from PATH'
     expect bundle rake
 )
 end-test
+
+end-test-suite

tests/test-utils

@@ -4,30 +4,36 @@
 # This builtin only works in real completions, so stub it for the tests
 compopt() { true; }
 
+begin-test-suite() {
+    print-binary-versions
+    echo
+}
+
+end-test-suite() {
+    true
+}
+
 begin-test() {
     echo "TEST: $1"
 }
 
 end-test() {
     local status=$?
     if [[ $status -eq 0 ]]; then
-        echo 'PASS'
+        echo '  PASS'
         echo
     else
         if [[ -n $_TEST_BINARIES ]]; then
             echo
-            local bin
-            for bin in "${_TEST_BINARIES[@]}"; do
-                "$bin" --version
-            done
+            print-binary-versions
         fi
         exit $status
     fi
 }
 
 test-completion() {
-    print-array 'RUNNING TEST:       ' "$@"
-    _COMPLETION_TEST=($@)
+    _COMPLETION_TEST=($@⇥)
+    print-array '  INPUT:' "${_COMPLETION_TEST[@]}"
     COMP_WORDS=($@)
     COMP_CWORD=$(($# - 1))
     COMP_LINE="$*"
@@ -36,35 +42,35 @@ test-completion() {
 }
 
 expect() {
-    print-array 'EXPECTED RESULT:    ' "$@"
+    print-array '  EXPECTED RESULT:' "$@"
     local word
     for word in "$@"; do
         if ! [[ " ${COMPREPLY[@]} " =~ " $word " ]]; then
-            echo 'Completion failed!'
-            print-array '  Command:   ' "${_COMPLETION_TEST[@]}"
-            print-array '  Output:    ' "${COMPREPLY[@]}"
-            echo "  Missing:    $(printf "%q" "$word")"
+            echo '    Expectation failed!'
+            print-array '    Output:' "${COMPREPLY[@]}"
+            if [[ -n $COMPREPLY ]]; then
+                echo "    Missing:    $(printf "%q" "$word")"
+            fi
             exit 1
         fi >&2
     done
 }
 
 reject() {
-    print-array 'SHOULD NOT INCLUDE: ' "$@"
+    print-array '  SHOULD NOT INCLUDE:' "$@"
     local word
     for word in "$@"; do
         if [[ " ${COMPREPLY[@]} " =~ " $word " ]]; then
-            echo 'Completion failed!'
-            print-array '  Command:   ' "${_COMPLETION_TEST[@]}"
-            print-array '  Output:    ' "${COMPREPLY[@]}"
-            echo "  Unexpected: $(printf "%q" "$word")"
+            echo '    Expectation failed!'
+            print-array '    Output:' "${COMPREPLY[@]}"
+            echo "    Unexpected: $(printf "%q" "$word")"
             exit 1
         fi >&2
     done
 }
 
 print-array() {
-    echo -n "$1"
+    printf '%-22s' "$1"
     if [[ $# -eq 1 ]]; then
         echo ' (empty)'
         return
@@ -75,3 +81,11 @@ print-array() {
     done
     echo
 }
+
+print-binary-versions() {
+    echo 'Versions:'
+    local bin
+    for bin in "${_TEST_BINARIES[@]}"; do
+        "$bin" --version || echo "`$bin --version` failed with status $?" >&2
+    done
+}