1 /* cunit - A little C Unit facility */
3 /* Copyright (c) 2005-2014. The SimGrid Team.
4 * All rights reserved. */
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. */
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 */
12 #include "src/internal_config.h"
16 #include "xbt/sysdep.h" /* bvprintf */
17 #include "xbt/cunit.h"
18 #include "xbt/dynar.h"
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;
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;
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;
39 xbt_test_unit_t _xbt_test_current_unit = nullptr;
41 /* test suite test log */
42 typedef struct s_xbt_test_log {
48 static void xbt_test_log_dump(xbt_test_log_t log)
51 fprintf(stderr, " log %p(%s:%d)=%s\n", log, log->file, log->line, log->text);
53 fprintf(stderr, " log=nullptr\n");
56 /* test suite test check */
57 typedef struct s_xbt_test_test {
67 static void xbt_test_test_dump(xbt_test_test_t test)
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);
77 fprintf(stderr, " test=nullptr\n");
80 /* test suite test unit */
81 struct s_xbt_test_unit {
88 xbt_dynar_t tests; /* of xbt_test_test_t */
96 static void xbt_test_unit_dump(xbt_test_unit_t unit)
100 unsigned int it_test;
101 fprintf(stderr, " UNIT %s: %s (%s)\n", unit->name, unit->title, (unit->enabled ? "enabled" : "disabled"));
103 xbt_dynar_foreach(unit->tests, it_test, test)
104 xbt_test_test_dump(test);
106 fprintf(stderr, " unit=nullptr\n");
111 struct s_xbt_test_suite {
115 xbt_dynar_t units; /* of xbt_test_unit_t */
127 /* destroy test suite */
128 static void xbt_test_suite_free(void *s)
130 xbt_test_suite_t suite = *(xbt_test_suite_t *) s;
132 if (suite == nullptr)
134 xbt_dynar_free(&suite->units);
139 static void xbt_test_unit_free(void *unit)
141 xbt_test_unit_t u = *(xbt_test_unit_t *) unit;
144 xbt_dynar_free(&u->tests);
148 static void xbt_test_test_free(void *test)
150 xbt_test_test_t t = *(xbt_test_test_t *) test;
152 xbt_dynar_free(&(t->logs));
156 static void xbt_test_log_free(void *log)
158 xbt_test_log_t l = *(xbt_test_log_t *) log;
163 /** @brief create test suite */
164 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...)
166 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite, 1);
169 if (_xbt_test_suites == nullptr)
170 _xbt_test_suites = xbt_dynar_new(sizeof(xbt_test_suite_t), xbt_test_suite_free);
173 suite->title = bvprintf(fmt, ap);
174 suite->units = xbt_dynar_new(sizeof(xbt_test_unit_t), &xbt_test_unit_free);
179 xbt_dynar_push(_xbt_test_suites, &suite);
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, ...)
187 xbt_test_suite_t suite;
188 unsigned int it_suite;
193 if (_xbt_test_suites)
194 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
195 if (not strcmp(suite->name, name))
199 bufname = bvprintf(fmt, ap);
201 suite = xbt_test_suite_new(name, bufname, nullptr);
207 void xbt_test_suite_dump(xbt_test_suite_t suite)
210 xbt_test_unit_t unit;
211 unsigned int it_unit;
212 fprintf(stderr, "TESTSUITE %s: %s (%s)\n", suite->name, suite->title, suite->enabled ? "enabled" : "disabled");
214 xbt_dynar_foreach(suite->units, it_unit, unit)
215 xbt_test_unit_dump(unit);
217 fprintf(stderr, "TESTSUITE IS nullptr!\n");
221 /* add test case to test suite */
222 void xbt_test_suite_push(xbt_test_suite_t suite, const char *name, ts_test_cb_t func, const char *fmt, ...)
224 xbt_test_unit_t unit;
231 unit = xbt_new0(struct s_xbt_test_unit, 1);
233 unit->title = bvprintf(fmt, ap);
235 unit->name = (char *) name;
237 unit->file = nullptr;
240 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), xbt_test_test_free);
242 xbt_dynar_push(suite->units, &unit);
245 /* run test one suite */
246 static int xbt_test_suite_run(xbt_test_suite_t suite, int verbosity)
248 xbt_test_unit_t unit;
249 xbt_test_test_t test;
255 unsigned int it_unit;
256 unsigned int it_test;
259 int first = 1; /* for result pretty printing */
261 if (suite == nullptr)
264 /* suite title pretty-printing */
265 char suite_title[81];
266 int suite_len = strlen(suite->title);
268 xbt_assert(suite_len < 68, "suite title \"%s\" too long (%d should be less than 68", suite->title, suite_len);
270 suite_title[0] = ' ';
271 for (int i = 1; i < 79; i++)
272 suite_title[i] = '=';
273 suite_title[79] = '\n';
274 suite_title[80] = '\0';
276 snprintf(suite_title + 40 - (suite_len + 4) / 2, 81 - (40 - (suite_len + 4) / 2), "[ %s ]", suite->title);
277 suite_title[40 + (suite_len + 5) / 2] = '=';
278 if (not suite->enabled)
279 snprintf(suite_title + 70, 11, " DISABLED ");
280 fprintf(stderr, "\n%s\n", suite_title);
282 if (suite->enabled) {
283 /* iterate through all tests */
284 xbt_dynar_foreach(suite->units, it_unit, unit) {
285 /* init unit case counters */
287 unit->test_ignore = 0;
288 unit->test_failed = 0;
289 unit->test_expect = 0;
291 /* display unit title */
292 cp = bprintf(" Unit: %s ......................................"
293 "......................................", unit->title);
295 fprintf(stderr, "%s", cp);
298 /* run the test case function */
299 _xbt_test_current_unit = unit;
303 /* iterate through all performed tests to determine status */
304 xbt_dynar_foreach(unit->tests, it_test, test) {
310 if (test->failed && not test->expected_failure)
312 if (not test->failed && test->expected_failure)
314 if (test->expected_failure)
318 /* Display whether this unit went well */
319 if (unit->test_failed > 0 || unit->test_expect || (verbosity && unit->nb_tests > 0)) {
320 /* some tests failed (or were supposed to), so do detailed reporting of test case */
321 if (unit->test_failed > 0) {
322 fprintf(stderr, ".. failed\n");
323 } else if (unit->nb_tests) {
324 fprintf(stderr, "...... ok\n"); /* successful, but show about expected */
326 fprintf(stderr, ".... skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
328 xbt_dynar_foreach(unit->tests, it_test, test) {
329 file = (test->file != nullptr ? test->file : unit->file);
330 line = (test->line != 0 ? test->line : unit->line);
334 else if (test->expected_failure) {
345 fprintf(stderr, " %s: %s [%s:%d]\n", resname, test->title, file, line);
347 if ((test->expected_failure && not test->failed) || (not test->expected_failure && test->failed)) {
348 xbt_dynar_foreach(test->logs, it_log, log) {
349 file = (log->file != nullptr ? log->file : file);
350 line = (log->line != 0 ? log->line : line);
351 fprintf(stderr, " %s:%d: %s\n", file, line, log->text);
355 fprintf(stderr, " Summary: %d of %d tests failed", unit->test_failed, unit->nb_tests);
356 if (unit->test_ignore) {
357 fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
359 fprintf(stderr, "\n");
361 } else if (not unit->enabled) {
362 fprintf(stderr, " disabled\n"); /* no test were run */
363 } else if (unit->nb_tests) {
364 fprintf(stderr, "...... ok\n"); /* successful */
366 fprintf(stderr, ".... skip\n"); /* no test were run */
369 /* Accumulate test counts into the suite */
370 suite->nb_tests += unit->nb_tests;
371 suite->test_failed += unit->test_failed;
372 suite->test_ignore += unit->test_ignore;
373 suite->test_expect += unit->test_expect;
375 _xbt_test_nb_tests += unit->nb_tests;
376 _xbt_test_test_failed += unit->test_failed;
377 _xbt_test_test_ignore += unit->test_ignore;
378 _xbt_test_test_expect += unit->test_expect;
380 /* What's the conclusion of this test anyway? */
381 if (unit->nb_tests) {
383 if (unit->test_failed)
384 suite->unit_failed++;
385 } else if (not unit->enabled) {
386 suite->unit_disabled++;
388 suite->unit_ignore++;
392 _xbt_test_nb_units += suite->nb_units;
393 _xbt_test_unit_failed += suite->unit_failed;
394 _xbt_test_unit_ignore += suite->unit_ignore;
395 _xbt_test_unit_disabled += suite->unit_disabled;
397 if (suite->nb_units) {
398 _xbt_test_nb_suites++;
399 if (suite->test_failed)
400 _xbt_test_suite_failed++;
401 } else if (not suite->enabled) {
402 _xbt_test_suite_disabled++;
404 _xbt_test_suite_ignore++;
407 /* print test suite summary */
408 if (suite->enabled) {
409 fprintf(stderr," =====================================================================%s\n",
410 (suite->nb_units ? (suite->unit_failed ? "== FAILED" : "====== OK") :
411 (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
412 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ", suite->nb_units
413 ? ((1 - (double) suite->unit_failed / (double) suite->nb_units) * 100.0) : 100.0, suite->nb_units);
415 if (suite->nb_units != suite->unit_failed) {
416 fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_units - suite->unit_failed);
419 if (suite->unit_failed) {
420 fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->unit_failed);
423 if (suite->unit_ignore) {
424 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), suite->unit_ignore);
427 if (suite->unit_disabled) {
428 fprintf(stderr, "%s%d disabled", (first ? "" : ", "), suite->unit_disabled);
430 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ", suite->nb_tests
431 ? ((1 - (double) suite->test_failed / (double) suite->nb_tests) * 100.0) : 100.0, suite->nb_tests);
434 if (suite->nb_tests != suite->test_failed) {
435 fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_tests - suite->test_failed);
438 if (suite->test_failed) {
439 fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->test_failed);
442 if (suite->test_ignore) {
443 fprintf(stderr, "%s%d ignored", (first ? "" : "; "), suite->test_ignore);
446 if (suite->test_expect) {
447 fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "), suite->test_expect);
449 fprintf(stderr, ")\n");
451 return suite->unit_failed;
454 static void apply_selection(char *selection)
456 /* for the parsing */
457 char *sel = selection;
459 char dir[1024]; /* the directive */
461 unsigned int it_suite;
462 xbt_test_suite_t suite;
463 xbt_test_unit_t unit;
464 unsigned int it_unit;
469 if (not selection || selection[0] == '\0')
472 /*printf("Test selection: %s\n", selection); */
474 /* First apply the selection */
478 char *p = strchr(sel, ',');
480 strncpy(dir, sel, p - sel);
484 strncpy(dir, sel,1024);
490 memmove(dir, dir + 1, strlen(dir));
494 memmove(dir, dir + 1, strlen(dir));
497 p = strchr(dir, ':');
499 strncpy(unitname, p + 1,512);
500 strncpy(suitename, dir, p - dir);
501 suitename[p - dir] = '\0';
503 strncpy(suitename, dir,512);
507 /* Deal with the specific case of 'all' pseudo serie */
508 if (not strcmp("all", suitename)) {
509 xbt_assert(unitname[0] == '\0', "The 'all' pseudo-suite does not accept any unit specification\n");
511 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
512 xbt_dynar_foreach(suite->units, it_unit, unit) {
513 unit->enabled = enabling;
515 suite->enabled = enabling;
519 for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
520 xbt_test_suite_t thissuite =
521 xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
522 if (not strcmp(suitename, thissuite->name)) {
523 /* Do not disable the whole suite when we just want to disable a child */
524 if (enabling || (unitname[0] == '\0'))
525 thissuite->enabled = enabling;
527 if (unitname[0] == '\0') {
528 xbt_dynar_foreach(thissuite->units, it_unit, unit) {
529 unit->enabled = enabling;
531 } else { /* act on one child only */
532 unsigned int it2_unit;
533 /* search it, first (we won't reuse it for external loop which gets broken) */
535 it2_unit < xbt_dynar_length(thissuite->units);
537 xbt_test_unit_t thisunit = xbt_dynar_get_as(thissuite->units, it2_unit, xbt_test_unit_t);
538 if (not strcmp(thisunit->name, unitname)) {
539 thisunit->enabled = enabling;
542 } /* search relevant unit */
543 xbt_assert(it2_unit != xbt_dynar_length(thissuite->units),
544 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n", suitename, unitname);
545 } /* act on childs (either all or one) */
547 break; /* found the relevant serie. We are happy */
549 } /* search relevant series */
550 xbt_assert(it != xbt_dynar_length(_xbt_test_suites),
551 "No suite of name '%s' found. Cannot apply the selection\n", suitename);
556 void xbt_test_dump(char *selection)
558 apply_selection(selection);
560 if (_xbt_test_suites) {
561 unsigned int it_suite;
562 xbt_test_suite_t suite;
564 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
565 xbt_test_suite_dump(suite);
567 printf(" No suite defined.");
571 int xbt_test_run(char *selection, int verbosity)
573 apply_selection(selection);
575 if (_xbt_test_suites) {
576 unsigned int it_suite;
577 xbt_test_suite_t suite;
580 /* Run all the suites */
581 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
582 xbt_test_suite_run(suite, verbosity);
584 /* Display some more statistics */
585 fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",_xbt_test_nb_suites
586 ? ((1 - (double) _xbt_test_suite_failed / (double) _xbt_test_nb_suites) * 100.0)
587 : 100.0, _xbt_test_nb_suites);
588 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
589 fprintf(stderr, "%d ok", _xbt_test_nb_suites - _xbt_test_suite_failed);
592 if (_xbt_test_suite_failed) {
593 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_suite_failed);
597 if (_xbt_test_suite_ignore) {
598 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_suite_ignore);
600 fprintf(stderr, ")\n Units: %.0f%% ok (%d units: ", _xbt_test_nb_units
601 ? ((1 - (double) _xbt_test_unit_failed / (double) _xbt_test_nb_units) * 100.0) : 100.0, _xbt_test_nb_units);
603 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
604 fprintf(stderr, "%d ok", _xbt_test_nb_units - _xbt_test_unit_failed);
607 if (_xbt_test_unit_failed) {
608 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_unit_failed);
611 if (_xbt_test_unit_ignore) {
612 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_unit_ignore);
614 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ", _xbt_test_nb_tests
615 ? ((1 - (double) _xbt_test_test_failed / (double) _xbt_test_nb_tests) * 100.0) : 100.0, _xbt_test_nb_tests);
617 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
618 fprintf(stderr, "%d ok", _xbt_test_nb_tests - _xbt_test_test_failed);
621 if (_xbt_test_test_failed) {
622 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_test_failed);
625 if (_xbt_test_test_ignore) {
626 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_test_ignore);
629 if (_xbt_test_test_expect) {
630 fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "), _xbt_test_test_expect);
633 fprintf(stderr, ")\n");
635 fprintf(stderr, "No unit to run!\n");
636 _xbt_test_unit_failed++;
638 return _xbt_test_unit_failed;
643 xbt_dynar_free(&_xbt_test_suites);
646 /* annotate test case with test */
647 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
649 xbt_test_unit_t unit = _xbt_test_current_unit;
653 xbt_test_test_t test = xbt_new0(struct s_xbt_test_test, 1);
655 test->title = bvprintf(fmt, ap);
658 test->expected_failure = 0;
662 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
663 xbt_dynar_push(unit->tests, &test);
666 /* annotate test case with log message and failure */
667 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
669 xbt_test_unit_t unit = _xbt_test_current_unit;
671 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
672 "Test failed even before being declared (broken unit: %s)", unit->title);
675 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
677 log->text = bvprintf(fmt, ap);
682 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
683 xbt_dynar_push(test->logs, &log);
688 void xbt_test_exception(xbt_ex_t e)
690 _xbt_test_fail(e.throwPoint().file, e.throwPoint().line, "Exception %s raised: %s", xbt_ex_catname(e.category), e.what());
693 void xbt_test_expect_failure()
695 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
696 "Cannot expect the failure of a test before declaring it (broken unit: %s)", _xbt_test_current_unit->title);
697 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
698 test->expected_failure = 1;
703 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
704 "Test skipped even before being declared (broken unit: %s)", _xbt_test_current_unit->title);
705 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
709 /* annotate test case with log message only */
710 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
712 xbt_test_unit_t unit = _xbt_test_current_unit;
714 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
715 "Test logged into even before being declared (broken test unit: %s)", unit->title);
718 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
720 log->text = bvprintf(fmt, ap);
725 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
726 xbt_dynar_push(test->logs, &log);
730 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
732 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
734 xbt_test_add("Skipped test");
737 xbt_test_add("%s %s", "EXPECTED", "FAILURE");
738 xbt_test_expect_failure();
739 xbt_test_log("%s %s", "Test", "log");
740 xbt_test_fail("EXPECTED FAILURE");
742 #endif /* SIMGRID_TEST */