1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
|
// --------------------------------------------------------------------------
// OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of any author or any participating institution
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Stephan Aiche $
// $Authors: Marc Sturm, Clemens Groepl $
// --------------------------------------------------------------------------
#ifndef OPENMS_CONCEPT_CLASSTEST_H
#define OPENMS_CONCEPT_CLASSTEST_H
// Avoid OpenMS includes here at all costs
// When the included headers are changed, *all* tests have to be recompiled!
// Use the ClassTest class if you need add high-level functionality.
// Includes in the C-file are ok...
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/CONCEPT/UniqueIdGenerator.h>
#include <OpenMS/SYSTEM/File.h>
#include <vector>
#include <string>
#include <cstring>
#include <list>
#include <iostream>
#include <fstream>
#include <boost/lexical_cast.hpp>
#ifdef OPENMS_HAS_UNISTD_H
#include <unistd.h> // unlink()
#endif
#include <cstdio> // tmpnam()
#include <cmath> // fabs
#include <cstdlib> // getenv()
// Empty declaration to avoid problems in case the namespace is not
// yet defined (e.g. TEST/ClassTest_test.C)
/// Provide a point of redirection for testing the test macros, see ClassTest_test.C
#ifndef std__cout
#define std__cout std::cout
#endif
namespace OpenMS
{
namespace Internal
{
/// Namespace for class tests
namespace ClassTest
{
/**
@brief Validates the given files against the XML schema (if available)
@return If all files passed the validation
*/
bool OPENMS_DLLAPI
validate(const std::vector<std::string>& file_names);
/// Creates a temporary file name from the test name and the line
std::string OPENMS_DLLAPI
tmpFileName(const std::string& file, int line);
/// This overload returns true; @c float is a floating point type.
inline bool OPENMS_DLLAPI
isRealType(float)
{
return true;
}
/// This overload returns true; @c double is a floating point type.
inline bool OPENMS_DLLAPI
isRealType(double)
{
return true;
}
/// This overload returns true; @c long @c double is a floating point type.
inline bool OPENMS_DLLAPI
isRealType(long double)
{
return true;
}
/// This overload returns true; @c DataValue will be converted to DoubleReal by #TEST_REAL_SIMILAR.
inline bool OPENMS_DLLAPI
isRealType(const DataValue&)
{
return true;
}
/// This catch-all template returns false; it will be instantiated for non-floating point types.
template <typename T>
inline bool
isRealType(const T&)
{
return false;
}
/** @brief Compare floating point numbers using @em absdiff_max_allowed and
@em ratio_max_allowed.
Side effects: Updates #fuzzy_message.
*/
void OPENMS_DLLAPI
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 /* number_2_is_realtype */, Int number_2_written_digits);
/// used by testRealSimilar()
bool OPENMS_DLLAPI
isRealSimilar(long double number_1, long double number_2);
/**@brief Compare strings using @em absdiff_max_allowed and @em ratio_max_allowed.
This is called by the #TEST_STRING_SIMILAR macro.
Side effects: Updates #absdiff, #ratio, #fuzzy_message, #line_num_1_max
and #line_num_2_max.
*/
void OPENMS_DLLAPI
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);
/// used by TEST_STRING_EQUAL
void OPENMS_DLLAPI
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);
/**@brief Compare files using @em absdiff_max_allowed and @em ratio_max_allowed.
Side effects: Updates #absdiff, #ratio, #fuzzy_message, #line_num_1_max
and #line_num_2_max.
*/
bool OPENMS_DLLAPI
isFileSimilar(const std::string& filename_1,
const std::string& filename_2);
/// make sure we have a newline before results from first subtest
void OPENMS_DLLAPI
initialNewline();
/// print the text, each line gets a prefix, the marked line number gets a special prefix
void OPENMS_DLLAPI
printWithPrefix(const std::string& text, const int marked = -1);
/// set the whitelist_
void OPENMS_DLLAPI
setWhitelist(const char* const /* file */, const int line,
const std::string& whitelist);
/// Maximum ratio of numbers allowed, see #TOLERANCE_RELATIVE.
extern OPENMS_DLLAPI double ratio_max_allowed;
/// Maximum ratio of numbers observed so far, see #TOLERANCE_RELATIVE.
extern OPENMS_DLLAPI double ratio_max;
/// Recent ratio of numbers, see #TOLERANCE_RELATIVE.
extern OPENMS_DLLAPI double ratio;
/// Maximum absolute difference of numbers allowed, see #TOLERANCE_ABSOLUTE.
extern OPENMS_DLLAPI double absdiff_max_allowed;
/// Maximum difference of numbers observed so far, see #TOLERANCE_ABSOLUTE.
extern OPENMS_DLLAPI double absdiff_max;
/// Recent absolute difference of numbers, see #TOLERANCE_ABSOLUTE.
extern OPENMS_DLLAPI double absdiff;
extern OPENMS_DLLAPI int line_num_1_max;
extern OPENMS_DLLAPI int line_num_2_max;
/// Verbosity level ( "-v" is 1 and "-V" is 2 )
extern OPENMS_DLLAPI int verbose;
/// Status of the whole test
extern OPENMS_DLLAPI bool all_tests;
/// Status of the current subsection
extern OPENMS_DLLAPI bool test;
/// Status of last elementary test
extern OPENMS_DLLAPI bool this_test;
/// (Used by various macros. Indicates a rough category of the exception being caught.)
extern OPENMS_DLLAPI int exception;
/// (Used by various macros. Stores the "name" of the exception, if applicable.)
extern OPENMS_DLLAPI std::string exception_name;
/// (Used by various macros. Stores the "message" of the exception, if applicable.)
extern OPENMS_DLLAPI std::string exception_message;
/// Name of current subsection
extern OPENMS_DLLAPI std::string test_name;
/// Line where current subsection started
extern OPENMS_DLLAPI int start_section_line;
/// Line of current elementary test
extern OPENMS_DLLAPI int test_line;
/// Version string supplied with #START_TEST
extern OPENMS_DLLAPI const char* version_string;
/// List of tmp file names (these will be cleaned up, see #NEW_TMP_FILE)
extern OPENMS_DLLAPI std::vector<std::string> tmp_file_list;
/// List of all failed lines for summary at the end of the test
extern OPENMS_DLLAPI std::vector<UInt> failed_lines_list;
/// Questionable file tested by #TEST_FILE_EQUAL
extern OPENMS_DLLAPI std::ifstream infile;
/// Template (correct) file used by #TEST_FILE_EQUAL
extern OPENMS_DLLAPI std::ifstream templatefile;
/// (A variable used by #TEST_FILE_EQUAL)
extern OPENMS_DLLAPI bool equal_files;
/// (A buffer for one line from a file. Used by #TEST_FILE_EQUAL.)
extern OPENMS_DLLAPI char line_buffer[65536];
/// Counter for the number of elementary tests within the current subsection.
extern OPENMS_DLLAPI int test_count;
/// See #ADD_MESSAGE.
extern OPENMS_DLLAPI std::string add_message;
/**@brief Last message from a fuzzy comparison. Written by
#isRealSimilar(), #testStringSimilar(), #isFileSimilar(). Read by
#TEST_REAL_SIMILAR, #TEST_STRING_SIMILAR, #TEST_FILE_SIMILAR;
*/
extern OPENMS_DLLAPI std::string fuzzy_message;
/// (Flags whether a new line is in place, depending on context and verbosity setting. Used by initialNewline() and some macros.)
extern OPENMS_DLLAPI bool newline;
template <typename T1, typename T2>
void
testEqual(const char* /*file*/, int line, const T1& expression_1,
const char* expression_1_stringified,
const T2& expression_2,
const char* expression_2_stringified)
{
++test_count;
test_line = line;
this_test = bool(expression_1 == T1(expression_2));
test = test && this_test;
{
initialNewline();
if (this_test)
{
std__cout << " + line " << line << ": TEST_EQUAL("
<< expression_1_stringified << ','
<< expression_2_stringified << "): got " << expression_1
<< ", expected " << expression_2 << std::endl;
}
else
{
std__cout << " - line " << line << ": TEST_EQUAL("
<< expression_1_stringified << ','
<< expression_2_stringified << "): got " << expression_1
<< ", expected " << expression_2 << std::endl;
failed_lines_list.push_back(line);
}
}
}
template <typename T1, typename T2>
void
testNotEqual(const char* /*file*/, int line, const T1& expression_1,
const char* expression_1_stringified,
const T2& expression_2,
const char* expression_2_stringified)
{
++test_count;
test_line = line;
this_test = !(expression_1 == T1(expression_2));
test = test && this_test;
{
initialNewline();
if (this_test)
{
std__cout << " + line " << line << ": TEST_NOT_EQUAL("
<< expression_1_stringified << ','
<< expression_2_stringified << "): got " << expression_1
<< ", forbidden is " << expression_2 << std::endl;
}
else
{
std__cout << " - line " << line << ": TEST_NOT_EQUAL("
<< expression_1_stringified << ','
<< expression_2_stringified << "): got " << expression_1
<< ", forbidden is " << expression_2 << std::endl;
failed_lines_list.push_back(line);
}
}
}
}
}
}
// A namespace alias - apparently these cannot be documented using doxygen (?)
namespace TEST = OpenMS::Internal::ClassTest;
/**
@defgroup ClassTest Class test macros
@brief These macros are used by the test programs in the subdirectory
<code>OpenMS/source/TEST</code>.
On successful operation the test program will print out the message "PASSED",
otherwise "FAILED".
If called with the @b -v option, the test program prints verbose information
about subsections.
If called with the @b -V option, the test program prints even more verbose
information for every elementary test.
The implementation is done in namespace #OpenMS::Internal::ClassTest.
To create a test you can use the 'create_test.php' script in %OpenMS/tools/
(other useful scripts in the same directory - have a look).
@ingroup Concept
*/
//@{
//@name test and subtest
//@{
/** @brief Begin of the test program for a given class. @sa #END_TEST.
The #START_TEST macro defines the start of the test program for a given
classname. The classname is printed together with some information when
calling the test program with any arguments (except for <code>-v</code> or
<code>-V</code>).
The second argument version should take the form "$Id:$". The actual
version info will then be filled in by Subversion (the revision control
system). If it does not, use "svn help propset" to find out how to include
"Id" in the property "svn:keywords" for the *_test.C file in question.
The #START_TEST macro should be the first one to call in a test program. It
opens a global <code>try</code> block to catch any unwanted exceptions. If
any of these exceptions occurs, all tests fail. Exceptions defined by
%OpenMS (i.e. exception classes derived from Exception::BaseException)
provide some additional information that is evaluated by the #END_TEST
macro. The #END_TEST macro also closes the <code>try</code> block. This
<code>try</code> block should never catch an exception! All exceptions that
are thrown due to some malfunction in one of the member functions should be
caught by the <code>try</code> block created by #START_SECTION and
#END_SECTION .
@hideinitializer
*/
#define START_TEST(class_name, version) \
int main(int argc, char** argv) \
{ \
\
{ \
/* initialize the random generator as early as possible! */ \
OpenMS::DateTime date_time; \
date_time.set("1999-12-31 23:59:59"); \
OpenMS::UniqueIdGenerator::setSeed(date_time); \
} \
\
TEST::version_string = version; \
\
if (argc > 1) \
{ \
std::cerr \
<< "This is " << argv[0] << ", the test program for the\n" \
<< # class_name " class.\n" \
"\n" \
"On successful operation it returns PASSED,\n" \
"otherwise FAILED is printed.\n"; \
return 1; \
} \
\
try {
/** @brief End of the test program for a class. @sa #START_TEST.
The #END_TEST macro implements the correct termination of the test program
and should therefore be the last macro to call. It determines the exit code
based on all previously run subtests and prints out the message "PASSED" or
"FAILED". This macro also closes the global <code>try</code> block opened
by #START_TEST and contains the related <code>catch</code> clauses. If an
exception is caught here, the test program fails.
@hideinitializer
*/
#define END_TEST \
/* global try block */ \
} \
catch (::OpenMS::Exception::BaseException& e) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught unexpected OpenMS exception of type '" \
<< e.getName() \
<< "'"; \
if ((e.getLine() > 0) && (std::strcmp(e.getFile(), "") != 0)) \
{ \
std__cout << " thrown in line " << e.getLine() << " of file '" << e.getFile() \
<< "' in function '" << e.getFunction() << "'"; \
} \
std__cout << " - Message: " << e.what() << std::endl; \
} \
} \
/* catch std:: exceptions */ \
catch (std::exception& e) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught unexpected std::exception" << std::endl; \
std__cout << " - Message: " << e.what() << std::endl; \
} \
} \
/* catch all other exceptions */ \
catch (...) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught unidentified and unexpected exception - No message." \
<< std::endl; \
} \
} \
/* check validity of temporary files if known */ \
if (!TEST::validate(TEST::tmp_file_list)) \
{ \
TEST::all_tests = false; \
} \
/* check for exit code */ \
if (!TEST::all_tests) \
{ \
std__cout << "FAILED" << std::endl; \
if (TEST::add_message != "") std__cout << "Message: " \
<< TEST::add_message \
<< std::endl; \
std__cout << "Failed lines: "; \
for (OpenMS::Size i = 0; i < TEST::failed_lines_list.size(); ++i) \
{ \
std__cout << TEST::failed_lines_list[i] << " "; \
} \
std__cout << std::endl; \
return 1; \
} \
else \
{ \
/* remove temporary files*/ \
for (OpenMS::Size i = 0; i < TEST::tmp_file_list.size(); ++i) \
{ \
if (!OpenMS::File::remove(TEST::tmp_file_list[i])) \
{ \
std__cout << "Warning: unable to remove temporary file '" \
<< TEST::tmp_file_list[i] \
<< "'" \
<< std::endl; \
} \
} \
std__cout << "PASSED"; \
if (TEST::add_message != "") std__cout << " (" << TEST::add_message << ")"; \
std__cout << std::endl; \
return 0; \
} \
}
/** @brief Begin of a subtest with a given name. @sa #END_SECTION.
The #START_SECTION macro is used to declare the name of a subtest. Use this
to examine a member function of the class which was specified in
#START_TEST. If you want to check e.g. the memFunc() method of a class,
insert a line #START_SECTION(memFunc()) in your test program. If the test
program is called in verbose mode, this leads to the name of the subtest
being printed on execution.
If you are testing a non-public method you can use the [EXTRA] statement,
e.g. #START_SECTION([EXTRA]memFunc())
to indicate this. Otherwise you will trigger a warning by %OpenMS/tools/checker.php
due to this unexpected subtest.
This macro also opens a <code>try</code> block to catch any unexpected
exceptions thrown in the course of a subtest. To catch <em>wanted</em>
exceptions (i.e. to check for exceptions that are the expected result of
some command) use the #TEST_EXCEPTION macro. The <code>try</code> block
opened by #START_SECTION is closed in #END_SECTION, so these two macros have to be
balanced.
@hideinitializer
*/
#define START_SECTION(name_of_test) \
TEST::test = true; \
TEST::newline = false; \
TEST::test_name = # name_of_test; \
TEST::test_count = 0; \
TEST::start_section_line = __LINE__; \
std__cout << "checking " << TEST::test_name << " ... " << std::flush; \
try \
{ \
while (true) \
{
/** @brief End of a subtest. @sa #START_SECTION.
The #END_SECTION macro defines the end of a subtest.
Each elementary test macro updates an internal variable (TEST::test) that
holds the state of the current subtest. #END_SECTION prints whether the
subtest has passed or failed (in verbose mode) and updates the internal
variables <b>TEST::all_tests</b> that describes the state of the whole class
test. <b>TEST::all_tests</b> is initialized to be <b>true</b>. If any
elementary test fails, <b>TEST::test</b> becomes <b>false</b>. At the time
of the next call to #END_SECTION, <b>TEST::all_tests</b> will be set to
false, if <b>TEST::test</b> is false. One failed elementary test leads
therefore to a failed subtest, which leads to a failed class test.
This macro closes the <code>try</code> block opened by #START_SECTION, so
#START_SECTION and #END_SECTION have to be balanced, or some ugly
compile-time errors will occur. #END_SECTION first tries to catch all
<code>OpenMS::Exception</code>s (i.e. exceptions derived from
OpenMS::Exception::BaseException). If this fails, it tries to catch any
exception. After the exception is caught, the execution will continue with
the next subtest, but the current subtest is marked as failed (as is the
whole test program).
@hideinitializer
*/
#define END_SECTION \
break; \
} \
} \
catch (::OpenMS::Exception::BaseException& e) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught unexpected exception of type '" << e.getName() << "'"; \
if ((e.getLine() > 0) && (std::strcmp(e.getFile(), "") != 0)) \
{ \
std__cout << " thrown in line " << e.getLine() << " of file '" << e.getFile() \
<< "' in function '" << e.getFunction() << "'"; \
} \
std__cout << " - Message: " << e.what() << std::endl; \
} \
} \
/* catch std:: exceptions */ \
catch (std::exception& e) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught std::exception" << std::endl; \
std__cout << " - Message: " << e.what() << std::endl; \
} \
} \
/* catch all other exceptions */ \
catch (...) \
{ \
TEST::this_test = false; \
TEST::test = false; \
TEST::all_tests = false; \
{ \
TEST::initialNewline(); \
std__cout << "Error: Caught unidentified and unexpected exception - No message." \
<< std::endl; \
} \
} \
TEST::all_tests = TEST::all_tests && TEST::test; \
{ \
if (TEST::test) \
{ \
std__cout << ": passed" << std::endl; \
} \
else \
{ \
std__cout << ": failed" << std::endl; \
} \
} \
/* issue a warning if no tests were performed (unless in destructor)*/ \
if (TEST::test_count == 0) \
{ \
bool destructor = false; \
for (OpenMS::Size i = 0; i != TEST::test_name.size(); ++i) \
{ \
if (TEST::test_name[i] == '~') \
{ \
destructor = true; \
break; \
} \
} \
if (!destructor) std__cout << "Warning: no subtests performed in '" \
<< TEST::test_name \
<< "' (line " \
<< __LINE__ \
<< ")!" \
<< std::endl \
<< std::flush; \
} \
std__cout << std::endl;
//@}
/** @brief Generic equality macro.
This macro uses the operator == to check its two arguments for equality.
Besides handling some internal stuff, it basically evaluates ((a) == (b)).
Remember that operator == has to be defined somehow for the two argument
types. Additionally the << operator needs to be defined.
If only == is available you will get a compilation error. As workaround
use TEST_EQUAL(a==b, true) thereby making bug tracing harder,
as you won't see the values of a and b.
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@param a value/object to test
@param b expected value
@hideinitializer
*/
#define TEST_EQUAL(a, b) TEST::testEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
/** @brief Generic inequality macro.
This macro checks for inequality just like #TEST_EQUAL tests for equality.
The only difference between the two macros is that #TEST_NOT_EQUAL evaluates
!((a) == (b)).
@param a value/object to test
@param b forbidden value
@hideinitializer
*/
#define TEST_NOT_EQUAL(a, b) TEST::testNotEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
/** @brief String equality macro.
Both arguments are converted to std::string and tested for equality. (That
is, we check whether <code>(std::string(a) == std::string(b))</code> holds.)
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@param a value to test
@param b expected value
@hideinitializer
*/
#define TEST_STRING_EQUAL(a, b) TEST::testStringEqual(__FILE__, __LINE__, (a), (# a), (b), (# b));
/**
@brief File comparison macro.
This macro is used to test file operations. It
compares the file with name <code>filename</code> against a template file
<code>templatename</code>. Corresponding lines of the two files have to be
identical.
@note line length is limited to 64k characters
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@hideinitializer
*/
#define TEST_FILE_EQUAL(filename, templatename) \
{ \
++TEST::test_count; \
TEST::equal_files = true; \
TEST::infile.open(filename, std::ios::in); \
TEST::templatefile.open(templatename, std::ios::in); \
\
if (TEST::infile.good() && TEST::templatefile.good()) \
{ \
std::string TEST_FILE__template_line; \
std::string TEST_FILE__line; \
\
while (TEST::infile.good() && TEST::templatefile.good()) \
{ \
TEST::templatefile.getline(TEST::line_buffer, 65535); \
TEST_FILE__template_line = TEST::line_buffer; \
TEST::infile.getline(TEST::line_buffer, 65535); \
TEST_FILE__line = TEST::line_buffer; \
\
TEST::equal_files &= (TEST_FILE__template_line == TEST_FILE__line); \
if (TEST_FILE__template_line != TEST_FILE__line) \
{ \
{ \
TEST::initialNewline(); \
std__cout << " TEST_FILE_EQUAL: line mismatch:\n got: '" \
<< TEST_FILE__line << "'\n expected: '" \
<< TEST_FILE__template_line << "'" << std::endl; \
} \
} \
} \
} \
else \
{ \
TEST::equal_files = false; \
{ \
TEST::initialNewline(); \
std__cout << " + line " \
<< __LINE__ \
<< ": TEST_FILE_EQUAL(" \
<< # filename \
<< ", " \
<< # templatename; \
std__cout << ") : " << " cannot open file: \""; \
if (!TEST::infile.good()) \
{ \
std__cout << filename << "\" (input file) "; \
} \
if (!TEST::templatefile.good()) \
{ \
std__cout << templatename << "\" (template file) "; \
} \
std__cout << std::endl; \
\
} \
} \
TEST::infile.close(); \
TEST::templatefile.close(); \
TEST::infile.clear(); \
TEST::templatefile.clear(); \
\
TEST::this_test = TEST::equal_files; \
TEST::test = TEST::test && TEST::this_test; \
{ \
TEST::initialNewline(); \
if (TEST::this_test) \
{ \
std__cout << " + line " \
<< __LINE__ \
<< ": TEST_FILE_EQUAL(" \
<< # filename \
<< ", " \
<< # templatename \
<< "): true"; \
} \
else \
{ \
std__cout << " - line " \
<< __LINE__ \
<< ": TEST_FILE_EQUAL(" \
<< # filename \
<< ", " \
<< # templatename \
<< "): false (different files: " \
<< filename \
<< " " \
<< templatename \
<< " )\n"; \
TEST::failed_lines_list.push_back(TEST::test_line); \
} \
} \
}
/** @brief Floating point similarity macro.
Checks whether the two numbers are sufficiently close based upon the
settings of #TOLERANCE_ABSOLUTE and #TOLERANCE_RELATIVE.
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@note Both arguments are converted to @c double. The actual comparison is done
by isRealSimilar().
@param a value to test
@param b expected value
@hideinitializer
*/
#define TEST_REAL_SIMILAR(a, b) TEST::testRealSimilar(__FILE__, __LINE__, (a), (# a), TEST::isRealType(a), writtenDigits(a), (b), (# b), TEST::isRealType(b), writtenDigits(b));
/** @brief String similarity macro.
Compares the two strings using @em FuzzyStringComparator with the settings of
#TOLERANCE_ABSOLUTE and #TOLERANCE_RELATIVE.
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@note Both arguments are converted to @c std::string. The actual comparison
is done by testStringSimilar().
@param a value to test
@param b expected value
@hideinitializer
*/
#define TEST_STRING_SIMILAR(a, b) TEST::testStringSimilar(__FILE__, __LINE__, (a), (# a), (b), (# b));
/** @brief File similarity macro.
Compares the two files using @em FuzzyStringComparator with the settings of
#TOLERANCE_ABSOLUTE and #TOLERANCE_RELATIVE.
@note This macro evaluates its arguments once or twice, depending on verbosity settings.
@note The actual comparison is done by isFileSimilar().
@param a value to test
@param b expected value
@hideinitializer
*/
#define TEST_FILE_SIMILAR(a, b) \
{ \
++TEST::test_count; \
TEST::test_line = __LINE__; \
TEST::this_test = TEST::isFileSimilar((a), (b)); \
TEST::test = TEST::test && TEST::this_test; \
{ \
TEST::initialNewline(); \
if (TEST::this_test) \
{ \
std__cout << " + line " << __LINE__ \
<< ": TEST_FILE_SIMILAR(" # a "," # b "): absolute: " \
<< precisionWrapper(TEST::absdiff) \
<< " (" \
<< precisionWrapper(TEST::absdiff_max_allowed) \
<< "), relative: " \
<< precisionWrapper(TEST::ratio) \
<< " (" \
<< precisionWrapper(TEST::ratio_max_allowed) \
<< ")" \
<< std::endl; \
std__cout << "message: \n"; \
std__cout << TEST::fuzzy_message; \
} \
else \
{ \
std__cout << " - line " << TEST::test_line << \
": TEST_FILE_SIMILAR(" # a "," # b ") ... -\n"; \
std__cout << "message: \n"; \
std__cout << TEST::fuzzy_message; \
TEST::failed_lines_list.push_back(TEST::test_line); \
} \
} \
}
/** @brief Define the relative tolerance for floating point comparisons.
@sa #TEST_REAL_SIMILAR, #TEST_STRING_SIMILAR, #TEST_FILE_SIMILAR
Several macros consider two numbers sufficiently "close" if <b>the ratio of
the larger and the smaller</b> is bounded by the value supplied by
#TOLERANCE_RELATIVE. The default value is @f$ 1 + 10^{-5} @f$. It is
possible to redefine the relative tolerance by calling #TOLERANCE_RELATIVE
with the new value.
@hideinitializer
*/
#define TOLERANCE_RELATIVE(a) \
TEST::ratio_max_allowed = (a); \
{ \
TEST::initialNewline(); \
std__cout << " + line " << __LINE__ << \
": TOLERANCE_RELATIVE(" << TEST::ratio_max_allowed << \
") (\"" # a "\")" << std::endl; \
}
/** @brief Define the absolute tolerance for floating point comparisons.
@sa #TEST_REAL_SIMILAR, #TEST_STRING_SIMILAR, #TEST_FILE_SIMILAR
Several macros consider two numbers sufficiently "close" if <b>the absolute
difference</b> is bounded by the value supplied by #TOLERANCE_ABSOLUTE. The
default value is @f$ 10^{-5} @f$. It is possible to redefine the absolute
tolerance by calling #TOLERANCE_ABSOLUTE with the new value.
@hideinitializer
*/
#define TOLERANCE_ABSOLUTE(a) \
TEST::absdiff_max_allowed = (a); \
{ \
TEST::initialNewline(); \
std__cout << " + line " << __LINE__ << \
": TOLERANCE_ABSOLUTE(" << TEST::absdiff_max_allowed << \
") (\"" # a "\")" << std::endl; \
}
/** @brief Define the whitelist_ used by #TEST_STRING_SIMILAR and #TEST_FILE_SIMILAR.
If both lines contain the same element from this list, they are skipped
over. (See @em FuzzyStringComparator.)
*/
#define WHITELIST(a) TEST::setWhitelist(__FILE__, __LINE__, (a));
/** @brief Exception test macro.
This macro checks if a given type of exception occurred while executing the
given command. Example: #TEST_EXCEPTION(Exception::IndexOverflow,
vector[-1]). If no or a wrong exception occurred, false is returned,
otherwise true.
@param exception_type the exception-class
@param command any general C++ or OpenMS-specific command
@hideinitializer
*/
#define TEST_EXCEPTION(exception_type, command) \
{ \
++TEST::test_count; \
TEST::test_line = __LINE__; \
TEST::exception = 0; \
try \
{ \
command; \
} \
catch (exception_type) \
{ \
TEST::exception = 1; \
} \
catch (::OpenMS::Exception::BaseException e) \
{ \
TEST::exception = 2; \
TEST::exception_name = e.getName(); \
} \
catch (...) \
{ \
TEST::exception = 3; \
} \
TEST::this_test = (TEST::exception == 1); \
TEST::test = TEST::test && TEST::this_test; \
\
{ \
TEST::initialNewline(); \
switch (TEST::exception) \
{ \
case 0: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION(" # exception_type "," # command \
"): no exception thrown!" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
case 1: \
std__cout << " + line " << TEST::test_line << \
": TEST_EXCEPTION(" # exception_type "," # command \
"): OK" << std::endl; \
break; \
case 2: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION(" # exception_type "," # command \
"): wrong exception thrown! \"" \
<< TEST::exception_name << "\"" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
case 3: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION(" # exception_type "," # command \
"): wrong exception thrown!" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
} \
} \
}
/** @brief Precondition test macro
This macro checks if a precondition violation is detected while executing the command,
similar to <code>TEST_EXCEPTION(Exception::Precondition,command)</code>.
However the test is executed only when the #OPENMS_PRECONDITION macros are active,
i.e., when compiling in Debug mode. (See Macros.h)
@param command any general C++ or OpenMS-specific command
@hideinitializer
*/
#ifdef OPENMS_ASSERTIONS
#define TEST_PRECONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Precondition, command);
#else
#define TEST_PRECONDITION_VIOLATED(command) STATUS("TEST_PRECONDITION_VIOLATED(" # command ") - skipped");
#endif
/** @brief Postcondition test macro
This macro checks if a postcondition violation is detected while executing the command,
similar to <code>TEST_EXCEPTION(Exception::Postcondition,command)</code>.
However the test is executed only when the #OPENMS_POSTCONDITION macros are active,
i.e., when compiling in Debug mode. (See Macros.h)
@param command any general C++ or OpenMS-specific command
@hideinitializer
*/
#ifdef OPENMS_ASSERTIONS
#define TEST_POSTCONDITION_VIOLATED(command) TEST_EXCEPTION(Exception::Postcondition, command);
#else
#define TEST_POSTCONDITION_VIOLATED(command) STATUS("TEST_POSTCONDITION_VIOLATED(" # command ") - skipped");
#endif
/** @brief Exception test macro (with test for exception message).
This macro checks if a given type of exception occurred while executing the
given command and additionally tests for the message of the exception.
Example: #TEST_EXCEPTION_WITH_MESSAGE(Exception::IndexOverflow, vector[-1], "a null pointer was specified")
If no, a wrong exception occurred or a wrong message is returned, false is
returned, otherwise true.
@param exception_type the exception-class
@param command any general C++ or OpenMS-specific command
@param message the message the exception should give
@hideinitializer
*/
#define TEST_EXCEPTION_WITH_MESSAGE(exception_type, command, message) \
{ \
++TEST::test_count; \
TEST::test_line = __LINE__; \
TEST::exception = 0; \
try \
{ \
command; \
} \
catch (exception_type et) \
{ \
if (std::string(et.getMessage()) != std::string(message)) \
{ \
TEST::exception = 4; \
TEST::exception_message = et.getMessage(); \
} \
else TEST::exception = 1; \
} \
catch (::OpenMS::Exception::BaseException e) \
{ \
TEST::exception = 2; \
TEST::exception_name = e.getName(); \
} \
catch (...) \
{ \
TEST::exception = 3; \
} \
TEST::this_test = (TEST::exception == 1); \
TEST::test = TEST::test && TEST::this_test; \
\
{ \
TEST::initialNewline(); \
switch (TEST::exception) \
{ \
case 0: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
"): no exception thrown!" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
case 1: \
/* this is actually what we want to get: */ \
std__cout << " + line " << TEST::test_line << \
": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
"): OK" << std::endl; \
break; \
case 2: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
"): wrong exception thrown! \"" << \
TEST::exception_name << "\"" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
case 3: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
"): wrong exception thrown!" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
case 4: \
std__cout << " - line " << TEST::test_line << \
": TEST_EXCEPTION_WITH_MESSAGE(" # exception_type "," # command ", " # message \
"): exception has wrong message: got '" << \
TEST::exception_message << \
"', expected '" << \
(message) << \
"'" << std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
break; \
} \
} \
}
/** @brief Create a temporary filename.
This macro assigns a new temporary filename to the string variable given as
its argument. The filename is created using the filename of the test and the
line number where this macro is invoked, for example 'Matrix_test.C' might
create a temporary file 'Matrix_test_268.tmp' if NEW_TMP_FILE is used in
line 268. All temporary files are deleted if #END_TEST is called. @param
filename string will contain the filename on completion of the macro.
All temporary files are validated using the XML schema,if the type of file
can be determined by FileHandler. Therefore for each file written in a test
NEW_TMP_FILE should be called. Otherwise only the last written file is checked.
@hideinitializer
*/
#define NEW_TMP_FILE(filename) \
{ \
filename = TEST::tmpFileName(__FILE__, __LINE__); \
TEST::tmp_file_list.push_back(filename); \
{ \
TEST::initialNewline(); \
std__cout << " creating new temporary filename '" \
<< filename \
<< "' (line " \
<< __LINE__ \
<< ")" \
<< std::endl; \
} \
}
/** @brief Skip the remainder of the current subtest.
If the condition is not fulfilled, the remainder of the current subtest is
skipped over. The status (whether it fails or passes) remains unchanged.
@hideinitializer
*/
#define ABORT_IF(condition) \
if (condition) \
{ \
{ \
TEST::initialNewline(); \
std__cout << " - line " << __LINE__ << \
": ABORT_IF(" # condition "): TEST ABORTED" << \
std::endl; \
TEST::failed_lines_list.push_back(TEST::test_line); \
} \
break; \
}
/**
@brief Print a status message.
If tests require longer preparations, #STATUS may be used to print some
intermediated progress messages. #STATUS uses <code>cout</code> to print
these messages (in verbose mode only). The given stream expression
<code>message</code> is prefixed by the string <code>status:</code> and
terminated with a newline. All valid operations on a stream may be performed
in <code>message</code>.
<b>Example:</b>
<code>
STATUS( "just calculated x = " << precisionWrapper(x) )
</code>
@hideinitializer
*/
#define STATUS(message) \
{ \
TEST::initialNewline(); \
std__cout << " line " \
<< __LINE__ \
<< ": status: " \
<< message \
<< std::endl; \
}
/**
@brief Sets an additional text that is displayed after final result of the test.
This can be used to provide additional information about the test to the user.
It is e.g. used to indicate that the DB test were skipped, when there are no
credentials given.
@hideinitializer
*/
#define ADD_MESSAGE(message) \
TEST::add_message = message;
/**
@brief Macro that suppresses the warning issued when no subtests are performed
Please use this macro only if the method cannot be tested at all or cannot be
tested properly on its own. In the later case, the method must however be tested
in tests of related methods. See also @em test_count.
@hideinitializer
*/
#define NOT_TESTABLE \
TEST::test_count = 1;
//@} // end of ClassTest
#endif //OPENMS_CONCEPT_CLASSTEST_H
|
