unmock all test doubles after each test

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 - Add multi-invokers; consolidate parameterized-testing documentation
 - Add `fail()` function
+- Add `unmock()` function
+- Remove all test mocks after each test case
 
 ## [0.11.0](https://github.com/TypedDevs/bashunit/compare/0.10.1...0.11.0) - 2024-03-02
 

docs/test-doubles.md

@@ -7,6 +7,8 @@ When creating tests, you might need to override existing function to be able to
 
 Allows you to override the behavior of a callable.
 
+> You can undo a mock function, to revert it to its previous original behaviour, with `unmock`.
+
 ::: code-group
 ```bash [Example]
 function test_example() {
@@ -25,7 +27,31 @@ Allows you to override the output of a callable.
 ```bash [Example]
 function test_example() {
   function code() {
-      ps a | grep bash
+    ps a | grep bash
+  }
+
+  mock ps<<EOF
+PID TTY          TIME CMD
+13525 pts/7    00:00:01 bash
+24162 pts/7    00:00:00 ps
+EOF
+
+  assert_equals "13525 pts/7    00:00:01 bash" "$(code)"
+}
+```
+:::
+
+## unmock
+
+> `unmock "function"`
+
+Undo the previous overridden behavior of a callable using mock.
+
+::: code-group
+```bash [Example]
+function test_example() {
+  function code() {
+    ps a | grep bash
   }
 
   mock ps<<EOF
@@ -34,7 +60,11 @@ PID TTY          TIME CMD
 24162 pts/7    00:00:00 ps
 EOF
 
+  # At this point, ps will return the mocked value above
   assert_equals "13525 pts/7    00:00:01 bash" "$(code)"
+
+  # From now on, ps will have the original behaviour again
+  unmock ps
 }
 ```
 :::

src/runner.sh

@@ -83,7 +83,8 @@ function runner::call_test_functions() {
           runner::run_test "$function_name" "$data"
         done
       else
-        local multi_invoker=$(helper::get_multi_invoker_function "$function_name" "$script")
+        local multi_invoker
+        multi_invoker=$(helper::get_multi_invoker_function "$function_name" "$script")
         if [[ -n "${multi_invoker}" ]]; then
           helper::execute_function_if_exists "${multi_invoker}"
         else
@@ -163,6 +164,7 @@ function runner::run_test() {
     "$function_name" "$@" 2>&1 1>&3
 
     runner::run_tear_down
+    runner::clear_mocks
     state::export_assertions_count
   )
 
@@ -228,6 +230,12 @@ function runner::run_tear_down() {
   helper::execute_function_if_exists 'tear_down'
 }
 
+function runner::clear_mocks() {
+  for i in "${!MOCKED_FUNCTIONS[@]}"; do
+    unmock "${MOCKED_FUNCTIONS[$i]}"
+  done
+}
+
 function runner::run_tear_down_after_script() {
   helper::execute_function_if_exists 'tear_down_after_script'
 }

src/test_doubles.sh

@@ -1,5 +1,19 @@
 #!/bin/bash
 
+declare -a MOCKED_FUNCTIONS=()
+
+function unmock() {
+  local command=$1
+
+  for i in "${!MOCKED_FUNCTIONS[@]}"; do
+    if [[ "${MOCKED_FUNCTIONS[$i]}" == "$command" ]]; then
+      unset "MOCKED_FUNCTIONS[$i]"
+      unset -f "$command"
+      break
+    fi
+  done
+}
+
 function mock() {
   local command=$1
   shift
@@ -11,6 +25,8 @@ function mock() {
   fi
 
   export -f "${command?}"
+
+  MOCKED_FUNCTIONS+=("$command")
 }
 
 function spy() {
@@ -24,6 +40,8 @@ function spy() {
   eval "function $command() { ${variable}_params=(\"\$*\"); ((${variable}_times++)) || true; }"
 
   export -f "${command?}"
+
+  MOCKED_FUNCTIONS+=("$command")
 }
 
 function assert_have_been_called() {

tests/acceptance/mock_test.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+#
+# Make sure that the `runner::clear_mocks()` is being called,
+# removing the mocks and spies from the first test
+#
+function test_runner_clear_mocks_first() {
+  mock ls echo foo
+  assert_equals "foo" "$(ls)"
+
+  spy ps
+  ps foo bar
+  assert_have_been_called_times 1 ps
+}
+
+function test_runner_clear_mocks_second() {
+  assert_not_equals "foo" "$(ls)"
+  assert_have_been_called_times 0 ps
+}