tests/harness/testsuite.h File Reference
#include "noreturn.h"#include "output.h"#include "stringutils.h"#include <iomanip>#include <map>#include <sstream>#include <string>#include <vector>#include <cfloat>#include "testmacros.h"
Go to the source code of this file.
Classes | |
| class | TestFail |
| Class which is thrown when a test case fails. More... | |
| class | TestSkip |
| Class which is thrown when a test case is to be skipped. More... | |
| struct | test_desc |
| Structure holding a description of a test. More... | |
| class | test_driver |
| The test driver. This class takes care of running the tests. More... | |
| struct | test_driver::result |
| A structure used to report the summary of tests passed and failed. More... | |
Defines | |
| #define | FAIL_TEST(a) |
| Macro used to build a TestFail object and throw it. | |
| #define | SKIP_TEST(a) |
| Macro used to build a TestSkip object and throw it. | |
| #define | TESTCASE_LOCN(a) __FILE__":"STRINGIZE(__LINE__)": "STRINGIZE(a) |
| Display the location at which a testcase occurred, with an explanation. | |
| #define | TEST_AND_EXPLAIN(a, b) |
| Test a condition, and display the test with an extra explanation if the condition fails. | |
| #define | TEST(a) TEST_AND_EXPLAIN(a, "") |
| Test a condition, without an additional explanation for failure. | |
| #define | TEST_EQUAL(a, b) |
| Test for equality of two things. | |
| #define | TEST_STRINGS_EQUAL(a, b) |
| Test for equality of two strings. | |
| #define | TEST_EQUAL_DOUBLE(a, b) |
| Test two doubles for near equality. | |
| #define | TEST_NOT_EQUAL_DOUBLE(a, b) |
| Test two doubles for non-near-equality. | |
| #define | TEST_NOT_EQUAL(a, b) |
| Test for non-equality of two things. | |
| #define | DEFINE_TESTCASE(S, COND) bool test_##S() |
Typedefs | |
| typedef bool(* | test_func )() |
| Type for a test function. | |
Functions | |
| bool | TEST_EQUAL_DOUBLE_ (double a, double b) |
| Helper function for TEST_EQUAL_DOUBLE macro. | |
Variables | |
| bool | verbose |
| The global verbose flag. | |
| const char * | expected_exception |
| The exception type we were expecting in TEST_EXCEPTION. | |
| std::ostringstream | tout |
| The output stream. | |
Define Documentation
| #define DEFINE_TESTCASE | ( | S, | |||
| COND | ) | bool test_##S() |
Definition at line 279 of file testsuite.h.
| #define FAIL_TEST | ( | a | ) |
Value:
Macro used to build a TestFail object and throw it.
Definition at line 53 of file testsuite.h.
Referenced by apply_changeset(), DEFINE_TESTCASE(), do_read(), do_write(), file_size(), get_changeset(), CPUTimer::get_current_cputime(), ChangeMaxweightPostingSource::get_weight(), MyDontAskWeightPostingSource::get_weight(), make_sparse_db(), mktmpdir(), NeverUseMeSorter::operator()(), NeverUseMeKeyMaker::operator()(), test_stemdict(), test_stemjunk(), test_stemrandom(), test_termgen1(), and truncated_copy().
| #define SKIP_TEST | ( | a | ) |
Value:
Macro used to build a TestSkip object and throw it.
Definition at line 60 of file testsuite.h.
Referenced by DEFINE_TESTCASE(), qp_scale1_helper(), skip_test_for_backend(), skip_test_unless_backend(), test_qp_flag_partial1(), test_qp_flag_wildcard1(), test_qp_flag_wildcard2(), test_qp_flag_wildcard3(), test_qp_stopword_group1(), test_qp_value_range3(), test_scalability(), and test_stemdict().
| #define TEST | ( | a | ) | TEST_AND_EXPLAIN(a, "") |
Test a condition, without an additional explanation for failure.
Definition at line 245 of file testsuite.h.
Referenced by check_double_serialisation(), check_msets_contain_same_docs(), dbcheck(), DEFINE_TESTCASE(), serialisequery1_helper(), test_autoptr1(), test_pack_uint_preserving_sort1(), test_qp_stoplist1(), test_qp_unstem_boolean_prefix(), test_serialisedoc1(), test_serialiseerror1(), and test_serialiselength2().
| #define TEST_AND_EXPLAIN | ( | a, | |||
| b | ) |
Value:
do {\ if (!(a)) FAIL_TEST(TESTCASE_LOCN(a) << std::endl << b << std::endl);\ } while (0)
NB: wrapped in do { ... } while (0) so a trailing ';' works correctly.
Definition at line 240 of file testsuite.h.
Referenced by DEFINE_TESTCASE(), mset_expect_order_(), mset_range_is_same(), mset_range_is_same_percents(), mset_range_is_same_weights(), test_mset_order_equal(), test_refcnt1(), test_refcnt2(), and test_value_range_serialise1().
| #define TEST_EQUAL | ( | a, | |||
| b | ) |
Value:
TEST_AND_EXPLAIN(((a) == (b)), \ "Expected `"STRINGIZE(a)"' and `"STRINGIZE(b)"' to be equal:" \ " were " << (a) << " and " << (b))
Definition at line 248 of file testsuite.h.
Referenced by apply_changeset(), check_double_serialisation(), check_equal_dbs(), check_msets_contain_same_docs(), check_sparse_uid_terms(), check_vals(), dbcheck(), DEFINE_TESTCASE(), get_changeset(), closedb1_iterators::perform(), replicate_with_brokenness(), test_autoptr1(), test_emptyterm1_helper(), test_emptyterm2_helper(), test_exception1(), test_pack_uint_preserving_sort1(), test_qp_stoplist1(), test_qp_unstem_boolean_prefix(), test_qp_value_range3(), test_refcnt1(), test_resolverelativepath1(), test_serialiselength1(), test_serialiselength2(), test_stemdict(), test_strbool1(), test_temporarydtor1(), test_tostring1(), and test_value_range_serialise1().
| #define TEST_EQUAL_DOUBLE | ( | a, | |||
| b | ) |
Value:
TEST_AND_EXPLAIN(TEST_EQUAL_DOUBLE_((a), (b)), \ "Expected `"STRINGIZE(a)"' and `"STRINGIZE(b)"' to be (nearly) equal:" \ " were " << setprecision(DBL_DIG) << (a) << " and " << (b) << ")" << setprecision(6))
Definition at line 265 of file testsuite.h.
Referenced by dbcheck(), and DEFINE_TESTCASE().
| #define TEST_NOT_EQUAL | ( | a, | |||
| b | ) |
Value:
TEST_AND_EXPLAIN(((a) != (b)), \ "Expected `"STRINGIZE(a)"' and `"STRINGIZE(b)"' not to be equal:" \ " were " << (a) << " and " << (b))
Definition at line 275 of file testsuite.h.
Referenced by check_vals(), DEFINE_TESTCASE(), and closedb1_iterators::perform().
| #define TEST_NOT_EQUAL_DOUBLE | ( | a, | |||
| b | ) |
Value:
TEST_AND_EXPLAIN(!TEST_EQUAL_DOUBLE_((a), (b)), \ "Expected `"STRINGIZE(a)"' and `"STRINGIZE(b)"' not to be (nearly) equal:" \ " were " << setprecision(DBL_DIG) << (a) << " and " << (b) << ")" << setprecision(6))
Definition at line 270 of file testsuite.h.
Referenced by DEFINE_TESTCASE().
| #define TEST_STRINGS_EQUAL | ( | a, | |||
| b | ) |
Value:
TEST_AND_EXPLAIN(((a) == (b)), \ "Expected "STRINGIZE(a)" and "STRINGIZE(b)" to be equal, were:\n\"" \ << (a) << "\"\n\"" << (b) << '"')
If they aren't equal, show each on a separate line so the difference can be seen clearly.
Definition at line 257 of file testsuite.h.
Referenced by DEFINE_TESTCASE(), test_qp_default_op1(), test_qp_default_prefix1(), test_qp_default_prefix2(), test_qp_flag_bool_any_case1(), test_qp_flag_partial1(), test_qp_flag_pure_not1(), test_qp_flag_wildcard1(), test_qp_flag_wildcard2(), test_qp_near1(), test_qp_odd_chars1(), test_qp_phrase1(), test_qp_spell1(), test_qp_spell2(), test_qp_spellpartial1(), test_qp_spellwild1(), test_qp_stem_all1(), test_qp_stopper1(), test_qp_stopword_group1(), test_qp_synonym1(), test_qp_synonym2(), test_qp_synonym3(), test_qp_unstem_boolean_prefix(), test_qp_value_customrange1(), test_qp_value_daterange1(), test_qp_value_daterange2(), test_qp_value_range1(), test_qp_value_range2(), test_qp_value_range4(), test_qp_value_stringrange1(), test_queryparser1(), test_serialiseerror1(), test_termgen1(), and test_tg_spell1().
| #define TESTCASE_LOCN | ( | a | ) | __FILE__":"STRINGIZE(__LINE__)": "STRINGIZE(a) |
Display the location at which a testcase occurred, with an explanation.
Definition at line 234 of file testsuite.h.
Typedef Documentation
| typedef bool(* test_func)() |
Function Documentation
| bool TEST_EQUAL_DOUBLE_ | ( | double | a, | |
| double | b | |||
| ) |
Helper function for TEST_EQUAL_DOUBLE macro.
Definition at line 784 of file testsuite.cc.
Referenced by mset_range_is_same(), and mset_range_is_same_weights().
Variable Documentation
| const char* expected_exception |
The exception type we were expecting in TEST_EXCEPTION.
Definition at line 90 of file testsuite.cc.
Referenced by test_driver::runtest().
| std::ostringstream tout |
The output stream.
Data written to this stream will only appear when a test fails.
Definition at line 93 of file testsuite.cc.
Referenced by check_double_serialisation(), check_vals(), DEFINE_TESTCASE(), initrand(), make_sparse_db(), mset_range_is_same(), mset_range_is_same_percents(), mset_range_is_same_weights(), print_mset_percentages(), print_mset_weights(), qp_scale1_helper(), replicate_with_brokenness(), test_driver::runtest(), test_autoptr::test_autoptr(), test_qp_default_op1(), test_qp_default_op2(), test_qp_flag_pure_not1(), test_qp_near1(), test_qp_odd_chars1(), test_qp_phrase1(), test_qp_spell1(), test_qp_spell2(), test_qp_spellpartial1(), test_qp_spellwild1(), test_qp_stem_all1(), test_qp_stopper1(), test_qp_stopword_group1(), test_qp_synonym1(), test_qp_synonym2(), test_qp_synonym3(), test_qp_value_customrange1(), test_qp_value_daterange1(), test_qp_value_daterange2(), test_qp_value_range1(), test_qp_value_range2(), test_qp_value_range3(), test_qp_value_range4(), test_qp_value_stringrange1(), test_queryparser1(), test_refcnt::test_refcnt(), test_scalability(), test_serialiselength1(), test_stemdict(), test_stemjunk(), test_stemrandom(), test_stringcomp1(), test_termgen1(), test_value_range_serialise1(), test_driver::write_and_clear_tout(), test_autoptr::~test_autoptr(), and test_refcnt::~test_refcnt().
| bool verbose |