assert_fails is more consistent than assert_fail

Fix #35 assert_fails is more consistent than assret_fail.
Keeping an assert_fail function to avoid compatibility issue.

Author: pgrange

README.adoc

@@ -76,9 +76,9 @@ To run tests, simply call *bash_unit* with all your tests files as parameter. Fo
 Running tests in tests/test_core.sh
 Running test_assert_equals_fails_when_not_equal... SUCCESS
 Running test_assert_equals_succeed_when_equal... SUCCESS
-Running test_assert_fail_fails... SUCCESS
-Running test_assert_fail_succeeds... SUCCESS
 Running test_assert_fails... SUCCESS
+Running test_assert_fails_fails... SUCCESS
+Running test_assert_fails_succeeds... SUCCESS
 Running test_assert_not_equals_fails_when_equal... SUCCESS
 Running test_assert_not_equals_succeeds_when_not_equal... SUCCESS
 Running test_assert_shows_stderr_on_failure... SUCCESS
@@ -108,9 +108,9 @@ functions against this pattern.
 Running tests in tests/test_core.sh
 Running test_assert_equals_fails_when_not_equal... SUCCESS
 Running test_assert_equals_succeed_when_equal... SUCCESS
-Running test_assert_fail_fails... SUCCESS
-Running test_assert_fail_succeeds... SUCCESS
 Running test_assert_fails... SUCCESS
+Running test_assert_fails_fails... SUCCESS
+Running test_assert_fails_succeeds... SUCCESS
 Running test_assert_not_equals_fails_when_equal... SUCCESS
 Running test_assert_not_equals_succeeds_when_not_equal... SUCCESS
 Running test_assert_shows_stderr_on_failure... SUCCESS
@@ -132,9 +132,9 @@ output with the _-f_ option.
 # Running tests in tests/test_core.sh
 ok - test_assert_equals_fails_when_not_equal
 ok - test_assert_equals_succeed_when_equal
-ok - test_assert_fail_fails
-ok - test_assert_fail_succeeds
 ok - test_assert_fails
+ok - test_assert_fails_fails
+ok - test_assert_fails_succeeds
 ok - test_assert_not_equals_fails_when_equal
 ok - test_assert_not_equals_succeeds_when_not_equal
 ok - test_assert_shows_stderr_on_failure
@@ -287,13 +287,13 @@ code() {
 test_code_does_not_write_cool_in_the_file() {
   code
 
-  assert_fail "grep cool /tmp/the_file" "should not write 'cool' in /tmp/the_file"
+  assert_fails "grep cool /tmp/the_file" "should not write 'cool' in /tmp/the_file"
 }
 
 test_code_does_not_write_this_in_the_file() {
   code
 
-  assert_fail "grep this /tmp/the_file" "should not write 'this' in /tmp/the_file"
+  assert_fails "grep this /tmp/the_file" "should not write 'this' in /tmp/the_file"
 }
 ```
 
@@ -444,7 +444,7 @@ test_code_fails_if_apache_does_not_run() {
 24162 pts/7    00:00:00 ps
 EOF
 
-  assert_fail code "code should fail when apache is not running"
+  assert_fails code "code should fail when apache is not running"
 }
 
 ```

bash_unit

@@ -48,7 +48,7 @@ assert() {
     "\"$message\""
 }
 
-assert_fail() {
+assert_fails() {
   local assertion=$1
   local message=$2
 
@@ -58,6 +58,11 @@ assert_fail() {
     "\"$message\""
 }
 
+assert_fail() {
+  #deprecated, use assert_fails instead
+  assert_fails "$@"
+}
+
 assert_status_code() {
   local expected_status=$1
   local assertion="$2"

tests/test_cli.sh

@@ -16,7 +16,7 @@ EOF
 }
 
 test_exit_code_not_0_in_case_of_failure() {
-  assert_fail "$BASH_UNIT <(cat << EOF
+  assert_fails "$BASH_UNIT <(cat << EOF
 function test_succeed() { assert true ; }
 function test_fails()   { assert false ; }
 EOF
@@ -75,7 +75,7 @@ Running todo_should_not_run... PENDING" \
 }
 
 test_fails_when_test_file_does_not_exist() {
-  assert_fail "$BASH_UNIT /not_exist/not_exist"
+  assert_fails "$BASH_UNIT /not_exist/not_exist"
 }
 
 test_display_usage_when_test_file_does_not_exist() {

tests/test_core.sh

@@ -11,28 +11,28 @@ test_fail_fails() {
 
 #fail can now be used in the following tests
 
-test_assert_fail_succeeds() {
-  (assert_fail false) || fail 'assert_fail should succeed' 
+test_assert_fails_succeeds() {
+  (assert_fails false) || fail 'assert_fails should succeed' 
 }
 
-test_assert_fail_fails() {
-  with_bash_unit_muted assert_fail true && fail 'assert_fail should fail' || true
+test_assert_fails_fails() {
+  with_bash_unit_muted assert_fails true && fail 'assert_fails should fail' || true
 }
 
-#assert_fail can now be used in the following tests
+#assert_fails can now be used in the following tests
 
 test_assert_succeeds() {
   assert true || fail 'assert should succeed'
 }
 
 test_assert_fails() {
-  assert_fail "with_bash_unit_muted assert false" "assert should fail"
+  assert_fails "with_bash_unit_muted assert false" "assert should fail"
 }
 
 #assert can now be used in the following tests
 
 test_assert_equals_fails_when_not_equal() {
-  assert_fail \
+  assert_fails \
     "with_bash_unit_muted assert_equals toto tutu" \
     "assert_equals should fail"
 }
@@ -46,7 +46,7 @@ test_assert_equals_succeed_when_equal() {
 #assert_equals can now be used in the following tests
 
 test_assert_not_equals_fails_when_equal() {
-  assert_fail \
+  assert_fails \
     "with_bash_unit_muted assert_not_equals toto toto" \
     "assert_not_equals should fail"
 }
@@ -75,7 +75,7 @@ test_assert_status_code_succeeds() {
 }
 
 test_assert_status_code_fails() {
-  assert_fail "with_bash_unit_muted assert_status_code 3 true" \
+  assert_fails "with_bash_unit_muted assert_status_code 3 true" \
     "assert_status_code should fail"
 }
 

tests/test_tap_format

@@ -5,7 +5,7 @@ test_bash_unit_accepts_tap_format_option() {
 }
 
 test_bash_unit_rejects_invalid_format() {
-  assert_fail "$BASH_UNIT -f invalid_format"
+  assert_fails "$BASH_UNIT -f invalid_format"
 }
 
 test_tap_format_for_one_succesfull_test() {
@@ -62,7 +62,7 @@ not ok - test_not_ok
 " \
 "$(bash_unit_out_for_code <<EOF
   test_not_ok() {
-    assert_fail "echo message on stdout ; echo message on stderr >&2"
+    assert_fails "echo message on stdout ; echo message on stderr >&2"
   }
 EOF
 )"
@@ -78,7 +78,7 @@ not ok - test_not_ok
 " \
 "$(bash_unit_out_for_code <<EOF
   test_not_ok() {
-    assert_fail true "obvious failure"
+    assert_fails true "obvious failure"
   }
 EOF
 )"
@@ -95,7 +95,7 @@ not ok - test_not_ok
 " \
 "$(bash_unit_out_for_code <<EOF
   test_not_ok() {
-    assert_fail true "obvious failure\non multiple lines"
+    assert_fails true "obvious failure\non multiple lines"
   }
 EOF
 )"