X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9f6cbb176d4301cae36a945dfa57e6b6a9cbafef..680abdb047c1a66d3ccc14cad518117773c3cc8c:/include/xbt/cunit.h diff --git a/include/xbt/cunit.h b/include/xbt/cunit.h index 219a42a5b3..c0064534dc 100644 --- a/include/xbt/cunit.h +++ b/include/xbt/cunit.h @@ -1,15 +1,14 @@ /* cunit - A little C Unit facility */ -/* Copyright (c) 2005-2014. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -/* This is partially inspirated from the OSSP ts (Test Suite Library) */ +/* This is partially inspired from the OSSP ts (Test Suite Library) */ -#ifndef _XBT_CUNIT_H_ -#define _XBT_CUNIT_H_ +#ifndef XBT_CUNIT_H_ +#define XBT_CUNIT_H_ #include "xbt/sysdep.h" /* XBT_GNU_PRINTF */ #include "xbt/ex.h" @@ -25,7 +24,7 @@ typedef struct s_xbt_test_suite *xbt_test_suite_t; typedef struct s_xbt_test_unit *xbt_test_unit_t; /* test callback function type */ -typedef void (*ts_test_cb_t) (void); +typedef void (*ts_test_cb_t) (); /* test suite operations */ XBT_PUBLIC(xbt_test_suite_t) xbt_test_suite_new(const char *name, const char *fmt, ...); @@ -37,10 +36,10 @@ XBT_PUBLIC(void) xbt_test_suite_push(xbt_test_suite_t suite, const char *name, t * It is a coma (,) separated list of directives. They are applied from left to right. * * Each of them of form: - * + * * [-|+]suitename[:unitname[:testname]] - * - * * First char: + * + * * First char: * if it's a '-', the directive disables something * if it's a '+', the directive enables something * By default, everything is enabled, but you can disable a suite and reenable some parts @@ -53,26 +52,26 @@ XBT_PUBLIC(int) xbt_test_run(char *selection, int verbosity); /* Show information about the selection of tests */ XBT_PUBLIC(void) xbt_test_dump(char *selection); /* Cleanup the mess */ -XBT_PUBLIC(void) xbt_test_exit(void); +XBT_PUBLIC(void) xbt_test_exit(); -/** +/** * @addtogroup XBT_cunit * @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 as a user. Only use it in external projects at your own risk (but it works rather well for us). We play * with the idea of migrating to an external solution for our unit tests, possibly offering more features, but having * absolutely no dependencies is a nice feature of SimGrid (and this code is sufficient to cover our needs, actually, * so why should we bother switching?) - * + * * Unit testing is not intended to write integration tests. * Please refer to \ref inside_tests_add_integration for that instead. * - * @{ + * @{ */ -/** @brief Provide informations about the suite declared in this file +/** @brief Provide information about the suite declared in this file * @hideinitializer - * + * * 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 @@ -102,15 +101,15 @@ XBT_PUBLIC(void) xbt_test_exit(void); XBT_PUBLIC(void) _xbt_test_add(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4); XBT_PUBLIC(void) _xbt_test_fail(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4); XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt, ...) XBT_ATTRIB_PRINTF(3, 4); -/** @brief Declare that a new test begins (printf-like parameters, describing the test) +/** @brief Declare that a new test begins (printf-like parameters, describing the test) * @hideinitializer */ #define xbt_test_add(...) _xbt_test_add(__FILE__, __LINE__, __VA_ARGS__) -/** @brief Declare that the lastly started test failed (printf-like parameters, describing failure cause) +/** @brief Declare that the lastly started test failed (printf-like parameters, describing failure cause) * @hideinitializer */ #define xbt_test_fail(...) _xbt_test_fail(__FILE__, __LINE__, __VA_ARGS__) /** @brief The lastly started test is actually an assert - * @hideinitializer - * + * @hideinitializer + * * - If provided a uniq parameter, this is assumed to be a condition that is expected to be true * - If provided more parameters, the first one is a condition, and the other ones are printf-like arguments that are * to be displayed when the condition fails. @@ -118,10 +117,8 @@ XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt, ...) #define xbt_test_assert(...) _XBT_IF_ONE_ARG(_xbt_test_assert_ARG1, \ _xbt_test_assert_ARGN, \ __VA_ARGS__)(__VA_ARGS__) -#define _xbt_test_assert_ARG1(cond) _xbt_test_assert_CHECK(cond, \ - "%s", #cond) -#define _xbt_test_assert_ARGN(cond, ...) _xbt_test_assert_CHECK(cond, \ - __VA_ARGS__) +#define _xbt_test_assert_ARG1(cond) _xbt_test_assert_CHECK(cond, "%s", #cond) +#define _xbt_test_assert_ARGN(cond, ...) _xbt_test_assert_CHECK(cond, __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) @@ -132,11 +129,11 @@ XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt, ...) XBT_PUBLIC(void) xbt_test_exception(xbt_ex_t e); /** @brief Declare that the lastly started test was expected to fail (and actually failed) */ -XBT_PUBLIC(void) xbt_test_expect_failure(void); -/** @brief Declare that the lastly started test should be skiped today */ -XBT_PUBLIC(void) xbt_test_skip(void); +XBT_PUBLIC(void) xbt_test_expect_failure(); +/** @brief Declare that the lastly started test should be skipped today */ +XBT_PUBLIC(void) xbt_test_skip(); /** @} */ SG_END_DECL() -#endif /* _XBT_CUNIT_H_ */ +#endif /* XBT_CUNIT_H_ */