Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove every XBT_USE_DEPRECATED parts
[simgrid.git] / include / xbt / cunit.h
index f462e06..d7b80c5 100644 (file)
@@ -62,7 +62,7 @@ XBT_PUBLIC(void) xbt_test_exit(void);
 
 /** 
  * @addtogroup XBT_cunit
- * @brief Unit test mechanism (to test a set of functions)
+ * @brief Unit testing implementation (see @ref inside_tests_add_units)
  *  
  * This module is mainly intended to allow the tests of SimGrid
  * itself and may lack the level of genericity that you would expect
@@ -73,28 +73,9 @@ XBT_PUBLIC(void) xbt_test_exit(void);
  * feature of SimGrid (and this code is sufficient to cover our
  * needs, actually, so why should we bother switching?)
  * 
- * Note that if you want to test a full binary (such as an example),
- * you want to use our integration testing mechanism, not our unit
- * testing one. Please refer to Section \ref
- * inside_tests_add_integration
+ * Unit testing is not intended to write integration tests.
+ * Please refer to \ref inside_tests_add_integration for that instead.
  * 
- * Some more information on our unit testing is available in Section @ref inside_tests_add_units.
- * 
- * All code intended to be executed as a unit test will be extracted
- * by a script (tools/sg_unit_extract.pl), and must thus be protected
- * between preprocessor definitions, as follows. Note that
- * SIMGRID_TEST string must appear on the endif line too for the
- * script to work, and that this script does not allow to have more
- * than one suite per file. For now, but patches are naturally
- * welcome.
- * 
-@verbatim
-#ifdef SIMGRID_TEST
-
-<your code>
-
-#endif  // SIMGRID_TEST
-@endverbatim
  * 
  *
  * @{ 
@@ -102,8 +83,8 @@ XBT_PUBLIC(void) xbt_test_exit(void);
 /** @brief Provide informations about the suite declared in this file
  *  @hideinitializer
  * 
- * Actually, this macro is not used by C, but by the script
- * extracting the test units, but that should be transparent for you.
+ * Actually, this macro is only used by the script extracting the test 
+ * units, but that should be transparent for you. 
  *
  * @param suite_name the short name of this suite, to be used in the --tests argument of testall afterward. Avoid spaces and any other strange chars
  * @param suite_title instructive title that testall should display when your suite is run
@@ -156,6 +137,8 @@ XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt,
                                                                 __VA_ARGS__)
 #define _xbt_test_assert_CHECK(cond, ...)                       \
   do { if (!(cond)) xbt_test_fail(__VA_ARGS__); } while (0)
+/** @brief Report some details to help debugging when the test fails (shown only on failure)
+ *  @hideinitializer  */
 #define xbt_test_log(...)       _xbt_test_log(__FILE__, __LINE__, __VA_ARGS__)
 
 /** @brief Declare that the lastly started test failed because of the provided exception */
@@ -168,39 +151,5 @@ XBT_PUBLIC(void) xbt_test_skip(void);
 
 /** @} */
 
-#ifdef XBT_USE_DEPRECATED
-
-/* Kept for backward compatibility. */
-
-#define xbt_test_add0(...)      xbt_test_add(__VA_ARGS__)
-#define xbt_test_add1(...)      xbt_test_add(__VA_ARGS__)
-#define xbt_test_add2(...)      xbt_test_add(__VA_ARGS__)
-#define xbt_test_add3(...)      xbt_test_add(__VA_ARGS__)
-#define xbt_test_add4(...)      xbt_test_add(__VA_ARGS__)
-#define xbt_test_add5(...)      xbt_test_add(__VA_ARGS__)
-
-#define xbt_test_fail0(...)     xbt_test_fail(__VA_ARGS__)
-#define xbt_test_fail1(...)     xbt_test_fail(__VA_ARGS__)
-#define xbt_test_fail2(...)     xbt_test_fail(__VA_ARGS__)
-#define xbt_test_fail3(...)     xbt_test_fail(__VA_ARGS__)
-#define xbt_test_fail4(...)     xbt_test_fail(__VA_ARGS__)
-#define xbt_test_fail5(...)     xbt_test_fail(__VA_ARGS__)
-
-#define xbt_test_assert0(...)   xbt_test_assert(__VA_ARGS__)
-#define xbt_test_assert1(...)   xbt_test_assert(__VA_ARGS__)
-#define xbt_test_assert2(...)   xbt_test_assert(__VA_ARGS__)
-#define xbt_test_assert3(...)   xbt_test_assert(__VA_ARGS__)
-#define xbt_test_assert4(...)   xbt_test_assert(__VA_ARGS__)
-#define xbt_test_assert5(...)   xbt_test_assert(__VA_ARGS__)
-
-#define xbt_test_log0(...)      xbt_test_log(__VA_ARGS__)
-#define xbt_test_log1(...)      xbt_test_log(__VA_ARGS__)
-#define xbt_test_log2(...)      xbt_test_log(__VA_ARGS__)
-#define xbt_test_log3(...)      xbt_test_log(__VA_ARGS__)
-#define xbt_test_log4(...)      xbt_test_log(__VA_ARGS__)
-#define xbt_test_log5(...)      xbt_test_log(__VA_ARGS__)
-
-#endif
-
 SG_END_DECL()
-#endif                          /* _TS_H_ */
+#endif                          /* _XBT_CUNIT_H_ */