Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
chasing minor smells
[simgrid.git] / src / xbt / cunit.cpp
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 inspirated from the OSSP ts (Test Suite Library)       */
10 /* At some point we should use https://github.com/google/googletest instead */
11
12 #include "src/internal_config.h"
13 #include <stdio.h>
14
15 #include <xbt/ex.hpp>
16 #include "xbt/sysdep.h"         /* bvprintf */
17 #include "xbt/cunit.h"
18 #include "xbt/dynar.h"
19
20 /* collection of all suites */
21 static xbt_dynar_t _xbt_test_suites = nullptr;
22 /* global statistics */
23 static int _xbt_test_nb_tests = 0;
24 static int _xbt_test_test_failed = 0;
25 static int _xbt_test_test_ignore = 0;
26 static int _xbt_test_test_expect = 0;
27
28 static int _xbt_test_nb_units = 0;
29 static int _xbt_test_unit_failed = 0;
30 static int _xbt_test_unit_ignore = 0;
31 static int _xbt_test_unit_disabled = 0;
32
33 static int _xbt_test_nb_suites = 0;
34 static int _xbt_test_suite_failed = 0;
35 static int _xbt_test_suite_ignore = 0;
36 static int _xbt_test_suite_disabled = 0;
37
38 /* Context */
39 xbt_test_unit_t _xbt_test_current_unit = nullptr;
40
41 /* test suite test log */
42 typedef struct s_xbt_test_log {
43   char *text;
44   const char *file;
45   int line;
46 } *xbt_test_log_t;
47
48 static void xbt_test_log_dump(xbt_test_log_t log)
49 {
50   if (log)
51     fprintf(stderr, "      log %p(%s:%d)=%s\n", log, log->file, log->line, log->text);
52   else
53     fprintf(stderr, "      log=nullptr\n");
54 }
55
56 /* test suite test check */
57 typedef struct s_xbt_test_test {
58   char *title;
59   int failed;
60   int expected_failure;
61   int ignored;
62   const char *file;
63   int line;
64   xbt_dynar_t logs;
65 } *xbt_test_test_t;
66
67 static void xbt_test_test_dump(xbt_test_test_t test)
68 {
69   if (test) {
70     xbt_test_log_t log;
71     unsigned int it_log;
72     fprintf(stderr, "    test %p(%s:%d)=%s (%s)\n", test, test->file, test->line, test->title,
73             test->failed ? "failed" : "not failed");
74     xbt_dynar_foreach(test->logs, it_log, log)
75         xbt_test_log_dump(log);
76   } else
77     fprintf(stderr, "    test=nullptr\n");
78 }
79
80 /* test suite test unit */
81 struct s_xbt_test_unit {
82   int enabled;
83   char *name;
84   char *title;
85   ts_test_cb_t func;
86   const char *file;
87   int line;
88   xbt_dynar_t tests;            /* of xbt_test_test_t */
89
90   int nb_tests;
91   int test_failed;
92   int test_ignore;
93   int test_expect;
94 };
95
96 static void xbt_test_unit_dump(xbt_test_unit_t unit)
97 {
98   if (unit) {
99     xbt_test_test_t test;
100     unsigned int it_test;
101     fprintf(stderr, "  UNIT %s: %s (%s)\n", unit->name, unit->title, (unit->enabled ? "enabled" : "disabled"));
102     if (unit->enabled)
103       xbt_dynar_foreach(unit->tests, it_test, test)
104           xbt_test_test_dump(test);
105   } else {
106     fprintf(stderr, "  unit=nullptr\n");
107   }
108 }
109
110 /* test suite */
111 struct s_xbt_test_suite {
112   int enabled;
113   const char *name;
114   char *title;
115   xbt_dynar_t units;            /* of xbt_test_unit_t */
116
117   int nb_tests;
118   int nb_units;
119   int test_failed;
120   int test_ignore;
121   int test_expect;
122   int unit_failed;
123   int unit_ignore;
124   int unit_disabled;
125 };
126
127 /* destroy test suite */
128 static void xbt_test_suite_free(void *s)
129 {
130   xbt_test_suite_t suite = *(xbt_test_suite_t *) s;
131
132   if (suite == nullptr)
133     return;
134   xbt_dynar_free(&suite->units);
135   free(suite->title);
136   free(suite);
137 }
138
139 static void xbt_test_unit_free(void *unit)
140 {
141   xbt_test_unit_t u = *(xbt_test_unit_t *) unit;
142   /* name is static */
143   free(u->title);
144   xbt_dynar_free(&u->tests);
145   free(u);
146 }
147
148 static void xbt_test_test_free(void *test)
149 {
150   xbt_test_test_t t = *(xbt_test_test_t *) test;
151   free(t->title);
152   xbt_dynar_free(&(t->logs));
153   free(t);
154 }
155
156 static void xbt_test_log_free(void *log)
157 {
158   xbt_test_log_t l = *(xbt_test_log_t *) log;
159   free(l->text);
160   free(l);
161 }
162
163 /** @brief create test suite */
164 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...)
165 {
166   xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite, 1);
167   va_list ap;
168
169   if (!_xbt_test_suites)
170     _xbt_test_suites = xbt_dynar_new(sizeof(xbt_test_suite_t), xbt_test_suite_free);
171
172   va_start(ap, fmt);
173   suite->title = bvprintf(fmt, ap);
174   suite->units = xbt_dynar_new(sizeof(xbt_test_unit_t), &xbt_test_unit_free);
175   va_end(ap);
176   suite->name = name;
177   suite->enabled = 1;
178
179   xbt_dynar_push(_xbt_test_suites, &suite);
180
181   return suite;
182 }
183
184 /** @brief retrieve a testsuite from name, or create a new one */
185 xbt_test_suite_t xbt_test_suite_by_name(const char *name, const char *fmt, ...)
186 {
187   xbt_test_suite_t suite;
188   unsigned int it_suite;
189
190   char *bufname;
191   va_list ap;
192
193   if (_xbt_test_suites)
194     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
195         if (!strcmp(suite->name, name))
196       return suite;
197
198   va_start(ap, fmt);
199   bufname = bvprintf(fmt, ap);
200   va_end(ap);
201   suite = xbt_test_suite_new(name, bufname, nullptr);
202   free(bufname);
203
204   return suite;
205 }
206
207 void xbt_test_suite_dump(xbt_test_suite_t suite)
208 {
209   if (suite) {
210     xbt_test_unit_t unit;
211     unsigned int it_unit;
212     fprintf(stderr, "TESTSUITE %s: %s (%s)\n", suite->name, suite->title, suite->enabled ? "enabled" : "disabled");
213     if (suite->enabled)
214       xbt_dynar_foreach(suite->units, it_unit, unit)
215           xbt_test_unit_dump(unit);
216   } else {
217     fprintf(stderr, "TESTSUITE IS nullptr!\n");
218   }
219 }
220
221 /* add test case to test suite */
222 void xbt_test_suite_push(xbt_test_suite_t suite, const char *name, ts_test_cb_t func, const char *fmt, ...)
223 {
224   xbt_test_unit_t unit;
225   va_list ap;
226
227   xbt_assert(suite);
228   xbt_assert(func);
229   xbt_assert(fmt);
230
231   unit = xbt_new0(struct s_xbt_test_unit, 1);
232   va_start(ap, fmt);
233   unit->title = bvprintf(fmt, ap);
234   va_end(ap);
235   unit->name = (char *) name;
236   unit->func = func;
237   unit->file = nullptr;
238   unit->line = 0;
239   unit->enabled = 1;
240   unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), xbt_test_test_free);
241
242   xbt_dynar_push(suite->units, &unit);
243 }
244
245 /* run test one suite */
246 static int xbt_test_suite_run(xbt_test_suite_t suite, int verbosity)
247 {
248   xbt_test_unit_t unit;
249   xbt_test_test_t test;
250   xbt_test_log_t log;
251
252   const char *file;
253   int line;
254   char *cp;
255   unsigned int it_unit;
256   unsigned int it_test;
257   unsigned int it_log;
258
259   int first = 1;                /* for result pretty printing */
260
261   if (suite == nullptr)
262     return 0;
263
264   /* suite title pretty-printing */
265   char suite_title[81];
266   int suite_len = strlen(suite->title);
267
268   xbt_assert(suite_len < 68, "suite title \"%s\" too long (%d should be less than 68", suite->title, suite_len);
269
270   suite_title[0] = ' ';
271   for (int i = 1; i < 79; i++)
272     suite_title[i] = '=';
273   suite_title[79]  = '\n';
274   suite_title[80]  = '\0';
275
276   snprintf(suite_title + 40 - (suite_len + 4) / 2, 81 - (40 - (suite_len + 4) / 2), "[ %s ]", suite->title);
277   suite_title[40 + (suite_len + 5) / 2] = '=';
278   if (!suite->enabled)
279     snprintf(suite_title + 70, 11, " DISABLED ");
280   fprintf(stderr, "\n%s\n", suite_title);
281
282   if (suite->enabled) {
283     /* iterate through all tests */
284     xbt_dynar_foreach(suite->units, it_unit, unit) {
285       /* init unit case counters */
286       unit->nb_tests = 0;
287       unit->test_ignore = 0;
288       unit->test_failed = 0;
289       unit->test_expect = 0;
290
291       /* display unit title */
292       cp = bprintf(" Unit: %s ......................................"
293                    "......................................", unit->title);
294       cp[70] = '\0';
295       fprintf(stderr, "%s", cp);
296       free(cp);
297
298       /* run the test case function */
299       _xbt_test_current_unit = unit;
300       if (unit->enabled)
301         unit->func();
302
303       /* iterate through all performed tests to determine status */
304       xbt_dynar_foreach(unit->tests, it_test, test) {
305         if (test->ignored) {
306           unit->test_ignore++;
307         } else {
308           unit->nb_tests++;
309
310           if (test->failed && !test->expected_failure)
311             unit->test_failed++;
312           if (!test->failed && test->expected_failure)
313             unit->test_failed++;
314           if (test->expected_failure)
315             unit->test_expect++;
316         }
317       }
318       /* Display whether this unit went well */
319       if (unit->test_failed > 0 || unit->test_expect || (verbosity && unit->nb_tests > 0)) {
320         /* some tests failed (or were supposed to), so do detailed reporting of test case */
321         if (unit->test_failed > 0) {
322           fprintf(stderr, ".. failed\n");
323         } else if (unit->nb_tests) {
324           fprintf(stderr, "...... ok\n");       /* successful, but show about expected */
325         } else {
326           fprintf(stderr, ".... skip\n");       /* shouldn't happen, but I'm a bit lost with this logic */
327         }
328         xbt_dynar_foreach(unit->tests, it_test, test) {
329           file = (test->file != nullptr ? test->file : unit->file);
330           line = (test->line != 0 ? test->line : unit->line);
331           const char* resname;
332           if (test->ignored)
333             resname = " SKIP";
334           else if (test->expected_failure) {
335             if (test->failed)
336               resname = "EFAIL";
337             else
338               resname = "EPASS";
339           } else {
340             if (test->failed)
341               resname = " FAIL";
342             else
343               resname = " PASS";
344           }
345           fprintf(stderr, "      %s: %s [%s:%d]\n", resname, test->title, file, line);
346
347           if ((test->expected_failure && !test->failed) || (!test->expected_failure && test->failed)) {
348             xbt_dynar_foreach(test->logs, it_log, log) {
349               file = (log->file != nullptr ? log->file : file);
350               line = (log->line != 0 ? log->line : line);
351               fprintf(stderr, "             %s:%d: %s\n", file, line, log->text);
352             }
353           }
354         }
355         fprintf(stderr, "    Summary: %d of %d tests failed", unit->test_failed, unit->nb_tests);
356         if (unit->test_ignore) {
357           fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
358         } else {
359           fprintf(stderr, "\n");
360         }
361       } else if (!unit->enabled) {
362         fprintf(stderr, " disabled\n"); /* no test were run */
363       } else if (unit->nb_tests) {
364         fprintf(stderr, "...... ok\n"); /* successful */
365       } else {
366         fprintf(stderr, ".... skip\n"); /* no test were run */
367       }
368
369       /* Accumulate test counts into the suite */
370       suite->nb_tests += unit->nb_tests;
371       suite->test_failed += unit->test_failed;
372       suite->test_ignore += unit->test_ignore;
373       suite->test_expect += unit->test_expect;
374
375       _xbt_test_nb_tests += unit->nb_tests;
376       _xbt_test_test_failed += unit->test_failed;
377       _xbt_test_test_ignore += unit->test_ignore;
378       _xbt_test_test_expect += unit->test_expect;
379
380       /* What's the conclusion of this test anyway? */
381       if (unit->nb_tests) {
382         suite->nb_units++;
383         if (unit->test_failed)
384           suite->unit_failed++;
385       } else if (!unit->enabled) {
386         suite->unit_disabled++;
387       } else {
388         suite->unit_ignore++;
389       }
390     }
391   }
392   _xbt_test_nb_units += suite->nb_units;
393   _xbt_test_unit_failed += suite->unit_failed;
394   _xbt_test_unit_ignore += suite->unit_ignore;
395   _xbt_test_unit_disabled += suite->unit_disabled;
396
397   if (suite->nb_units) {
398     _xbt_test_nb_suites++;
399     if (suite->test_failed)
400       _xbt_test_suite_failed++;
401   } else if (!suite->enabled) {
402     _xbt_test_suite_disabled++;
403   } else {
404     _xbt_test_suite_ignore++;
405   }
406
407   /* print test suite summary */
408   if (suite->enabled) {
409     fprintf(stderr," =====================================================================%s\n",
410             (suite->nb_units ? (suite->unit_failed ? "== FAILED" : "====== OK") :
411                                (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
412     fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ", suite->nb_units
413             ? ((1 - (double) suite->unit_failed / (double) suite->nb_units) * 100.0) : 100.0, suite->nb_units);
414
415     if (suite->nb_units != suite->unit_failed) {
416       fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_units - suite->unit_failed);
417       first = 0;
418     }
419     if (suite->unit_failed) {
420       fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->unit_failed);
421       first = 0;
422     }
423     if (suite->unit_ignore) {
424       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), suite->unit_ignore);
425       first = 0;
426     }
427     if (suite->unit_disabled) {
428       fprintf(stderr, "%s%d disabled", (first ? "" : ", "), suite->unit_disabled);
429     }
430     fprintf(stderr, ")\n          Tests: %.0f%% ok (%d tests: ", suite->nb_tests
431             ? ((1 - (double) suite->test_failed / (double) suite->nb_tests) * 100.0) : 100.0, suite->nb_tests);
432
433     first = 1;
434     if (suite->nb_tests != suite->test_failed) {
435       fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_tests - suite->test_failed);
436       first = 0;
437     }
438     if (suite->test_failed) {
439       fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->test_failed);
440       first = 0;
441     }
442     if (suite->test_ignore) {
443       fprintf(stderr, "%s%d ignored", (first ? "" : "; "), suite->test_ignore);
444       first = 0;
445     }
446     if (suite->test_expect) {
447       fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "), suite->test_expect);
448     }
449     fprintf(stderr, ")\n");
450   }
451   return suite->unit_failed;
452 }
453
454 static void apply_selection(char *selection)
455 {
456   /* for the parsing */
457   char *sel = selection;
458   int done = 0;
459   char dir[1024];               /* the directive */
460   /* iterators */
461   unsigned int it_suite;
462   xbt_test_suite_t suite;
463   xbt_test_unit_t unit;
464   unsigned int it_unit;
465
466   char suitename[512];
467   char unitname[512];
468
469   if (!selection || selection[0] == '\0')
470     return;
471
472   /*printf("Test selection: %s\n", selection); */
473
474   /* First apply the selection */
475   while (!done) {
476     int enabling = 1;
477
478     char *p = strchr(sel, ',');
479     if (p) {
480       strncpy(dir, sel, p - sel);
481       dir[p - sel] = '\0';
482       sel = p + 1;
483     } else {
484       strncpy(dir, sel,1024);
485       done = 1;
486     }
487
488     if (dir[0] == '-') {
489       enabling = 0;
490       memmove(dir, dir + 1, strlen(dir));
491     }
492     if (dir[0] == '+') {
493       enabling = 1;
494       memmove(dir, dir + 1, strlen(dir));
495     }
496
497     p = strchr(dir, ':');
498     if (p) {
499       strncpy(unitname, p + 1,512);
500       strncpy(suitename, dir, p - dir);
501       suitename[p - dir] = '\0';
502     } else {
503       strncpy(suitename, dir,512);
504       unitname[0] = '\0';
505     }
506
507     /* Deal with the specific case of 'all' pseudo serie */
508     if (!strcmp("all", suitename)) {
509       xbt_assert(unitname[0] == '\0', "The 'all' pseudo-suite does not accept any unit specification\n");
510
511       xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
512         xbt_dynar_foreach(suite->units, it_unit, unit) {
513           unit->enabled = enabling;
514         }
515         suite->enabled = enabling;
516       }
517     } else {
518       unsigned int it;
519       for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
520         xbt_test_suite_t thissuite =
521             xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
522         if (!strcmp(suitename, thissuite->name)) {
523           /* Do not disable the whole suite when we just want to disable a child */
524           if (enabling || (unitname[0] == '\0'))
525             thissuite->enabled = enabling;
526
527           if (unitname[0] == '\0') {
528             xbt_dynar_foreach(thissuite->units, it_unit, unit) {
529               unit->enabled = enabling;
530             }
531           } else {              /* act on one child only */
532             unsigned int it2_unit;
533             /* search it, first (we won't reuse it for external loop which gets broken) */
534             for (it2_unit = 0;
535                  it2_unit < xbt_dynar_length(thissuite->units);
536                  it2_unit++) {
537               xbt_test_unit_t thisunit = xbt_dynar_get_as(thissuite->units, it2_unit, xbt_test_unit_t);
538               if (!strcmp(thisunit->name, unitname)) {
539                 thisunit->enabled = enabling;
540                 break;
541               }
542             }                   /* search relevant unit */
543             xbt_assert(it2_unit != xbt_dynar_length(thissuite->units),
544                 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n", suitename, unitname);
545           }                     /* act on childs (either all or one) */
546
547           break;                /* found the relevant serie. We are happy */
548         }
549       }                         /* search relevant series */
550       xbt_assert(it != xbt_dynar_length(_xbt_test_suites),
551                  "No suite of name '%s' found. Cannot apply the selection\n", suitename);
552     }
553   }
554 }
555
556 void xbt_test_dump(char *selection)
557 {
558   apply_selection(selection);
559
560   if (_xbt_test_suites) {
561     unsigned int it_suite;
562     xbt_test_suite_t suite;
563
564     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
565         xbt_test_suite_dump(suite);
566   } else {
567     printf(" No suite defined.");
568   }
569 }
570
571 int xbt_test_run(char *selection, int verbosity)
572 {
573   apply_selection(selection);
574
575   if (_xbt_test_suites) {
576     unsigned int it_suite;
577     xbt_test_suite_t suite;
578     int first = 1;
579
580     /* Run all the suites */
581     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
582       xbt_test_suite_run(suite, verbosity);
583
584     /* Display some more statistics */
585     fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",_xbt_test_nb_suites
586             ? ((1 - (double) _xbt_test_suite_failed / (double) _xbt_test_nb_suites) * 100.0)
587             : 100.0, _xbt_test_nb_suites);
588     if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
589       fprintf(stderr, "%d ok", _xbt_test_nb_suites - _xbt_test_suite_failed);
590       first = 0;
591     }
592     if (_xbt_test_suite_failed) {
593       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_suite_failed);
594       first = 0;
595     }
596
597     if (_xbt_test_suite_ignore) {
598       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_suite_ignore);
599     }
600     fprintf(stderr, ")\n        Units:  %.0f%% ok (%d units: ", _xbt_test_nb_units
601             ? ((1 - (double) _xbt_test_unit_failed / (double) _xbt_test_nb_units) * 100.0) : 100.0, _xbt_test_nb_units);
602     first = 1;
603     if (_xbt_test_nb_units != _xbt_test_unit_failed) {
604       fprintf(stderr, "%d ok", _xbt_test_nb_units - _xbt_test_unit_failed);
605       first = 0;
606     }
607     if (_xbt_test_unit_failed) {
608       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_unit_failed);
609       first = 0;
610     }
611     if (_xbt_test_unit_ignore) {
612       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_unit_ignore);
613     }
614     fprintf(stderr, ")\n        Tests:  %.0f%% ok (%d tests: ", _xbt_test_nb_tests
615             ? ((1 - (double) _xbt_test_test_failed / (double) _xbt_test_nb_tests) * 100.0) : 100.0, _xbt_test_nb_tests);
616     first = 1;
617     if (_xbt_test_nb_tests != _xbt_test_test_failed) {
618       fprintf(stderr, "%d ok", _xbt_test_nb_tests - _xbt_test_test_failed);
619       first = 0;
620     }
621     if (_xbt_test_test_failed) {
622       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_test_failed);
623       first = 0;
624     }
625     if (_xbt_test_test_ignore) {
626       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_test_ignore);
627       first = 0;
628     }
629     if (_xbt_test_test_expect) {
630       fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "), _xbt_test_test_expect);
631     }
632
633     fprintf(stderr, ")\n");
634   } else {
635     fprintf(stderr, "No unit to run!\n");
636     _xbt_test_unit_failed++;
637   }
638   return _xbt_test_unit_failed;
639 }
640
641 void xbt_test_exit()
642 {
643   xbt_dynar_free(&_xbt_test_suites);
644 }
645
646 /* annotate test case with test */
647 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
648 {
649   xbt_test_unit_t unit = _xbt_test_current_unit;
650   xbt_assert(unit);
651
652   va_list ap;
653   xbt_test_test_t test = xbt_new0(struct s_xbt_test_test, 1);
654   va_start(ap, fmt);
655   test->title = bvprintf(fmt, ap);
656   va_end(ap);
657   test->failed = 0;
658   test->expected_failure = 0;
659   test->ignored = 0;
660   test->file = file;
661   test->line = line;
662   test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
663   xbt_dynar_push(unit->tests, &test);
664 }
665
666 /* annotate test case with log message and failure */
667 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
668 {
669   xbt_test_unit_t unit = _xbt_test_current_unit;
670   xbt_assert(unit);
671   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
672       "Test failed even before being declared (broken unit: %s)", unit->title);
673
674   va_list ap;
675   xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
676   va_start(ap, fmt);
677   log->text = bvprintf(fmt, ap);
678   va_end(ap);
679   log->file = file;
680   log->line = line;
681
682   xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
683   xbt_dynar_push(test->logs, &log);
684
685   test->failed = 1;
686 }
687
688 void xbt_test_exception(xbt_ex_t e)
689 {
690   _xbt_test_fail(e.throwPoint().file, e.throwPoint().line, "Exception %s raised: %s", xbt_ex_catname(e.category), e.what());
691 }
692
693 void xbt_test_expect_failure()
694 {
695   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
696       "Cannot expect the failure of a test before declaring it (broken unit: %s)", _xbt_test_current_unit->title);
697   xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
698   test->expected_failure = 1;
699 }
700
701 void xbt_test_skip()
702 {
703   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
704       "Test skipped even before being declared (broken unit: %s)", _xbt_test_current_unit->title);
705   xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
706   test->ignored = 1;
707 }
708
709 /* annotate test case with log message only */
710 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
711 {
712   xbt_test_unit_t unit = _xbt_test_current_unit;
713   xbt_assert(unit);
714   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
715       "Test logged into even before being declared (broken test unit: %s)", unit->title);
716
717   va_list ap;
718   xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
719   va_start(ap, fmt);
720   log->text = bvprintf(fmt, ap);
721   va_end(ap);
722   log->file = file;
723   log->line = line;
724
725   xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
726   xbt_dynar_push(test->logs, &log);
727 }
728
729 #ifdef SIMGRID_TEST
730 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
731
732 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
733 {
734   xbt_test_add("Skipped test");
735   xbt_test_skip();
736
737   xbt_test_add("%s %s", "EXPECTED", "FAILURE");
738   xbt_test_expect_failure();
739   xbt_test_log("%s %s", "Test", "log");
740   xbt_test_fail("EXPECTED FAILURE");
741 }
742 #endif                          /* SIMGRID_TEST */