docs: update assert_true/false documentation

Author: Chemaclass

docs/assertions.md

@@ -5,9 +5,9 @@ We provide assertions for these checks.
 Below is their documentation.
 
 ## assert_true
-> `assert_true bool`
+> `assert_true bool|function|command`
 
-Reports an error if the `bool` is truthy `true` or `0`.
+Reports an error if the argument result in a truthy value: `true` or `0`.
 
 - [assert_false](#assert-false) is similar but different.
 
@@ -16,19 +16,30 @@ Reports an error if the `bool` is truthy `true` or `0`.
 function test_success() {
   assert_true true
   assert_true 0
+  assert_true "eval return 0"
+  assert_true mock_true
 }
 
 function test_failure() {
   assert_true false
   assert_true 1
+  assert_true "eval return 1"
+  assert_true mock_false
 }
 ```
+```bash [globals.sh]
+function mock_true() {
+  return 0
+}
+function mock_false() {
+  return 1
+}
 :::
 
 ## assert_false
-> `assert_false bool`
+> `assert_false bool|function|command`
 
-Reports an error if the `bool` is falsy `false` or `1`.
+Reports an error if the argument result in a falsy value: `false` or `1`.
 
 - [assert_true](#assert-true) is similar but different.
 
@@ -37,11 +48,23 @@ Reports an error if the `bool` is falsy `false` or `1`.
 function test_success() {
   assert_false false
   assert_false 1
+  assert_false "eval return 1"
+  assert_false mock_false
 }
 
 function test_failure() {
   assert_false true
   assert_false 0
+  assert_false "eval return 0"
+  assert_false mock_true
+}
+```
+```bash [globals.sh]
+function mock_true() {
+  return 0
+}
+function mock_false() {
+  return 1
 }
 ```
 :::

src/assert.sh

@@ -23,7 +23,7 @@ function assert_true() {
   local exit_code=$?
 
   if [[ $exit_code -ne 0 ]]; then
-    handle_bool_assertion_failure "valid command, function, or true/0" "exit code: $exit_code"
+    handle_bool_assertion_failure "command or function with zero exit code" "exit code: $exit_code"
   else
     state::add_assertions_passed
   fi

tests/unit/assert_test.sh

@@ -40,9 +40,9 @@ function test_unsuccessful_assert_true_on_function() {
   assert_same\
     "$(console_results::print_failed_test\
       "Unsuccessful assert true on function"\
-      "valid command, function, or true/0"\
-      "but got " "exit code: 127")" \
-    "$(assert_true "$(return 1)")"
+      "command or function with zero exit code"\
+      "but got " "exit code: 2")" \
+    "$(assert_true "eval return 2")"
 }
 
 # data_provider provider_successful_assert_false