Fix the bug related to the empty version list
[bertos.git] / bertos / cfg / test.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2006 Develer S.r.l. (http://www.develer.com/)
30  * All Rights Reserved.
31  * -->
32  *
33  * \brief Utility for the test suite.
34  *
35  * \version $Id$
36  *
37  * \author Daniele Basile <asterix@develer.com>
38  * \author Francesco Sacchi <batt@develer.com>
39  *
40  * When you want to test a module that is emulable on hosted
41  * platforms, these macros come in handy.
42  * Your module_test should supply three basic functions:
43  *
44  * \code
45  * int module_testSetup(void)
46  * int module_testRun(void)
47  * int module_testTearDown(void)
48  * \endcode
49  *
50  * All of these should return 0 if ok or a value != 0 on errors.
51  *
52  * Then, at the end of your module_test you can write:
53  * \code
54  * #if UNIT_TEST
55  *      #include <whatuneed.h>
56  *      #include <whatuneed.c>
57  *      #include <...>
58  *
59  *      TEST_MAIN(module);
60  * #endif
61  * \endcode
62  *
63  * Including directly into your module the file.c you need to
64  * run the test allows you to build and run the test compiling
65  * only one file.
66  *
67  * To achieve this you also need a main() that is supplied by
68  * the TEST_MAIN macro.
69  * This will expand to a full main that calls, in sequence:
70  * Setup, Run and TearDown of your module.
71  */
72
73 #ifndef CFG_TEST_H
74 #define CFG_TEST_H
75
76 #include "cfg/cfg_arch.h"
77
78 #if defined(ARCH_UNITTEST) && (ARCH & ARCH_UNITTEST)
79         #define UNIT_TEST 1
80
81         /**
82          * Macro used to generate a main() for a test to be compiled
83          * on hosted platform.
84          */
85         #define TEST_MAIN(module) \
86         int main(void) \
87         { \
88                 if (module##_testSetup() != 0) \
89                         return 1; \
90                 if (module##_testRun() != 0) \
91                         return 2; \
92                 if (module##_testTearDown() != 0) \
93                         return 3; \
94                 return 0; \
95         }
96 #else /* !TEST */
97         #define UNIT_TEST 0
98
99         #define TEST_MAIN(module) /* nothing */
100 #endif /* TEST */
101
102
103 /**
104  * Silent an assert in a test.
105  *
106  * This is useful when we run a test and we want to test
107  * an error condition. We know that an assert will fail but
108  * this is not really an error. To ignore that we mark it
109  * with this macro, where str is the message string of the assert
110  * that we want to drop.
111  * To use this macro copy the assert log message and paste as argument
112  * of this macro. In assert message log is reported also the line number
113  * of the code that have generated the assert.
114  * In this way you can trap only the selected assert message.
115  */
116 #define SILENT_ASSERT(str) kputs("SILENT_ASSERT:$"str"$\n")
117
118 #endif /* CFG_TEST_H */