OpenMS
ClassTest.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2023.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm, Clemens Groepl $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // Avoid OpenMS includes here at all costs
38 // When the included headers are changed, *all* tests have to be recompiled!
39 // Use the ClassTest class if you need add high-level functionality.
40 // Includes in the C-file are ok...
41 #include <OpenMS/CONCEPT/PrecisionWrapper.h>
42 #include <OpenMS/CONCEPT/Types.h>
43 #include <OpenMS/DATASTRUCTURES/DataValue.h>
44 #include <OpenMS/CONCEPT/MacrosTest.h>
45 #include <OpenMS/OpenMSConfig.h>
46 #include <OpenMS/config.h>
47 
48 #include <cstring>
49 #include <iostream>
50 #include <string>
51 #include <vector>
52 
53 // Empty declaration to avoid problems in case the namespace is not
54 // yet defined (e.g. TEST/ClassTest_test.cpp)
55 
57 #ifndef stdcout
58 #define stdcout std::cout
59 #endif
60 
61 namespace OpenMS
62 {
63  namespace Internal
64  {
66  namespace ClassTest
67  {
68 
73  bool OPENMS_DLLAPI
74  validate(const std::vector<std::string>& file_names);
75 
77  std::string OPENMS_DLLAPI
78  tmpFileName(const std::string& file, int line);
79 
81  inline bool OPENMS_DLLAPI
82  isRealType(float)
83  {
84  return true;
85  }
86 
88  inline bool OPENMS_DLLAPI
89  isRealType(double)
90  {
91  return true;
92  }
93 
95  inline bool OPENMS_DLLAPI
96  isRealType(long double)
97  {
98  return true;
99  }
100 
102  inline bool OPENMS_DLLAPI
103  isRealType(const ParamValue&)
104  {
105  return true;
106  }
107 
109  inline bool OPENMS_DLLAPI
110  isRealType(const DataValue&)
111  {
112  return true;
113  }
114 
116  template <typename T>
117  inline bool
118  isRealType(const T&)
119  {
120  return false;
121  }
122 
128  void OPENMS_DLLAPI
129  testRealSimilar(const char* file, int line, long double number_1,
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 /* number_2_is_realtype */, Int number_2_written_digits);
134 
136  bool OPENMS_DLLAPI
137  isRealSimilar(long double number_1, long double number_2);
138 
146  void OPENMS_DLLAPI
147  testStringSimilar(const char* file, int line,
148  const std::string& string_1,
149  const char* string_1_stringified,
150  const std::string& string_2,
151  const char* string_2_stringified);
152 
154  void OPENMS_DLLAPI
155  testStringEqual(const char* file, int line,
156  const std::string& string_1,
157  const char* string_1_stringified,
158  const std::string& string_2,
159  const char* string_2_stringified);
160 
166  bool OPENMS_DLLAPI
167  isFileSimilar(const std::string& filename_1,
168  const std::string& filename_2);
169 
171  void OPENMS_DLLAPI
172  initialNewline();
173 
175  void OPENMS_DLLAPI
176  printWithPrefix(const std::string& text, const int marked = -1);
177 
187  void OPENMS_DLLAPI mainInit(const char* version, const char* class_name, int argc, const char* argv0);
188 
198  void OPENMS_DLLAPI filesEqual(int line, const char* filename, const char* templatename, const char* filename_stringified, const char* templatename_stringified);
199 
201  void OPENMS_DLLAPI removeTempFiles();
202 
204  void OPENMS_DLLAPI
205  setWhitelist(const char* const /* file */, const int line,
206  const std::string& whitelist);
207 
209  extern OPENMS_DLLAPI double ratio_max_allowed;
210 
212  extern OPENMS_DLLAPI double ratio_max;
213 
215  extern OPENMS_DLLAPI double ratio;
216 
218  extern OPENMS_DLLAPI double absdiff_max_allowed;
219 
221  extern OPENMS_DLLAPI double absdiff_max;
222 
224  extern OPENMS_DLLAPI double absdiff;
225 
226  extern OPENMS_DLLAPI int line_num_1_max;
227  extern OPENMS_DLLAPI int line_num_2_max;
228 
230  extern OPENMS_DLLAPI int verbose;
231 
233  extern OPENMS_DLLAPI bool all_tests;
234 
236  extern OPENMS_DLLAPI bool test;
237 
239  extern OPENMS_DLLAPI bool this_test;
240 
242  extern OPENMS_DLLAPI int exception;
243 
245  extern OPENMS_DLLAPI std::string exception_name;
246 
248  extern OPENMS_DLLAPI std::string exception_message;
249 
251  extern OPENMS_DLLAPI std::string test_name;
252 
254  extern OPENMS_DLLAPI int start_section_line;
255 
257  extern OPENMS_DLLAPI int test_line;
258 
260  extern OPENMS_DLLAPI const char* version_string;
261 
263  extern OPENMS_DLLAPI std::vector<std::string> tmp_file_list;
264 
266  extern OPENMS_DLLAPI std::vector<UInt> failed_lines_list;
267 
269  extern OPENMS_DLLAPI std::ifstream infile;
270 
272  extern OPENMS_DLLAPI std::ifstream templatefile;
273 
275  extern OPENMS_DLLAPI bool equal_files;
276 
278  extern OPENMS_DLLAPI char line_buffer[65536];
279 
281  extern OPENMS_DLLAPI int test_count;
282 
284  extern OPENMS_DLLAPI std::string add_message;
285 
290  extern OPENMS_DLLAPI std::string fuzzy_message;
291 
293  extern OPENMS_DLLAPI bool newline;
294 
295  template <typename T1, typename T2>
296  void
297  testEqual(const char* /*file*/, int line, const T1& expression_1,
298  const char* expression_1_stringified,
299  const T2& expression_2,
300  const char* expression_2_stringified)
301  {
302  ++test_count;
303  test_line = line;
304  this_test = bool(expression_1 == T1(expression_2));
305  test = test && this_test;
306  {
307  initialNewline();
308  if (this_test)
309  {
310  if (verbose > 1)
311  {
312  stdcout << " + line " << line << ": TEST_EQUAL("
313  << expression_1_stringified << ','
314  << expression_2_stringified << "): got '" << expression_1
315  << "', expected '" << expression_2 << "'\n";
316  }
317  }
318  else
319  {
320  stdcout << " - line " << line << ": TEST_EQUAL("
321  << expression_1_stringified << ','
322  << expression_2_stringified << "): got '" << expression_1
323  << "', expected '" << expression_2 << "'\n";
324  failed_lines_list.push_back(line);
325  }
326  }
327  }
328 
329  void testTrue(const char* /*file*/, int line, const bool expression_1, const char* expression_1_stringified)
330  {
331  ++test_count;
332  test_line = line;
333  this_test = expression_1;
334  test = test && this_test;
335  {
336  initialNewline();
337  if (this_test)
338  {
339  if (verbose > 1)
340  {
341  stdcout << " + line " << line << ": TEST_TRUE(" << expression_1_stringified << "): ok\n";
342  }
343  }
344  else
345  {
346  stdcout << " - line " << line << ": TEST_TRUE(" << expression_1_stringified << "): failed\n";
347  failed_lines_list.push_back(line);
348  }
349  }
350  }
351 
352  void testFalse(const char* /*file*/, int line, const bool expression_1, const char* expression_1_stringified)
353  {
354  ++test_count;
355  test_line = line;
356  this_test = !expression_1;
357  test = test && this_test;
358  {
359  initialNewline();
360  if (this_test)
361  {
362  if (verbose > 1)
363  {
364  stdcout << " + line " << line << ": TEST_FALSE(" << expression_1_stringified << "): ok\n";
365  }
366  }
367  else
368  {
369  stdcout << " - line " << line << ": TEST_FALSE(" << expression_1_stringified << "): failed\n";
370  failed_lines_list.push_back(line);
371  }
372  }
373  }
374 
375  template <typename T1, typename T2>
376  void
377  testNotEqual(const char* /*file*/, int line, const T1& expression_1,
378  const char* expression_1_stringified,
379  const T2& expression_2,
380  const char* expression_2_stringified)
381  {
382  ++test_count;
383  test_line = line;
384  this_test = !(expression_1 == T1(expression_2));
385  test = test && this_test;
386  {
387  initialNewline();
388  if (this_test)
389  {
390  if (verbose > 1)
391  {
392  stdcout << " + line " << line << ": TEST_NOT_EQUAL("
393  << expression_1_stringified << ','
394  << expression_2_stringified << "): got '" << expression_1
395  << "', forbidden is '" << expression_2 << "'\n";
396  }
397  }
398  else
399  {
400  stdcout << " - line " << line << ": TEST_NOT_EQUAL("
401  << expression_1_stringified << ','
402  << expression_2_stringified << "): got '" << expression_1
403  << "', forbidden is '" << expression_2 << "'\n";
404  failed_lines_list.push_back(line);
405  }
406  }
407  }
408 
409 
410  void OPENMS_DLLAPI printLastException(std::ostream& out);
411 
412  int OPENMS_DLLAPI endTestPostProcess(std::ostream& out);
413 
414  void OPENMS_DLLAPI endSectionPostProcess(std::ostream& out, const int line);
415  }
416  }
417 }
418 
419 // A namespace alias - apparently these cannot be documented using doxygen (?)
420 namespace TEST = OpenMS::Internal::ClassTest;
421 
446 
447 //@name test and subtest
449 
474 #define START_TEST(class_name, version) \
475  int main(int argc, char** argv) \
476  { \
477  TEST::mainInit(version, #class_name, argc, argv[0]); \
478  try {
479 
491 #define END_TEST \
492  /* global try block */ \
493  } \
494  catch (...) \
495  { \
496  TEST::printLastException(stdcout); \
497  } \
498  return TEST::endTestPostProcess(stdcout); \
499  }
500 
523 #define START_SECTION(name_of_test) \
524  TEST::test = true; \
525  TEST::newline = false; \
526  TEST::test_name = # name_of_test; \
527  TEST::test_count = 0; \
528  TEST::start_section_line = __LINE__; \
529  stdcout << "checking " << TEST::test_name << " ... " << std::flush; \
530  try \
531  { \
532  while (true) \
533  {
534 
560 #define END_SECTION \
561  break; \
562  } \
563  } \
564  catch (...) \
565  { \
566  TEST::printLastException(stdcout);\
567  } \
568  TEST::endSectionPostProcess(stdcout, __LINE__);
569 
570 
572 
592 #define TEST_EQUAL(a, b) TEST::testEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
593 
603 #define TEST_TRUE(a) TEST::testTrue(__FILE__, __LINE__, (a), (#a));
604 
614 #define TEST_FALSE(a) TEST::testFalse(__FILE__, __LINE__, (a), (#a));
615 
616 
628 #define TEST_NOT_EQUAL(a, b) TEST::testNotEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
629 
642 #define TEST_STRING_EQUAL(a, b) TEST::testStringEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
643 
658 #define TEST_FILE_EQUAL(filename, templatename) \
659  { \
660  TEST::filesEqual(__LINE__, filename, templatename, #filename, #templatename); \
661  }
662 
678 #define TEST_REAL_SIMILAR(a, b) TEST::testRealSimilar(__FILE__, __LINE__, (a), (# a), TEST::isRealType(a), writtenDigits(a), (b), (# b), TEST::isRealType(b), writtenDigits(b));
679 
695 #define TEST_STRING_SIMILAR(a, b) TEST::testStringSimilar(__FILE__, __LINE__, (a), (# a), (b), (# b));
696 
711 #define TEST_FILE_SIMILAR(a, b) \
712  { \
713  ++TEST::test_count; \
714  TEST::test_line = __LINE__; \
715  TEST::this_test = TEST::isFileSimilar((a), (b)); \
716  TEST::test = TEST::test && TEST::this_test; \
717  { \
718  TEST::initialNewline(); \
719  if (TEST::this_test) \
720  { \
721  if (TEST::verbose > 1) \
722  { \
723  stdcout << " + line " << __LINE__ \
724  << ": TEST_FILE_SIMILAR(" # a "," # b "): absolute: " \
725  << precisionWrapper(TEST::absdiff) \
726  << " (" \
727  << precisionWrapper(TEST::absdiff_max_allowed) \
728  << "), relative: " \
729  << precisionWrapper(TEST::ratio) \
730  << " (" \
731  << precisionWrapper(TEST::ratio_max_allowed) \
732  << ")\n"; \
733  stdcout << "message: \n"; \
734  stdcout << TEST::fuzzy_message; \
735  } \
736  } \
737  else \
738  { \
739  stdcout << " - line " << TEST::test_line << \
740  ": TEST_FILE_SIMILAR(" # a "," # b ") ... -\n"; \
741  stdcout << "message: \n"; \
742  stdcout << TEST::fuzzy_message; \
743  TEST::failed_lines_list.push_back(TEST::test_line); \
744  } \
745  } \
746  }
747 
760 #define TOLERANCE_RELATIVE(a) \
761  TEST::ratio_max_allowed = (a); \
762  { \
763  TEST::initialNewline(); \
764  if (TEST::verbose > 1) \
765  { \
766  stdcout << " + line " << __LINE__ << \
767  ": TOLERANCE_RELATIVE(" << TEST::ratio_max_allowed << \
768  ") (\"" # a "\")\n"; \
769  } \
770  }
771 
783 #define TOLERANCE_ABSOLUTE(a) \
784  TEST::absdiff_max_allowed = (a); \
785  { \
786  TEST::initialNewline(); \
787  if (TEST::verbose > 1) \
788  { \
789  stdcout << " + line " << __LINE__ << \
790  ": TOLERANCE_ABSOLUTE(" << TEST::absdiff_max_allowed << \
791  ") (\"" # a "\")\n"; \
792  } \
793  }
794 
800 #define WHITELIST(a) TEST::setWhitelist(__FILE__, __LINE__, (a));
801 
814 #define TEST_EXCEPTION(exception_type, command) \
815  { \
816  ++TEST::test_count; \
817  TEST::test_line = __LINE__; \
818  TEST::exception = 0; \
819  try \
820  { \
821  command; \
822  } \
823  catch (exception_type&) \
824  { \
825  TEST::exception = 1; \
826  } \
827  catch (::OpenMS::Exception::BaseException& e) \
828  { \
829  TEST::exception = 2; \
830  TEST::exception_name = e.getName(); \
831  } \
832  catch (const std::exception& e) \
833  { \
834  TEST::exception = 3; \
835  TEST::exception_name = e.what(); \
836  } \
837  catch (...) \
838  { \
839  TEST::exception = 4; \
840  } \
841  TEST::this_test = (TEST::exception == 1); \
842  TEST::test = TEST::test && TEST::this_test; \
843  { \
844  TEST::initialNewline(); \
845  switch (TEST::exception) \
846  { \
847  case 0: \
848  stdcout << " - line " << TEST::test_line << \
849  ": TEST_EXCEPTION(" # exception_type "," # command \
850  "): no exception thrown!\n"; \
851  TEST::failed_lines_list.push_back(TEST::test_line); \
852  break; \
853  case 1: \
854  if (TEST::verbose > 1) \
855  { \
856  stdcout << " + line " << TEST::test_line << \
857  ": TEST_EXCEPTION(" # exception_type "," # command \
858  "): OK\n"; \
859  } \
860  break; \
861  case 2: \
862  stdcout << " - line " << TEST::test_line << \
863  ": TEST_EXCEPTION(" # exception_type "," # command \
864  "): wrong exception thrown! \"" \
865  << TEST::exception_name << "\"\n"; \
866  TEST::failed_lines_list.push_back(TEST::test_line); \
867  break; \
868  case 3: \
869  stdcout << " - line " << TEST::test_line << \
870  ": TEST_EXCEPTION(" # exception_type "," # command \
871  "): wrong exception thrown! \"" \
872  << TEST::exception_name << "\"\n"; \
873  TEST::failed_lines_list.push_back(TEST::test_line); \
874  break; \
875  case 4: \
876  stdcout << " - line " << TEST::test_line << \
877  ": TEST_EXCEPTION(" # exception_type "," # command \
878  "): wrong exception thrown!\n"; \
879  TEST::failed_lines_list.push_back(TEST::test_line); \
880  break; \
881  } \
882  } \
883  }
884 
896 #ifdef OPENMS_ASSERTIONS
897 #define TEST_PRECONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Precondition, command);
898 #else
899 #define TEST_PRECONDITION_VIOLATED(command) STATUS("TEST_PRECONDITION_VIOLATED(" # command ") - skipped");
900 #endif
901 
913 #ifdef OPENMS_ASSERTIONS
914 #define TEST_POSTCONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Postcondition, command);
915 #else
916 #define TEST_POSTCONDITION_VIOLATED(command) STATUS("TEST_POSTCONDITION_VIOLATED(" # command ") - skipped");
917 #endif
918 
919 
936 #define TEST_EXCEPTION_WITH_MESSAGE(exception_type, command, message) \
937  { \
938  ++TEST::test_count; \
939  TEST::test_line = __LINE__; \
940  TEST::exception = 0; \
941  try \
942  { \
943  command; \
944  } \
945  catch (exception_type& et) \
946  { \
947  if (std::string(et.what()) != std::string(message)) \
948  { \
949  TEST::exception = 4; \
950  TEST::exception_message = et.what(); \
951  } \
952  else TEST::exception = 1; \
953  } \
954  catch (::OpenMS::Exception::BaseException& e) \
955  { \
956  TEST::exception = 2; \
957  TEST::exception_name = e.getName(); \
958  } \
959  catch (...) \
960  { \
961  TEST::exception = 3; \
962  } \
963  TEST::this_test = (TEST::exception == 1); \
964  TEST::test = TEST::test && TEST::this_test; \
965  \
966  { \
967  TEST::initialNewline(); \
968  switch (TEST::exception) \
969  { \
970  case 0: \
971  stdcout << " - line " << TEST::test_line << \
972  ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
973  "): no exception thrown!\n"; \
974  TEST::failed_lines_list.push_back(TEST::test_line); \
975  break; \
976  case 1: \
977  if (TEST::verbose > 1) \
978  { \
979  /* this is actually what we want to get: */ \
980  stdcout << " + line " << TEST::test_line << \
981  ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
982  "): OK\n"; \
983  break; \
984  } \
985  case 2: \
986  stdcout << " - line " << TEST::test_line << \
987  ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
988  "): wrong exception thrown! \"" << \
989  TEST::exception_name << "\"\n"; \
990  TEST::failed_lines_list.push_back(TEST::test_line); \
991  break; \
992  case 3: \
993  stdcout << " - line " << TEST::test_line << \
994  ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
995  "): wrong exception thrown!\n"; \
996  TEST::failed_lines_list.push_back(TEST::test_line); \
997  break; \
998  case 4: \
999  stdcout << " - line " << TEST::test_line << \
1000  ": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
1001  "): exception has wrong message: got '" << \
1002  TEST::exception_message << \
1003  "', expected '" << \
1004  (message) << "'\n"; \
1005  TEST::failed_lines_list.push_back(TEST::test_line); \
1006  break; \
1007  } \
1008  } \
1009  }
1010 
1026 #define NEW_TMP_FILE(filename) \
1027  { \
1028  filename = TEST::tmpFileName(__FILE__, __LINE__); \
1029  TEST::tmp_file_list.push_back(filename); \
1030  { \
1031  TEST::initialNewline(); \
1032  stdcout << " creating new temporary filename '" \
1033  << filename \
1034  << "' (line " \
1035  << __LINE__ \
1036  << ")\n"; \
1037  } \
1038  }
1039 
1047 #define ABORT_IF(condition) \
1048  if (condition) \
1049  { \
1050  { \
1051  TEST::test_line = __LINE__; \
1052  TEST::this_test = false; \
1053  TEST::test = TEST::test && TEST::this_test; \
1054  TEST::failed_lines_list.push_back(TEST::test_line); \
1055  TEST::initialNewline(); \
1056  stdcout << " - line " << TEST::test_line << \
1057  ": ABORT_IF(" # condition "): TEST ABORTED\n"; \
1058  } \
1059  break; \
1060  }
1061 
1079 #define STATUS(message) \
1080  { \
1081  TEST::initialNewline(); \
1082  stdcout << " line " \
1083  << __LINE__ \
1084  << ": status: " \
1085  << message \
1086  << "\n"; \
1087  }
1088 
1098 #define ADD_MESSAGE(message) \
1099  TEST::add_message = message;
1100 
1110 #define NOT_TESTABLE \
1111  TEST::test_count = 1;
1112 
stdcout
#define stdcout
Provide a point of redirection for testing the test macros, see ClassTest_test.cpp.
Definition: ClassTest.h:58
OpenMS::DataValue
Class to hold strings, numeric values, lists of strings and lists of numeric values.
Definition: DataValue.h:59
OpenMS::ParamValue
Class to hold strings, numeric values, vectors of strings and vectors of numeric values using the stl...
Definition: ParamValue.h:55
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS::Internal::ClassTest
Namespace for class tests.
Definition: ClassTest.h:67
OpenMS::Internal::ClassTest::ratio_max
double ratio_max
Maximum ratio of numbers observed so far, see TOLERANCE_RELATIVE.
OpenMS::Internal::ClassTest::verbose
int verbose
Verbosity level ( "-v" is 1 and "-V" is 2 )
OpenMS::Internal::ClassTest::test_count
int test_count
Counter for the number of elementary tests within the current subsection.
OpenMS::Internal::ClassTest::endTestPostProcess
int endTestPostProcess(std::ostream &out)
OpenMS::Internal::ClassTest::initialNewline
void initialNewline()
make sure we have a newline before results from first subtest
OpenMS::Internal::ClassTest::testStringSimilar
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.
OpenMS::Internal::ClassTest::endSectionPostProcess
void endSectionPostProcess(std::ostream &out, const int line)
OpenMS::Internal::ClassTest::testEqual
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:297
OpenMS::Internal::ClassTest::test_line
int test_line
Line of current elementary test.
OpenMS::Internal::ClassTest::testRealSimilar
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.
OpenMS::Internal::ClassTest::absdiff
double absdiff
Recent absolute difference of numbers, see TOLERANCE_ABSOLUTE.
OpenMS::Internal::ClassTest::line_buffer
char line_buffer[65536]
(A buffer for one line from a file. Used by TEST_FILE_EQUAL.)
OpenMS::Internal::ClassTest::add_message
std::string add_message
See ADD_MESSAGE.
OpenMS::Internal::ClassTest::validate
bool validate(const std::vector< std::string > &file_names)
Validates the given files against the XML schema (if available)
OpenMS::Internal::ClassTest::fuzzy_message
std::string fuzzy_message
Last message from a fuzzy comparison. Written by isRealSimilar(), testStringSimilar(),...
OpenMS::Internal::ClassTest::mainInit
void mainInit(const char *version, const char *class_name, int argc, const char *argv0)
Set up some classtest variables as obtained from the 'START_TEST' macro and check that no additional ...
OpenMS::Internal::ClassTest::all_tests
bool all_tests
Status of the whole test.
OpenMS::Internal::ClassTest::exception_message
std::string exception_message
(Used by various macros. Stores the "message" of the exception, if applicable.)
OpenMS::Internal::ClassTest::test_name
std::string test_name
Name of current subsection.
OpenMS::Internal::ClassTest::testStringEqual
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
OpenMS::Internal::ClassTest::absdiff_max
double absdiff_max
Maximum difference of numbers observed so far, see TOLERANCE_ABSOLUTE.
OpenMS::Internal::ClassTest::printWithPrefix
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
OpenMS::Internal::ClassTest::newline
bool newline
(Flags whether a new line is in place, depending on context and verbosity setting....
OpenMS::Internal::ClassTest::tmpFileName
std::string tmpFileName(const std::string &file, int line)
Creates a temporary file name from the test name and the line.
OpenMS::Internal::ClassTest::test
bool test
Status of the current subsection.
OpenMS::Internal::ClassTest::absdiff_max_allowed
double absdiff_max_allowed
Maximum absolute difference of numbers allowed, see TOLERANCE_ABSOLUTE.
OpenMS::Internal::ClassTest::version_string
const char * version_string
Version string supplied with START_TEST.
OpenMS::Internal::ClassTest::infile
std::ifstream infile
Questionable file tested by TEST_FILE_EQUAL.
OpenMS::Internal::ClassTest::testTrue
void testTrue(const char *, int line, const bool expression_1, const char *expression_1_stringified)
Definition: ClassTest.h:329
OpenMS::Internal::ClassTest::testFalse
void testFalse(const char *, int line, const bool expression_1, const char *expression_1_stringified)
Definition: ClassTest.h:352
OpenMS::Internal::ClassTest::exception_name
std::string exception_name
(Used by various macros. Stores the "name" of the exception, if applicable.)
OpenMS::Internal::ClassTest::failed_lines_list
std::vector< UInt > failed_lines_list
List of all failed lines for summary at the end of the test.
OpenMS::Internal::ClassTest::removeTempFiles
void removeTempFiles()
removed all temporary files created with the NEW_TMP_FILE macro
OpenMS::Internal::ClassTest::ratio
double ratio
Recent ratio of numbers, see TOLERANCE_RELATIVE.
OpenMS::Internal::ClassTest::tmp_file_list
std::vector< std::string > tmp_file_list
List of tmp file names (these will be cleaned up, see NEW_TMP_FILE)
OpenMS::Internal::ClassTest::isFileSimilar
bool isFileSimilar(const std::string &filename_1, const std::string &filename_2)
Compare files using absdiff_max_allowed and ratio_max_allowed.
OpenMS::Internal::ClassTest::testNotEqual
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:377
OpenMS::Internal::ClassTest::this_test
bool this_test
Status of last elementary test.
OpenMS::Internal::ClassTest::templatefile
std::ifstream templatefile
Template (correct) file used by TEST_FILE_EQUAL.
OpenMS::Internal::ClassTest::ratio_max_allowed
double ratio_max_allowed
Maximum ratio of numbers allowed, see TOLERANCE_RELATIVE.
OpenMS::Internal::ClassTest::setWhitelist
void setWhitelist(const char *const, const int line, const std::string &whitelist)
set the whitelist_
OpenMS::Internal::ClassTest::isRealType
bool isRealType(float)
This overload returns true; float is a floating point type.
Definition: ClassTest.h:82
OpenMS::Internal::ClassTest::equal_files
bool equal_files
(A variable used by TEST_FILE_EQUAL)
OpenMS::Internal::ClassTest::start_section_line
int start_section_line
Line where current subsection started.
OpenMS::Internal::ClassTest::filesEqual
void filesEqual(int line, const char *filename, const char *templatename, const char *filename_stringified, const char *templatename_stringified)
Test if two files are exactly equal (used in TEST_FILE_EQUAL macro)
OpenMS::Internal::ClassTest::printLastException
void printLastException(std::ostream &out)
OpenMS::Internal::ClassTest::exception
int exception
(Used by various macros. Indicates a rough category of the exception being caught....
OpenMS::Internal::ClassTest::isRealSimilar
bool isRealSimilar(long double number_1, long double number_2)
used by testRealSimilar()
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48