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