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