Merge pull request #511 from carlfriedrich/feat/pass-args-to-mocked-functions

Pass arguments to mocked functions

Author: Chemaclass

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Pass arguments to mocked functions
 - Fix lifecycle hooks not catching failing commands (exit code errors)
 
 ## [0.26.0](https://github.com/TypedDevs/bashunit/compare/0.25.0...0.26.0) - 2025-11-02

docs/test-doubles.md

@@ -75,6 +75,36 @@ function test_example() {
 ```
 :::
 
+All arguments passed to the original call are forwarded to the mocked function, so you can mock different behavior depending on the arguments.
+
+::: code-group
+```bash [Example]
+mockTool() {
+  if [[ "$1" == "--version" ]]; then
+    echo "1.2.3"
+    return 0
+  else
+    echo "tool: '$1' is not a valid command."
+    return 1
+  fi
+}
+
+test_example() {
+  local output
+  mock tool mockTool
+
+  output="$(tool --version)"
+  assert_successful_code
+  assert_same "1.2.3" "${output}"
+
+  output="$(tool foo)"
+  assert_general_error
+  assert_contains "is not a valid command" "${output}"
+}
+
+```
+:::
+
 ## spy
 > `spy "function"`
 

src/test_doubles.sh

@@ -27,7 +27,7 @@ function mock() {
   shift
 
   if [[ $# -gt 0 ]]; then
-    eval "function $command() { $* ; }"
+    eval "function $command() { $* \"\$@\"; }"
   else
     eval "function $command() { echo \"$($CAT)\" ; }"
   fi

tests/acceptance/install_test.sh

@@ -138,8 +138,8 @@ function test_install_downloads_the_non_stable_beta_version() {
     skip "curl or wget not installed" && return
   fi
 
-  mock date echo "2023-11-13"
-  mock tput echo ""
+  mock date <<< "2023-11-13"
+  mock tput <<< ""
   local installed_bashunit="./deps/bashunit"
   local output
 

tests/unit/clock_test.sh

@@ -24,7 +24,7 @@ function mock_date_seconds() {
 
 function test_now_with_perl() {
   mock clock::shell_time mock_non_existing_fn
-  mock perl echo "1720705883457"
+  mock perl <<< "1720705883457"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
@@ -35,7 +35,7 @@ function test_now_on_linux_unknown() {
   mock_unknown_linux_os
   mock clock::shell_time mock_non_existing_fn
   mock perl mock_non_existing_fn
-  mock date echo "1720705883457"
+  mock date <<< "1720705883457"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
@@ -45,7 +45,7 @@ function test_now_on_linux_unknown() {
 function test_now_on_linux_alpine() {
   mock_alpine_os
   mock clock::shell_time mock_non_existing_fn
-  mock perl echo "1720705883457"
+  mock perl <<< "1720705883457"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
@@ -56,7 +56,7 @@ function test_now_on_windows_without_with_powershell() {
   mock_windows_os
   mock dependencies::has_perl mock_false
   mock dependencies::has_powershell mock_true
-  mock powershell echo "1727768183281580800"
+  mock powershell <<< "1727768183281580800"
   mock clock::shell_time mock_non_existing_fn
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
@@ -68,7 +68,7 @@ function test_now_on_windows_without_without_powershell() {
   mock_windows_os
   mock dependencies::has_perl mock_false
   mock dependencies::has_powershell mock_false
-  mock date echo "1727768951"
+  mock date <<< "1727768951"
   mock clock::shell_time mock_non_existing_fn
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
@@ -94,24 +94,24 @@ function test_now_on_osx_without_perl() {
 
   mock_macos
   mock dependencies::has_perl mock_false
-  mock clock::shell_time echo "1727708708.326957"
+  mock clock::shell_time <<< "1727708708.326957"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
   assert_same "1727708708326957000" "$(clock::now)"
 }
 
 function test_runtime_in_milliseconds_when_not_empty_time() {
-  mock perl echo "1720705883457"
+  mock perl <<< "1720705883457"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
   assert_not_empty "$(clock::total_runtime_in_milliseconds)"
 }
 
 function test_now_prefers_perl_over_shell_time() {
-  mock clock::shell_time echo "1234.0"
-  mock perl echo "999999999999"
+  mock clock::shell_time <<< "1234.0"
+  mock perl <<< "999999999999"
   mock dependencies::has_python mock_false
   mock dependencies::has_node mock_false
 
@@ -121,9 +121,9 @@ function test_now_prefers_perl_over_shell_time() {
 function test_now_prefers_python_over_node() {
   mock perl mock_non_existing_fn
   mock dependencies::has_python mock_true
-  mock python echo "777777777777"
+  mock python <<< "777777777777"
   mock dependencies::has_node mock_true
-  mock node echo "888888888888"
+  mock node <<< "888888888888"
 
   assert_same "777777777777" "$(clock::now)"
 }

tests/unit/console_results_test.sh

@@ -315,10 +315,10 @@ function test_render_execution_time_on_osx_with_perl() {
   mock dependencies::has_adjtimex mock_false
   mock dependencies::has_perl mock_true
   _START_TIME="1726393394574382186"
-  mock perl echo "1726393394574372186"
-  mock uname echo "Darwin"
+  mock perl <<< "1726393394574372186"
+  mock uname <<< "Darwin"
   render_result=$(
-  mock perl echo "1726393394574372186";
+  mock perl <<< "1726393394574372186";
 
     console_results::render_result
   )