include/xbt/cunit.h

   1 /* cunit - A little C Unit facility                                         */
   2
   3 /* Copyright (c) 2005-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 /* This is partially inspired from the OSSP ts (Test Suite Library)         */
  10
  11 #ifndef _XBT_CUNIT_H_
  12 #define _XBT_CUNIT_H_
  13
  14 #include "xbt/sysdep.h"         /* XBT_GNU_PRINTF */
  15 #include "xbt/ex.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /* note that the internals of testall, that follow, are not publicly documented */
  20
  21 /* test suite object type */
  22 typedef struct s_xbt_test_suite *xbt_test_suite_t;
  23
  24 /* test object type */
  25 typedef struct s_xbt_test_unit *xbt_test_unit_t;
  26
  27 /* test callback function type */
  28 typedef void (*ts_test_cb_t) (void);
  29
  30 /* test suite operations */
  31 XBT_PUBLIC(xbt_test_suite_t) xbt_test_suite_new(const char *name, const char *fmt, ...);
  32 XBT_PUBLIC(xbt_test_suite_t) xbt_test_suite_by_name(const char *name, const char *fmt, ...);
  33 XBT_PUBLIC(void) xbt_test_suite_dump(xbt_test_suite_t suite);
  34 XBT_PUBLIC(void) xbt_test_suite_push(xbt_test_suite_t suite, const char *name, ts_test_cb_t func, const char *fmt, ...);
  35
  36 /* Run all the specified tests. what_to_do allows to disable some tests.
  37  * It is a coma (,) separated list of directives. They are applied from left to right.
  38  *
  39  * Each of them of form:
  40  *
  41  * [-|+]suitename[:unitname[:testname]]
  42  *
  43  * * First char:
  44  *   if it's a '-', the directive disables something
  45  *   if it's a '+', the directive enables something
  46  *   By default, everything is enabled, but you can disable a suite and reenable some parts
  47  * * Suitename: the suite on which the directive acts
  48  * * unitname: if given, the unit on which the directive acts. If not, acts on any units.
  49  * * testname: if given, the test on which the directive acts. If not, acts on any tests.
  50  */
  51
  52 XBT_PUBLIC(int) xbt_test_run(char *selection, int verbosity);
  53 /* Show information about the selection of tests */
  54 XBT_PUBLIC(void) xbt_test_dump(char *selection);
  55 /* Cleanup the mess */
  56 XBT_PUBLIC(void) xbt_test_exit(void);
  57
  58 /**
  59  * @addtogroup XBT_cunit
  60  * @brief Unit testing implementation (see @ref inside_tests_add_units)
  61  *
  62  * This module is mainly intended to allow the tests of SimGrid itself and may lack the level of genericity that you
  63  * would expect as a user. Only use it in external projects at your own risk (but it works rather well for us). We play
  64  * with the idea of migrating to an external solution for our unit tests, possibly offering more features, but having
  65  * absolutely no dependencies is a nice feature of SimGrid (and this code is sufficient to cover our needs, actually,
  66  * so why should we bother switching?)
  67  *
  68  * Unit testing is not intended to write integration tests.
  69  * Please refer to \ref inside_tests_add_integration for that instead.
  70  *
  71  * @{
  72  */
  73 /** @brief Provide information about the suite declared in this file
  74  *  @hideinitializer
  75  *
  76  * Actually, this macro is only used by the script extracting the test units, but that should be transparent for you.
  77  *
  78  * @param suite_name the short name of this suite, to be used in the --tests argument of testall afterward. Avoid
  79  *        spaces and any other strange chars
  80  * @param suite_title instructive title that testall should display when your suite is run
  81  */
  82 #define XBT_TEST_SUITE(suite_name,suite_title)
  83
  84 /** @brief Declare a new test units (containing individual tests)
  85  *  @hideinitializer
  86  *
  87  * @param name the short name that will be used in test all to enable/disable this test
  88  * @param func a valid function name that will be used to contain all code of this unit
  89  * @param title human informative description of your test (displayed in testall)
  90  */
  91 #ifdef __cplusplus
  92 #define XBT_TEST_UNIT(name,func,title)    \
  93     extern "C" void func(void);  /*prototype*/ \
  94     void func(void)
  95 #else
  96 #define XBT_TEST_UNIT(name,func,title)    \
  97     void func(void);  /*prototype*/       \
  98     void func(void)
  99 #endif
 100
 101 /* test operations */
 102 XBT_PUBLIC(void) _xbt_test_add(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4);
 103 XBT_PUBLIC(void) _xbt_test_fail(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4);
 104 XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4);
 105 /** @brief Declare that a new test begins (printf-like parameters, describing the test)
 106  *  @hideinitializer */
 107 #define xbt_test_add(...)       _xbt_test_add(__FILE__, __LINE__, __VA_ARGS__)
 108 /** @brief Declare that the lastly started test failed (printf-like parameters, describing failure cause)
 109  *  @hideinitializer */
 110 #define xbt_test_fail(...)      _xbt_test_fail(__FILE__, __LINE__, __VA_ARGS__)
 111 /** @brief The lastly started test is actually an assert
 112  *  @hideinitializer
 113  *
 114  * - If provided a uniq parameter, this is assumed to be a condition that is expected to be true
 115  * - If provided more parameters, the first one is a condition, and the other ones are printf-like arguments that are
 116  *   to be displayed when the condition fails.
 117  */
 118 #define xbt_test_assert(...)    _XBT_IF_ONE_ARG(_xbt_test_assert_ARG1,  \
 119                                                 _xbt_test_assert_ARGN,  \
 120                                                 __VA_ARGS__)(__VA_ARGS__)
 121 #define _xbt_test_assert_ARG1(cond)      _xbt_test_assert_CHECK(cond, "%s", #cond)
 122 #define _xbt_test_assert_ARGN(cond, ...) _xbt_test_assert_CHECK(cond, __VA_ARGS__)
 123 #define _xbt_test_assert_CHECK(cond, ...)                       \
 124   do { if (!(cond)) xbt_test_fail(__VA_ARGS__); } while (0)
 125 /** @brief Report some details to help debugging when the test fails (shown only on failure)
 126  *  @hideinitializer  */
 127 #define xbt_test_log(...)       _xbt_test_log(__FILE__, __LINE__, __VA_ARGS__)
 128
 129 /** @brief Declare that the lastly started test failed because of the provided exception */
 130 XBT_PUBLIC(void) xbt_test_exception(xbt_ex_t e);
 131
 132 /** @brief Declare that the lastly started test was expected to fail (and actually failed) */
 133 XBT_PUBLIC(void) xbt_test_expect_failure(void);
 134 /** @brief Declare that the lastly started test should be skipped today */
 135 XBT_PUBLIC(void) xbt_test_skip(void);
 136
 137 /** @} */
 138
 139 SG_END_DECL()
 140 #endif                          /* _XBT_CUNIT_H_ */