Remove c files inclusions: use libunittest instead.

[bertos.git] / bertos / cfg / test.h

diff --git a/bertos/cfg/test.h b/bertos/cfg/test.h
index c9d736b22362d1aaeb3a2e8b6951b8820d641db1..ffa3a8d5e0fc932296375c68a53570c4f79c75a8 100644 (file)
--- a/bertos/cfg/test.h
+++ b/bertos/cfg/test.h
@@ -35,13 +35,72 @@
  * \version $Id$
  *
  * \author Daniele Basile <asterix@develer.com>
+ * \author Francesco Sacchi <batt@develer.com>
+ *
+ * When you want to test a module that is emulable on hosted
+ * platforms, these macros come in handy.
+ * Your module_test should supply three basic functions:
+ *
+ * int module_testSetup(void)
+ * int module_testRun(void)
+ * int module_testTearDown(void)
+ *
+ * All of these should return 0 if ok or a value != 0 on errors.
+ *
+ * Then, at the end of your module_test you can write:
+ * \code
+ * #if UNIT_TEST
+ *     #include <whatuneed.h>
+ *     #include <whatuneed.c>
+ *     #include <...>
+ *
+ *     TEST_MAIN(module);
+ * #endif
+ * \endcode
+ *
+ * Including directly into your module the file.c you need to
+ * run the test allows you to build and run the test compiling
+ * only one file.
+ *
+ * To achieve this you also need a main() that is supplied by
+ * the TEST_MAIN macro.
+ * This will expand to a full main that calls, in sequence:
+ * Setup, Run and TearDown of your module.
  */
 
 #ifndef CFG_TEST_H
 #define CFG_TEST_H
 
+#include "cfg/cfg_arch.h"
+
+#if defined(ARCH_UNITTEST) && (ARCH & ARCH_UNITTEST)
+       #define UNIT_TEST 1
+
+       /**
+        * Macro used to generate a main() for a test to be compiled
+        * on hosted platform.
+        */
+       #define TEST_MAIN(module) \
+       int main(void) \
+       { \
+               if (module##_testSetup() != 0) \
+                       return 1; \
+               if (module##_testRun() != 0) \
+                       return 2; \
+               if (module##_testTearDown() != 0) \
+                       return 3; \
+               return 0; \
+       }
+#else /* !TEST */
+       #define UNIT_TEST 0
+
+       #define TEST_MAIN(module) /* nothing */
+#endif /* TEST */
+
+
 /**
  * Silent an assert in a test.
+ *
  * This is useful when we run a test and we want to test
  * an error condition. We know that an assert will fail but
  * this is not really an error. To ignore that we mark it
@@ -54,5 +113,4 @@
  */
 #define SILENT_ASSERT(str) kputs("SILENT_ASSERT:$"str"$\n")
 
-
 #endif /* CFG_TEST_H */