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