35 #ifndef OPENMS_CONCEPT_CLASSTEST_H
36 #define OPENMS_CONCEPT_CLASSTEST_H
65 #define std__cout std::cout
81 validate(
const std::vector<std::string>& file_names);
84 std::string OPENMS_DLLAPI
88 inline bool OPENMS_DLLAPI
95 inline bool OPENMS_DLLAPI
102 inline bool OPENMS_DLLAPI
109 inline bool OPENMS_DLLAPI
116 template <
typename T>
130 const char* number_1_stringified,
131 bool number_1_is_realtype,
Int number_1_written_digits,
132 long double number_2,
const char* number_2_stringified,
133 bool ,
Int number_2_written_digits);
148 const std::string& string_1,
149 const char* string_1_stringified,
150 const std::string& string_2,
151 const char* string_2_stringified);
156 const std::string& string_1,
157 const char* string_1_stringified,
158 const std::string& string_2,
159 const char* string_2_stringified);
168 const std::string& filename_2);
181 const std::string& whitelist);
190 extern OPENMS_DLLAPI
double ratio;
199 extern OPENMS_DLLAPI
double absdiff;
205 extern OPENMS_DLLAPI
int verbose;
211 extern OPENMS_DLLAPI
bool test;
226 extern OPENMS_DLLAPI std::string
test_name;
244 extern OPENMS_DLLAPI std::ifstream
infile;
268 extern OPENMS_DLLAPI
bool newline;
270 template <
typename T1,
typename T2>
272 testEqual(
const char* ,
int line,
const T1& expression_1,
273 const char* expression_1_stringified,
274 const T2& expression_2,
275 const char* expression_2_stringified)
279 this_test =
bool(expression_1 == T1(expression_2));
285 std__cout <<
" + line " << line <<
": TEST_EQUAL("
286 << expression_1_stringified <<
','
287 << expression_2_stringified <<
"): got " << expression_1
288 <<
", expected " << expression_2 << std::endl;
292 std__cout <<
" - line " << line <<
": TEST_EQUAL("
293 << expression_1_stringified <<
','
294 << expression_2_stringified <<
"): got " << expression_1
295 <<
", expected " << expression_2 << std::endl;
296 failed_lines_list.push_back(line);
301 template <
typename T1,
typename T2>
304 const char* expression_1_stringified,
305 const T2& expression_2,
306 const char* expression_2_stringified)
310 this_test = !(expression_1 == T1(expression_2));
316 std__cout <<
" + line " << line <<
": TEST_NOT_EQUAL("
317 << expression_1_stringified <<
','
318 << expression_2_stringified <<
"): got " << expression_1
319 <<
", forbidden is " << expression_2 << std::endl;
323 std__cout <<
" - line " << line <<
": TEST_NOT_EQUAL("
324 << expression_1_stringified <<
','
325 << expression_2_stringified <<
"): got " << expression_1
326 <<
", forbidden is " << expression_2 << std::endl;
327 failed_lines_list.push_back(line);
392 #define START_TEST(class_name, version) \
393 int main(int argc, char** argv) \
395 OpenMS::UInt64 seed = 2453440375; \
396 OpenMS::UniqueIdGenerator::setSeed(seed); \
397 TEST::version_string = version; \
402 << "This is " << argv[0] << ", the test program for the\n" \
403 << # class_name " class.\n" \
405 "On successful operation it returns PASSED,\n" \
406 "otherwise FAILED is printed.\n"; \
426 catch (::OpenMS::Exception::BaseException& e) \
428 TEST::this_test = false; \
429 TEST::test = false; \
430 TEST::all_tests = false; \
432 TEST::initialNewline(); \
433 std__cout << "Error: Caught unexpected OpenMS exception of type '" \
436 if ((e.getLine() > 0) && (std::strcmp(e.getFile(), "") != 0)) \
438 std__cout << " thrown in line " << e.getLine() << " of file '" << e.getFile() \
439 << "' in function '" << e.getFunction() << "'"; \
441 std__cout << " - Message: " << e.what() << std::endl; \
445 catch (std::exception& e) \
447 TEST::this_test = false; \
448 TEST::test = false; \
449 TEST::all_tests = false; \
451 TEST::initialNewline(); \
452 std__cout << "Error: Caught unexpected std::exception" << std::endl; \
453 std__cout << " - Message: " << e.what() << std::endl; \
459 TEST::this_test = false; \
460 TEST::test = false; \
461 TEST::all_tests = false; \
463 TEST::initialNewline(); \
464 std__cout << "Error: Caught unidentified and unexpected exception - No message." \
469 if (!TEST::validate(TEST::tmp_file_list)) \
471 TEST::all_tests = false; \
474 if (!TEST::all_tests) \
476 std__cout << "FAILED" << std::endl; \
477 if (TEST::add_message != "") std__cout << "Message: " \
478 << TEST::add_message \
480 std__cout << "Failed lines: "; \
481 for (OpenMS::Size i = 0; i < TEST::failed_lines_list.size(); ++i) \
483 std__cout << TEST::failed_lines_list[i] << " "; \
485 std__cout << std::endl; \
491 for (OpenMS::Size i = 0; i < TEST::tmp_file_list.size(); ++i) \
493 if (!OpenMS::File::remove(TEST::tmp_file_list[i])) \
495 std__cout << "Warning: unable to remove temporary file '" \
496 << TEST::tmp_file_list[i] \
501 std__cout << "PASSED"; \
502 if (TEST::add_message != "") std__cout << " (" << TEST::add_message << ")"; \
503 std__cout << std::endl; \
530 #define START_SECTION(name_of_test) \
532 TEST::newline = false; \
533 TEST::test_name = # name_of_test; \
534 TEST::test_count = 0; \
535 TEST::start_section_line = __LINE__; \
536 std__cout << "checking " << TEST::test_name << " ... " << std::flush; \
567 #define END_SECTION \
571 catch (::OpenMS::Exception::BaseException& e) \
573 TEST::this_test = false; \
574 TEST::test = false; \
575 TEST::all_tests = false; \
577 TEST::initialNewline(); \
578 std__cout << "Error: Caught unexpected exception of type '" << e.getName() << "'"; \
579 if ((e.getLine() > 0) && (std::strcmp(e.getFile(), "") != 0)) \
581 std__cout << " thrown in line " << e.getLine() << " of file '" << e.getFile() \
582 << "' in function '" << e.getFunction() << "'"; \
584 std__cout << " - Message: " << e.what() << std::endl; \
588 catch (std::exception& e) \
590 TEST::this_test = false; \
591 TEST::test = false; \
592 TEST::all_tests = false; \
594 TEST::initialNewline(); \
595 std__cout << "Error: Caught std::exception" << std::endl; \
596 std__cout << " - Message: " << e.what() << std::endl; \
602 TEST::this_test = false; \
603 TEST::test = false; \
604 TEST::all_tests = false; \
606 TEST::initialNewline(); \
607 std__cout << "Error: Caught unidentified and unexpected exception - No message." \
611 TEST::all_tests = TEST::all_tests && TEST::test; \
615 std__cout << ": passed" << std::endl; \
619 std__cout << ": failed" << std::endl; \
623 if (TEST::test_count == 0) \
625 bool destructor = false; \
626 for (OpenMS::Size i = 0; i != TEST::test_name.size(); ++i) \
628 if (TEST::test_name[i] == '~') \
634 if (!destructor) std__cout << "Warning: no subtests performed in '" \
642 std__cout << std::endl;
665 #define TEST_EQUAL(a, b) TEST::testEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
678 #define TEST_NOT_EQUAL(a, b) TEST::testNotEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
692 #define TEST_STRING_EQUAL(a, b) TEST::testStringEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
708 #define TEST_FILE_EQUAL(filename, templatename) \
710 ++TEST::test_count; \
711 TEST::equal_files = true; \
712 TEST::infile.open(filename, std::ios::in); \
713 TEST::templatefile.open(templatename, std::ios::in); \
715 if (TEST::infile.good() && TEST::templatefile.good()) \
717 std::string TEST_FILE__template_line; \
718 std::string TEST_FILE__line; \
720 while (TEST::infile.good() && TEST::templatefile.good()) \
722 TEST::templatefile.getline(TEST::line_buffer, 65535); \
723 TEST_FILE__template_line = TEST::line_buffer; \
724 TEST::infile.getline(TEST::line_buffer, 65535); \
725 TEST_FILE__line = TEST::line_buffer; \
727 TEST::equal_files &= (TEST_FILE__template_line == TEST_FILE__line); \
728 if (TEST_FILE__template_line != TEST_FILE__line) \
731 TEST::initialNewline(); \
732 std__cout << " TEST_FILE_EQUAL: line mismatch:\n got: '" \
733 << TEST_FILE__line << "'\n expected: '" \
734 << TEST_FILE__template_line << "'" << std::endl; \
741 TEST::equal_files = false; \
743 TEST::initialNewline(); \
744 std__cout << " + line " \
746 << ": TEST_FILE_EQUAL(" \
750 std__cout << ") : " << " cannot open file: \""; \
751 if (!TEST::infile.good()) \
753 std__cout << filename << "\" (input file) "; \
755 if (!TEST::templatefile.good()) \
757 std__cout << templatename << "\" (template file) "; \
759 std__cout << std::endl; \
763 TEST::infile.close(); \
764 TEST::templatefile.close(); \
765 TEST::infile.clear(); \
766 TEST::templatefile.clear(); \
768 TEST::this_test = TEST::equal_files; \
769 TEST::test = TEST::test && TEST::this_test; \
771 TEST::initialNewline(); \
772 if (TEST::this_test) \
774 std__cout << " + line " \
776 << ": TEST_FILE_EQUAL(" \
784 std__cout << " - line " \
786 << ": TEST_FILE_EQUAL(" \
790 << "): false (different files: " \
795 TEST::failed_lines_list.push_back(TEST::test_line); \
815 #define TEST_REAL_SIMILAR(a, b) TEST::testRealSimilar(__FILE__, __LINE__, (a), (# a), TEST::isRealType(a), writtenDigits(a), (b), (# b), TEST::isRealType(b), writtenDigits(b));
832 #define TEST_STRING_SIMILAR(a, b) TEST::testStringSimilar(__FILE__, __LINE__, (a), (# a), (b), (# b));
848 #define TEST_FILE_SIMILAR(a, b) \
850 ++TEST::test_count; \
851 TEST::test_line = __LINE__; \
852 TEST::this_test = TEST::isFileSimilar((a), (b)); \
853 TEST::test = TEST::test && TEST::this_test; \
855 TEST::initialNewline(); \
856 if (TEST::this_test) \
858 std__cout << " + line " << __LINE__ \
859 << ": TEST_FILE_SIMILAR(" # a "," # b "): absolute: " \
860 << precisionWrapper(TEST::absdiff) \
862 << precisionWrapper(TEST::absdiff_max_allowed) \
864 << precisionWrapper(TEST::ratio) \
866 << precisionWrapper(TEST::ratio_max_allowed) \
869 std__cout << "message: \n"; \
870 std__cout << TEST::fuzzy_message; \
874 std__cout << " - line " << TEST::test_line << \
875 ": TEST_FILE_SIMILAR(" # a "," # b ") ... -\n"; \
876 std__cout << "message: \n"; \
877 std__cout << TEST::fuzzy_message; \
878 TEST::failed_lines_list.push_back(TEST::test_line); \
895 #define TOLERANCE_RELATIVE(a) \
896 TEST::ratio_max_allowed = (a); \
898 TEST::initialNewline(); \
899 std__cout << " + line " << __LINE__ << \
900 ": TOLERANCE_RELATIVE(" << TEST::ratio_max_allowed << \
901 ") (\"" # a "\")" << std::endl; \
915 #define TOLERANCE_ABSOLUTE(a) \
916 TEST::absdiff_max_allowed = (a); \
918 TEST::initialNewline(); \
919 std__cout << " + line " << __LINE__ << \
920 ": TOLERANCE_ABSOLUTE(" << TEST::absdiff_max_allowed << \
921 ") (\"" # a "\")" << std::endl; \
929 #define WHITELIST(a) TEST::setWhitelist(__FILE__, __LINE__, (a));
943 #define TEST_EXCEPTION(exception_type, command) \
945 ++TEST::test_count; \
946 TEST::test_line = __LINE__; \
947 TEST::exception = 0; \
952 catch (exception_type) \
954 TEST::exception = 1; \
956 catch (::OpenMS::Exception::BaseException e) \
958 TEST::exception = 2; \
959 TEST::exception_name = e.getName(); \
963 TEST::exception = 3; \
965 TEST::this_test = (TEST::exception == 1); \
966 TEST::test = TEST::test && TEST::this_test; \
969 TEST::initialNewline(); \
970 switch (TEST::exception) \
973 std__cout << " - line " << TEST::test_line << \
974 ": TEST_EXCEPTION(" # exception_type "," # command \
975 "): no exception thrown!" << std::endl; \
976 TEST::failed_lines_list.push_back(TEST::test_line); \
979 std__cout << " + line " << TEST::test_line << \
980 ": TEST_EXCEPTION(" # exception_type "," # command \
981 "): OK" << std::endl; \
984 std__cout << " - line " << TEST::test_line << \
985 ": TEST_EXCEPTION(" # exception_type "," # command \
986 "): wrong exception thrown! \"" \
987 << TEST::exception_name << "\"" << std::endl; \
988 TEST::failed_lines_list.push_back(TEST::test_line); \
991 std__cout << " - line " << TEST::test_line << \
992 ": TEST_EXCEPTION(" # exception_type "," # command \
993 "): wrong exception thrown!" << std::endl; \
994 TEST::failed_lines_list.push_back(TEST::test_line); \
1011 #ifdef OPENMS_ASSERTIONS
1012 #define TEST_PRECONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Precondition, command);
1014 #define TEST_PRECONDITION_VIOLATED(command) STATUS("TEST_PRECONDITION_VIOLATED(" # command ") - skipped");
1028 #ifdef OPENMS_ASSERTIONS
1029 #define TEST_POSTCONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Postcondition, command);
1031 #define TEST_POSTCONDITION_VIOLATED(command) STATUS("TEST_POSTCONDITION_VIOLATED(" # command ") - skipped");
1051 #define TEST_EXCEPTION_WITH_MESSAGE(exception_type, command, message) \
1053 ++TEST::test_count; \
1054 TEST::test_line = __LINE__; \
1055 TEST::exception = 0; \
1060 catch (exception_type et) \
1062 if (std::string(et.getMessage()) != std::string(message)) \
1064 TEST::exception = 4; \
1065 TEST::exception_message = et.getMessage(); \
1067 else TEST::exception = 1; \
1069 catch (::OpenMS::Exception::BaseException e) \
1071 TEST::exception = 2; \
1072 TEST::exception_name = e.getName(); \
1076 TEST::exception = 3; \
1078 TEST::this_test = (TEST::exception == 1); \
1079 TEST::test = TEST::test && TEST::this_test; \
1082 TEST::initialNewline(); \
1083 switch (TEST::exception) \
1086 std__cout << " - line " << TEST::test_line << \
1087 ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1088 "): no exception thrown!" << std::endl; \
1089 TEST::failed_lines_list.push_back(TEST::test_line); \
1093 std__cout << " + line " << TEST::test_line << \
1094 ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1095 "): OK" << std::endl; \
1098 std__cout << " - line " << TEST::test_line << \
1099 ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1100 "): wrong exception thrown! \"" << \
1101 TEST::exception_name << "\"" << std::endl; \
1102 TEST::failed_lines_list.push_back(TEST::test_line); \
1105 std__cout << " - line " << TEST::test_line << \
1106 ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1107 "): wrong exception thrown!" << std::endl; \
1108 TEST::failed_lines_list.push_back(TEST::test_line); \
1111 std__cout << " - line " << TEST::test_line << \
1112 ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1113 "): exception has wrong message: got '" << \
1114 TEST::exception_message << \
1115 "', expected '" << \
1118 TEST::failed_lines_list.push_back(TEST::test_line); \
1139 #define NEW_TMP_FILE(filename) \
1141 filename = TEST::tmpFileName(__FILE__, __LINE__); \
1142 TEST::tmp_file_list.push_back(filename); \
1144 TEST::initialNewline(); \
1145 std__cout << " creating new temporary filename '" \
1161 #define ABORT_IF(condition) \
1165 TEST::initialNewline(); \
1166 std__cout << " - line " << __LINE__ << \
1167 ": ABORT_IF(" # condition "): TEST ABORTED" << \
1169 TEST::failed_lines_list.push_back(TEST::test_line); \
1191 #define STATUS(message) \
1193 TEST::initialNewline(); \
1194 std__cout << " line " \
1210 #define ADD_MESSAGE(message) \
1211 TEST::add_message = message;
1222 #define NOT_TESTABLE \
1223 TEST::test_count = 1;
1227 #endif //OPENMS_CONCEPT_CLASSTEST_H
double absdiff_max_allowed
Maximum absolute difference of numbers allowed, see TOLERANCE_ABSOLUTE.
int test_count
Counter for the number of elementary tests within the current subsection.
void testStringSimilar(const char *file, int line, const std::string &string_1, const char *string_1_stringified, const std::string &string_2, const char *string_2_stringified)
Compare strings using absdiff_max_allowed and ratio_max_allowed.
std::ifstream templatefile
Template (correct) file used by TEST_FILE_EQUAL.
std::string exception_name
(Used by various macros. Stores the "name" of the exception, if applicable.)
void setWhitelist(const char *const , const int line, const std::string &whitelist)
set the whitelist_
bool newline
(Flags whether a new line is in place, depending on context and verbosity setting. Used by initialNewline() and some macros.)
bool this_test
Status of last elementary test.
std::ifstream infile
Questionable file tested by TEST_FILE_EQUAL.
int start_section_line
Line where current subsection started.
std::vector< std::string > tmp_file_list
List of tmp file names (these will be cleaned up, see NEW_TMP_FILE)
std::string add_message
See ADD_MESSAGE.
double ratio_max
Maximum ratio of numbers observed so far, see TOLERANCE_RELATIVE.
void testEqual(const char *, int line, const T1 &expression_1, const char *expression_1_stringified, const T2 &expression_2, const char *expression_2_stringified)
Definition: ClassTest.h:272
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
std::string tmpFileName(const std::string &file, int line)
Creates a temporary file name from the test name and the line.
char line_buffer[65536]
(A buffer for one line from a file. Used by TEST_FILE_EQUAL.)
bool isRealType(float)
This overload returns true; float is a floating point type.
Definition: ClassTest.h:89
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:57
std::string exception_message
(Used by various macros. Stores the "message" of the exception, if applicable.)
#define std__cout
Provide a point of redirection for testing the test macros, see ClassTest_test.cpp.
Definition: ClassTest.h:65
bool equal_files
(A variable used by TEST_FILE_EQUAL)
void testNotEqual(const char *, int line, const T1 &expression_1, const char *expression_1_stringified, const T2 &expression_2, const char *expression_2_stringified)
Definition: ClassTest.h:303
int exception
(Used by various macros. Indicates a rough category of the exception being caught.)
double ratio
Recent ratio of numbers, see TOLERANCE_RELATIVE.
const char * version_string
Version string supplied with START_TEST.
bool all_tests
Status of the whole test.
int test_line
Line of current elementary test.
void testRealSimilar(const char *file, int line, long double number_1, const char *number_1_stringified, bool number_1_is_realtype, Int number_1_written_digits, long double number_2, const char *number_2_stringified, bool, Int number_2_written_digits)
Compare floating point numbers using absdiff_max_allowed and ratio_max_allowed.
void initialNewline()
make sure we have a newline before results from first subtest
std::string test_name
Name of current subsection.
std::vector< UInt > failed_lines_list
List of all failed lines for summary at the end of the test.
Namespace for class tests.
Definition: ClassTest.h:73
bool isRealSimilar(long double number_1, long double number_2)
used by testRealSimilar()
double absdiff
Recent absolute difference of numbers, see TOLERANCE_ABSOLUTE.
bool isFileSimilar(const std::string &filename_1, const std::string &filename_2)
Compare files using absdiff_max_allowed and ratio_max_allowed.
bool test
Status of the current subsection.
int Int
Signed integer type.
Definition: Types.h:96
double absdiff_max
Maximum difference of numbers observed so far, see TOLERANCE_ABSOLUTE.
bool validate(const std::vector< std::string > &file_names)
Validates the given files against the XML schema (if available)
int verbose
Verbosity level ( "-v" is 1 and "-V" is 2 )
void testStringEqual(const char *file, int line, const std::string &string_1, const char *string_1_stringified, const std::string &string_2, const char *string_2_stringified)
used by TEST_STRING_EQUAL
void printWithPrefix(const std::string &text, const int marked=-1)
print the text, each line gets a prefix, the marked line number gets a special prefix ...
std::string fuzzy_message
Last message from a fuzzy comparison. Written by isRealSimilar(), testStringSimilar(), isFileSimilar(). Read by TEST_REAL_SIMILAR, TEST_STRING_SIMILAR, TEST_FILE_SIMILAR;.
double ratio_max_allowed
Maximum ratio of numbers allowed, see TOLERANCE_RELATIVE.