Validate arguments on mocks

This is the first working version, will only support
ordered successive calls, upcoming change should have
param-base action triggers

README.md

@@ -43,7 +43,7 @@ clean.sh
 test
 
     test_clean_works() {
-        mock rm --and exit-code 0
+        mock rm --with-args "somewhere/some-file" --and exit-code 0
 
         bash ./clean.sh some-file
 

examples/2-mocking/test/test_clean.sh

@@ -1,15 +1,15 @@
 #!/bin/bash
 
 test_clean_works() {
-    mock rm --and exit-code 0
+    mock rm --with-args "somewhere/some-file" --and exit-code 0
 
     bash ./clean.sh some-file
 
     assert ${?} succeeded
 }
 
 test_clean_works_fails() {
-    mock rm --and exit-code 1
+    mock rm --with-args "somewhere/non-existing-file" --and exit-code 1
 
     bash ./clean.sh non-existing-file
 

src/mocking.sh

@@ -1,4 +1,3 @@
-
 action-echo() {
     text="$@"
     cat <<EOF
@@ -13,22 +12,51 @@ exit ${return_code}
 EOF
 }
 
+validate-args() {
+    expected="$@"
+    cat <<EOF
+args="\$@"
+
+if [ "\${args}" != "${expected}" ]; then
+
+    cat <<OUT
+Unexpected invocation for command 'some-command':
+Got :      <"\${args}">
+Expected : <"${expected}">
+OUT
+    exit 1
+fi
+EOF
+}
+
 mock() {
     local executable=$1; shift
     local actions=()
     local actions_params=()
     local action_count=0
+    local has_args_validation=false
 
     while [[ $# -gt 0 ]]; do
-        key="$1"
+        local key="$1"
 
         case ${key} in
             --and)
-            actions[$action_count]="$2"
+            actions[$action_count]="action-$2"
             actions_params[$action_count]="$3"
             shift; shift
             ((action_count=action_count + 1))
             ;;
+            --with-args)
+            if [ ${has_args_validation} == false ]; then
+                actions[$action_count]="validate-args"
+                actions_params[$action_count]="$2"; shift
+                ((action_count=action_count + 1))
+                has_args_validation=true
+            else
+                echo "Cannot expect more than 1 set of argument for an invocation, please use 'mock' multiple times"
+                return 1
+            fi
+            ;;
         esac
         shift
     done
@@ -52,9 +80,8 @@ mock() {
 
     echo "#!/bin/bash" > ${invocation_file}
 
-    for i in ${!actions[@]};
-    do
-        action-${actions[$i]} ${actions_params[$i]} >> ${invocation_file}
+    for i in ${!actions[@]}; do
+        ${actions[$i]} ${actions_params[$i]} >> ${invocation_file}
     done
 
     chmod +x ${invocation_file}
@@ -63,13 +90,16 @@ mock() {
 _mock_handler() {
     cat <<EOF
 #!/bin/bash
+args="\$@"
+
 workspace=$1
+
 invocation_index=\$(cat \${workspace}/invocation_index)
 
 if [ \${invocation_index} -lt \$(cat \${workspace}/invocation_count) ]; then
     echo \$((invocation_index + 1)) > \${workspace}/invocation_index
 fi
 
-\${workspace}/invocation_\${invocation_index}
+\${workspace}/invocation_\${invocation_index} \${args}
 EOF
 }

test/test_mocking_args_matching.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+test_fails_if_given_arguments_isnt_right() {
+    mock some-command --with-args "one two three"
+
+    some-command three two one > assertion_output
+    assert ${?} failed
+
+    expected_error=$(cat <<-EXP
+Unexpected invocation for command 'some-command':
+Got :      <"three two one">
+Expected : <"one two three">
+EXP
+)
+    assert "$(cat assertion_output)" equals "${expected_error}"
+}
+
+test_fails_if_2_with_args_argments_are_given() {
+    mock some-command --with-args "a" --with-args "b" > error
+    assert ${?} failed
+
+    assert "$(cat error)" equals "Cannot expect more than 1 set of argument for an invocation, please use 'mock' multiple times"
+}