src/xbt/cunit.cpp

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