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 */
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", unit->name, unit->title, (unit->enabled ? "enabled" : "disabled"));
101 xbt_dynar_foreach(unit->tests, it_test, test)
102 xbt_test_test_dump(test);
104 fprintf(stderr, " unit=nullptr\n");
109 struct s_xbt_test_suite {
113 xbt_dynar_t units; /* of xbt_test_unit_t */
115 int nb_tests, nb_units;
116 int test_failed, test_ignore, test_expect;
117 int unit_failed, unit_ignore, unit_disabled;
120 /* destroy test suite */
121 static void xbt_test_suite_free(void *s)
123 xbt_test_suite_t suite = *(xbt_test_suite_t *) s;
125 if (suite == nullptr)
127 xbt_dynar_free(&suite->units);
132 static void xbt_test_unit_free(void *unit)
134 xbt_test_unit_t u = *(xbt_test_unit_t *) unit;
137 xbt_dynar_free(&u->tests);
141 static void xbt_test_test_free(void *test)
143 xbt_test_test_t t = *(xbt_test_test_t *) test;
145 xbt_dynar_free(&(t->logs));
149 static void xbt_test_log_free(void *log)
151 xbt_test_log_t l = *(xbt_test_log_t *) log;
156 /** @brief create test suite */
157 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...)
159 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite, 1);
162 if (!_xbt_test_suites)
163 _xbt_test_suites = xbt_dynar_new(sizeof(xbt_test_suite_t), xbt_test_suite_free);
166 suite->title = bvprintf(fmt, ap);
167 suite->units = xbt_dynar_new(sizeof(xbt_test_unit_t), &xbt_test_unit_free);
172 xbt_dynar_push(_xbt_test_suites, &suite);
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, ...)
180 xbt_test_suite_t suite;
181 unsigned int it_suite;
186 if (_xbt_test_suites)
187 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
188 if (!strcmp(suite->name, name))
192 bufname = bvprintf(fmt, ap);
194 suite = xbt_test_suite_new(name, bufname, nullptr);
200 void xbt_test_suite_dump(xbt_test_suite_t 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");
207 xbt_dynar_foreach(suite->units, it_unit, unit)
208 xbt_test_unit_dump(unit);
210 fprintf(stderr, "TESTSUITE IS nullptr!\n");
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, ...)
217 xbt_test_unit_t unit;
224 unit = xbt_new0(struct s_xbt_test_unit, 1);
226 unit->title = bvprintf(fmt, ap);
228 unit->name = (char *) name;
230 unit->file = nullptr;
233 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), xbt_test_test_free);
235 xbt_dynar_push(suite->units, &unit);
238 /* run test one suite */
239 static int xbt_test_suite_run(xbt_test_suite_t suite, int verbosity)
241 xbt_test_unit_t unit;
242 xbt_test_test_t test;
248 unsigned int it_unit, it_test, it_log;
250 int first = 1; /* for result pretty printing */
252 if (suite == nullptr)
255 /* suite title pretty-printing */
257 char suite_title[81];
258 int suite_len = strlen(suite->title);
261 xbt_assert(suite_len < 68, "suite title \"%s\" too long (%d should be less than 68", suite->title, suite_len);
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';
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] = '=';
272 snprintf(suite_title + 70, 11, " DISABLED ");
273 fprintf(stderr, "\n%s\n", suite_title);
276 if (suite->enabled) {
277 /* iterate through all tests */
278 xbt_dynar_foreach(suite->units, it_unit, unit) {
279 /* init unit case counters */
281 unit->test_ignore = 0;
282 unit->test_failed = 0;
283 unit->test_expect = 0;
285 /* display unit title */
286 cp = bprintf(" Unit: %s ......................................"
287 "......................................", unit->title);
289 fprintf(stderr, "%s", cp);
292 /* run the test case function */
293 _xbt_test_current_unit = unit;
297 /* iterate through all performed tests to determine status */
298 xbt_dynar_foreach(unit->tests, it_test, test) {
304 if (test->failed && !test->expected_failure)
306 if (!test->failed && test->expected_failure)
308 if (test->expected_failure)
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 */
320 fprintf(stderr, ".... skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
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 fprintf(stderr, " %s: %s [%s:%d]\n", (test->ignored ? " SKIP" : (test->expected_failure
326 ? (test-> failed ? "EFAIL" : "EPASS") : (test->failed ? " FAIL" : " PASS"))),test->title, file, line);
328 if ((test->expected_failure && !test->failed) || (!test->expected_failure && test->failed)) {
329 xbt_dynar_foreach(test->logs, it_log, log) {
330 file = (log->file != nullptr ? log->file : file);
331 line = (log->line != 0 ? log->line : line);
332 fprintf(stderr, " %s:%d: %s\n", file, line, log->text);
336 fprintf(stderr, " Summary: %d of %d tests failed", unit->test_failed, unit->nb_tests);
337 if (unit->test_ignore) {
338 fprintf(stderr, " (%d tests ignored)\n", unit->test_ignore);
340 fprintf(stderr, "\n");
342 } else if (!unit->enabled) {
343 fprintf(stderr, " disabled\n"); /* no test were run */
344 } else if (unit->nb_tests) {
345 fprintf(stderr, "...... ok\n"); /* successful */
347 fprintf(stderr, ".... skip\n"); /* no test were run */
350 /* Accumulate test counts into the suite */
351 suite->nb_tests += unit->nb_tests;
352 suite->test_failed += unit->test_failed;
353 suite->test_ignore += unit->test_ignore;
354 suite->test_expect += unit->test_expect;
356 _xbt_test_nb_tests += unit->nb_tests;
357 _xbt_test_test_failed += unit->test_failed;
358 _xbt_test_test_ignore += unit->test_ignore;
359 _xbt_test_test_expect += unit->test_expect;
361 /* What's the conclusion of this test anyway? */
362 if (unit->nb_tests) {
364 if (unit->test_failed)
365 suite->unit_failed++;
366 } else if (!unit->enabled) {
367 suite->unit_disabled++;
369 suite->unit_ignore++;
373 _xbt_test_nb_units += suite->nb_units;
374 _xbt_test_unit_failed += suite->unit_failed;
375 _xbt_test_unit_ignore += suite->unit_ignore;
376 _xbt_test_unit_disabled += suite->unit_disabled;
378 if (suite->nb_units) {
379 _xbt_test_nb_suites++;
380 if (suite->test_failed)
381 _xbt_test_suite_failed++;
382 } else if (!suite->enabled) {
383 _xbt_test_suite_disabled++;
385 _xbt_test_suite_ignore++;
388 /* print test suite summary */
389 if (suite->enabled) {
390 fprintf(stderr," =====================================================================%s\n",
391 (suite->nb_units ? (suite->unit_failed ? "== FAILED" : "====== OK") :
392 (suite->unit_disabled ? " DISABLED" : "==== SKIP")));
393 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ", suite->nb_units
394 ? ((1 - (double) suite->unit_failed / (double) suite->nb_units) * 100.0) : 100.0, suite->nb_units);
396 if (suite->nb_units != suite->unit_failed) {
397 fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_units - suite->unit_failed);
400 if (suite->unit_failed) {
401 fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->unit_failed);
404 if (suite->unit_ignore) {
405 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), suite->unit_ignore);
408 if (suite->unit_disabled) {
409 fprintf(stderr, "%s%d disabled", (first ? "" : ", "), suite->unit_disabled);
411 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ", suite->nb_tests
412 ? ((1 - (double) suite->test_failed / (double) suite->nb_tests) * 100.0) : 100.0, suite->nb_tests);
415 if (suite->nb_tests != suite->test_failed) {
416 fprintf(stderr, "%s%d ok", (first ? "" : ", "), suite->nb_tests - suite->test_failed);
419 if (suite->test_failed) {
420 fprintf(stderr, "%s%d failed", (first ? "" : ", "), suite->test_failed);
423 if (suite->test_ignore) {
424 fprintf(stderr, "%s%d ignored", (first ? "" : "; "), suite->test_ignore);
427 if (suite->test_expect) {
428 fprintf(stderr, "%s%d expected to fail", (first ? "" : "; "), suite->test_expect);
430 fprintf(stderr, ")\n");
432 return suite->unit_failed;
435 static void apply_selection(char *selection)
437 /* for the parsing */
438 char *sel = selection;
440 char dir[1024]; /* the directive */
442 unsigned int it_suite;
443 xbt_test_suite_t suite;
444 xbt_test_unit_t unit;
445 unsigned int it_unit;
450 if (!selection || selection[0] == '\0')
453 /*printf("Test selection: %s\n", selection); */
455 /* First apply the selection */
459 char *p = strchr(sel, ',');
461 strncpy(dir, sel, p - sel);
465 strncpy(dir, sel,1024);
471 memmove(dir, dir + 1, strlen(dir));
475 memmove(dir, dir + 1, strlen(dir));
478 p = strchr(dir, ':');
480 strncpy(unitname, p + 1,512);
481 strncpy(suitename, dir, p - dir);
482 suitename[p - dir] = '\0';
484 strncpy(suitename, dir,512);
488 /* Deal with the specific case of 'all' pseudo serie */
489 if (!strcmp("all", suitename)) {
490 xbt_assert(unitname[0] == '\0', "The 'all' pseudo-suite does not accept any unit specification\n");
492 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite) {
493 xbt_dynar_foreach(suite->units, it_unit, unit) {
494 unit->enabled = enabling;
496 suite->enabled = enabling;
500 for (it = 0; it < xbt_dynar_length(_xbt_test_suites); it++) {
501 xbt_test_suite_t thissuite =
502 xbt_dynar_get_as(_xbt_test_suites, it, xbt_test_suite_t);
503 if (!strcmp(suitename, thissuite->name)) {
504 /* Do not disable the whole suite when we just want to disable a child */
505 if (enabling || (unitname[0] == '\0'))
506 thissuite->enabled = enabling;
508 if (unitname[0] == '\0') {
509 xbt_dynar_foreach(thissuite->units, it_unit, unit) {
510 unit->enabled = enabling;
512 } else { /* act on one child only */
513 unsigned int it2_unit;
514 /* search it, first (we won't reuse it for external loop which gets broken) */
516 it2_unit < xbt_dynar_length(thissuite->units);
518 xbt_test_unit_t thisunit = xbt_dynar_get_as(thissuite->units, it2_unit, xbt_test_unit_t);
519 if (!strcmp(thisunit->name, unitname)) {
520 thisunit->enabled = enabling;
523 } /* search relevant unit */
524 xbt_assert(it2_unit != xbt_dynar_length(thissuite->units),
525 "Suite '%s' has no unit of name '%s'. Cannot apply the selection\n", suitename, unitname);
526 } /* act on childs (either all or one) */
528 break; /* found the relevant serie. We are happy */
530 } /* search relevant series */
531 xbt_assert(it != xbt_dynar_length(_xbt_test_suites),
532 "No suite of name '%s' found. Cannot apply the selection\n", suitename);
537 void xbt_test_dump(char *selection)
539 apply_selection(selection);
541 if (_xbt_test_suites) {
542 unsigned int it_suite;
543 xbt_test_suite_t suite;
545 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
546 xbt_test_suite_dump(suite);
548 printf(" No suite defined.");
552 int xbt_test_run(char *selection, int verbosity)
554 apply_selection(selection);
556 if (_xbt_test_suites) {
557 unsigned int it_suite;
558 xbt_test_suite_t suite;
561 /* Run all the suites */
562 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
563 xbt_test_suite_run(suite, verbosity);
565 /* Display some more statistics */
566 fprintf(stderr, "\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",_xbt_test_nb_suites
567 ? ((1 - (double) _xbt_test_suite_failed / (double) _xbt_test_nb_suites) * 100.0)
568 : 100.0, _xbt_test_nb_suites);
569 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
570 fprintf(stderr, "%d ok", _xbt_test_nb_suites - _xbt_test_suite_failed);
573 if (_xbt_test_suite_failed) {
574 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_suite_failed);
578 if (_xbt_test_suite_ignore) {
579 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_suite_ignore);
581 fprintf(stderr, ")\n Units: %.0f%% ok (%d units: ", _xbt_test_nb_units
582 ? ((1 - (double) _xbt_test_unit_failed / (double) _xbt_test_nb_units) * 100.0) : 100.0, _xbt_test_nb_units);
584 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
585 fprintf(stderr, "%d ok", _xbt_test_nb_units - _xbt_test_unit_failed);
588 if (_xbt_test_unit_failed) {
589 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_unit_failed);
592 if (_xbt_test_unit_ignore) {
593 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_unit_ignore);
595 fprintf(stderr, ")\n Tests: %.0f%% ok (%d tests: ", _xbt_test_nb_tests
596 ? ((1 - (double) _xbt_test_test_failed / (double) _xbt_test_nb_tests) * 100.0) : 100.0, _xbt_test_nb_tests);
598 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
599 fprintf(stderr, "%d ok", _xbt_test_nb_tests - _xbt_test_test_failed);
602 if (_xbt_test_test_failed) {
603 fprintf(stderr, "%s%d failed", (first ? "" : ", "), _xbt_test_test_failed);
606 if (_xbt_test_test_ignore) {
607 fprintf(stderr, "%s%d ignored", (first ? "" : ", "), _xbt_test_test_ignore);
610 if (_xbt_test_test_expect) {
611 fprintf(stderr, "%s%d expected to fail", (first ? "" : ", "), _xbt_test_test_expect);
614 fprintf(stderr, ")\n");
616 fprintf(stderr, "No unit to run!\n");
617 _xbt_test_unit_failed++;
619 return _xbt_test_unit_failed;
624 xbt_dynar_free(&_xbt_test_suites);
627 /* annotate test case with test */
628 void _xbt_test_add(const char *file, int line, const char *fmt, ...)
630 xbt_test_unit_t unit = _xbt_test_current_unit;
634 xbt_test_test_t test = xbt_new0(struct s_xbt_test_test, 1);
636 test->title = bvprintf(fmt, ap);
639 test->expected_failure = 0;
643 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t), xbt_test_log_free);
644 xbt_dynar_push(unit->tests, &test);
647 /* annotate test case with log message and failure */
648 void _xbt_test_fail(const char *file, int line, const char *fmt, ...)
650 xbt_test_unit_t unit = _xbt_test_current_unit;
652 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
653 "Test failed even before being declared (broken unit: %s)", unit->title);
656 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
658 log->text = bvprintf(fmt, ap);
663 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
664 xbt_dynar_push(test->logs, &log);
669 void xbt_test_exception(xbt_ex_t e)
671 _xbt_test_fail(e.throwPoint().file, e.throwPoint().line, "Exception %s raised: %s", xbt_ex_catname(e.category), e.what());
674 void xbt_test_expect_failure()
676 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
677 "Cannot expect the failure of a test before declaring it (broken unit: %s)", _xbt_test_current_unit->title);
678 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
679 test->expected_failure = 1;
684 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
685 "Test skipped even before being declared (broken unit: %s)", _xbt_test_current_unit->title);
686 xbt_test_test_t test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests, xbt_test_test_t);
690 /* annotate test case with log message only */
691 void _xbt_test_log(const char *file, int line, const char *fmt, ...)
693 xbt_test_unit_t unit = _xbt_test_current_unit;
695 xbt_assert(xbt_dynar_length(_xbt_test_current_unit->tests),
696 "Test logged into even before being declared (broken test unit: %s)", unit->title);
699 xbt_test_log_t log = xbt_new(struct s_xbt_test_log, 1);
701 log->text = bvprintf(fmt, ap);
706 xbt_test_test_t test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
707 xbt_dynar_push(test->logs, &log);
711 XBT_TEST_SUITE("cunit", "Testsuite mechanism autotest");
713 XBT_TEST_UNIT("expect", test_expected_failure, "expected failures")
715 xbt_test_add("Skipped test");
718 xbt_test_add("%s %s", "EXPECTED", "FAILURE");
719 xbt_test_expect_failure();
720 xbt_test_log("%s %s", "Test", "log");
721 xbt_test_fail("EXPECTED FAILURE");
723 #endif /* SIMGRID_TEST */