3 /* cunit - A little C Unit facility */
5 /* Copyright (c) 2005 Martin Quinson. All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 /* This is partially inspirated from the OSSP ts (Test Suite Library) */
14 #include "xbt/sysdep.h" /* vasprintf */
15 #include "xbt/cunit.h"
16 #include "xbt/dynar.h"
18 /* collection of all suites */
19 static xbt_dynar_t _xbt_test_suites = NULL;
20 /* global statistics */
21 static int _xbt_test_nb_tests = 0;
22 static int _xbt_test_test_failed = 0;
23 static int _xbt_test_test_ignore = 0;
24 static int _xbt_test_test_expect = 0;
26 static int _xbt_test_nb_units = 0;
27 static int _xbt_test_unit_failed = 0;
28 static int _xbt_test_unit_ignore = 0;
29 static int _xbt_test_unit_disabled = 0;
31 static int _xbt_test_nb_suites = 0;
32 static int _xbt_test_suite_failed = 0;
33 static int _xbt_test_suite_ignore = 0;
34 static int _xbt_test_suite_disabled = 0;
37 xbt_test_unit_t _xbt_test_current_unit = NULL;
40 /* test suite test log */
41 typedef struct s_xbt_test_log {
47 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,log->text);
51 fprintf(stderr," log=NULL\n");
53 static void xbt_test_log_free(xbt_test_log_t log) {
61 /* test suite test check */
62 typedef struct s_xbt_test_test {
72 static void xbt_test_test_dump(xbt_test_test_t test){
76 fprintf(stderr," test %p(%s:%d)=%s (%s)\n",
77 test,test->file,test->line,test->title,
78 test->failed?"failed":"not failed");
79 xbt_dynar_foreach(test->logs,it_log,log)
80 xbt_test_log_dump(log);
83 fprintf(stderr," test=NULL\n");
86 /* test suite test unit */
87 struct s_xbt_test_unit {
94 xbt_dynar_t tests; /* of xbt_test_test_t*/
97 int test_failed,test_ignore,test_expect;
100 static void xbt_test_unit_dump(xbt_test_unit_t unit) {
102 xbt_test_test_t test;
104 fprintf(stderr," UNIT %s: %s (%s)\n",
105 unit->name,unit->title,
106 (unit->enabled?"enabled":"disabled"));
108 xbt_dynar_foreach(unit->tests,it_test,test)
109 xbt_test_test_dump(test);
111 fprintf(stderr," unit=NULL\n");
116 struct s_xbt_test_suite {
120 xbt_dynar_t units; /* of xbt_test_unit_t */
122 int nb_tests,nb_units;
123 int test_failed,test_ignore,test_expect;
124 int unit_failed,unit_ignore,unit_disabled;
127 /* destroy test suite */
128 static void xbt_test_suite_free(void *s) {
129 xbt_test_suite_t suite = *(xbt_test_suite_t*) s;
133 xbt_dynar_free(&suite->units);
138 /** @brief create test suite */
139 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...) {
140 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite,1);
143 if (!_xbt_test_suites)
144 _xbt_test_suites = xbt_dynar_new(sizeof(xbt_test_suite_t),&xbt_test_suite_free);
147 vasprintf(&suite->title,fmt, ap);
148 suite->units = xbt_dynar_new(sizeof(xbt_test_unit_t), NULL);
153 xbt_dynar_push(_xbt_test_suites,&suite);
158 /** @brief retrieve a testsuite from name, or create a new one */
159 xbt_test_suite_t xbt_test_suite_by_name(const char *name,const char *fmt, ...) {
160 xbt_test_suite_t suite;
166 if (_xbt_test_suites)
167 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
168 if (!strcmp(suite->name,name))
172 vasprintf(&bufname,fmt, ap);
174 suite = xbt_test_suite_new(name,bufname,NULL);
180 void xbt_test_suite_dump(xbt_test_suite_t suite) {
182 xbt_test_unit_t unit;
184 fprintf(stderr,"TESTSUITE %s: %s (%s)\n",
185 suite->name, suite->title,
186 suite->enabled?"enabled":"disabled");
188 xbt_dynar_foreach(suite->units,it_unit,unit)
189 xbt_test_unit_dump(unit);
191 fprintf(stderr,"TESTSUITE IS NULL!\n");
195 /* add test case to test suite */
196 void xbt_test_suite_push(xbt_test_suite_t suite, const char *name, ts_test_cb_t func, const char *fmt, ...) {
197 xbt_test_unit_t unit;
204 unit = xbt_new0(struct s_xbt_test_unit,1);
206 vasprintf(&unit->title, fmt, ap);
208 unit->name = (char*)name;
213 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), NULL);
215 xbt_dynar_push(suite->units, &unit);
219 /* run test one suite */
220 static int xbt_test_suite_run(xbt_test_suite_t suite) {
221 xbt_test_unit_t unit;
222 xbt_test_test_t test;
228 int it_unit,it_test,it_log;
230 int first=1; /* for result pretty printing */
235 /* suite title pretty-printing */
237 char suite_title[80];
238 int suite_len=strlen(suite->title);
241 xbt_assert2(suite_len<68,"suite title \"%s\" too long (%d should be less than 68",
242 suite->title,suite_len);
247 suite_title[i++]='\n';
250 sprintf(suite_title + 40 - (suite_len+4)/2, "[ %s ]", suite->title);
251 suite_title[40 + (suite_len+5)/2] = '=';
253 sprintf(suite_title+ 70," DISABLED ");
254 fprintf(stderr, "\n%s",suite_title);
257 if (suite->enabled) {
258 /* iterate through all tests */
259 xbt_dynar_foreach(suite->units, it_unit, unit) {
260 /* init unit case counters */
262 unit->test_ignore = 0;
263 unit->test_failed = 0;
264 unit->test_expect = 0;
266 /* display unit title */
267 asprintf(&cp," Unit: %s ......................................"
268 "......................................", unit->title);
270 fprintf(stderr, "%s", cp);
273 /* run the test case function */
274 _xbt_test_current_unit = unit;
278 /* iterate through all performed tests to determine status */
279 xbt_dynar_foreach(unit->tests,it_test, test) {
285 if ( test->failed && !test->expected_failure) unit->test_failed++;
286 if (!test->failed && test->expected_failure) unit->test_failed++;
287 if (test->expected_failure)
293 /* Display whether this unit went well */
294 if (unit->test_failed > 0 || unit->test_expect) {
295 /* some tests failed (or were supposed to), so do detailed reporting of test case */
296 if (unit->test_failed > 0) {
297 fprintf(stderr, ".. failed\n");
298 } else if (unit->nb_tests) {
299 fprintf(stderr, "...... ok\n"); /* successful, but show about expected */
301 fprintf(stderr, ".... skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
303 xbt_dynar_foreach(unit->tests,it_test, test) {
304 file = (test->file != NULL ? test->file : unit->file);
305 line = (test->line != 0 ? test->line : unit->line);
306 fprintf(stderr, " %s: %s [%s:%d]\n",
307 (test->ignored?" SKIP":(test->expected_failure?(test->failed?"EFAIL":"EPASS"):
308 (test->failed?" FAIL":" PASS"))),
309 test->title, file, line);
311 xbt_dynar_foreach(test->logs,it_log,log) {
312 file = (log->file != NULL ? log->file : file);
313 line = (log->line != 0 ? log->line : line);
314 fprintf(stderr, " %s:%d: %s\n",
315 file, line,log->text);
319 fprintf(stderr, " Summary: %d of %d tests failed",unit->test_failed, unit->nb_tests);
320 if (unit->test_ignore) {
321 fprintf(stderr," (%d tests ignored)\n",unit->test_ignore);
323 fprintf(stderr,"\n");
326 } else if (!unit->enabled) {
327 fprintf(stderr, " disabled\n"); /* no test were run */
328 } else if (unit->nb_tests) {
329 fprintf(stderr, "...... ok\n"); /* successful */
331 fprintf(stderr, ".... skip\n"); /* no test were run */
334 /* Accumulate test counts into the suite */
335 suite->nb_tests += unit->nb_tests;
336 suite->test_failed += unit->test_failed;
337 suite->test_ignore += unit->test_ignore;
338 suite->test_expect += unit->test_expect;
340 _xbt_test_nb_tests += unit->nb_tests;
341 _xbt_test_test_failed += unit->test_failed;
342 _xbt_test_test_ignore += unit->test_ignore;
343 _xbt_test_test_expect += unit->test_expect;
345 /* What's the conclusion of this test anyway? */
346 if (unit->nb_tests) {
348 if (unit->test_failed)
349 suite->unit_failed++;
350 } else if (!unit->enabled) {
351 suite->unit_disabled++;
353 suite->unit_ignore++;
357 _xbt_test_nb_units += suite->nb_units;
358 _xbt_test_unit_failed += suite->unit_failed;
359 _xbt_test_unit_ignore += suite->unit_ignore;
360 _xbt_test_unit_disabled += suite->unit_disabled;
362 if (suite->nb_units) {
363 _xbt_test_nb_suites++;
364 if (suite->test_failed)
365 _xbt_test_suite_failed++;
366 } else if (!suite->enabled) {
367 _xbt_test_suite_disabled++;
369 _xbt_test_suite_ignore++;
373 /* print test suite summary */
374 if (suite->enabled) {
377 " =====================================================================%s\n",
378 (suite->nb_units ? (suite->unit_failed ? "== FAILED":"====== OK")
379 : (suite->unit_disabled ? " DISABLED":"==== SKIP")));
380 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
381 suite->nb_units?((1-(double)suite->unit_failed/(double)suite->nb_units)*100.0):100.0,
384 if (suite->nb_units != suite->unit_failed) {
385 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_units - suite->unit_failed);
388 if (suite->unit_failed) {
389 fprintf(stderr, "%s%d failed",(first?"":", "),suite->unit_failed);
392 if (suite->unit_ignore) {
393 fprintf(stderr, "%s%d ignored",(first?"":", "),suite->unit_ignore);
396 if (suite->unit_disabled) {
397 fprintf(stderr, "%s%d disabled",(first?"":", "),suite->unit_disabled);
400 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
401 suite->nb_tests?((1-(double)suite->test_failed/(double)suite->nb_tests)*100.0):100.0,
405 if (suite->nb_tests != suite->test_failed) {
406 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_tests - suite->test_failed);
409 if (suite->test_failed) {
410 fprintf(stderr, "%s%d failed",(first?"":", "),suite->test_failed);
413 if (suite->test_ignore) {
414 fprintf(stderr, "%s%d ignored",(first?"":"; "),suite->test_ignore);
417 if (suite->test_expect) {
418 fprintf(stderr, "%s%d expected to fail",(first?"":"; "),suite->test_expect);
421 fprintf(stderr,")\n");
423 return suite->unit_failed;
426 static void apply_selection(char *selection) {
427 /* for the parsing */
431 char dir[1024]; /* the directive */
434 xbt_test_suite_t suite;
435 xbt_test_unit_t unit;
441 if (!selection || selection[0] == '\0')
444 /*printf("Test selection: %s\n", selection);*/
446 /* First apply the selection */
452 strncpy(dir,sel,p-sel);
462 memmove(dir,dir+1,strlen(dir));
467 strcpy(unitname,p+1);
468 strncpy(suitename,dir,p-dir);
469 suitename[p-dir]='\0';
471 strcpy(suitename,dir);
474 /*fprintf(stderr,"Seen %s (%s; suite=%s; unit=%s)\n",
475 dir,enabling?"enabling":"disabling", suitename, unitname);*/
477 /* Deal with the specific case of 'all' pseudo serie */
478 if (!strcmp("all",suitename)) {
479 if (unitname[0]!='\0') {
480 fprintf(stderr,"The 'all' pseudo-suite does not accept any unit specification\n");
484 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite) {
485 xbt_dynar_foreach(suite->units,it_unit,unit) {
486 unit->enabled = enabling;
488 suite->enabled = enabling;
492 for (it=0; it<xbt_dynar_length(_xbt_test_suites); it++) {
493 xbt_test_suite_t thissuite=xbt_dynar_get_as(_xbt_test_suites,it,xbt_test_suite_t);
494 if (!strcmp(suitename,thissuite->name)) {
495 /* Do not disable the whole suite when we just want to disable a child */
496 if (enabling || (unitname[0]=='\0'))
497 thissuite->enabled = enabling;
499 if (unitname[0]=='\0') {
500 xbt_dynar_foreach(thissuite->units,it_unit,unit){
501 unit->enabled = enabling;
503 } else { /* act on one child only */
505 /* search it, first (we won't reuse it for external loop which gets broken) */
506 for (it2_unit=0; it2_unit<xbt_dynar_length(thissuite->units); it2_unit++) {
507 xbt_test_unit_t thisunit=xbt_dynar_get_as(thissuite->units,it2_unit,xbt_test_unit_t);
508 if (!strcmp(thisunit->name,unitname)) {
509 thisunit->enabled = enabling;
512 } /* search relevant unit */
513 if (it2_unit==xbt_dynar_length(thissuite->units)) {
514 fprintf(stderr,"Suite '%s' has no unit of name '%s'. Cannot apply the selection\n",
518 } /* act on childs (either all or one) */
520 break;/* found the relevant serie. We are happy */
522 } /* search relevant series */
523 if (it==xbt_dynar_length(_xbt_test_suites)) {
524 fprintf(stderr,"No suite of name '%s' found. Cannot apply the selection\n",suitename);
532 void xbt_test_dump(char *selection) {
533 apply_selection(selection);
535 if (_xbt_test_suites) {
537 xbt_test_suite_t suite;
539 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite)
540 xbt_test_suite_dump(suite);
542 printf(" No suite defined.");
546 int xbt_test_run(char *selection) {
547 apply_selection(selection);
549 if (_xbt_test_suites) {
551 xbt_test_suite_t suite;
554 /* Run all the suites */
555 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite)
556 xbt_test_suite_run(suite);
558 /* Display some more statistics */
559 fprintf(stderr,"\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
561 ? ((1-(double)_xbt_test_suite_failed/(double)_xbt_test_nb_suites)*100.0)
563 _xbt_test_nb_suites);
564 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
565 fprintf(stderr, "%d ok",_xbt_test_nb_suites - _xbt_test_suite_failed);
568 if (_xbt_test_suite_failed) {
569 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_suite_failed);
573 if (_xbt_test_suite_ignore) {
574 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_suite_ignore);
577 fprintf(stderr,")\n Units: %.0f%% ok (%d units: ",
578 _xbt_test_nb_units?((1-(double)_xbt_test_unit_failed/(double)_xbt_test_nb_units)*100.0):100.0,
581 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
582 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_units - _xbt_test_unit_failed);
585 if (_xbt_test_unit_failed) {
586 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_unit_failed);
589 if (_xbt_test_unit_ignore) {
590 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_unit_ignore);
593 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
594 _xbt_test_nb_tests?((1-(double)_xbt_test_test_failed/(double)_xbt_test_nb_tests)*100.0):100.0,
597 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
598 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_tests - _xbt_test_test_failed);
601 if (_xbt_test_test_failed) {
602 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_test_failed);
605 if (_xbt_test_test_ignore) {
606 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_test_ignore);
609 if (_xbt_test_test_expect) {
610 fprintf(stderr, "%s%d expected to fail",(first?"":", "),_xbt_test_test_expect);
613 fprintf(stderr,")\n");
615 fprintf(stderr,"No unit to run!\n");
616 _xbt_test_unit_failed++;
618 return _xbt_test_unit_failed;
622 /* annotate test case with test */
623 void _xbt_test_add(const char*file,int line, const char *fmt, ...) {
624 xbt_test_unit_t unit=_xbt_test_current_unit;
625 xbt_test_test_t test;
631 test = xbt_new(struct s_xbt_test_test,1);
633 vasprintf(&test->title, fmt, ap);
636 test->expected_failure = 0;
640 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t),NULL);
641 xbt_dynar_push(unit->tests,&test);
645 /* annotate test case with log message and failure */
646 void _xbt_test_fail(const char*file,int line,const char *fmt, ...) {
647 xbt_test_unit_t unit = _xbt_test_current_unit;
648 xbt_test_test_t test;
655 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
656 "Test failed even before being declared (broken unit: %s)",
659 log = xbt_new(struct s_xbt_test_log,1);
661 vasprintf(&log->text,fmt, ap);
666 test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
667 xbt_dynar_push(test->logs, &log);
672 void xbt_test_exception(xbt_ex_t e) {
673 _xbt_test_fail(e.file,e.line,"Exception %s raised: %s",xbt_ex_catname(e.category),e.msg);
676 void xbt_test_expect_failure(void) {
677 xbt_test_test_t test;
678 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
679 "Cannot expect the failure of a test before declaring it (broken unit: %s)",
680 _xbt_test_current_unit->title);
681 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,xbt_test_test_t);
682 test->expected_failure = 1;
684 void xbt_test_skip(void) {
685 xbt_test_test_t test;
687 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
688 "Test skiped even before being declared (broken unit: %s)",
689 _xbt_test_current_unit->title);
691 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,
696 /* annotate test case with log message only */
697 void _xbt_test_log(const char*file,int line,const char *fmt, ...) {
698 xbt_test_unit_t unit=_xbt_test_current_unit;
699 xbt_test_test_t test;
706 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
707 "Test logged into even before being declared (broken test unit: %s)",unit->title);
709 log = xbt_new(struct s_xbt_test_log,1);
711 vasprintf(&log->text, fmt, ap);
716 test = xbt_dynar_getlast_as(unit->tests,xbt_test_test_t);
717 xbt_dynar_push(test->logs, &log);
725 XBT_TEST_SUITE("cunit","Testsuite mechanism autotest");
727 XBT_TEST_UNIT("expect",test_expected_failure,"expected failures") {
728 xbt_test_add0("Skipped test");
731 xbt_test_add2("%s %s","EXPECTED","FAILURE");
732 xbt_test_expect_failure();
733 xbt_test_log2("%s %s","Test","log");
734 xbt_test_fail0("EXPECTED FAILURE");
737 #endif /* SIMGRID_TEST */