feat: improve assert_have_been_called_with arg matching

Author: Chemaclass

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Improve `assert_have_been_called_with` with strict argument matching
+
 ## [0.23.0](https://github.com/TypedDevs/bashunit/compare/0.22.3...0.23.0) - 2025-08-03
 
 - Update docs mocks usage

docs/test-doubles.md

@@ -87,7 +87,7 @@ function test_example() {
 
   ps foo bar
 
-  assert_have_been_called_with "foo bar" ps
+  assert_have_been_called_with ps "foo bar"
   assert_have_been_called ps
 }
 ```
@@ -117,11 +117,12 @@ function test_failure() {
 :::
 
 ## assert_have_been_called_with
-> `assert_have_been_called_with "expected" "spy" [call_index]`
+> `assert_have_been_called_with spy expected [call_index] [--strict]`
 
 Reports an error if `spy` is not called with `expected`. When `call_index` is
 provided, the assertion checks the arguments of that specific call (starting at
-1). Without `call_index` it checks the last invocation.
+1). Without `call_index` it checks the last invocation. The optional `--strict`
+flag forces an exact match on argument boundaries.
 
 ::: code-group
 ```bash [Example]
@@ -131,20 +132,31 @@ function test_success() {
   ps foo
   ps bar
 
-  assert_have_been_called_with "foo" ps 1
-  assert_have_been_called_with "bar" ps 2
+  assert_have_been_called_with ps "foo" 1
+  assert_have_been_called_with ps "bar" 2
 }
 
 function test_failure() {
   spy ps
 
   ps bar
 
-  assert_have_been_called_with "foo" ps 1
+  assert_have_been_called_with ps "foo" 1
 }
 ```
 :::
 
+### Argument boundaries
+
+By default, `assert_have_been_called_with` joins arguments with spaces before comparison. This means a call like `ps "foo bar"` is indistinguishable from `ps foo bar`. Use the `--strict` flag to force an exact match on argument boundaries:
+
+```bash
+spy ps
+ps "foo bar"
+assert_have_been_called_with ps "foo bar" --strict # succeeds
+assert_have_been_called_with ps foo bar --strict   # fails
+```
+
 ## assert_have_been_called_times
 > assert_have_been_called_times "expected" "spy"
 

src/test_doubles.sh

@@ -52,7 +52,14 @@ function spy() {
   export "${variable}_params_file"="$params_file"
 
   eval "function $command() {
-    echo \"\$*\" >> '$params_file'
+    local raw=\"\$*\"
+    local serialized=\"\"
+    local arg
+    for arg in \"\$@\"; do
+      serialized+=\"\$(printf '%q' \"\$arg\")$'\\x1f'\"
+    done
+    serialized=\${serialized%$'\\x1f'}
+    printf '%s|%s\\n' \"\$raw\" \"\$serialized\" >> '$params_file'
     local _c=\$(cat '$times_file')
     _c=\$((_c+1))
     echo \"\$_c\" > '$times_file'
@@ -84,37 +91,60 @@ function assert_have_been_called() {
 }
 
 function assert_have_been_called_with() {
-  local expected=$1
-  local command=$2
-  local third_arg="${3:-}"
-  local fourth_arg="${4:-}"
+  local command=$1
+  shift
+
+  local strict=false
+  if [[ ${!#} == "--strict" ]]; then
+    strict=true
+    set -- "${@:1:$#-1}"
+  fi
 
   local index=""
-  local label=""
-  if [[ -n $third_arg && $third_arg =~ ^[0-9]+$ ]]; then
-    index=$third_arg
-    label="${fourth_arg:-$(helper::normalize_test_function_name "${FUNCNAME[1]}")}"
-  else
-    label="${third_arg:-$(helper::normalize_test_function_name "${FUNCNAME[1]}")}"
-    index="$fourth_arg"
+  if [[ ${!#} =~ ^[0-9]+$ ]]; then
+    index=${!#}
+    set -- "${@:1:$#-1}"
   fi
 
+  local expected=("$@")
+
   local variable
   variable="$(helper::normalize_variable_name "$command")"
   local file_var="${variable}_params_file"
-  local params=""
+  local line=""
   if [[ -f "${!file_var-}" ]]; then
     if [[ -n $index ]]; then
-      params=$(sed -n "${index}p" "${!file_var}")
+      line=$(sed -n "${index}p" "${!file_var}")
     else
-      params=$(tail -n 1 "${!file_var}")
+      line=$(tail -n 1 "${!file_var}")
     fi
   fi
 
-  if [[ "$expected" != "$params" ]]; then
-    state::add_assertions_failed
-    console_results::print_failed_test "${label}" "${expected}" "but got " "$params"
-    return
+  local raw recorded
+  IFS='|' read -r raw recorded <<<"$line"
+
+  if [[ $strict == true ]]; then
+    local serialized=""
+    local arg
+    for arg in "${expected[@]}"; do
+      serialized+="$(printf '%q' "$arg")$'\x1f'"
+    done
+    serialized=${serialized%$'\x1f'}
+    if [[ "$serialized" != "$recorded" ]]; then
+      state::add_assertions_failed
+      local expected_joined="${expected[*]}"
+      console_results::print_failed_test "$(helper::normalize_test_function_name \
+        "${FUNCNAME[1]}")" "${expected_joined}" "but got " "$raw"
+      return
+    fi
+  else
+    local expected_raw="${expected[*]}"
+    if [[ "$expected_raw" != "$raw" ]]; then
+      state::add_assertions_failed
+      console_results::print_failed_test "$(helper::normalize_test_function_name \
+        "${FUNCNAME[1]}")" "${expected_raw}" "but got " "$raw"
+      return
+    fi
   fi
 
   state::add_assertions_passed

tests/unit/dependencies_test.sh

@@ -4,48 +4,48 @@ function test_has_perl_search_path_for_perl() {
   spy command
   dependencies::has_perl
 
-  assert_have_been_called_with "-v perl" command
+  assert_have_been_called_with command "-v perl"
 }
 
 function test_has_adjtimex() {
   spy command
   dependencies::has_adjtimex
 
-  assert_have_been_called_with "-v adjtimex" command
+  assert_have_been_called_with command "-v adjtimex"
 }
 
 function test_has_bc() {
   spy command
 
   dependencies::has_bc
 
-  assert_have_been_called_with "-v bc" command
+  assert_have_been_called_with command "-v bc"
 }
 
 function test_has_awk() {
   spy command
   dependencies::has_awk
 
-  assert_have_been_called_with "-v awk" command
+  assert_have_been_called_with command "-v awk"
 }
 
 function test_has_git() {
   spy command
   dependencies::has_git
 
-  assert_have_been_called_with "-v git" command
+  assert_have_been_called_with command "-v git"
 }
 
 function test_has_python() {
   spy command
   dependencies::has_python
 
-  assert_have_been_called_with "-v python" command
+  assert_have_been_called_with command "-v python"
 }
 
 function test_has_node() {
   spy command
   dependencies::has_node
 
-  assert_have_been_called_with "-v node" command
+  assert_have_been_called_with command "-v node"
 }

tests/unit/test_doubles_test.sh

@@ -33,7 +33,7 @@ function test_successful_spy() {
   spy ps
   ps a_random_parameter_1 a_random_parameter_2
 
-  assert_have_been_called_with "a_random_parameter_1 a_random_parameter_2" ps
+  assert_have_been_called_with ps "a_random_parameter_1 a_random_parameter_2"
   assert_have_been_called ps
 }
 
@@ -122,7 +122,7 @@ function test_spy_called_in_subshell() {
   assert_same "done" "$result"
   assert_have_been_called spy_called_in_subshell
   assert_have_been_called_times 2 spy_called_in_subshell
-  assert_have_been_called_with "2025-05-23" spy_called_in_subshell
+  assert_have_been_called_with spy_called_in_subshell "2025-05-23"
 }
 
 function test_mock_called_in_subshell() {
@@ -144,8 +144,18 @@ function test_spy_called_with_different_arguments() {
   ps first_a first_b
   ps second
 
-  assert_have_been_called_with "first_a first_b" ps 1
-  assert_have_been_called_with "second" ps 2
+  assert_have_been_called_with ps "first_a first_b" 1
+  assert_have_been_called_with ps "second" 2
+}
+
+function test_strict_argument_matching() {
+  spy ps
+
+  ps "arg1 arg2"
+  ps arg1 arg2
+
+  assert_have_been_called_with ps "arg1 arg2" 1 --strict
+  assert_have_been_called_with ps arg1 arg2 2 --strict
 }
 
 function test_spy_successful_not_called() {