Show complete/incomplete calls in error messages. Closes #10.

Author: ryanplusplus

rockspecs/mach-git-0.rockspec

@@ -17,8 +17,10 @@ build = {
     ['mach'] = 'mach.lua',
     ['mach.Expectation'] = 'mach/Expectation.lua',
     ['mach.ExpectedCall'] = 'mach/ExpectedCall.lua',
+    ['mach.CompletedCall'] = 'mach/CompletedCall.lua',
     ['mach.unexpected_call_error'] = 'mach/unexpected_call_error.lua',
     ['mach.unexpected_args_error'] = 'mach/unexpected_args_error.lua',
     ['mach.out_of_order_call_error'] = 'mach/out_of_order_call_error.lua',
+    ['mach.call_status_message'] = 'mach/call_status_message.lua',
   }
 }

spec/mach_spec.lua

@@ -16,9 +16,20 @@ describe('The mach library', function()
     local result, actualMessage = pcall(test)
     _, _, actualMessage = actualMessage:find(":%w+: (.+)")
 
-    if(result) then
+    if result then
       error('expected failure did not occur')
-    elseif(actualMessage ~= expectedMessage) then
+    elseif not actualMessage:find(expectedMessage, 1, true) then
+      error('expected failure message: "' .. expectedMessage .. '" did not match actual failure message: "' .. actualMessage .. '"')
+    end
+  end
+
+  local function should_fail_with_exactly(expectedMessage, test)
+    local result, actualMessage = pcall(test)
+    _, _, actualMessage = actualMessage:find(":%w+: (.+)")
+
+    if result then
+      error('expected failure did not occur')
+    elseif actualMessage ~= expectedMessage then
       error('expected failure message: "' .. expectedMessage .. '" did not match actual failure message: "' .. actualMessage .. '"')
     end
   end
@@ -480,7 +491,7 @@ describe('The mach library', function()
     end)
   end)
 
-  it('should give mocked functions a default name when none is provided', function()
+  it('should give mocked methods a default name when none is provided', function()
     should_fail_with('unexpected function call <anonymous>(2, 3)', function()
       mach.mock_method()(1, 2, 3)
     end)
@@ -492,4 +503,130 @@ describe('The mach library', function()
       f2()
     end)
   end)
+
+  it('should report completed and incomplete calls in unexpected call errors', function()
+    local expected_failure =
+      'unexpected function call f3()\n' ..
+      'completed calls:\n' ..
+      '\tf1()\n' ..
+      'incomplete calls:\n' ..
+      '\tf2()'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():and_also(f2:should_be_called()):when(function()
+        f1()
+        f3()
+      end)
+    end)
+  end)
+
+  it('should report completed and incomplete calls in unexpected argument errors', function()
+    local expected_failure =
+      'unexpected arguments (3) provided to function f2\n' ..
+      'completed calls:\n' ..
+      '\tf1()\n' ..
+      'incomplete calls:\n' ..
+      '\tf2()'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():and_also(f2:should_be_called()):when(function()
+        f1()
+        f2(3)
+      end)
+    end)
+  end)
+
+  it('should report completed and incomplete calls in out of order call errors', function()
+    local expected_failure =
+      'out of order function call f3()\n' ..
+      'completed calls:\n' ..
+      '\tf1()\n' ..
+      'incomplete calls:\n' ..
+      '\tf2()\n' ..
+      '\tf3()'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():
+        and_then(f2:should_be_called()):
+        and_then(f3:should_be_called()):
+        when(function()
+          f1()
+          f3()
+        end)
+    end)
+  end)
+
+  it('should omit the completed call list in an error when no calls were completed', function()
+    local expected_failure =
+      'unexpected function call f3()\n' ..
+      'incomplete calls:\n' ..
+      '\tf1()'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():when(function()
+        f3()
+      end)
+    end)
+  end)
+
+  it('should omit the incomplete call list in an error when all calls were completed', function()
+    local expected_failure =
+      'unexpected function call f3()\n' ..
+      'completed calls:\n' ..
+      '\tf1()'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():when(function()
+        f1()
+        f3()
+      end)
+    end)
+  end)
+
+  it('should show methods in call status messages', function()
+    local o = {
+      m = mach.mock_method('m')
+    }
+
+    local expected_failure =
+      'unexpected function call f()\n' ..
+      'incomplete calls:\n' ..
+      '\tm()'
+
+    should_fail_with_exactly(expected_failure, function()
+      o.m:should_be_called():when(function()
+          f()
+        end)
+    end)
+  end)
+
+  it('should show optional function calls as optional in call status messages', function()
+    local expected_failure =
+      'unexpected function call f3()\n' ..
+      'completed calls:\n' ..
+      '\tf1()\n' ..
+      'incomplete calls:\n' ..
+      '\tf2() (optional)'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called():and_also(f2:may_be_called()):when(function()
+        f1()
+        f3()
+      end)
+    end)
+  end)
+
+  it('should show actual arguments in call status messages', function()
+    local expected_failure =
+      'unexpected function call f3()\n' ..
+      'completed calls:\n' ..
+      '\tf1(1, 2, 3)'
+
+    should_fail_with_exactly(expected_failure, function()
+      f1:should_be_called_with_any_arguments():when(function()
+        f1(1, 2, 3)
+        f3()
+      end)
+    end)
+  end)
 end)

src/mach.lua

@@ -5,7 +5,7 @@ local unexpected_call_error = require 'mach.unexpected_call_error'
 local mach = {}
 
 function unexpected_call(m, name, args)
-  unexpected_call_error(name, args, 2)
+  unexpected_call_error(name, args, {}, {}, 2)
 end
 
 local subscriber = unexpected_call
@@ -29,7 +29,7 @@ end
 
 function mach.mock_function(name)
   name = name or '<anonymous>'
-  local f = {}
+  local f = { _name = name }
 
   setmetatable(f, {
     __call = function(_, ...)
@@ -44,7 +44,7 @@ end
 
 function mach.mock_method(name)
   name = name or '<anonymous>'
-  local m = {}
+  local m = { _name = name }
 
   setmetatable(m, {
     __call = function(_, _, ...)

src/mach/Expectation.lua

@@ -1,4 +1,5 @@
 local ExpectedCall = require 'mach.ExpectedCall'
+local CompletedCall = require 'mach.CompletedCall'
 local unexpected_call_error = require 'mach.unexpected_call_error'
 local unexpected_args_error = require 'mach.unexpected_args_error'
 local out_of_order_call_error = require 'mach.out_of_order_call_error'
@@ -10,7 +11,8 @@ local function create(m)
   local o = {
     _m = m,
     _call_specified = false,
-    _calls = {}
+    _calls = {},
+    _completed_calls = {}
   }
 
   setmetatable(o, expectation)
@@ -57,7 +59,7 @@ function expectation:when(thunk)
 
         if call:args_match(args) then
           if call:has_fixed_order() and incomplete_expectation_found then
-            out_of_order_call_error(name, args, 2)
+            out_of_order_call_error(name, args, self._completed_calls, self._calls, 2)
           end
 
           if call:has_fixed_order() then
@@ -66,6 +68,8 @@ function expectation:when(thunk)
 
           table.remove(self._calls, i)
 
+          table.insert(self._completed_calls, CompletedCall(name, args))
+
           if call:has_error() then
             error(call:get_error())
           end
@@ -81,9 +85,9 @@ function expectation:when(thunk)
 
     if not self._ignore_other_calls then
       if not valid_function_found then
-        unexpected_call_error(name, args, 2)
+        unexpected_call_error(name, args, self._completed_calls, self._calls, 2)
       else
-        unexpected_args_error(name, args, 2)
+        unexpected_args_error(name, args, self._completed_calls, self._calls, 2)
       end
     end
   end

src/mach/ExpectedCall.lua

@@ -1,6 +1,21 @@
 local expected_call = {}
 expected_call.__index = expected_call
 
+expected_call.__tostring = function(self)
+  local arg_strings = {}
+  for _, arg in ipairs(self._args) do
+    table.insert(arg_strings, tostring(arg))
+  end
+
+  local s = self._f._name .. '(' .. table.concat(arg_strings, ', ') .. ')'
+
+  if not self._required then
+    s = s .. ' (optional)'
+  end
+
+  return s
+end
+
 local function create(f, config)
   local o = {
     _f = f,

src/mach/out_of_order_call_error.lua

@@ -1,8 +1,14 @@
-return function(name, args, level)
+local call_status_message = require 'mach.call_status_message'
+
+return function(name, args, completed_calls, incomplete_calls, level)
   local arg_strings = {}
   for _, arg in ipairs(args) do
     table.insert(arg_strings, tostring(arg))
   end
 
-  error('out of order function call ' .. name .. '(' .. table.concat(arg_strings, ', ') .. ')', level + 1)
+  local error_message =
+    'out of order function call ' .. name .. '(' .. table.concat(arg_strings, ', ') .. ')' ..
+    call_status_message(completed_calls, incomplete_calls)
+
+  error(error_message, level + 1)
 end

src/mach/unexpected_args_error.lua

@@ -1,8 +1,14 @@
-return function(name, args, level)
+local call_status_message = require 'mach.call_status_message'
+
+return function(name, args, completed_calls, incomplete_calls, level)
   local arg_strings = {}
   for _, arg in ipairs(args) do
     table.insert(arg_strings, tostring(arg))
   end
 
-  error('unexpected arguments (' .. table.concat(arg_strings) .. ') provided to function ' .. name, level + 1)
+  local error_message =
+    'unexpected arguments (' .. table.concat(arg_strings) .. ') provided to function ' .. name ..
+    call_status_message(completed_calls, incomplete_calls)
+
+  error(error_message, level + 1)
 end

src/mach/unexpected_call_error.lua

@@ -1,8 +1,14 @@
-return function(name, args, level)
+local call_status_message = require 'mach.call_status_message'
+
+return function(name, args, completed_calls, incomplete_calls, level)
   local arg_strings = {}
   for _, arg in ipairs(args) do
     table.insert(arg_strings, tostring(arg))
   end
 
-  error('unexpected function call ' .. name .. '(' .. table.concat(arg_strings, ', ') .. ')', level + 1)
+  local message =
+    'unexpected function call ' .. name .. '(' .. table.concat(arg_strings, ', ') .. ')' ..
+    call_status_message(completed_calls, incomplete_calls)
+
+  error(message, level + 1)
 end