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"
15 #include "xbt/sysdep.h" /* bvprintf */
16 #include "xbt/cunit.h"
17 #include "xbt/dynar.h"
19 /* collection of all suites */
20 static xbt_dynar_t _xbt_test_suites = NULL;
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;
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;
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;
38 xbt_test_unit_t _xbt_test_current_unit = NULL;
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,
54 fprintf(stderr, " log=NULL\n");
57 /* test suite test check */
58 typedef struct s_xbt_test_test {
68 static void xbt_test_test_dump(xbt_test_test_t test)
73 fprintf(stderr, " test %p(%s:%d)=%s (%s)\n",
74 test, test->file, test->line, test->title,
75 test->failed ? "failed" : "not failed");
76 xbt_dynar_foreach(test->logs, it_log, log)
77 xbt_test_log_dump(log);
79 fprintf(stderr, " test=NULL\n");
82 /* test suite test unit */
83 struct s_xbt_test_unit {
90 xbt_dynar_t tests; /* of xbt_test_test_t */
93 int test_failed, test_ignore, test_expect;
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",
102 unit->name, unit->title,
103 (unit->enabled ? "enabled" : "disabled"));
105 xbt_dynar_foreach(unit->tests, it_test, test)
106 xbt_test_test_dump(test);
108 fprintf(stderr, " unit=NULL\n");
113 struct s_xbt_test_suite {
117 xbt_dynar_t units; /* of xbt_test_unit_t */
119 int nb_tests, nb_units;
120 int test_failed, test_ignore, test_expect;
121 int unit_failed, unit_ignore, unit_disabled;
124 /* destroy test suite */
125 static void xbt_test_suite_free(void *s)
127 xbt_test_suite_t suite = *(xbt_test_suite_t *) s;
131 xbt_dynar_free(&suite->units);
136 static void xbt_test_unit_free(void *unit)
138 xbt_test_unit_t u = *(xbt_test_unit_t *) unit;
141 xbt_dynar_free(&u->tests);
145 static void xbt_test_test_free(void *test)
147 xbt_test_test_t t = *(xbt_test_test_t *) test;
149 xbt_dynar_free(&(t->logs));
153 static void xbt_test_log_free(void *log)
155 xbt_test_log_t l = *(xbt_test_log_t *) log;
160 /** @brief create test suite */
161 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...)
163 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite, 1);
166 if (!_xbt_test_suites)
168 xbt_dynar_new(sizeof(xbt_test_suite_t), xbt_test_suite_free);
171 suite->title = bvprintf(fmt, ap);
173 xbt_dynar_new(sizeof(xbt_test_unit_t), &xbt_test_unit_free);
178 xbt_dynar_push(_xbt_test_suites, &suite);
183 /** @brief retrieve a testsuite from name, or create a new one */
184 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 (!strcmp(suite->name, name))
199 bufname = bvprintf(fmt, ap);
201 suite = xbt_test_suite_new(name, bufname, NULL);
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",
213 suite->name, suite->title,
214 suite->enabled ? "enabled" : "disabled");
216 xbt_dynar_foreach(suite->units, it_unit, unit)
217 xbt_test_unit_dump(unit);
219 fprintf(stderr, "TESTSUITE IS NULL!\n");
223 /* add test case to test suite */
224 void xbt_test_suite_push(xbt_test_suite_t suite, const char *name,
225 ts_test_cb_t func, const char *fmt, ...)
227 xbt_test_unit_t unit;
234 unit = xbt_new0(struct s_xbt_test_unit, 1);
236 unit->title = bvprintf(fmt, ap);
238 unit->name = (char *) name;
243 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), xbt_test_test_free);
245 xbt_dynar_push(suite->units, &unit);
249 /* run test one suite */
250 static int xbt_test_suite_run(xbt_test_suite_t suite, int verbosity)
252 xbt_test_unit_t unit;
253 xbt_test_test_t test;
259 unsigned int it_unit, it_test, it_log;
261 int first = 1; /* for result pretty printing */
266 /* suite title pretty-printing */
268 char suite_title[81];
269 int suite_len = strlen(suite->title);
272 xbt_assert(suite_len < 68,
273 "suite title \"%s\" too long (%d should be less than 68",
274 suite->title, suite_len);
276 suite_title[0] = ' ';
277 for (i = 1; i < 80; i++)
278 suite_title[i] = '=';
279 suite_title[i++] = '\n';
280 suite_title[80] = '\0';
282 sprintf(suite_title + 40 - (suite_len + 4) / 2, "[ %s ]",
284 suite_title[40 + (suite_len + 5) / 2] = '=';
286 snprintf(suite_title + 70, 11, " DISABLED ");
287 fprintf(stderr, "\n%s\n", suite_title);
290 if (suite->enabled) {
291 /* iterate through all tests */
292 xbt_dynar_foreach(suite->units, it_unit, unit) {
293 /* init unit case counters */
295 unit->test_ignore = 0;
296 unit->test_failed = 0;
297 unit->test_expect = 0;
299 /* display unit title */
300 cp = bprintf(" Unit: %s ......................................"
301 "......................................", unit->title);
303 fprintf(stderr, "%s", cp);
306 /* run the test case function */
307 _xbt_test_current_unit = unit;
311 /* iterate through all performed tests to determine status */
312 xbt_dynar_foreach(unit->tests, it_test, test) {
318 if (test->failed && !test->expected_failure)
320 if (!test->failed && test->expected_failure)
322 if (test->expected_failure)
328 /* Display whether this unit went well */
329 if (unit->test_failed > 0 || unit->test_expect ||
330 (verbosity && unit->nb_tests > 0)) {
331 /* some tests failed (or were supposed to), so do detailed reporting of test case */
332 if (unit->test_failed > 0) {
333 fprintf(stderr, ".. failed\n");
334 } else if (unit->nb_tests) {
335 fprintf(stderr, "...... ok\n"); /* successful, but show about expected */
337 fprintf(stderr, ".... skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
339 xbt_dynar_foreach(unit->tests, it_test, test) {
340 file = (test->file != NULL ? test->file : unit->file);
341 line = (test->line != 0 ? test->line : unit->line);
342 fprintf(stderr, " %s: %s [%s:%d]\n",
343 (test->ignored ? " SKIP"
344 : (test->expected_failure
346 failed ? "EFAIL" : "EPASS") : (test->failed ?
349 test->title, file, line);
351 if ((test->expected_failure && !test->failed)
352 || (!test->expected_failure && test->failed)) {
353 xbt_dynar_foreach(test->logs, it_log, log) {
354 file = (log->file != NULL ? log->file : file);
355 line = (log->line != 0 ? log->line : line);
356 fprintf(stderr, " %s:%d: %s\n",
357 file, line, log->text);
362 fprintf(stderr, " Summary: %d of %d tests failed",
363 unit->test_failed, unit->nb_tests);
364 if (unit->test_ignore) {
365 fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
367 fprintf(stderr, "\n");
370 } else if (!unit->enabled) {
371 fprintf(stderr, " disabled\n"); /* no test were run */
372 } else if (unit->nb_tests) {
373 fprintf(stderr, "...... ok\n"); /* successful */
375 fprintf(stderr, ".... skip\n"); /* no test were run */
378 /* Accumulate test counts into the suite */
379 suite->nb_tests += unit->nb_tests;
380 suite->test_failed += unit->test_failed;
381 suite->test_ignore += unit->test_ignore;
382 suite->test_expect += unit->test_expect;
384 _xbt_test_nb_tests += unit->nb_tests;
385 _xbt_test_test_failed += unit->test_failed;
386 _xbt_test_test_ignore += unit->test_ignore;
387 _xbt_test_test_expect += unit->test_expect;
389 /* What's the conclusion of this test anyway? */
390 if (unit->nb_tests) {
392 if (unit->test_failed)
393 suite->unit_failed++;
394 } else if (!unit->enabled) {
395 suite->unit_disabled++;
397 suite->unit_ignore++;
401 _xbt_test_nb_units += suite->nb_units;
402 _xbt_test_unit_failed += suite->unit_failed;
403 _xbt_test_unit_ignore += suite->unit_ignore;
404 _xbt_test_unit_disabled += suite->unit_disabled;
406 if (suite->nb_units) {
407 _xbt_test_nb_suites++;
408 if (suite->test_failed)
409 _xbt_test_suite_failed++;
410 } else if (!suite->enabled) {
411 _xbt_test_suite_disabled++;
413 _xbt_test_suite_ignore++;
417 /* print test suite summary */
418 if (suite->enabled) {
421 " =====================================================================%s\n",
423 ? (suite->unit_failed ? "== FAILED" : "====== OK")
424 : (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
425 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
428 (double) suite->unit_failed / (double) suite->nb_units) *
429 100.0) : 100.0, suite->nb_units);
431 if (suite->nb_units != suite->unit_failed) {
432 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
433 suite->nb_units - suite->unit_failed);
436 if (suite->unit_failed) {
437 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
441 if (suite->unit_ignore) {
442 fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
446 if (suite->unit_disabled) {
447 fprintf(stderr, "%s%d disabled", (first ? "" : ", "),
448 suite->unit_disabled);
450 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ",
453 (double) suite->test_failed / (double) suite->nb_tests) *
454 100.0) : 100.0, suite->nb_tests);
457 if (suite->nb_tests != suite->test_failed) {
458 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
459 suite->nb_tests - suite->test_failed);
462 if (suite->test_failed) {
463 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
467 if (suite->test_ignore) {
468 fprintf(stderr, "%s%d ignored", (first ? "" : "; "),
472 if (suite->test_expect) {
473 fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "),
476 fprintf(stderr, ")\n");
478 return suite->unit_failed;
481 static void apply_selection(char *selection)
483 /* for the parsing */
484 char *sel = selection;
486 char dir[1024]; /* the directive */
488 unsigned int it_suite;
489 xbt_test_suite_t suite;
490 xbt_test_unit_t unit;
491 unsigned int it_unit;
496 if (!selection || selection[0] == '\0')
499 /*printf("Test selection: %s\n", selection); */
501 /* First apply the selection */
505 char *p = strchr(sel, ',');
507 strncpy(dir, sel, p - sel);
517 memmove(dir, dir + 1, strlen(dir));
521 memmove(dir, dir + 1, strlen(dir));
524 p = strchr(dir, ':');
526 strcpy(unitname, p + 1);
527 strncpy(suitename, dir, p - dir);
528 suitename[p - dir] = '\0';
530 strcpy(suitename, dir);
534 /* Deal with the specific case of 'all' pseudo serie */
535 if (!strcmp("all", suitename)) {
536 xbt_assert(unitname[0] == '\0', "The 'all' pseudo-suite does not accept any unit specification\n");
538 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
539 xbt_dynar_foreach(suite->units, it_unit, unit) {
540 unit->enabled = enabling;
542 suite->enabled = enabling;
546 for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
547 xbt_test_suite_t thissuite =
548 xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
549 if (!strcmp(suitename, thissuite->name)) {
550 /* Do not disable the whole suite when we just want to disable a child */
551 if (enabling || (unitname[0] == '\0'))
552 thissuite->enabled = enabling;
554 if (unitname[0] == '\0') {
555 xbt_dynar_foreach(thissuite->units, it_unit, unit) {
556 unit->enabled = enabling;
558 } else { /* act on one child only */
559 unsigned int it2_unit;
560 /* search it, first (we won't reuse it for external loop which gets broken) */
562 it2_unit < xbt_dynar_length(thissuite->units);
564 xbt_test_unit_t thisunit = xbt_dynar_get_as(thissuite->units, it2_unit, xbt_test_unit_t);
565 if (!strcmp(thisunit->name, unitname)) {
566 thisunit->enabled = enabling;
569 } /* search relevant unit */
570 xbt_assert(it2_unit != xbt_dynar_length(thissuite->units),
571 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n", suitename, unitname);
572 } /* act on childs (either all or one) */
574 break; /* found the relevant serie. We are happy */
576 } /* search relevant series */
577 xbt_assert(it != xbt_dynar_length(_xbt_test_suites), "No suite of name '%s' found. Cannot apply the selection\n", suitename);
583 void xbt_test_dump(char *selection)
585 apply_selection(selection);
587 if (_xbt_test_suites) {
588 unsigned int it_suite;
589 xbt_test_suite_t suite;
591 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
592 xbt_test_suite_dump(suite);
594 printf(" No suite defined.");
598 int xbt_test_run(char *selection, int verbosity)
600 apply_selection(selection);
602 if (_xbt_test_suites) {
603 unsigned int it_suite;
604 xbt_test_suite_t suite;
607 /* Run all the suites */
608 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
609 xbt_test_suite_run(suite, verbosity);
611 /* Display some more statistics */
612 fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
615 (double) _xbt_test_suite_failed /
616 (double) _xbt_test_nb_suites) * 100.0)
617 : 100.0, _xbt_test_nb_suites);
618 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
619 fprintf(stderr, "%d ok", _xbt_test_nb_suites - _xbt_test_suite_failed);
622 if (_xbt_test_suite_failed) {
623 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_suite_failed);
627 if (_xbt_test_suite_ignore) {
628 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_suite_ignore);
630 fprintf(stderr, ")\n Units: %.0f%% ok (%d units: ",
633 (double) _xbt_test_unit_failed /
634 (double) _xbt_test_nb_units) * 100.0) : 100.0,
637 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
638 fprintf(stderr, "%s%d ok", (first ? "" : ", "), _xbt_test_nb_units - _xbt_test_unit_failed);
641 if (_xbt_test_unit_failed) {
642 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_unit_failed);
645 if (_xbt_test_unit_ignore) {
646 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_unit_ignore);
648 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ",
651 (double) _xbt_test_test_failed /
652 (double) _xbt_test_nb_tests) * 100.0) : 100.0,
655 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
656 fprintf(stderr, "%s%d ok", (first ? "" : ", "), _xbt_test_nb_tests - _xbt_test_test_failed);
659 if (_xbt_test_test_failed) {
660 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_test_failed);
663 if (_xbt_test_test_ignore) {
664 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_test_ignore);
667 if (_xbt_test_test_expect) {
668 fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "), _xbt_test_test_expect);
671 fprintf(stderr, ")\n");
673 fprintf(stderr, "No unit to run!\n");
674 _xbt_test_unit_failed++;
676 return _xbt_test_unit_failed;
679 void xbt_test_exit(void)
681 xbt_dynar_free(&_xbt_test_suites);
684 /* annotate test case with test */
685 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
687 xbt_test_unit_t unit = _xbt_test_current_unit;
691 xbt_test_test_t test = xbt_new0(struct s_xbt_test_test, 1);
693 test->title = bvprintf(fmt, ap);
696 test->expected_failure = 0;
700 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
701 xbt_dynar_push(unit->tests, &test);
705 /* annotate test case with log message and failure */
706 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
708 xbt_test_unit_t unit = _xbt_test_current_unit;
710 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
711 "Test failed even before being declared (broken unit: %s)", unit->title);
714 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
716 log->text = bvprintf(fmt, ap);
721 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
722 xbt_dynar_push(test->logs, &log);
727 void xbt_test_exception(xbt_ex_t e)
729 _xbt_test_fail(e.file, e.line, "Exception %s raised: %s", xbt_ex_catname(e.category), e.msg);
732 void xbt_test_expect_failure(void)
734 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
735 "Cannot expect the failure of a test before declaring it (broken unit: %s)", _xbt_test_current_unit->title);
736 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
737 test->expected_failure = 1;
740 void xbt_test_skip(void)
742 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
743 "Test skiped even before being declared (broken unit: %s)", _xbt_test_current_unit->title);
744 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
748 /* annotate test case with log message only */
749 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
751 xbt_test_unit_t unit = _xbt_test_current_unit;
753 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
754 "Test logged into even before being declared (broken test unit: %s)", unit->title);
757 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
759 log->text = bvprintf(fmt, ap);
764 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
765 xbt_dynar_push(test->logs, &log);
771 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
773 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
775 xbt_test_add("Skipped test");
778 xbt_test_add("%s %s", "EXPECTED", "FAILURE");
779 xbt_test_expect_failure();
780 xbt_test_log("%s %s", "Test", "log");
781 xbt_test_fail("EXPECTED FAILURE");
784 #endif /* SIMGRID_TEST */