include/xbt/cunit.h

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