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) */
12 #include "gras_config.h"
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;
30 static int _xbt_test_nb_suites = 0;
31 static int _xbt_test_suite_failed = 0;
32 static int _xbt_test_suite_ignore = 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) {
48 fprintf(stderr," log %p(%s:%d)=%s\n",log,log->file,log->line,log->text);
50 fprintf(stderr," log=NULL\n");
52 static void xbt_test_log_free(xbt_test_log_t log) {
60 /* test suite test check */
61 typedef struct s_xbt_test_test {
71 static void xbt_test_test_dump(xbt_test_test_t test){
75 fprintf(stderr," test %p(%s:%d)=%s (%s)\n",
76 test,test->file,test->line,test->title,
77 test->failed?"failed":"not failed");
78 xbt_dynar_foreach(test->logs,it_log,log)
79 xbt_test_log_dump(log);
82 fprintf(stderr," test=NULL\n");
85 /* test suite test unit */
86 struct s_xbt_test_unit {
91 xbt_dynar_t tests; /* of xbt_test_test_t*/
94 int test_failed,test_ignore,test_expect;
97 static void xbt_test_unit_dump(xbt_test_unit_t unit) {
101 fprintf(stderr," unit %p(%s:%d)=%s (func=%p)\n",
102 unit,unit->file,unit->line,unit->title,unit->file);
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 {
114 xbt_dynar_t units; /* of xbt_test_unit_t */
116 int nb_tests,nb_units;
117 int test_failed,test_ignore,test_expect;
118 int unit_failed,unit_ignore;
121 /* destroy test suite */
122 static void xbt_test_suite_free(void *s) {
123 xbt_test_suite_t suite = *(xbt_test_suite_t*) s;
127 xbt_dynar_free(&suite->units);
132 /** @brief create test suite */
133 xbt_test_suite_t xbt_test_suite_new(const char *name, const char *fmt, ...) {
134 xbt_test_suite_t suite = xbt_new0(struct s_xbt_test_suite,1);
137 if (!_xbt_test_suites)
138 _xbt_test_suites = xbt_dynar_new(sizeof(xbt_test_suite_t),&xbt_test_suite_free);
141 vasprintf(&suite->title,fmt, ap);
142 suite->units = xbt_dynar_new(sizeof(xbt_test_unit_t), NULL);
146 xbt_dynar_push(_xbt_test_suites,&suite);
151 /** @brief retrive a testsuite from name, or create a new one */
152 xbt_test_suite_t xbt_test_suite_by_name(const char *name,const char *fmt, ...) {
153 xbt_test_suite_t suite;
159 if (_xbt_test_suites)
160 xbt_dynar_foreach(_xbt_test_suites, it_suite, suite)
161 if (!strcmp(suite->name,name))
165 vasprintf(&bufname,fmt, ap);
167 suite = xbt_test_suite_new(name,bufname,NULL);
173 void xbt_test_suite_dump(xbt_test_suite_t suite) {
175 xbt_test_unit_t unit;
177 fprintf(stderr,"DUMP suite %s\n",suite->title);
178 xbt_dynar_foreach(suite->units,it_unit,unit)
179 xbt_test_unit_dump(unit);
181 fprintf(stderr,"suite=NULL\n");
185 /* add test case to test suite */
186 void xbt_test_suite_push(xbt_test_suite_t suite, ts_test_cb_t func, const char *fmt, ...) {
187 xbt_test_unit_t unit;
194 unit = xbt_new(struct s_xbt_test_unit,1);
196 vasprintf(&unit->title, fmt, ap);
201 unit->tests = xbt_dynar_new(sizeof(xbt_test_test_t), NULL);
203 xbt_dynar_push(suite->units, &unit);
207 /* run test one suite */
208 static int xbt_test_suite_run(xbt_test_suite_t suite) {
209 xbt_test_unit_t unit;
210 xbt_test_test_t test;
216 int it_unit,it_test,it_log;
218 int first=1; /* for result pretty printing */
223 /* suite title pretty-printing */
225 char suite_title[80];
226 int suite_len=strlen(suite->title);
229 xbt_assert2(suite_len<70,"suite title \"%s\" too long (%d should be less than 70",
230 suite->title,suite_len);
237 sprintf(suite_title + 40 - (suite_len+4)/2, "[ %s ]", suite->title);
238 suite_title[40 + (suite_len+5)/2] = '=';
239 fprintf(stderr, "\n%s\n",suite_title);
242 /* iterate through all tests */
243 xbt_dynar_foreach(suite->units, it_unit, unit) {
244 /* init unit case counters */
246 unit->test_ignore = 0;
247 unit->test_failed = 0;
248 unit->test_expect = 0;
250 /* display unit title */
251 asprintf(&cp," Unit: %s ........................................"
252 "........................................", unit->title);
254 fprintf(stderr, "%s", cp);
257 /* run the test case function */
258 _xbt_test_current_unit = unit;
261 /* iterate through all performed tests to determine status */
262 xbt_dynar_foreach(unit->tests,it_test, test) {
268 if ( test->failed && !test->expected_failure) unit->test_failed++;
269 if (!test->failed && test->expected_failure) unit->test_failed++;
270 if (test->expected_failure)
275 /* Display whether this unit went well */
276 if (unit->test_failed > 0 || unit->test_expect) {
277 /* some tests failed (or were supposed to), so do detailed reporting of test case */
278 if (unit->test_failed > 0) {
279 fprintf(stderr, " failed\n");
280 } else if (unit->nb_tests) {
281 fprintf(stderr, ".... ok\n"); /* successful, but show about expected */
283 fprintf(stderr, ".. skip\n"); /* shouldn't happen, but I'm a bit lost with this logic */
285 xbt_dynar_foreach(unit->tests,it_test, test) {
286 file = (test->file != NULL ? test->file : unit->file);
287 line = (test->line != 0 ? test->line : unit->line);
288 fprintf(stderr, " %s: %s [%s:%d]\n",
289 (test->ignored?" SKIP":(test->expected_failure?(test->failed?"EFAIL":"EPASS"):
290 (test->failed?" FAIL":" PASS"))),
291 test->title, file, line);
293 xbt_dynar_foreach(test->logs,it_log,log) {
294 file = (log->file != NULL ? log->file : file);
295 line = (log->line != 0 ? log->line : line);
296 fprintf(stderr, " %s:%d: %s\n",
297 file, line,log->text);
301 fprintf(stderr, " Summary: %d of %d tests failed",unit->test_failed, unit->nb_tests);
302 if (unit->test_ignore) {
303 fprintf(stderr," (%d tests ignored)\n",unit->test_ignore);
305 fprintf(stderr,"\n");
307 } else if (unit->nb_tests) {
308 fprintf(stderr, ".... ok\n"); /* successful */
310 fprintf(stderr, ".. skip\n"); /* no test were run */
316 /* Accumulate test counts into the suite */
317 suite->nb_tests += unit->nb_tests;
318 suite->test_failed += unit->test_failed;
319 suite->test_ignore += unit->test_ignore;
320 suite->test_expect += unit->test_expect;
322 _xbt_test_nb_tests += unit->nb_tests;
323 _xbt_test_test_failed += unit->test_failed;
324 _xbt_test_test_ignore += unit->test_ignore;
325 _xbt_test_test_expect += unit->test_expect;
327 /* What's the conclusion of this test anyway? */
328 if (unit->nb_tests) {
330 if (unit->test_failed)
331 suite->unit_failed++;
333 suite->unit_ignore++;
336 _xbt_test_nb_units += suite->nb_units;
337 _xbt_test_unit_failed += suite->unit_failed;
338 _xbt_test_unit_ignore += suite->unit_ignore;
340 if (suite->nb_units) {
341 _xbt_test_nb_suites++;
342 if (suite->test_failed)
343 _xbt_test_suite_failed++;
345 _xbt_test_suite_ignore++;
349 /* print test suite summary */
351 " =======================================================================%s\n",
352 (suite->nb_units?(suite->unit_failed?" FAILED":"==== OK"):"== SKIP"));
353 fprintf(stderr, " Summary: Units: %.0f%% ok (%d units: ",
354 suite->nb_units?((1-(double)suite->unit_failed/(double)suite->nb_units)*100.0):100.0,
357 if (suite->nb_units != suite->unit_failed) {
358 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_units - suite->unit_failed);
361 if (suite->unit_failed) {
362 fprintf(stderr, "%s%d failed",(first?"":", "),suite->unit_failed);
365 if (suite->unit_ignore) {
366 fprintf(stderr, "%s%d ignored",(first?"":", "),suite->unit_ignore);
369 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
370 suite->nb_tests?((1-(double)suite->test_failed/(double)suite->nb_tests)*100.0):100.0,
374 if (suite->nb_tests != suite->test_failed) {
375 fprintf(stderr, "%s%d ok",(first?"":", "),suite->nb_tests - suite->test_failed);
378 if (suite->test_failed) {
379 fprintf(stderr, "%s%d failed",(first?"":", "),suite->test_failed);
382 if (suite->test_ignore) {
383 fprintf(stderr, "%s%d ignored",(first?"":"; "),suite->test_ignore);
386 if (suite->test_expect) {
387 fprintf(stderr, "%s%d expected to fail",(first?"":"; "),suite->test_expect);
390 fprintf(stderr,")\n");
392 return suite->unit_failed;
395 int xbt_test_run(void) {
397 if (_xbt_test_suites) {
399 xbt_test_suite_t suite;
402 /* Run all the suites */
403 xbt_dynar_foreach(_xbt_test_suites,it_suite,suite)
404 xbt_test_suite_run(suite);
406 /* Display some more statistics */
407 fprintf(stderr,"\n\n TOTAL: Suites: %.0f%% ok (%d suites: ",
409 ? ((1-(double)_xbt_test_suite_failed/(double)_xbt_test_nb_suites)*100.0)
411 _xbt_test_nb_suites);
412 if (_xbt_test_nb_suites != _xbt_test_suite_failed) {
413 fprintf(stderr, "%d ok",_xbt_test_nb_suites - _xbt_test_suite_failed);
416 if (_xbt_test_suite_failed) {
417 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_suite_failed);
421 if (_xbt_test_suite_ignore) {
422 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_suite_ignore);
425 fprintf(stderr,")\n Units: %.0f%% ok (%d units: ",
426 _xbt_test_nb_units?((1-(double)_xbt_test_unit_failed/(double)_xbt_test_nb_units)*100.0):100.0,
429 if (_xbt_test_nb_units != _xbt_test_unit_failed) {
430 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_units - _xbt_test_unit_failed);
433 if (_xbt_test_unit_failed) {
434 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_unit_failed);
437 if (_xbt_test_unit_ignore) {
438 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_unit_ignore);
441 fprintf(stderr,")\n Tests: %.0f%% ok (%d tests: ",
442 _xbt_test_nb_tests?((1-(double)_xbt_test_test_failed/(double)_xbt_test_nb_tests)*100.0):100.0,
445 if (_xbt_test_nb_tests != _xbt_test_test_failed) {
446 fprintf(stderr, "%s%d ok",(first?"":", "),_xbt_test_nb_tests - _xbt_test_test_failed);
449 if (_xbt_test_test_failed) {
450 fprintf(stderr, "%s%d failed",(first?"":", "),_xbt_test_test_failed);
453 if (_xbt_test_test_ignore) {
454 fprintf(stderr, "%s%d ignored",(first?"":", "),_xbt_test_test_ignore);
457 if (_xbt_test_test_expect) {
458 fprintf(stderr, "%s%d expected to fail",(first?"":", "),_xbt_test_test_expect);
461 fprintf(stderr,")\n");
463 fprintf(stderr,"No unit to run!\n");
464 _xbt_test_unit_failed++;
466 return _xbt_test_unit_failed;
470 /* annotate test case with test */
471 void _xbt_test_add(const char*file,int line, const char *fmt, ...) {
472 xbt_test_unit_t unit=_xbt_test_current_unit;
473 xbt_test_test_t test;
479 test = xbt_new(struct s_xbt_test_test,1);
481 vasprintf(&test->title, fmt, ap);
484 test->expected_failure = 0;
488 test->logs = xbt_dynar_new(sizeof(xbt_test_log_t),NULL);
489 xbt_dynar_push(unit->tests,&test);
493 /* annotate test case with log message and failure */
494 void _xbt_test_fail(const char*file,int line,const char *fmt, ...) {
495 xbt_test_unit_t unit = _xbt_test_current_unit;
496 xbt_test_test_t test;
503 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
504 "Test failed even before being declared (broken unit: %s)",
507 log = xbt_new(struct s_xbt_test_log,1);
509 vasprintf(&log->text,fmt, ap);
514 test = xbt_dynar_getlast_as(unit->tests, xbt_test_test_t);
515 xbt_dynar_push(test->logs, &log);
520 void xbt_test_exception(xbt_ex_t e) {
521 _xbt_test_fail(e.file,e.line,"Exception %s raised: %s",xbt_ex_catname(e.category),e.msg);
524 void xbt_test_expect_failure(void) {
525 xbt_test_test_t test;
526 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
527 "Cannot expect the failure of a test before declaring it (broken unit: %s)",
528 _xbt_test_current_unit->title);
529 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,xbt_test_test_t);
530 test->expected_failure = 1;
532 void xbt_test_skip(void) {
533 xbt_test_test_t test;
535 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
536 "Test skiped even before being declared (broken unit: %s)",
537 _xbt_test_current_unit->title);
539 test = xbt_dynar_getlast_as(_xbt_test_current_unit->tests,
544 /* annotate test case with log message only */
545 void _xbt_test_log(const char*file,int line,const char *fmt, ...) {
546 xbt_test_unit_t unit=_xbt_test_current_unit;
547 xbt_test_test_t test;
554 xbt_assert1(xbt_dynar_length(_xbt_test_current_unit->tests),
555 "Test logged into even before being declared (broken test unit: %s)",unit->title);
557 log = xbt_new(struct s_xbt_test_log,1);
559 vasprintf(&log->text, fmt, ap);
564 test = xbt_dynar_getlast_as(unit->tests,xbt_test_test_t);
565 xbt_dynar_push(test->logs, &log);
573 XBT_TEST_SUITE("cuint","Testsuite Autotest %d",0);
575 XBT_TEST_UNIT("expect",test_expected_failure,"expected failures") {
576 xbt_test_add0("Skipped test");
579 xbt_test_add2("%s %s","EXPECTED","FAILURE");
580 xbt_test_expect_failure();
581 xbt_test_log2("%s %s","Test","log");
582 xbt_test_fail0("EXPECTED FAILURE");
585 #endif /* SIMGRID_TEST */