73 : file(file), line(line), call(call)
78 : file(file), line(line), call(call), local_info(local_info.str())
82 std::string
format()
const;
84 void format(std::ostream& out)
const;
87 struct TestStack :
public std::vector<TestStackFrame>
109 template<
typename ...Args>
118 template<
typename ...Args>
125 const char*
what() const noexcept
override {
return message.c_str(); }
127 template<
typename ...Args>
128 void add_stack_info(Args&&... args) { stack.emplace_back(std::forward<Args>(args)...); }
135 #define EPT_TEST_INFO(name) \
136 ept::tests::LocationInfo ept_test_location_info; \
137 ept::tests::LocationInfo& name = ept_test_location_info
145 std::stringstream ss;
146 ss <<
"actual value " << actual <<
" is not true";
157 std::stringstream ss;
158 ss <<
"actual value " << actual <<
" is not false";
168 template<
typename A,
typename E>
171 if (actual == expected)
return;
172 std::stringstream ss;
173 ss <<
"value '" << actual <<
"' is different than the expected '" << expected <<
"'";
181 template<
typename A,
typename E>
184 if (actual != expected)
return;
185 std::stringstream ss;
186 ss <<
"value '" << actual <<
"' is not different than the expected '" << expected <<
"'";
191 template<
typename A,
typename E>
194 if (actual < expected)
return;
195 std::stringstream ss;
196 ss <<
"value '" << actual <<
"' is not less than the expected '" << expected <<
"'";
201 template<
typename A,
typename E>
204 if (actual <= expected)
return;
205 std::stringstream ss;
206 ss <<
"value '" << actual <<
"' is not less than or equals to the expected '" << expected <<
"'";
211 template<
typename A,
typename E>
214 if (actual > expected)
return;
215 std::stringstream ss;
216 ss <<
"value '" << actual <<
"' is not greater than the expected '" << expected <<
"'";
221 template<
typename A,
typename E>
224 if (actual >= expected)
return;
225 std::stringstream ss;
226 ss <<
"value '" << actual <<
"' is not greater than or equals to the expected '" << expected <<
"'";
284 void operator==(
const std::string& expected)
const;
286 void operator!=(
const std::string& expected)
const;
287 void operator<(
const std::string& expected)
const;
288 void operator<=(
const std::string& expected)
const;
289 void operator>(
const std::string& expected)
const;
290 void operator>=(
const std::string& expected)
const;
291 void startswith(
const std::string& expected)
const;
292 void endswith(
const std::string& expected)
const;
293 void contains(
const std::string& expected)
const;
295 void matches(
const std::string& re)
const;
303 void startswith(
const std::string& expected)
const;
304 void endswith(
const std::string& expected)
const;
305 void contains(
const std::string& expected)
const;
307 void matches(
const std::string& re)
const;
315 void almost_equal(
double expected,
unsigned places)
const;
330 void throws(
const std::string& what_match)
const;
343 #define wassert(...) \
346 } catch (TestFailed& e) { \
347 e.add_stack_info(__FILE__, __LINE__, #__VA_ARGS__, ept_test_location_info); \
349 } catch (std::exception& e) { \
350 throw TestFailed(e, __FILE__, __LINE__, #__VA_ARGS__, ept_test_location_info); \
354 #define wassert_true(...) wassert(actual(__VA_ARGS__).istrue())
357 #define wassert_false(...) wassert(actual(__VA_ARGS__).isfalse())
366 #define wcallchecked(func) \
369 } catch (TestFailed& e) { \
370 e.add_stack_info(__FILE__, __LINE__, #func, ept_test_location_info); \
372 } catch (std::exception& e) { \
373 throw TestFailed(e, __FILE__, __LINE__, #func, ept_test_location_info); \
404 : test_case(test_case), test_method(test_method) {}
408 error_message = e.
what();
409 error_stack = e.
stack;
410 if (error_message.empty())
411 error_message =
"test failed with an empty error message";
416 error_message = e.what();
417 if (error_message.empty())
418 error_message =
"test threw an exception with an empty error message";
419 exception_typeid =
typeid(e).name();
424 error_message =
"unknown exception caught";
429 error_message =
"[setup failed: ";
430 error_message += e.what();
431 error_message +=
"]";
436 error_message =
"[teardown failed: ";
437 error_message += e.what();
438 error_message +=
"]";
443 return error_message.empty();
468 fail_setup =
"test case setup method threw an unknown exception";
473 fail_setup =
"test case setup method threw an exception: ";
474 fail_setup += e.what();
479 fail_teardown =
"test case teardown method threw an unknown exception";
484 fail_teardown =
"test case teardown method threw an exception: ";
485 fail_teardown += e.what();
490 methods.emplace_back(std::move(e));
495 if (!fail_setup.empty() || !fail_teardown.empty())
return false;
496 for (
const auto& m: methods)
504 struct TestCaseResult;
506 struct TestMethodResult;
605 TestMethod(
const std::string& name, std::function<
void()> test_function)
606 : name(name), test_function(test_function) {}
684 template<
typename ...Args>
685 void add_method(
const std::string& name, std::function<
void()> test_function)
687 methods.emplace_back(name, test_function);
693 template<
typename ...Args>
694 void add_method(
const std::string& name, std::function<
void()> test_function, Args&&... args)
696 methods.emplace_back(name, test_function, std::forward<Args>(args)...);
704 template<
typename FUNC,
typename ...Args>
705 void add_method(
const std::string& name, FUNC test_function, Args&&... args)
707 methods.emplace_back(name, [test_function, args...]() { test_function(args...); });
736 template<
typename FIXTURE>
744 template<
typename... Args>
748 make_fixture = [=]() {
return new Fixture(args...); };
767 if (fixture) fixture->test_setup();
772 if (fixture) fixture->test_teardown();
782 template<
typename FUNC,
typename ...Args>
783 void add_method(
const std::string& name, FUNC test_function, Args&&... args)
785 methods.emplace_back(name, [
this, test_function, args...] { test_function(*fixture, args...); });
793 std::function<void()> test_func;
797 virtual void add_tests() {}
virtual bool test_case_begin(const TestCase &test_case, const TestCaseResult &test_case_result)
Called before running a test case.
Definition: tests.h:523
TestCase(const std::string &name)
Definition: tests.h:622
void test_case_end(const TestCase &test_case, const TestCaseResult &test_case_result) override
Called after running a test case.
Definition: tests.cc:552
void endswith(const std::string &expected) const
Definition: tests.cc:318
static TestRegistry & get()
Get the singleton instance of TestRegistry.
Definition: tests.cc:423
void not_matches(const std::string &re) const
Definition: tests.cc:338
bool test_method_should_run(const std::string &fullname) const
Definition: tests.cc:528
TestFailed(const std::string &message)
Definition: tests.h:116
std::string test_case
Name of the test case.
Definition: tests.h:385
Simple default implementation of TestController.
Definition: tests.h:549
TestFailed(const std::exception &e)
Definition: tests.cc:70
std::vector< TestCaseResult > run_tests(TestController &controller)
Run all the registered tests using the given controller.
Definition: tests.cc:436
virtual void test_method_end(const TestMethod &test_method, const TestMethodResult &test_method_result)
Called after running a test method.
Definition: tests.h:540
LocationInfo()
Definition: tests.h:55
void startswith(const std::string &expected) const
Definition: tests.cc:289
FIXTURE Fixture
Definition: tests.h:739
void add_method(const std::string &name, std::function< void()> test_function)
Register a new test method.
Definition: tests.h:685
void almost_equal(double expected, unsigned places) const
Definition: tests.cc:343
void operator<=(const E &expected) const
Definition: tests.h:271
void operator!=(const E &expected) const
Definition: tests.h:269
const char * file
Definition: tests.h:67
virtual ~TestController()
Definition: tests.h:516
std::string error_message
If non-empty, the test failed with this error.
Definition: tests.h:391
bool test_method_begin(const TestMethod &test_method, const TestMethodResult &test_method_result) override
Called before running a test method.
Definition: tests.cc:563
void operator>=(const std::string &expected) const
Definition: tests.cc:271
ActualStdString(const std::string &s)
Definition: tests.h:301
void add_method(const std::string &name, std::function< void()> test_function, Args &&...args)
Register a new test method.
Definition: tests.h:694
void operator==(const char *expected) const
Definition: tests.cc:213
const char * _actual
Definition: tests.h:278
void assert_equal(const A &actual, const E &expected)
Test function that ensures that the actual value is the same as a reference one.
Definition: tests.h:169
TestMethod(const std::string &name, std::function< void()> test_function)
Definition: tests.h:605
TestStackFrame(const char *file, int line, const char *call)
Definition: tests.h:72
Definition: packagerecord-test.cc:4
virtual bool test_method_begin(const TestMethod &test_method, const TestMethodResult &test_method_result)
Called before running a test method.
Definition: tests.h:535
void set_setup_exception(std::exception &e)
Definition: tests.h:427
void not_contains(const std::string &expected) const
Definition: tests.cc:328
void set_exception(std::exception &e)
Definition: tests.h:414
void contains(const std::string &expected) const
Definition: tests.cc:323
void isfalse() const
Definition: tests.h:267
String functions.
Definition: apt.cc:38
TestStack error_stack
Stack frame of where the error happened.
Definition: tests.h:394
void assert_not_contains(const std::string &actual, const std::string &expected)
Ensure that the string actual does not contain expected.
Definition: tests.cc:135
void operator<(const std::string &expected) const
Definition: tests.cc:253
virtual void test_setup()
Definition: tests.h:727
void assert_less_equal(const A &actual, const E &expected)
Ensure that the actual value is less or equal than the reference value.
Definition: tests.h:202
const char * call
Definition: tests.h:69
std::string local_info
Definition: tests.h:70
void set_setup_failed(std::exception &e)
Definition: tests.h:471
Base class for test fixtures.
Definition: tests.h:722
bool skipped
Set to true if this test case has been skipped.
Definition: tests.h:462
void not_contains(const std::string &expected) const
Definition: tests.cc:307
bool test_case_begin(const TestCase &test_case, const TestCaseResult &test_case_result) override
Called before running a test case.
Definition: tests.cc:539
void matches(const std::string &re) const
Definition: tests.cc:333
Fixture * fixture
Definition: tests.h:741
void set_setup_failed()
Definition: tests.h:466
TestStack stack
Definition: tests.h:105
virtual void register_tests()=0
This will be called before running the test case, to populate it with its test methods.
void set_teardown_exception(std::exception &e)
Definition: tests.h:434
std::string backtrace() const
Return the formatted backtrace for this location.
Definition: tests.cc:58
void assert_not_re_matches(const std::string &actual, const std::string &expected)
Ensure that the string actual does not match the extended regular expression expected.
Definition: tests.cc:188
void assert_greater_equal(const A &actual, const E &expected)
Ensure that the actual value is greather or equal than the reference value.
Definition: tests.h:222
std::string exception_typeid
If non-empty, the test raised an exception and this is its type ID.
Definition: tests.h:397
Abstract interface for the objects that supervise test execution.
Definition: tests.h:514
std::vector< TestMethodResult > methods
Outcome of all the methods that have been run.
Definition: tests.h:455
Result of running a test method.
Definition: tests.h:382
virtual ~TestCase()
Definition: tests.h:627
virtual void test_case_end(const TestCase &test_case, const TestCaseResult &test_case_result)
Called after running a test case.
Definition: tests.h:528
void operator>(const std::string &expected) const
Definition: tests.cc:265
Test case that includes a fixture.
Definition: tests.h:737
std::string message
Definition: tests.h:104
void assert_not_equal(const A &actual, const E &expected)
Test function that ensures that the actual value is different than a reference one.
Definition: tests.h:182
void not_matches(const std::string &re) const
Definition: tests.cc:283
TestFailed(const std::string &message, Args &&...args)
Definition: tests.h:119
void operator<(const E &expected) const
Definition: tests.h:270
std::string test_case
Name of the test case.
Definition: tests.h:453
A _actual
Definition: tests.h:262
TestMethodResult(const std::string &test_case, const std::string &test_method)
Definition: tests.h:403
std::function< void()> test_function
Main body of the test method.
Definition: tests.h:603
Test method information.
Definition: tests.h:597
virtual void method_setup(TestMethodResult &)
Set up before the test method is run.
Definition: tests.h:651
void assert_startswith(const std::string &actual, const std::string &expected)
Ensure that the string actual starts with expected.
Definition: tests.cc:111
void operator<=(const std::string &expected) const
Definition: tests.cc:259
void set_teardown_failed(std::exception &e)
Definition: tests.h:482
std::string format() const
Definition: tests.cc:32
void contains(const std::string &expected) const
Definition: tests.cc:301
void operator!=(const char *expected) const
Definition: tests.cc:239
Information about one stack frame in the test execution stack.
Definition: tests.h:65
std::string name
Name of the test case.
Definition: tests.h:617
const char * what() const noexceptoverride
Definition: tests.h:125
~Actual()
Definition: tests.h:264
std::vector< TestMethod > methods
All registered test methods.
Definition: tests.h:620
std::function< Fixture *()> make_fixture
Definition: tests.h:742
void assert_endswith(const std::string &actual, const std::string &expected)
Ensure that the string actual ends with expected.
Definition: tests.cc:119
void add_stack_info(Args &&...args)
Definition: tests.h:128
void operator>=(const E &expected) const
Definition: tests.h:273
void teardown() override
Clean up after the test case is run.
Definition: tests.h:757
void register_test_case(TestCase &test_case)
Register a new test case.
Definition: tests.cc:431
std::vector< TestCase * > entries
All known test cases.
Definition: tests.h:575
void assert_true(std::nullptr_t actual)
Definition: tests.cc:197
void setup() override
Set up the test case before it is run.
Definition: tests.h:751
Actual(const A &actual)
Definition: tests.h:263
void assert_contains(const std::string &actual, const std::string &expected)
Ensure that the string actual contains expected.
Definition: tests.cc:127
Actual< A > actual(const A &actual)
Definition: tests.h:320
void matches(const std::string &re) const
Definition: tests.cc:277
void assert_greater(const A &actual, const E &expected)
Ensure that the actual value is greater than the reference value.
Definition: tests.h:212
void assert_false(std::nullptr_t actual)
Definition: tests.cc:202
void istrue() const
Definition: tests.h:281
int line
Definition: tests.h:68
void endswith(const std::string &expected) const
Definition: tests.cc:295
Add information to the test backtrace for the tests run in the current scope.
Definition: tests.h:53
virtual ~Fixture()
Definition: tests.h:724
bool is_success() const
Definition: tests.h:493
FixtureTestCase(const std::string &name, Args...args)
Definition: tests.h:745
std::string fail_teardown
Set to a non-empty string if the teardown method of the test case failed.
Definition: tests.h:460
void add_method(const std::string &name, FUNC test_function, Args &&...args)
Add a method that takes a reference to the fixture as argument.
Definition: tests.h:783
std::string whitelist
Any method not matching this glob expression will not be run.
Definition: tests.h:552
void assert_re_matches(const std::string &actual, const std::string &expected)
Ensure that the string actual matches the extended regular expression expected.
Definition: tests.cc:179
void method_teardown(TestMethodResult &mr) override
Clean up after the test method is run.
Definition: tests.h:770
virtual void setup()
Set up the test case before it is run.
Definition: tests.h:641
void istrue() const
Definition: tests.h:266
std::string name
Name of the test method.
Definition: tests.h:600
virtual void test_teardown()
Definition: tests.h:730
virtual TestCaseResult run_tests(TestController &controller)
Call setup(), run all the tests that have been registered, then call teardown().
Definition: tests.cc:448
virtual void teardown()
Clean up after the test case is run.
Definition: tests.h:646
virtual TestMethodResult run_test(TestController &controller, TestMethod &method)
Run a test method.
Definition: tests.cc:483
void set_failed(TestFailed &e)
Definition: tests.h:406
void set_unknown_exception()
Definition: tests.h:422
std::string test_method
Name of the test method.
Definition: tests.h:388
struct ept::apt::AptImplementation tests
bool skipped
True if the test has been skipped.
Definition: tests.h:400
void operator==(const E &expected) const
Definition: tests.h:268
void method_setup(TestMethodResult &mr) override
Set up before the test method is run.
Definition: tests.h:764
TestCaseResult(const std::string &test_case)
Definition: tests.h:464
void operator>(const E &expected) const
Definition: tests.h:272
std::string fail_setup
Set to a non-empty string if the setup method of the test case failed.
Definition: tests.h:457
ActualFunction actual_function(std::function< void()> actual)
Definition: tests.h:333
TestStackFrame(const char *file, int line, const char *call, const LocationInfo &local_info)
Definition: tests.h:77
void assert_less(const A &actual, const E &expected)
Ensure that the actual value is less than the reference value.
Definition: tests.h:192
Result of running a whole test case.
Definition: tests.h:450
void test_method_end(const TestMethod &test_method, const TestMethodResult &test_method_result) override
Called after running a test method.
Definition: tests.cc:569
void isfalse() const
Definition: tests.h:282
TestFailed(const std::exception &e, Args &&...args)
Definition: tests.h:110
void add_test_method(TestMethodResult &&e)
Definition: tests.h:488
void startswith(const std::string &expected) const
Definition: tests.cc:313
Exception raised when a test assertion fails, normally by Location::fail_test.
Definition: tests.h:102
virtual void method_teardown(TestMethodResult &)
Clean up after the test method is run.
Definition: tests.h:656
std::string blacklist
Any method matching this glob expression will not be run.
Definition: tests.h:555
void not_almost_equal(double expected, unsigned places) const
Definition: tests.cc:352
const ept::tests::LocationInfo ept_test_location_info
Definition: tests.cc:23
Test case collecting several test methods, and self-registering with the singleton instance of TestRe...
Definition: tests.h:614
bool is_success() const
Definition: tests.h:441
void set_teardown_failed()
Definition: tests.h:477
ActualCString(const char *s)
Definition: tests.h:279
std::ostream & operator()()
Clear the current information and return the output stream to which new information can be sent...
Definition: tests.cc:100
Test registry.
Definition: tests.h:572
void add_method(const std::string &name, FUNC test_function, Args &&...args)
Register a new test metheod, with arguments.
Definition: tests.h:705