1 /* cunit - A little C Unit facility */
3 /* Copyright (c) 2005, 2006, 2007, 2008, 2009, 2010. 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) */
13 #include "xbt/sysdep.h" /* vasprintf */
14 #include "xbt/cunit.h"
15 #include "xbt/dynar.h"
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;
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;
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;
36 xbt_test_unit_t _xbt_test_current_unit = NULL;
39 /* test suite test log */
40 typedef struct s_xbt_test_log {
46 static void xbt_test_log_dump(xbt_test_log_t log)
49 fprintf(stderr, " log %p(%s:%d)=%s\n", log, log->file, log->line,
52 fprintf(stderr, " log=NULL\n");
55 /* test suite test check */
56 typedef struct s_xbt_test_test {
66 static void xbt_test_test_dump(xbt_test_test_t test)
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);
77 fprintf(stderr, " test=NULL\n");
80 /* test suite test unit */
81 struct s_xbt_test_unit {
88 xbt_dynar_t tests; /* of xbt_test_test_t */
91 int test_failed, test_ignore, test_expect;
94 static void xbt_test_unit_dump(xbt_test_unit_t unit)
99 fprintf(stderr, " UNIT %s: %s (%s)\n",
100 unit->name, unit->title,
101 (unit->enabled ? "enabled" : "disabled"));
103 xbt_dynar_foreach(unit->tests, it_test, test)
104 xbt_test_test_dump(test);
106 fprintf(stderr, " unit=NULL\n");
111 struct s_xbt_test_suite {
115 xbt_dynar_t units; /* of xbt_test_unit_t */
117 int nb_tests, nb_units;
118 int test_failed, test_ignore, test_expect;
119 int unit_failed, unit_ignore, unit_disabled;
122 /* destroy test suite */
123 static void xbt_test_suite_free(void *s)
125 xbt_test_suite_t suite = *(xbt_test_suite_t *) s;
129 xbt_dynar_free(&suite->units);
134 static void xbt_test_unit_free(void *unit)
136 xbt_test_unit_t u = *(xbt_test_unit_t *) unit;
139 xbt_dynar_free(&u->tests);
143 static void xbt_test_test_free(void *test)
145 xbt_test_test_t t = *(xbt_test_test_t *) test;
147 xbt_dynar_free(&(t->logs));
151 static void xbt_test_log_free(void *log)
153 xbt_test_log_t l = *(xbt_test_log_t *) log;
158 /** @brief create test suite */
159 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...)
161 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite, 1);
165 if (!_xbt_test_suites)
167 xbt_dynar_new(sizeof(xbt_test_suite_t), xbt_test_suite_free);
170 vres = vasprintf(&suite->title, fmt, ap);
172 xbt_dynar_new(sizeof(xbt_test_unit_t), &xbt_test_unit_free);
177 xbt_dynar_push(_xbt_test_suites, &suite);
182 /** @brief retrieve a testsuite from name, or create a new one */
183 xbt_test_suite_t xbt_test_suite_by_name(const char *name, const char *fmt,
186 xbt_test_suite_t suite;
187 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 vres = vasprintf(&bufname, 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;
235 unit = xbt_new0(struct s_xbt_test_unit, 1);
237 vres = vasprintf(&unit->title, fmt, ap);
239 unit->name = (char *) name;
244 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), xbt_test_test_free);
246 xbt_dynar_push(suite->units, &unit);
250 /* run test one suite */
251 static int xbt_test_suite_run(xbt_test_suite_t suite)
253 xbt_test_unit_t unit;
254 xbt_test_test_t test;
260 unsigned int it_unit, it_test, it_log;
262 int first = 1; /* for result pretty printing */
268 /* suite title pretty-printing */
270 char suite_title[81];
271 int suite_len = strlen(suite->title);
274 xbt_assert2(suite_len < 68,
275 "suite title \"%s\" too long (%d should be less than 68",
276 suite->title, suite_len);
278 suite_title[0] = ' ';
279 for (i = 1; i < 80; i++)
280 suite_title[i] = '=';
281 suite_title[i++] = '\n';
282 suite_title[80] = '\0';
284 sprintf(suite_title + 40 - (suite_len + 4) / 2, "[ %s ]",
286 suite_title[40 + (suite_len + 5) / 2] = '=';
288 snprintf(suite_title + 70, 11, " DISABLED ");
289 fprintf(stderr, "\n%s\n", suite_title);
292 if (suite->enabled) {
293 /* iterate through all tests */
294 xbt_dynar_foreach(suite->units, it_unit, unit) {
295 /* init unit case counters */
297 unit->test_ignore = 0;
298 unit->test_failed = 0;
299 unit->test_expect = 0;
301 /* display unit title */
304 " Unit: %s ......................................"
305 "......................................", unit->title);
307 fprintf(stderr, "%s", cp);
310 /* run the test case function */
311 _xbt_test_current_unit = unit;
315 /* iterate through all performed tests to determine status */
316 xbt_dynar_foreach(unit->tests, it_test, test) {
322 if (test->failed && !test->expected_failure)
324 if (!test->failed && test->expected_failure)
326 if (test->expected_failure)
332 /* Display whether this unit went well */
333 if (unit->test_failed > 0 || unit->test_expect) {
334 /* some tests failed (or were supposed to), so do detailed reporting of test case */
335 if (unit->test_failed > 0) {
336 fprintf(stderr, ".. failed\n");
337 } else if (unit->nb_tests) {
338 fprintf(stderr, "...... ok\n"); /* successful, but show about expected */
340 fprintf(stderr, ".... skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
342 xbt_dynar_foreach(unit->tests, it_test, test) {
343 file = (test->file != NULL ? test->file : unit->file);
344 line = (test->line != 0 ? test->line : unit->line);
345 fprintf(stderr, " %s: %s [%s:%d]\n",
346 (test->ignored ? " SKIP"
347 : (test->expected_failure
349 failed ? "EFAIL" : "EPASS") : (test->failed ?
352 test->title, file, line);
354 if ((test->expected_failure && !test->failed)
355 || (!test->expected_failure && test->failed)) {
356 xbt_dynar_foreach(test->logs, it_log, log) {
357 file = (log->file != NULL ? log->file : file);
358 line = (log->line != 0 ? log->line : line);
359 fprintf(stderr, " %s:%d: %s\n",
360 file, line, log->text);
365 fprintf(stderr, " Summary: %d of %d tests failed",
366 unit->test_failed, unit->nb_tests);
367 if (unit->test_ignore) {
368 fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
370 fprintf(stderr, "\n");
373 } else if (!unit->enabled) {
374 fprintf(stderr, " disabled\n"); /* no test were run */
375 } else if (unit->nb_tests) {
376 fprintf(stderr, "...... ok\n"); /* successful */
378 fprintf(stderr, ".... skip\n"); /* no test were run */
381 /* Accumulate test counts into the suite */
382 suite->nb_tests += unit->nb_tests;
383 suite->test_failed += unit->test_failed;
384 suite->test_ignore += unit->test_ignore;
385 suite->test_expect += unit->test_expect;
387 _xbt_test_nb_tests += unit->nb_tests;
388 _xbt_test_test_failed += unit->test_failed;
389 _xbt_test_test_ignore += unit->test_ignore;
390 _xbt_test_test_expect += unit->test_expect;
392 /* What's the conclusion of this test anyway? */
393 if (unit->nb_tests) {
395 if (unit->test_failed)
396 suite->unit_failed++;
397 } else if (!unit->enabled) {
398 suite->unit_disabled++;
400 suite->unit_ignore++;
404 _xbt_test_nb_units += suite->nb_units;
405 _xbt_test_unit_failed += suite->unit_failed;
406 _xbt_test_unit_ignore += suite->unit_ignore;
407 _xbt_test_unit_disabled += suite->unit_disabled;
409 if (suite->nb_units) {
410 _xbt_test_nb_suites++;
411 if (suite->test_failed)
412 _xbt_test_suite_failed++;
413 } else if (!suite->enabled) {
414 _xbt_test_suite_disabled++;
416 _xbt_test_suite_ignore++;
420 /* print test suite summary */
421 if (suite->enabled) {
424 " =====================================================================%s\n",
426 ? (suite->unit_failed ? "== FAILED" : "====== OK")
427 : (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
428 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
431 (double) suite->unit_failed / (double) suite->nb_units) *
432 100.0) : 100.0, suite->nb_units);
434 if (suite->nb_units != suite->unit_failed) {
435 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
436 suite->nb_units - suite->unit_failed);
439 if (suite->unit_failed) {
440 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
444 if (suite->unit_ignore) {
445 fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
449 if (suite->unit_disabled) {
450 fprintf(stderr, "%s%d disabled", (first ? "" : ", "),
451 suite->unit_disabled);
454 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ",
457 (double) suite->test_failed / (double) suite->nb_tests) *
458 100.0) : 100.0, suite->nb_tests);
461 if (suite->nb_tests != suite->test_failed) {
462 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
463 suite->nb_tests - suite->test_failed);
466 if (suite->test_failed) {
467 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
471 if (suite->test_ignore) {
472 fprintf(stderr, "%s%d ignored", (first ? "" : "; "),
476 if (suite->test_expect) {
477 fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "),
481 fprintf(stderr, ")\n");
483 return suite->unit_failed;
486 static void apply_selection(char *selection)
488 /* for the parsing */
489 char *sel = selection;
492 char dir[1024]; /* the directive */
494 unsigned int it_suite;
495 xbt_test_suite_t suite;
496 xbt_test_unit_t unit;
497 unsigned int it_unit;
502 if (!selection || selection[0] == '\0')
505 /*printf("Test selection: %s\n", selection); */
507 /* First apply the selection */
511 p = strchr(sel, ',');
513 strncpy(dir, sel, p - sel);
523 memmove(dir, dir + 1, strlen(dir));
527 memmove(dir, dir + 1, strlen(dir));
530 p = strchr(dir, ':');
532 strcpy(unitname, p + 1);
533 strncpy(suitename, dir, p - dir);
534 suitename[p - dir] = '\0';
536 strcpy(suitename, dir);
539 /*fprintf(stderr,"Seen %s (%s; suite=%s; unit=%s)\n",
540 dir,enabling?"enabling":"disabling", suitename, unitname); */
542 /* Deal with the specific case of 'all' pseudo serie */
543 if (!strcmp("all", suitename)) {
544 if (unitname[0] != '\0') {
546 "The 'all' pseudo-suite does not accept any unit specification\n");
550 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
551 xbt_dynar_foreach(suite->units, it_unit, unit) {
552 unit->enabled = enabling;
554 suite->enabled = enabling;
558 for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
559 xbt_test_suite_t thissuite =
560 xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
561 if (!strcmp(suitename, thissuite->name)) {
562 /* Do not disable the whole suite when we just want to disable a child */
563 if (enabling || (unitname[0] == '\0'))
564 thissuite->enabled = enabling;
566 if (unitname[0] == '\0') {
567 xbt_dynar_foreach(thissuite->units, it_unit, unit) {
568 unit->enabled = enabling;
570 } else { /* act on one child only */
571 unsigned int it2_unit;
572 /* search it, first (we won't reuse it for external loop which gets broken) */
574 it2_unit < xbt_dynar_length(thissuite->units);
576 xbt_test_unit_t thisunit =
577 xbt_dynar_get_as(thissuite->units, it2_unit,
579 if (!strcmp(thisunit->name, unitname)) {
580 thisunit->enabled = enabling;
583 } /* search relevant unit */
584 if (it2_unit == xbt_dynar_length(thissuite->units)) {
586 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n",
587 suitename, unitname);
590 } /* act on childs (either all or one) */
592 break; /* found the relevant serie. We are happy */
594 } /* search relevant series */
595 if (it == xbt_dynar_length(_xbt_test_suites)) {
597 "No suite of name '%s' found. Cannot apply the selection\n",
606 void xbt_test_dump(char *selection)
608 apply_selection(selection);
610 if (_xbt_test_suites) {
611 unsigned int it_suite;
612 xbt_test_suite_t suite;
614 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
615 xbt_test_suite_dump(suite);
617 printf(" No suite defined.");
621 int xbt_test_run(char *selection)
623 apply_selection(selection);
625 if (_xbt_test_suites) {
626 unsigned int it_suite;
627 xbt_test_suite_t suite;
630 /* Run all the suites */
631 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
632 xbt_test_suite_run(suite);
634 /* Display some more statistics */
635 fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
638 (double) _xbt_test_suite_failed /
639 (double) _xbt_test_nb_suites) * 100.0)
640 : 100.0, _xbt_test_nb_suites);
641 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
642 fprintf(stderr, "%d ok",
643 _xbt_test_nb_suites - _xbt_test_suite_failed);
646 if (_xbt_test_suite_failed) {
647 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
648 _xbt_test_suite_failed);
652 if (_xbt_test_suite_ignore) {
653 fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
654 _xbt_test_suite_ignore);
657 fprintf(stderr, ")\n Units: %.0f%% ok (%d units: ",
660 (double) _xbt_test_unit_failed /
661 (double) _xbt_test_nb_units) * 100.0) : 100.0,
664 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
665 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
666 _xbt_test_nb_units - _xbt_test_unit_failed);
669 if (_xbt_test_unit_failed) {
670 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
671 _xbt_test_unit_failed);
674 if (_xbt_test_unit_ignore) {
675 fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
676 _xbt_test_unit_ignore);
679 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ",
682 (double) _xbt_test_test_failed /
683 (double) _xbt_test_nb_tests) * 100.0) : 100.0,
686 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
687 fprintf(stderr, "%s%d ok", (first ? "" : ", "),
688 _xbt_test_nb_tests - _xbt_test_test_failed);
691 if (_xbt_test_test_failed) {
692 fprintf(stderr, "%s%d failed", (first ? "" : ", "),
693 _xbt_test_test_failed);
696 if (_xbt_test_test_ignore) {
697 fprintf(stderr, "%s%d ignored", (first ? "" : ", "),
698 _xbt_test_test_ignore);
701 if (_xbt_test_test_expect) {
702 fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "),
703 _xbt_test_test_expect);
706 fprintf(stderr, ")\n");
708 fprintf(stderr, "No unit to run!\n");
709 _xbt_test_unit_failed++;
711 return _xbt_test_unit_failed;
714 void xbt_test_exit(void)
716 xbt_dynar_free(&_xbt_test_suites);
719 /* annotate test case with test */
720 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
722 xbt_test_unit_t unit = _xbt_test_current_unit;
723 xbt_test_test_t test;
730 test = xbt_new0(struct s_xbt_test_test, 1);
732 vres = vasprintf(&test->title, fmt, ap);
735 test->expected_failure = 0;
739 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
740 xbt_dynar_push(unit->tests, &test);
744 /* annotate test case with log message and failure */
745 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
747 xbt_test_unit_t unit = _xbt_test_current_unit;
748 xbt_test_test_t test;
756 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
757 "Test failed even before being declared (broken unit: %s)",
760 log = xbt_new(struct s_xbt_test_log, 1);
762 vres = vasprintf(&log->text, fmt, ap);
767 test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
768 xbt_dynar_push(test->logs, &log);
773 void xbt_test_exception(xbt_ex_t e)
775 _xbt_test_fail(e.file, e.line, "Exception %s raised: %s",
776 xbt_ex_catname(e.category), e.msg);
779 void xbt_test_expect_failure(void)
781 xbt_test_test_t test;
782 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
783 "Cannot expect the failure of a test before declaring it (broken unit: %s)",
784 _xbt_test_current_unit->title);
786 xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
787 test->expected_failure = 1;
790 void xbt_test_skip(void)
792 xbt_test_test_t test;
794 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
795 "Test skiped even before being declared (broken unit: %s)",
796 _xbt_test_current_unit->title);
799 xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
803 /* annotate test case with log message only */
804 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
806 xbt_test_unit_t unit = _xbt_test_current_unit;
807 xbt_test_test_t test;
815 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
816 "Test logged into even before being declared (broken test unit: %s)",
819 log = xbt_new(struct s_xbt_test_log, 1);
821 vres = vasprintf(&log->text, fmt, ap);
826 test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
827 xbt_dynar_push(test->logs, &log);
835 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
837 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
839 xbt_test_add0("Skipped test");
842 xbt_test_add2("%s %s", "EXPECTED", "FAILURE");
843 xbt_test_expect_failure();
844 xbt_test_log2("%s %s", "Test", "log");
845 xbt_test_fail0("EXPECTED FAILURE");
848 #endif /* SIMGRID_TEST */