1 /* cunit - A little C Unit facility */
3 /* Copyright (c) 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
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. */
9 /* This is partially inspirated from the OSSP ts (Test Suite Library) */
14 #include "xbt/sysdep.h" /* XBT_GNU_PRINTF */
19 /* test suite object type */
20 typedef struct s_xbt_test_suite *xbt_test_suite_t;
22 /* test object type */
23 typedef struct s_xbt_test_unit *xbt_test_unit_t;
25 /* test callback function type */
26 typedef void (*ts_test_cb_t) (void);
28 /* test suite operations */
29 XBT_PUBLIC(xbt_test_suite_t) xbt_test_suite_new(const char *name,
30 const char *fmt, ...);
31 XBT_PUBLIC(xbt_test_suite_t) xbt_test_suite_by_name(const char *name,
32 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,
35 ts_test_cb_t func, const char *fmt, ...);
37 /* Run all the specified tests. what_to_do allows to disable some tests.
38 * It is a coma (,) separated list of directives. They are applied from left to right.
40 * Each of them of form:
42 * [-|+]suitename[:unitname[:testname]]
45 * if it's a '-', the directive disables something
46 * if it's a '+', the directive enables something
47 * By default, everything is enabled, but you can disable a suite and reenable some parts
48 * * Suitename: the suite on which the directive acts
49 * * unitname: if given, the unit on which the directive acts. If not, acts on any units.
50 * * testname: if given, the test on which the directive acts. If not, acts on any tests.
53 XBT_PUBLIC(int) xbt_test_run(char *selection);
54 /* Show information about the selection of tests */
55 XBT_PUBLIC(void) xbt_test_dump(char *selection);
56 /* Cleanup the mess */
57 XBT_PUBLIC(void) xbt_test_exit(void);
60 XBT_PUBLIC(void) _xbt_test_add(const char *file, int line, const char *fmt,
61 ...) _XBT_GNUC_PRINTF(3, 4);
62 #define xbt_test_add0(fmt) _xbt_test_add(__FILE__,__LINE__,fmt)
63 #define xbt_test_add1(fmt,a) _xbt_test_add(__FILE__,__LINE__,fmt,a)
64 #define xbt_test_add2(fmt,a,b) _xbt_test_add(__FILE__,__LINE__,fmt,a,b)
65 #define xbt_test_add3(fmt,a,b,c) _xbt_test_add(__FILE__,__LINE__,fmt,a,b,c)
66 #define xbt_test_add4(fmt,a,b,c,d) _xbt_test_add(__FILE__,__LINE__,fmt,a,b,c,d)
67 #define xbt_test_add5(fmt,a,b,c,d,e) _xbt_test_add(__FILE__,__LINE__,fmt,a,b,c,d,e)
69 XBT_PUBLIC(void) _xbt_test_fail(const char *file, int line, const char *fmt,
70 ...) _XBT_GNUC_PRINTF(3, 4);
71 #define xbt_test_fail0(fmt) _xbt_test_fail(__FILE__, __LINE__, fmt)
72 #define xbt_test_fail1(fmt,a) _xbt_test_fail(__FILE__, __LINE__, fmt,a)
73 #define xbt_test_fail2(fmt,a,b) _xbt_test_fail(__FILE__, __LINE__, fmt,a,b)
74 #define xbt_test_fail3(fmt,a,b,c) _xbt_test_fail(__FILE__, __LINE__, fmt,a,b,c)
75 #define xbt_test_fail4(fmt,a,b,c,d) _xbt_test_fail(__FILE__, __LINE__, fmt,a,b,c,d)
76 #define xbt_test_fail5(fmt,a,b,c,d,e) _xbt_test_fail(__FILE__, __LINE__, fmt,a,b,c,d,e)
78 #define xbt_test_assert0(cond,fmt) if(!(cond)) xbt_test_fail0(fmt)
79 #define xbt_test_assert1(cond,fmt,a) if(!(cond)) xbt_test_fail1(fmt,a)
80 #define xbt_test_assert2(cond,fmt,a,b) if(!(cond)) xbt_test_fail2(fmt,a,b)
81 #define xbt_test_assert3(cond,fmt,a,b,c) if(!(cond)) xbt_test_fail3(fmt,a,b,c)
82 #define xbt_test_assert4(cond,fmt,a,b,c,d) if(!(cond)) xbt_test_fail4(fmt,a,b,c,d)
83 #define xbt_test_assert5(cond,fmt,a,b,c,d,e) if(!(cond)) xbt_test_fail5(fmt,a,b,c,d,e)
84 #define xbt_test_assert(cond) xbt_test_assert0(cond,#cond)
86 XBT_PUBLIC(void) _xbt_test_log(const char *file, int line, const char *fmt,
87 ...) _XBT_GNUC_PRINTF(3, 4);
88 #define xbt_test_log0(fmt) _xbt_test_log(__FILE__, __LINE__, fmt)
89 #define xbt_test_log1(fmt,a) _xbt_test_log(__FILE__, __LINE__, fmt,a)
90 #define xbt_test_log2(fmt,a,b) _xbt_test_log(__FILE__, __LINE__, fmt,a,b)
91 #define xbt_test_log3(fmt,a,b,c) _xbt_test_log(__FILE__, __LINE__, fmt,a,b,c)
92 #define xbt_test_log4(fmt,a,b,c,d) _xbt_test_log(__FILE__, __LINE__, fmt,a,b,c,d)
93 #define xbt_test_log5(fmt,a,b,c,d,e) _xbt_test_log(__FILE__, __LINE__, fmt,a,b,c,d,e)
95 XBT_PUBLIC(void) xbt_test_exception(xbt_ex_t e);
97 XBT_PUBLIC(void) xbt_test_expect_failure(void);
98 XBT_PUBLIC(void) xbt_test_skip(void);
100 /* test suite short-cut macros */
101 #define XBT_TEST_UNIT(name,func,title) \
102 void func(void); /*prototype*/ \