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  * int module_testSetup(void)
  45  * int module_testRun(void)
  46  * int module_testTearDown(void)
  47  *
  48  * All of these should return 0 if ok or a value != 0 on errors.
  49  *
  50  * Then, at the end of your module_test you can write:
  51  * \code
  52  * #include TEST_ONLY(whatuneed.h)
  53  * #include TEST_ONLY(whatuneed.c)
  54  * #include TEST_ONLY(...)
  55  *
  56  * TEST_MAIN(module);
  57  * \endcode
  58  *
  59  * The macro TEST_ONLY expand to nothing in non-TEST mode or to
  60  * the specified filename if _TEST is defined.
  61  * Including directly into your module the file.c you need to
  62  * run the test allows you to build and run the test compiling
  63  * only one file.
  64  *
  65  * To achieve this you also need a main() that is supplied by
  66  * the TEST_MAIN macro.
  67  * This will expand to a full main that calls, in sequence:
  68  * Setup, Run and TearDown of your module.
  69  */
  70
  71 #ifndef CFG_TEST_H
  72 #define CFG_TEST_H
  73
  74 #include "cfg/cfg_arch.h"
  75
  76 #if defined(ARCH_UNITTEST) && (ARCH & ARCH_UNITTEST)
  77         #define UNIT_TEST 1
  78
  79         /**
  80          * Macro used to generate a main() for a test to be compiled
  81          * on hosted platform.
  82          */
  83         #define TEST_MAIN(module) \
  84         int main(void) \
  85         { \
  86                 if (module##_testSetup() != 0) \
  87                         return 1; \
  88                 if (module##_testRun() != 0) \
  89                         return 2; \
  90                 if (module##_testTearDown() != 0) \
  91                         return 3; \
  92                 return 0; \
  93         }
  94
  95         /** This macro will include the specified file only in test-mode */
  96         #define TEST_ONLY(file) PP_STRINGIZE(file)
  97
  98 #else /* !_TEST */
  99         #define UNIT_TEST 0
 100
 101         #define TEST_MAIN(module)  /* nothing */
 102         #define TEST_ONLY(file)    <cfg/nothing.h>
 103
 104 #endif /* _TEST */
 105
 106 /**
 107  * Silent an assert in a test.
 108  *
 109  * This is useful when we run a test and we want to test
 110  * an error condition. We know that an assert will fail but
 111  * this is not really an error. To ignore that we mark it
 112  * with this macro, where str is the message string of the assert
 113  * that we want to drop.
 114  * To use this macro copy the assert log message and paste as argument
 115  * of this macro. In assert message log is reported also the line number
 116  * of the code that have generated the assert.
 117  * In this way you can trap only the selected assert message.
 118  */
 119 #define SILENT_ASSERT(str) kputs("SILENT_ASSERT:$"str"$\n")
 120
 121 #endif /* CFG_TEST_H */