src/xbt/cunit.c

   1 /* cunit - A little C Unit facility                                         */
   2
   3 /* Copyright (c) 2005, 2006, 2007, 2008, 2009, 2010. 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)
 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_assert2(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         /* some tests failed (or were supposed to), so do detailed reporting of test case */
 329         if (unit->test_failed > 0) {
 330           fprintf(stderr, ".. failed\n");
 331         } else if (unit->nb_tests) {
 332           fprintf(stderr, "...... ok\n");       /* successful, but show about expected */
 333         } else {
 334           fprintf(stderr, ".... skip\n");       /* shouldn't happen, but I'm a bit lost with this logic */
 335         }
 336         xbt_dynar_foreach(unit->tests, it_test, test) {
 337           file = (test->file != NULL ? test->file : unit->file);
 338           line = (test->line != 0 ? test->line : unit->line);
 339           fprintf(stderr, "      %s: %s [%s:%d]\n",
 340                   (test->ignored ? " SKIP"
 341                    : (test->expected_failure
 342                       ? (test->
 343                          failed ? "EFAIL" : "EPASS") : (test->failed ?
 344                                                         " FAIL" :
 345                                                         " PASS"))),
 346                   test->title, file, line);
 347
 348           if ((test->expected_failure && !test->failed)
 349               || (!test->expected_failure && test->failed)) {
 350             xbt_dynar_foreach(test->logs, it_log, log) {
 351               file = (log->file != NULL ? log->file : file);
 352               line = (log->line != 0 ? log->line : line);
 353               fprintf(stderr, "             %s:%d: %s\n",
 354                       file, line, log->text);
 355
 356             }
 357           }
 358         }
 359         fprintf(stderr, "    Summary: %d of %d tests failed",
 360                 unit->test_failed, unit->nb_tests);
 361         if (unit->test_ignore) {
 362           fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
 363         } else {
 364           fprintf(stderr, "\n");
 365         }
 366
 367       } else if (!unit->enabled) {
 368         fprintf(stderr, " disabled\n"); /* no test were run */
 369       } else if (unit->nb_tests) {
 370         fprintf(stderr, "...... ok\n"); /* successful */
 371       } else {
 372         fprintf(stderr, ".... skip\n"); /* no test were run */
 373       }
 374
 375       /* Accumulate test counts into the suite */
 376       suite->nb_tests += unit->nb_tests;
 377       suite->test_failed += unit->test_failed;
 378       suite->test_ignore += unit->test_ignore;
 379       suite->test_expect += unit->test_expect;
 380
 381       _xbt_test_nb_tests += unit->nb_tests;
 382       _xbt_test_test_failed += unit->test_failed;
 383       _xbt_test_test_ignore += unit->test_ignore;
 384       _xbt_test_test_expect += unit->test_expect;
 385
 386       /* What's the conclusion of this test anyway? */
 387       if (unit->nb_tests) {
 388         suite->nb_units++;
 389         if (unit->test_failed)
 390           suite->unit_failed++;
 391       } else if (!unit->enabled) {
 392         suite->unit_disabled++;
 393       } else {
 394         suite->unit_ignore++;
 395       }
 396     }
 397   }
 398   _xbt_test_nb_units += suite->nb_units;
 399   _xbt_test_unit_failed += suite->unit_failed;
 400   _xbt_test_unit_ignore += suite->unit_ignore;
 401   _xbt_test_unit_disabled += suite->unit_disabled;
 402
 403   if (suite->nb_units) {
 404     _xbt_test_nb_suites++;
 405     if (suite->test_failed)
 406       _xbt_test_suite_failed++;
 407   } else if (!suite->enabled) {
 408     _xbt_test_suite_disabled++;
 409   } else {
 410     _xbt_test_suite_ignore++;
 411   }
 412
 413
 414   /* print test suite summary */
 415   if (suite->enabled) {
 416
 417     fprintf(stderr,
 418             " =====================================================================%s\n",
 419             (suite->nb_units
 420              ? (suite->unit_failed ? "== FAILED" : "====== OK")
 421              : (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
 422     fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
 423             suite->nb_units
 424             ? ((1 -
 425                 (double) suite->unit_failed / (double) suite->nb_units) *
 426                100.0) : 100.0, suite->nb_units);
 427
 428     if (suite->nb_units != suite->unit_failed) {
 429       fprintf(stderr, "%s%d ok", (first ? "" : ", "),
 430               suite->nb_units - suite->unit_failed);
 431       first = 0;
 432     }
 433     if (suite->unit_failed) {
 434       fprintf(stderr, "%s%d failed", (first ? "" : ", "),
 435               suite->unit_failed);
 436       first = 0;
 437     }
 438     if (suite->unit_ignore) {
 439       fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
 440               suite->unit_ignore);
 441       first = 0;
 442     }
 443     if (suite->unit_disabled) {
 444       fprintf(stderr, "%s%d disabled", (first ? "" : ", "),
 445               suite->unit_disabled);
 446       first = 0;
 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       first = 0;
 474     }
 475     fprintf(stderr, ")\n");
 476   }
 477   return suite->unit_failed;
 478 }
 479
 480 static void apply_selection(char *selection)
 481 {
 482   /* for the parsing */
 483   char *sel = selection;
 484   char *p;
 485   int done = 0;
 486   char dir[1024];               /* the directive */
 487   /* iterators */
 488   unsigned int it_suite;
 489   xbt_test_suite_t suite;
 490   xbt_test_unit_t unit;
 491   unsigned int it_unit;
 492
 493   char suitename[512];
 494   char unitname[512];
 495
 496   if (!selection || selection[0] == '\0')
 497     return;
 498
 499   /*printf("Test selection: %s\n", selection); */
 500
 501   /* First apply the selection */
 502   while (!done) {
 503     int enabling = 1;
 504
 505     p = strchr(sel, ',');
 506     if (p) {
 507       strncpy(dir, sel, p - sel);
 508       dir[p - sel] = '\0';
 509       sel = p + 1;
 510     } else {
 511       strcpy(dir, sel);
 512       done = 1;
 513     }
 514
 515     if (dir[0] == '-') {
 516       enabling = 0;
 517       memmove(dir, dir + 1, strlen(dir));
 518     }
 519     if (dir[0] == '+') {
 520       enabling = 1;
 521       memmove(dir, dir + 1, strlen(dir));
 522     }
 523
 524     p = strchr(dir, ':');
 525     if (p) {
 526       strcpy(unitname, p + 1);
 527       strncpy(suitename, dir, p - dir);
 528       suitename[p - dir] = '\0';
 529     } else {
 530       strcpy(suitename, dir);
 531       unitname[0] = '\0';
 532     }
 533     /*fprintf(stderr,"Seen %s (%s; suite=%s; unit=%s)\n",
 534        dir,enabling?"enabling":"disabling", suitename, unitname); */
 535
 536     /* Deal with the specific case of 'all' pseudo serie */
 537     if (!strcmp("all", suitename)) {
 538       if (unitname[0] != '\0') {
 539         fprintf(stderr,
 540                 "The 'all' pseudo-suite does not accept any unit specification\n");
 541         exit(1);
 542       }
 543
 544       xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
 545         xbt_dynar_foreach(suite->units, it_unit, unit) {
 546           unit->enabled = enabling;
 547         }
 548         suite->enabled = enabling;
 549       }
 550     } else {
 551       unsigned int it;
 552       for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
 553         xbt_test_suite_t thissuite =
 554             xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
 555         if (!strcmp(suitename, thissuite->name)) {
 556           /* Do not disable the whole suite when we just want to disable a child */
 557           if (enabling || (unitname[0] == '\0'))
 558             thissuite->enabled = enabling;
 559
 560           if (unitname[0] == '\0') {
 561             xbt_dynar_foreach(thissuite->units, it_unit, unit) {
 562               unit->enabled = enabling;
 563             }
 564           } else {              /* act on one child only */
 565             unsigned int it2_unit;
 566             /* search it, first (we won't reuse it for external loop which gets broken) */
 567             for (it2_unit = 0;
 568                  it2_unit < xbt_dynar_length(thissuite->units);
 569                  it2_unit++) {
 570               xbt_test_unit_t thisunit =
 571                   xbt_dynar_get_as(thissuite->units, it2_unit,
 572                                    xbt_test_unit_t);
 573               if (!strcmp(thisunit->name, unitname)) {
 574                 thisunit->enabled = enabling;
 575                 break;
 576               }
 577             }                   /* search relevant unit */
 578             if (it2_unit == xbt_dynar_length(thissuite->units)) {
 579               fprintf(stderr,
 580                       "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n",
 581                       suitename, unitname);
 582               exit(1);
 583             }
 584           }                     /* act on childs (either all or one) */
 585
 586           break;                /* found the relevant serie. We are happy */
 587         }
 588       }                         /* search relevant series */
 589       if (it == xbt_dynar_length(_xbt_test_suites)) {
 590         fprintf(stderr,
 591                 "No suite of name '%s' found. Cannot apply the selection\n",
 592                 suitename);
 593         exit(1);
 594       }
 595     }
 596
 597   }
 598 }
 599
 600 void xbt_test_dump(char *selection)
 601 {
 602   apply_selection(selection);
 603
 604   if (_xbt_test_suites) {
 605     unsigned int it_suite;
 606     xbt_test_suite_t suite;
 607
 608     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
 609         xbt_test_suite_dump(suite);
 610   } else {
 611     printf(" No suite defined.");
 612   }
 613 }
 614
 615 int xbt_test_run(char *selection)
 616 {
 617   apply_selection(selection);
 618
 619   if (_xbt_test_suites) {
 620     unsigned int it_suite;
 621     xbt_test_suite_t suite;
 622     int first = 1;
 623
 624     /* Run all the suites */
 625     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
 626         xbt_test_suite_run(suite);
 627
 628     /* Display some more statistics */
 629     fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
 630             _xbt_test_nb_suites
 631             ? ((1 -
 632                 (double) _xbt_test_suite_failed /
 633                 (double) _xbt_test_nb_suites) * 100.0)
 634             : 100.0, _xbt_test_nb_suites);
 635     if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
 636       fprintf(stderr, "%d ok",
 637               _xbt_test_nb_suites - _xbt_test_suite_failed);
 638       first = 0;
 639     }
 640     if (_xbt_test_suite_failed) {
 641       fprintf(stderr, "%s%d failed", (first ? "" : ", "),
 642               _xbt_test_suite_failed);
 643       first = 0;
 644     }
 645
 646     if (_xbt_test_suite_ignore) {
 647       fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
 648               _xbt_test_suite_ignore);
 649       first = 0;
 650     }
 651     fprintf(stderr, ")\n        Units:  %.0f%% ok (%d units: ",
 652             _xbt_test_nb_units
 653             ? ((1 -
 654                 (double) _xbt_test_unit_failed /
 655                 (double) _xbt_test_nb_units) * 100.0) : 100.0,
 656             _xbt_test_nb_units);
 657     first = 1;
 658     if (_xbt_test_nb_units != _xbt_test_unit_failed) {
 659       fprintf(stderr, "%s%d ok", (first ? "" : ", "),
 660               _xbt_test_nb_units - _xbt_test_unit_failed);
 661       first = 0;
 662     }
 663     if (_xbt_test_unit_failed) {
 664       fprintf(stderr, "%s%d failed", (first ? "" : ", "),
 665               _xbt_test_unit_failed);
 666       first = 0;
 667     }
 668     if (_xbt_test_unit_ignore) {
 669       fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
 670               _xbt_test_unit_ignore);
 671       first = 0;
 672     }
 673     fprintf(stderr, ")\n        Tests:  %.0f%% ok (%d tests: ",
 674             _xbt_test_nb_tests
 675             ? ((1 -
 676                 (double) _xbt_test_test_failed /
 677                 (double) _xbt_test_nb_tests) * 100.0) : 100.0,
 678             _xbt_test_nb_tests);
 679     first = 1;
 680     if (_xbt_test_nb_tests != _xbt_test_test_failed) {
 681       fprintf(stderr, "%s%d ok", (first ? "" : ", "),
 682               _xbt_test_nb_tests - _xbt_test_test_failed);
 683       first = 0;
 684     }
 685     if (_xbt_test_test_failed) {
 686       fprintf(stderr, "%s%d failed", (first ? "" : ", "),
 687               _xbt_test_test_failed);
 688       first = 0;
 689     }
 690     if (_xbt_test_test_ignore) {
 691       fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
 692               _xbt_test_test_ignore);
 693       first = 0;
 694     }
 695     if (_xbt_test_test_expect) {
 696       fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "),
 697               _xbt_test_test_expect);
 698     }
 699
 700     fprintf(stderr, ")\n");
 701   } else {
 702     fprintf(stderr, "No unit to run!\n");
 703     _xbt_test_unit_failed++;
 704   }
 705   return _xbt_test_unit_failed;
 706 }
 707
 708 void xbt_test_exit(void)
 709 {
 710   xbt_dynar_free(&_xbt_test_suites);
 711 }
 712
 713 /* annotate test case with test */
 714 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
 715 {
 716   xbt_test_unit_t unit = _xbt_test_current_unit;
 717   xbt_test_test_t test;
 718   va_list ap;
 719
 720   xbt_assert(unit);
 721   xbt_assert(fmt);
 722
 723   test = xbt_new0(struct s_xbt_test_test, 1);
 724   va_start(ap, fmt);
 725   test->title = bvprintf(fmt, ap);
 726   va_end(ap);
 727   test->failed = 0;
 728   test->expected_failure = 0;
 729   test->ignored = 0;
 730   test->file = file;
 731   test->line = line;
 732   test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
 733   xbt_dynar_push(unit->tests, &test);
 734   return;
 735 }
 736
 737 /* annotate test case with log message and failure */
 738 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
 739 {
 740   xbt_test_unit_t unit = _xbt_test_current_unit;
 741   xbt_test_test_t test;
 742   xbt_test_log_t log;
 743   va_list ap;
 744
 745   xbt_assert(unit);
 746   xbt_assert(fmt);
 747
 748   xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
 749               "Test failed even before being declared (broken unit: %s)",
 750               unit->title);
 751
 752   log = xbt_new(struct s_xbt_test_log, 1);
 753   va_start(ap, fmt);
 754   log->text = bvprintf(fmt, ap);
 755   va_end(ap);
 756   log->file = file;
 757   log->line = line;
 758
 759   test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
 760   xbt_dynar_push(test->logs, &log);
 761
 762   test->failed = 1;
 763 }
 764
 765 void xbt_test_exception(xbt_ex_t e)
 766 {
 767   _xbt_test_fail(e.file, e.line, "Exception %s raised: %s",
 768                  xbt_ex_catname(e.category), e.msg);
 769 }
 770
 771 void xbt_test_expect_failure(void)
 772 {
 773   xbt_test_test_t test;
 774   xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
 775               "Cannot expect the failure of a test before declaring it (broken unit: %s)",
 776               _xbt_test_current_unit->title);
 777   test =
 778       xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
 779   test->expected_failure = 1;
 780 }
 781
 782 void xbt_test_skip(void)
 783 {
 784   xbt_test_test_t test;
 785
 786   xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
 787               "Test skiped even before being declared (broken unit: %s)",
 788               _xbt_test_current_unit->title);
 789
 790   test =
 791       xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
 792   test->ignored = 1;
 793 }
 794
 795 /* annotate test case with log message only */
 796 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
 797 {
 798   xbt_test_unit_t unit = _xbt_test_current_unit;
 799   xbt_test_test_t test;
 800   xbt_test_log_t log;
 801   va_list ap;
 802
 803   xbt_assert(unit);
 804   xbt_assert(fmt);
 805
 806   xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
 807               "Test logged into even before being declared (broken test unit: %s)",
 808               unit->title);
 809
 810   log = xbt_new(struct s_xbt_test_log, 1);
 811   va_start(ap, fmt);
 812   log->text = bvprintf(fmt, ap);
 813   va_end(ap);
 814   log->file = file;
 815   log->line = line;
 816
 817   test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
 818   xbt_dynar_push(test->logs, &log);
 819 }
 820
 821
 822
 823
 824 #ifdef SIMGRID_TEST
 825
 826 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
 827
 828 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
 829 {
 830   xbt_test_add0("Skipped test");
 831   xbt_test_skip();
 832
 833   xbt_test_add2("%s %s", "EXPECTED", "FAILURE");
 834   xbt_test_expect_failure();
 835   xbt_test_log2("%s %s", "Test", "log");
 836   xbt_test_fail0("EXPECTED FAILURE");
 837 }
 838
 839 #endif                          /* SIMGRID_TEST */