Display overall result in text mode

See https://github.com/pgrange/bash_unit/pull/71/files

We add a notify_suites_succeded and notify_suites_failed so that
this events may be displayed by any formatter.

We use SUCCESS and FAILURE instead of PASS and FAIL just to stick
with the lingo used in the rest of bash_unit.

Author: Pascal Grange

README.adoc

@@ -102,7 +102,7 @@ Running tests in tests/test_core.sh
 	Running test_fake_echo_stdin_when_no_params ... SUCCESS
 	Running test_fake_exports_faked_in_subshells ... SUCCESS
 	Running test_fake_transmits_params_to_fake_code ... SUCCESS
-Overall result: PASS
+Overall result: SUCCESS
 ```
 
 You might also want to run only specific tests, you may do so with the
@@ -128,18 +128,7 @@ Running tests in tests/test_core.sh
 	Running test_assert_status_code_succeeds ... SUCCESS
 	Running test_assert_succeeds ... SUCCESS
 	Running test_fail_fails ... SUCCESS
-Overall result: PASS
-```
-
-The "Overall result:" line at the end can be suppressed with the _-o_ option:
-
-```test
-./bash_unit -o -p test_assert_succeeds tests/test_core.sh
-```
-
-```output
-Running tests in tests/test_core.sh
-	Running test_assert_succeeds ... SUCCESS
+Overall result: SUCCESS
 ```
 
 *bash_unit* supports the http://testanything.org/[Test Anything Protocol] so you can ask for a tap formatted

bash_unit

@@ -306,6 +306,14 @@ text_format() {
   notify_stack() {
     color "$YELLOW"
   }
+  notify_suites_succeded() {
+    echo -n "Overall result: SUCCESS" | pretty_success
+    echo
+  }
+  notify_suites_failed() {
+    echo -n "Overall result: FAILURE" | pretty_failure
+    echo
+  }
 }
 
 tap_format() {
@@ -314,7 +322,7 @@ tap_format() {
     echo "# Running tests in $test_file"
   }
   notify_test_starting() {
-    echo -n
+    :
   }
   notify_test_pending() {
     local test="$1"
@@ -343,12 +351,17 @@ tap_format() {
   notify_stack() {
     "$SED" 's:^:# :' | color "$YELLOW"
   }
+  notify_suites_succeded() {
+    :
+  }
+  notify_suites_failed() {
+    :
+  }
 }
 
 output_format=text
 test_pattern=""
 separator=""
-overall=1
 randomise=0
 while getopts "vp:f:or" option
 do
@@ -360,9 +373,6 @@ do
     f)
       output_format="${OPTARG}"
       ;;
-    o)
-      overall=0
-      ;;
     r)
       randomise=1
       ;;
@@ -389,7 +399,6 @@ case "$output_format" in
     ;;
   tap)
     tap_format
-    overall=0
     ;;
   *)
     usage "unsupported output format: $output_format"
@@ -417,17 +426,11 @@ do
   failure=$(( $? || failure))
 done
 
-# Show the overall result
-if ((overall))
+if ((failure))
 then
-  echo -n "Overall result: "
-  if ((failure))
-  then
-    echo -n "FAIL" | pretty_failure
-  else
-    echo -n "PASS" | pretty_success
-  fi
-  echo
+  notify_suites_failed
+else
+  notify_suites_succeded
 fi
 
 exit $failure

tests/test_cli.sh

@@ -7,7 +7,7 @@ Running tests in code
 	Running test_fails ... FAILURE
 code:2:test_fails()
 	Running test_succeed ... SUCCESS
-Overall resultcode: FAIL\
+Overall resultcode: FAILURE\
 " \
 "$(bash_unit_out_for_code << EOF
   function test_succeed() { assert true ; }
@@ -44,7 +44,7 @@ Running tests in test_file
 	Running test_one ... SUCCESS
 Running tests in test_file
 	Running test_two ... SUCCESS
-Overall result: PASS\
+Overall result: SUCCESS\
 " \
 "$bash_unit_output"
 }
@@ -60,7 +60,7 @@ test_run_only_tests_that_match_pattern() {
 Running tests in test_file
 	Running test_one ... SUCCESS
 Running tests in test_file
-Overall result: PASS" "$bash_unit_output"
+Overall result: SUCCESS" "$bash_unit_output"
 }
 
 test_do_not_run_pending_tests() {
@@ -81,7 +81,7 @@ test_pending_tests_appear_in_output() {
 Running tests in test_file
 	Running pending_should_not_run ... PENDING
 	Running todo_should_not_run ... PENDING
-Overall result: PASS" \
+Overall result: SUCCESS" \
   "$bash_unit_output"
 }
 

tests/test_core.sh

@@ -251,4 +251,6 @@ mute() {
   notify_stack         () { echo -n ; }
   notify_stdout        () { echo -n ; }
   notify_stderr        () { echo -n ; }
+  notify_suites_succeded () { echo -n ; }
+  notify_suites_failed   () { echo -n ; }
 }

tests/test_doc.sh

@@ -6,7 +6,7 @@ LANG=C.UTF-8
 
 export FORCE_COLOR=false
 export STICK_TO_CWD=true
-BASH_UNIT="eval ./bash_unit -o"
+BASH_UNIT="eval ./bash_unit"
 #BASH_UNIT="eval FORCE_COLOR=false ./bash_unit"
 
 prepare_tests() {
@@ -32,12 +32,25 @@ prepare_tests() {
 function run_doc_test() {
   local remaining="$1"
   local swap="$2"
-  $BASH_UNIT <(
-    cat "$remaining" | _next_code "$swap"
-  ) | tail -n +2 | sed -e 's:/dev/fd/[0-9]*:doc:g' 
+  $BASH_UNIT <(cat "$remaining" | _next_code "$swap") \
+  | clean_bash_unit_running_header \
+  | clean_bash_pseudo_files_name \
+  | clean_bash_unit_overall_result
   cat "$swap" > "$remaining"
 }
 
+function clean_bash_unit_running_header() {
+  tail -n +2
+}
+
+function clean_bash_pseudo_files_name() {
+  sed -e 's:/dev/fd/[0-9]*:doc:g'
+}
+
+function clean_bash_unit_overall_result() {
+  sed '$d'
+}
+
 function doc_to_output() {
   local remaining="$1"
   local swap="$2"