mirrors/turtle
3
0
Fork 0
mirror of https://github.com/mat007/turtle.git synced 2026-06-22 12:13:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document test/mock_error.hpp

Browse source 
Those test-only macros and structs are a bit tricky to read.
This commit is contained in:
Alexander Grund 2022-01-25 16:24:37 +01:00
parent 51fcd4f4b9
commit cdb4c1494a
No known key found for this signature in database
GPG key ID: AA48A0760367A42B
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

20
test/mock_error.hpp
View file

@ -15,6 +15,7 @@
#include <sstream> #include <sstream>
#include <stdexcept> #include <stdexcept>
/// Container to hold data about mocked function calls (and expectation errors)
struct mock_error_data_t : mock::detail::singleton<mock_error_data_t> struct mock_error_data_t : mock::detail::singleton<mock_error_data_t>
{ {
void reset() void reset()
@ -41,16 +42,15 @@ struct mock_error_data_t : mock::detail::singleton<mock_error_data_t>
++error_count; ++error_count;
} }
int error_count; int call_count = 0;
int call_count; int error_count = 0;
std::string last_message; std::string last_message, last_context, last_file;
std::string last_context; int last_line = 0;
std::string last_file;
int last_line;
MOCK_SINGLETON_CONS(mock_error_data_t); MOCK_SINGLETON_CONS(mock_error_data_t);
}; };
MOCK_SINGLETON_INST(mock_error_data) MOCK_SINGLETON_INST(mock_error_data)
/// Error handler that populates the mock_error_data singleton instead of failing
template<typename Result> template<typename Result>
struct mock_error struct mock_error
{ {
@ -73,6 +73,8 @@ struct mock_error
} }
}; };
/// Fixture to use CHECK_CALLS & CHECK_ERROR: Initializes the mock_error_data singleton
/// Verifies there are no pending verifications on end of the test
struct mock_error_fixture struct mock_error_fixture
{ {
mock_error_fixture() { mock_error_data.reset(); } mock_error_fixture() { mock_error_data.reset(); }
@ -83,9 +85,15 @@ struct mock_error_fixture
} }
}; };
/// Check that the number of calls to mocked function equals the given amount
/// and resets them (for the next check and cleanup)
#define CHECK_CALLS(calls) \ #define CHECK_CALLS(calls) \
BOOST_CHECK_EQUAL(calls, mock_error_data.call_count); \ BOOST_CHECK_EQUAL(calls, mock_error_data.call_count); \
mock_error_data.call_count = 0; mock_error_data.call_count = 0;
/// Similar to BOOST_CHECK_THROW:
/// Checks that running `expr` leads to an error of the set expectations,
/// that the error message equals `error`, with the given `context`
/// and `calls` mocked functions were called.
#define CHECK_ERROR(expr, error, calls, context) \ #define CHECK_ERROR(expr, error, calls, context) \
BOOST_CHECK(mock_error_data.verify()); \ BOOST_CHECK(mock_error_data.verify()); \
try \ try \