src/xbt/cunit.c

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