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;
103 unsigned int it_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;
161 unsigned int it_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;
183 unsigned int it_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 unsigned 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';
248 suite_title[79]='\0';
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\n",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 if ( (test->expected_failure && !test->failed) || (!test->expected_failure && test->failed) ) {
312 xbt_dynar_foreach(test->logs,it_log,log) {
313 file = (log->file != NULL ? log->file : file);
314 line = (log->line != 0 ? log->line : line);
315 fprintf(stderr, " %s:%d: %s\n",
316 file, line,log->text);
321 fprintf(stderr, " Summary: %d of %d tests failed",unit->test_failed, unit->nb_tests);
322 if (unit->test_ignore) {
323 fprintf(stderr," (%d tests ignored)\n",unit->test_ignore);
325 fprintf(stderr,"\n");
328 } else if (!unit->enabled) {
329 fprintf(stderr, " disabled\n"); /* no test were run */
330 } else if (unit->nb_tests) {
331 fprintf(stderr, "...... ok\n"); /* successful */
333 fprintf(stderr, ".... skip\n"); /* no test were run */
336 /* Accumulate test counts into the suite */
337 suite->nb_tests += unit->nb_tests;
338 suite->test_failed += unit->test_failed;
339 suite->test_ignore += unit->test_ignore;
340 suite->test_expect += unit->test_expect;
342 _xbt_test_nb_tests += unit->nb_tests;
343 _xbt_test_test_failed += unit->test_failed;
344 _xbt_test_test_ignore += unit->test_ignore;
345 _xbt_test_test_expect += unit->test_expect;
347 /* What's the conclusion of this test anyway? */
348 if (unit->nb_tests) {
350 if (unit->test_failed)
351 suite->unit_failed++;
352 } else if (!unit->enabled) {
353 suite->unit_disabled++;
355 suite->unit_ignore++;
359 _xbt_test_nb_units += suite->nb_units;
360 _xbt_test_unit_failed += suite->unit_failed;
361 _xbt_test_unit_ignore += suite->unit_ignore;
362 _xbt_test_unit_disabled += suite->unit_disabled;
364 if (suite->nb_units) {
365 _xbt_test_nb_suites++;
366 if (suite->test_failed)
367 _xbt_test_suite_failed++;
368 } else if (!suite->enabled) {
369 _xbt_test_suite_disabled++;
371 _xbt_test_suite_ignore++;
375 /* print test suite summary */
376 if (suite->enabled) {
379 " =====================================================================%s\n",
380 (suite->nb_units ? (suite->unit_failed ? "== FAILED":"====== OK")
381 : (suite->unit_disabled ? " DISABLED":"==== SKIP")));
382 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
383 suite->nb_units?((1-(double)suite->unit_failed/(double)suite->nb_units)*100.0):100.0,
386 if (suite->nb_units != suite->unit_failed) {
387 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_units - suite->unit_failed);
390 if (suite->unit_failed) {
391 fprintf(stderr, "%s%d failed",(first?"":", "),suite->unit_failed);
394 if (suite->unit_ignore) {
395 fprintf(stderr, "%s%d ignored",(first?"":", "),suite->unit_ignore);
398 if (suite->unit_disabled) {
399 fprintf(stderr, "%s%d disabled",(first?"":", "),suite->unit_disabled);
402 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
403 suite->nb_tests?((1-(double)suite->test_failed/(double)suite->nb_tests)*100.0):100.0,
407 if (suite->nb_tests != suite->test_failed) {
408 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_tests - suite->test_failed);
411 if (suite->test_failed) {
412 fprintf(stderr, "%s%d failed",(first?"":", "),suite->test_failed);
415 if (suite->test_ignore) {
416 fprintf(stderr, "%s%d ignored",(first?"":"; "),suite->test_ignore);
419 if (suite->test_expect) {
420 fprintf(stderr, "%s%d expected to fail",(first?"":"; "),suite->test_expect);
423 fprintf(stderr,")\n");
425 return suite->unit_failed;
428 static void apply_selection(char *selection) {
429 /* for the parsing */
433 char dir[1024]; /* the directive */
435 unsigned int it_suite;
436 xbt_test_suite_t suite;
437 xbt_test_unit_t unit;
438 unsigned int it_unit;
443 if (!selection || selection[0] == '\0')
446 /*printf("Test selection: %s\n", selection);*/
448 /* First apply the selection */
454 strncpy(dir,sel,p-sel);
464 memmove(dir,dir+1,strlen(dir));
468 memmove(dir,dir+1,strlen(dir));
473 strcpy(unitname,p+1);
474 strncpy(suitename,dir,p-dir);
475 suitename[p-dir]='\0';
477 strcpy(suitename,dir);
480 /*fprintf(stderr,"Seen %s (%s; suite=%s; unit=%s)\n",
481 dir,enabling?"enabling":"disabling", suitename, unitname);*/
483 /* Deal with the specific case of 'all' pseudo serie */
484 if (!strcmp("all",suitename)) {
485 if (unitname[0]!='\0') {
486 fprintf(stderr,"The 'all' pseudo-suite does not accept any unit specification\n");
490 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite) {
491 xbt_dynar_foreach(suite->units,it_unit,unit) {
492 unit->enabled = enabling;
494 suite->enabled = enabling;
498 for (it=0; it< xbt_dynar_length(_xbt_test_suites); it++) {
499 xbt_test_suite_t thissuite=xbt_dynar_get_as(_xbt_test_suites,it,xbt_test_suite_t);
500 if (!strcmp(suitename,thissuite->name)) {
501 /* Do not disable the whole suite when we just want to disable a child */
502 if (enabling || (unitname[0]=='\0'))
503 thissuite->enabled = enabling;
505 if (unitname[0]=='\0') {
506 xbt_dynar_foreach(thissuite->units,it_unit,unit){
507 unit->enabled = enabling;
509 } else { /* act on one child only */
510 unsigned int it2_unit;
511 /* search it, first (we won't reuse it for external loop which gets broken) */
512 for (it2_unit=0; it2_unit< xbt_dynar_length(thissuite->units); it2_unit++) {
513 xbt_test_unit_t thisunit=xbt_dynar_get_as(thissuite->units,it2_unit,xbt_test_unit_t);
514 if (!strcmp(thisunit->name,unitname)) {
515 thisunit->enabled = enabling;
518 } /* search relevant unit */
519 if (it2_unit==xbt_dynar_length(thissuite->units)) {
520 fprintf(stderr,"Suite '%s' has no unit of name '%s'. Cannot apply the selection\n",
524 } /* act on childs (either all or one) */
526 break;/* found the relevant serie. We are happy */
528 } /* search relevant series */
529 if (it==xbt_dynar_length(_xbt_test_suites)) {
530 fprintf(stderr,"No suite of name '%s' found. Cannot apply the selection\n",suitename);
538 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) {
553 apply_selection(selection);
555 if (_xbt_test_suites) {
556 unsigned int it_suite;
557 xbt_test_suite_t suite;
560 /* Run all the suites */
561 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite)
562 xbt_test_suite_run(suite);
564 /* Display some more statistics */
565 fprintf(stderr,"\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
567 ? ((1-(double)_xbt_test_suite_failed/(double)_xbt_test_nb_suites)*100.0)
569 _xbt_test_nb_suites);
570 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
571 fprintf(stderr, "%d ok",_xbt_test_nb_suites - _xbt_test_suite_failed);
574 if (_xbt_test_suite_failed) {
575 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_suite_failed);
579 if (_xbt_test_suite_ignore) {
580 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_suite_ignore);
583 fprintf(stderr,")\n Units: %.0f%% ok (%d units: ",
584 _xbt_test_nb_units?((1-(double)_xbt_test_unit_failed/(double)_xbt_test_nb_units)*100.0):100.0,
587 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
588 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_units - _xbt_test_unit_failed);
591 if (_xbt_test_unit_failed) {
592 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_unit_failed);
595 if (_xbt_test_unit_ignore) {
596 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_unit_ignore);
599 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
600 _xbt_test_nb_tests?((1-(double)_xbt_test_test_failed/(double)_xbt_test_nb_tests)*100.0):100.0,
603 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
604 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_tests - _xbt_test_test_failed);
607 if (_xbt_test_test_failed) {
608 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_test_failed);
611 if (_xbt_test_test_ignore) {
612 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_test_ignore);
615 if (_xbt_test_test_expect) {
616 fprintf(stderr, "%s%d expected to fail",(first?"":", "),_xbt_test_test_expect);
619 fprintf(stderr,")\n");
621 fprintf(stderr,"No unit to run!\n");
622 _xbt_test_unit_failed++;
624 return _xbt_test_unit_failed;
628 /* annotate test case with test */
629 void _xbt_test_add(const char*file,int line, const char *fmt, ...) {
630 xbt_test_unit_t unit=_xbt_test_current_unit;
631 xbt_test_test_t test;
637 test = xbt_new(struct s_xbt_test_test,1);
639 vasprintf(&test->title, fmt, ap);
642 test->expected_failure = 0;
646 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t),NULL);
647 xbt_dynar_push(unit->tests,&test);
651 /* annotate test case with log message and failure */
652 void _xbt_test_fail(const char*file,int line,const char *fmt, ...) {
653 xbt_test_unit_t unit = _xbt_test_current_unit;
654 xbt_test_test_t test;
661 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
662 "Test failed even before being declared (broken unit: %s)",
665 log = xbt_new(struct s_xbt_test_log,1);
667 vasprintf(&log->text,fmt, ap);
672 test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
673 xbt_dynar_push(test->logs, &log);
678 void xbt_test_exception(xbt_ex_t e) {
679 _xbt_test_fail(e.file,e.line,"Exception %s raised: %s",xbt_ex_catname(e.category),e.msg);
682 void xbt_test_expect_failure(void) {
683 xbt_test_test_t test;
684 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
685 "Cannot expect the failure of a test before declaring it (broken unit: %s)",
686 _xbt_test_current_unit->title);
687 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,xbt_test_test_t);
688 test->expected_failure = 1;
690 void xbt_test_skip(void) {
691 xbt_test_test_t test;
693 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
694 "Test skiped even before being declared (broken unit: %s)",
695 _xbt_test_current_unit->title);
697 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,
702 /* annotate test case with log message only */
703 void _xbt_test_log(const char*file,int line,const char *fmt, ...) {
704 xbt_test_unit_t unit=_xbt_test_current_unit;
705 xbt_test_test_t test;
712 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
713 "Test logged into even before being declared (broken test unit: %s)",unit->title);
715 log = xbt_new(struct s_xbt_test_log,1);
717 vasprintf(&log->text, fmt, ap);
722 test = xbt_dynar_getlast_as(unit->tests,xbt_test_test_t);
723 xbt_dynar_push(test->logs, &log);
731 XBT_TEST_SUITE("cunit","Testsuite mechanism autotest");
733 XBT_TEST_UNIT("expect",test_expected_failure,"expected failures") {
734 xbt_test_add0("Skipped test");
737 xbt_test_add2("%s %s","EXPECTED","FAILURE");
738 xbt_test_expect_failure();
739 xbt_test_log2("%s %s","Test","log");
740 xbt_test_fail0("EXPECTED FAILURE");
743 #endif /* SIMGRID_TEST */