src/xbt/cunit.cpp

   1 /* cunit - A little C Unit facility                                         */
   2
   3 /* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /* This is partially inspirated from the OSSP ts (Test Suite Library)       */
   9 /* At some point we should use https://github.com/google/googletest instead */
  10
  11 #include "src/internal_config.h"
  12 #include <stdio.h>
  13
  14 #include <xbt/ex.hpp>
  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 = nullptr;
  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 = nullptr;
  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=nullptr\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=nullptr\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;
  91   int test_ignore;
  92   int test_expect;
  93 };
  94
  95 static void xbt_test_unit_dump(xbt_test_unit_t unit)
  96 {
  97   if (unit) {
  98     fprintf(stderr, "  UNIT %s: %s (%s)\n", unit->name, unit->title, (unit->enabled ? "enabled" : "disabled"));
  99     if (unit->enabled) {
 100       xbt_test_test_t test;
 101       unsigned int it_test;
 102       xbt_dynar_foreach(unit->tests, it_test, test)
 103           xbt_test_test_dump(test);
 104     }
 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 == nullptr)
 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   char *bufname;
 189   va_list ap;
 190
 191   if (_xbt_test_suites) {
 192     unsigned int it_suite;
 193     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
 194       if (not strcmp(suite->name, name))
 195         return suite;
 196   }
 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     fprintf(stderr, "TESTSUITE %s: %s (%s)\n", suite->name, suite->title, suite->enabled ? "enabled" : "disabled");
 211     if (suite->enabled) {
 212       xbt_test_unit_t unit;
 213       unsigned int it_unit;
 214       xbt_dynar_foreach(suite->units, it_unit, unit)
 215           xbt_test_unit_dump(unit);
 216     }
 217   } else {
 218     fprintf(stderr, "TESTSUITE IS NULL!\n");
 219   }
 220 }
 221
 222 /* add test case to test suite */
 223 void xbt_test_suite_push(xbt_test_suite_t suite, const char *name, 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 = nullptr;
 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 }
 245
 246 /* run test one suite */
 247 static int xbt_test_suite_run(xbt_test_suite_t suite, int verbosity)
 248 {
 249   xbt_test_unit_t unit;
 250   xbt_test_test_t test;
 251   xbt_test_log_t log;
 252
 253   if (suite == nullptr)
 254     return 0;
 255
 256   /* suite title pretty-printing */
 257   char suite_title[81];
 258   int suite_len = strlen(suite->title);
 259
 260   xbt_assert(suite_len < 68, "suite title \"%s\" too long (%d should be less than 68", suite->title, suite_len);
 261
 262   suite_title[0] = ' ';
 263   for (int i = 1; i < 79; i++)
 264     suite_title[i] = '=';
 265   suite_title[79]  = '\n';
 266   suite_title[80]  = '\0';
 267
 268   snprintf(suite_title + 40 - (suite_len + 4) / 2, 81 - (40 - (suite_len + 4) / 2), "[ %s ]", suite->title);
 269   suite_title[40 + (suite_len + 5) / 2] = '=';
 270   if (not suite->enabled)
 271     snprintf(suite_title + 70, 11, " DISABLED ");
 272   fprintf(stderr, "\n%s\n", suite_title);
 273
 274   if (suite->enabled) {
 275     /* iterate through all tests */
 276     unsigned int it_unit;
 277     xbt_dynar_foreach(suite->units, it_unit, unit) {
 278       /* init unit case counters */
 279       unit->nb_tests = 0;
 280       unit->test_ignore = 0;
 281       unit->test_failed = 0;
 282       unit->test_expect = 0;
 283
 284       /* display unit title */
 285       char* cp = bprintf(" Unit: %s ......................................"
 286                          "......................................",
 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       unsigned int it_test;
 299       xbt_dynar_foreach(unit->tests, it_test, test) {
 300         if (test->ignored) {
 301           unit->test_ignore++;
 302         } else {
 303           unit->nb_tests++;
 304
 305           if (test->failed && not test->expected_failure)
 306             unit->test_failed++;
 307           if (not test->failed && test->expected_failure)
 308             unit->test_failed++;
 309           if (test->expected_failure)
 310             unit->test_expect++;
 311         }
 312       }
 313       /* Display whether this unit went well */
 314       if (unit->test_failed > 0 || unit->test_expect || (verbosity && unit->nb_tests > 0)) {
 315         /* some tests failed (or were supposed to), so do detailed reporting of test case */
 316         if (unit->test_failed > 0) {
 317           fprintf(stderr, ".. failed\n");
 318         } else if (unit->nb_tests) {
 319           fprintf(stderr, "...... ok\n");       /* successful, but show about expected */
 320         } else {
 321           fprintf(stderr, ".... skip\n");       /* shouldn't happen, but I'm a bit lost with this logic */
 322         }
 323         xbt_dynar_foreach(unit->tests, it_test, test) {
 324           const char* file = (test->file != nullptr ? test->file : unit->file);
 325           int line         = (test->line != 0 ? test->line : unit->line);
 326           const char* resname;
 327           if (test->ignored)
 328             resname = " SKIP";
 329           else if (test->expected_failure) {
 330             if (test->failed)
 331               resname = "EFAIL";
 332             else
 333               resname = "EPASS";
 334           } else {
 335             if (test->failed)
 336               resname = " FAIL";
 337             else
 338               resname = " PASS";
 339           }
 340           fprintf(stderr, "      %s: %s [%s:%d]\n", resname, test->title, file, line);
 341
 342           if ((test->expected_failure && not test->failed) || (not test->expected_failure && test->failed)) {
 343             unsigned int it_log;
 344             xbt_dynar_foreach(test->logs, it_log, log) {
 345               file = (log->file != nullptr ? log->file : file);
 346               line = (log->line != 0 ? log->line : line);
 347               fprintf(stderr, "             %s:%d: %s\n", file, line, log->text);
 348             }
 349           }
 350         }
 351         fprintf(stderr, "    Summary: %d of %d tests failed", unit->test_failed, unit->nb_tests);
 352         if (unit->test_ignore) {
 353           fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
 354         } else {
 355           fprintf(stderr, "\n");
 356         }
 357       } else if (not unit->enabled) {
 358         fprintf(stderr, " disabled\n"); /* no test were run */
 359       } else if (unit->nb_tests) {
 360         fprintf(stderr, "...... ok\n"); /* successful */
 361       } else {
 362         fprintf(stderr, ".... skip\n"); /* no test were run */
 363       }
 364
 365       /* Accumulate test counts into the suite */
 366       suite->nb_tests += unit->nb_tests;
 367       suite->test_failed += unit->test_failed;
 368       suite->test_ignore += unit->test_ignore;
 369       suite->test_expect += unit->test_expect;
 370
 371       _xbt_test_nb_tests += unit->nb_tests;
 372       _xbt_test_test_failed += unit->test_failed;
 373       _xbt_test_test_ignore += unit->test_ignore;
 374       _xbt_test_test_expect += unit->test_expect;
 375
 376       /* What's the conclusion of this test anyway? */
 377       if (unit->nb_tests) {
 378         suite->nb_units++;
 379         if (unit->test_failed)
 380           suite->unit_failed++;
 381       } else if (not unit->enabled) {
 382         suite->unit_disabled++;
 383       } else {
 384         suite->unit_ignore++;
 385       }
 386     }
 387   }
 388   _xbt_test_nb_units += suite->nb_units;
 389   _xbt_test_unit_failed += suite->unit_failed;
 390   _xbt_test_unit_ignore += suite->unit_ignore;
 391   _xbt_test_unit_disabled += suite->unit_disabled;
 392
 393   if (suite->nb_units) {
 394     _xbt_test_nb_suites++;
 395     if (suite->test_failed)
 396       _xbt_test_suite_failed++;
 397   } else if (not suite->enabled) {
 398     _xbt_test_suite_disabled++;
 399   } else {
 400     _xbt_test_suite_ignore++;
 401   }
 402
 403   /* print test suite summary */
 404   if (suite->enabled) {
 405     int first = 1; /* for result pretty printing */
 406
 407     fprintf(stderr," =====================================================================%s\n",
 408             (suite->nb_units ? (suite->unit_failed ? "== FAILED" : "====== OK") :
 409                                (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
 410     fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ", suite->nb_units
 411             ? ((1 - (double) suite->unit_failed / (double) suite->nb_units) * 100.0) : 100.0, suite->nb_units);
 412
 413     if (suite->nb_units != suite->unit_failed) {
 414       fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_units - suite->unit_failed);
 415       first = 0;
 416     }
 417     if (suite->unit_failed) {
 418       fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->unit_failed);
 419       first = 0;
 420     }
 421     if (suite->unit_ignore) {
 422       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), suite->unit_ignore);
 423       first = 0;
 424     }
 425     if (suite->unit_disabled) {
 426       fprintf(stderr, "%s%d disabled", (first ? "" : ", "), suite->unit_disabled);
 427     }
 428     fprintf(stderr, ")\n          Tests: %.0f%% ok (%d tests: ", suite->nb_tests
 429             ? ((1 - (double) suite->test_failed / (double) suite->nb_tests) * 100.0) : 100.0, suite->nb_tests);
 430
 431     first = 1;
 432     if (suite->nb_tests != suite->test_failed) {
 433       fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_tests - suite->test_failed);
 434       first = 0;
 435     }
 436     if (suite->test_failed) {
 437       fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->test_failed);
 438       first = 0;
 439     }
 440     if (suite->test_ignore) {
 441       fprintf(stderr, "%s%d ignored", (first ? "" : "; "), suite->test_ignore);
 442       first = 0;
 443     }
 444     if (suite->test_expect) {
 445       fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "), suite->test_expect);
 446     }
 447     fprintf(stderr, ")\n");
 448   }
 449   return suite->unit_failed;
 450 }
 451
 452 static void apply_selection(char *selection)
 453 {
 454   /* for the parsing */
 455   char *sel = selection;
 456   int done = 0;
 457   char dir[1024];               /* the directive */
 458   /* iterators */
 459   unsigned int it_suite;
 460   xbt_test_suite_t suite;
 461   xbt_test_unit_t unit;
 462   unsigned int it_unit;
 463
 464   char suitename[512];
 465   char unitname[512];
 466
 467   if (not selection || selection[0] == '\0')
 468     return;
 469
 470   /*printf("Test selection: %s\n", selection); */
 471
 472   /* First apply the selection */
 473   while (not done) {
 474     int enabling = 1;
 475
 476     char *p = strchr(sel, ',');
 477     if (p) {
 478       strncpy(dir, sel, p - sel);
 479       dir[p - sel] = '\0';
 480       sel = p + 1;
 481     } else {
 482       strncpy(dir, sel,1024);
 483       done = 1;
 484     }
 485
 486     if (dir[0] == '-') {
 487       enabling = 0;
 488       memmove(dir, dir + 1, strlen(dir));
 489     }
 490     if (dir[0] == '+') {
 491       enabling = 1;
 492       memmove(dir, dir + 1, strlen(dir));
 493     }
 494
 495     p = strchr(dir, ':');
 496     if (p) {
 497       strncpy(unitname, p + 1,512);
 498       strncpy(suitename, dir, p - dir);
 499       suitename[p - dir] = '\0';
 500     } else {
 501       strncpy(suitename, dir,512);
 502       unitname[0] = '\0';
 503     }
 504
 505     /* Deal with the specific case of 'all' pseudo serie */
 506     if (not strcmp("all", suitename)) {
 507       xbt_assert(unitname[0] == '\0', "The 'all' pseudo-suite does not accept any unit specification\n");
 508
 509       xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
 510         xbt_dynar_foreach(suite->units, it_unit, unit) {
 511           unit->enabled = enabling;
 512         }
 513         suite->enabled = enabling;
 514       }
 515     } else {
 516       unsigned int it;
 517       for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
 518         xbt_test_suite_t thissuite =
 519             xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
 520         if (not strcmp(suitename, thissuite->name)) {
 521           /* Do not disable the whole suite when we just want to disable a child */
 522           if (enabling || (unitname[0] == '\0'))
 523             thissuite->enabled = enabling;
 524
 525           if (unitname[0] == '\0') {
 526             xbt_dynar_foreach(thissuite->units, it_unit, unit) {
 527               unit->enabled = enabling;
 528             }
 529           } else {              /* act on one child only */
 530             unsigned int it2_unit;
 531             /* search it, first (we won't reuse it for external loop which gets broken) */
 532             for (it2_unit = 0;
 533                  it2_unit < xbt_dynar_length(thissuite->units);
 534                  it2_unit++) {
 535               xbt_test_unit_t thisunit = xbt_dynar_get_as(thissuite->units, it2_unit, xbt_test_unit_t);
 536               if (not strcmp(thisunit->name, unitname)) {
 537                 thisunit->enabled = enabling;
 538                 break;
 539               }
 540             }                   /* search relevant unit */
 541             xbt_assert(it2_unit != xbt_dynar_length(thissuite->units),
 542                 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n", suitename, unitname);
 543           }                     /* act on childs (either all or one) */
 544
 545           break;                /* found the relevant serie. We are happy */
 546         }
 547       }                         /* search relevant series */
 548       xbt_assert(it != xbt_dynar_length(_xbt_test_suites),
 549                  "No suite of name '%s' found. Cannot apply the selection\n", suitename);
 550     }
 551   }
 552 }
 553
 554 void xbt_test_dump(char *selection)
 555 {
 556   apply_selection(selection);
 557
 558   if (_xbt_test_suites) {
 559     unsigned int it_suite;
 560     xbt_test_suite_t suite;
 561
 562     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
 563         xbt_test_suite_dump(suite);
 564   } else {
 565     printf(" No suite defined.");
 566   }
 567 }
 568
 569 int xbt_test_run(char *selection, int verbosity)
 570 {
 571   apply_selection(selection);
 572
 573   if (_xbt_test_suites) {
 574     unsigned int it_suite;
 575     xbt_test_suite_t suite;
 576     int first = 1;
 577
 578     /* Run all the suites */
 579     xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
 580       xbt_test_suite_run(suite, verbosity);
 581
 582     /* Display some more statistics */
 583     fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",_xbt_test_nb_suites
 584             ? ((1 - (double) _xbt_test_suite_failed / (double) _xbt_test_nb_suites) * 100.0)
 585             : 100.0, _xbt_test_nb_suites);
 586     if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
 587       fprintf(stderr, "%d ok", _xbt_test_nb_suites - _xbt_test_suite_failed);
 588       first = 0;
 589     }
 590     if (_xbt_test_suite_failed) {
 591       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_suite_failed);
 592       first = 0;
 593     }
 594
 595     if (_xbt_test_suite_ignore) {
 596       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_suite_ignore);
 597     }
 598     fprintf(stderr, ")\n        Units:  %.0f%% ok (%d units: ", _xbt_test_nb_units
 599             ? ((1 - (double) _xbt_test_unit_failed / (double) _xbt_test_nb_units) * 100.0) : 100.0, _xbt_test_nb_units);
 600     first = 1;
 601     if (_xbt_test_nb_units != _xbt_test_unit_failed) {
 602       fprintf(stderr, "%d ok", _xbt_test_nb_units - _xbt_test_unit_failed);
 603       first = 0;
 604     }
 605     if (_xbt_test_unit_failed) {
 606       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_unit_failed);
 607       first = 0;
 608     }
 609     if (_xbt_test_unit_ignore) {
 610       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_unit_ignore);
 611     }
 612     fprintf(stderr, ")\n        Tests:  %.0f%% ok (%d tests: ", _xbt_test_nb_tests
 613             ? ((1 - (double) _xbt_test_test_failed / (double) _xbt_test_nb_tests) * 100.0) : 100.0, _xbt_test_nb_tests);
 614     first = 1;
 615     if (_xbt_test_nb_tests != _xbt_test_test_failed) {
 616       fprintf(stderr, "%d ok", _xbt_test_nb_tests - _xbt_test_test_failed);
 617       first = 0;
 618     }
 619     if (_xbt_test_test_failed) {
 620       fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_test_failed);
 621       first = 0;
 622     }
 623     if (_xbt_test_test_ignore) {
 624       fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_test_ignore);
 625       first = 0;
 626     }
 627     if (_xbt_test_test_expect) {
 628       fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "), _xbt_test_test_expect);
 629     }
 630
 631     fprintf(stderr, ")\n");
 632   } else {
 633     fprintf(stderr, "No unit to run!\n");
 634     _xbt_test_unit_failed++;
 635   }
 636   return _xbt_test_unit_failed;
 637 }
 638
 639 void xbt_test_exit()
 640 {
 641   xbt_dynar_free(&_xbt_test_suites);
 642 }
 643
 644 /* annotate test case with test */
 645 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
 646 {
 647   xbt_test_unit_t unit = _xbt_test_current_unit;
 648   xbt_assert(unit);
 649
 650   va_list ap;
 651   xbt_test_test_t test = xbt_new0(struct s_xbt_test_test, 1);
 652   va_start(ap, fmt);
 653   test->title = bvprintf(fmt, ap);
 654   va_end(ap);
 655   test->failed = 0;
 656   test->expected_failure = 0;
 657   test->ignored = 0;
 658   test->file = file;
 659   test->line = line;
 660   test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
 661   xbt_dynar_push(unit->tests, &test);
 662 }
 663
 664 /* annotate test case with log message and failure */
 665 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
 666 {
 667   xbt_test_unit_t unit = _xbt_test_current_unit;
 668   xbt_assert(unit);
 669   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
 670       "Test failed even before being declared (broken unit: %s)", unit->title);
 671
 672   va_list ap;
 673   xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
 674   va_start(ap, fmt);
 675   log->text = bvprintf(fmt, ap);
 676   va_end(ap);
 677   log->file = file;
 678   log->line = line;
 679
 680   xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
 681   xbt_dynar_push(test->logs, &log);
 682
 683   test->failed = 1;
 684 }
 685
 686 void xbt_test_exception(xbt_ex_t e)
 687 {
 688   _xbt_test_fail(e.throwPoint().file, e.throwPoint().line, "Exception %s raised: %s", xbt_ex_catname(e.category), e.what());
 689 }
 690
 691 void xbt_test_expect_failure()
 692 {
 693   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
 694       "Cannot expect the failure of a test before declaring it (broken unit: %s)", _xbt_test_current_unit->title);
 695   xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
 696   test->expected_failure = 1;
 697 }
 698
 699 void xbt_test_skip()
 700 {
 701   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
 702       "Test skipped even before being declared (broken unit: %s)", _xbt_test_current_unit->title);
 703   xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
 704   test->ignored = 1;
 705 }
 706
 707 /* annotate test case with log message only */
 708 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
 709 {
 710   xbt_test_unit_t unit = _xbt_test_current_unit;
 711   xbt_assert(unit);
 712   xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
 713       "Test logged into even before being declared (broken test unit: %s)", unit->title);
 714
 715   va_list ap;
 716   xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
 717   va_start(ap, fmt);
 718   log->text = bvprintf(fmt, ap);
 719   va_end(ap);
 720   log->file = file;
 721   log->line = line;
 722
 723   xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
 724   xbt_dynar_push(test->logs, &log);
 725 }
 726
 727 #ifdef SIMGRID_TEST
 728 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
 729
 730 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
 731 {
 732   xbt_test_add("Skipped test");
 733   xbt_test_skip();
 734
 735   xbt_test_add("%s %s", "EXPECTED", "FAILURE");
 736   xbt_test_expect_failure();
 737   xbt_test_log("%s %s", "Test", "log");
 738   xbt_test_fail("EXPECTED FAILURE");
 739 }
 740 #endif                          /* SIMGRID_TEST */