2 * Copyright © 2008 Chris Wilson
4 * Permission to use, copy, modify, distribute, and sell this software
5 * and its documentation for any purpose is hereby granted without
6 * fee, provided that the above copyright notice appear in all copies
7 * and that both that copyright notice and this permission notice
8 * appear in supporting documentation, and that the name of
9 * Chris Wilson not be used in advertising or publicity pertaining to
10 * distribution of the software without specific, written prior
11 * permission. Chris Wilson makes no representations about the
12 * suitability of this software for any purpose. It is provided "as
13 * is" without express or implied warranty.
15 * CHRIS WILSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
16 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
17 * FITNESS, IN NO EVENT SHALL CHRIS WILSON BE LIABLE FOR ANY SPECIAL,
18 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
19 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
20 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
21 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 * Author: Chris Wilson <chris@chris-wilson.co.uk>
26 #include "cairo-test-private.h"
27 #include "cairo-boilerplate-getopt.h"
29 /* get the "real" version info instead of dummy cairo-version.h */
30 #undef CAIRO_VERSION_H
31 #undef CAIRO_VERSION_MAJOR
32 #undef CAIRO_VERSION_MINOR
33 #undef CAIRO_VERSION_MICRO
34 #include "../cairo-version.h"
36 #include <pixman.h> /* for version information */
38 #define SHOULD_FORK HAVE_FORK && HAVE_WAITPID
46 #include <sys/types.h>
56 #define RUNNING_ON_VALGRIND 0
63 typedef struct _cairo_test_list {
64 const cairo_test_t *test;
65 struct _cairo_test_list *next;
68 typedef struct _cairo_test_runner {
69 cairo_test_context_t base;
71 unsigned int num_device_offsets;
81 cairo_test_list_t *crashes_preamble;
82 cairo_test_list_t *errors_preamble;
83 cairo_test_list_t *fails_preamble;
85 cairo_test_list_t **crashes_per_target;
86 cairo_test_list_t **errors_per_target;
87 cairo_test_list_t **fails_per_target;
89 int *num_failed_per_target;
90 int *num_error_per_target;
91 int *num_crashed_per_target;
93 cairo_bool_t foreground;
94 cairo_bool_t exit_on_failure;
95 cairo_bool_t list_only;
96 cairo_bool_t full_test;
97 cairo_bool_t keyword_match;
99 cairo_bool_t force_pass;
100 } cairo_test_runner_t;
105 } cairo_test_compare_op_t;
107 static cairo_test_list_t *tests;
109 static void CAIRO_BOILERPLATE_PRINTF_FORMAT(2,3)
110 _log (cairo_test_context_t *ctx,
121 cairo_test_logv (ctx, fmt, ap);
125 static cairo_test_list_t *
126 _list_prepend (cairo_test_list_t *head, const cairo_test_t *test)
128 cairo_test_list_t *list;
130 list = xmalloc (sizeof (cairo_test_list_t));
138 static cairo_test_list_t *
139 _list_reverse (cairo_test_list_t *head)
141 cairo_test_list_t *list, *next;
143 for (list = head, head = NULL; list != NULL; list = next) {
153 _list_free (cairo_test_list_t *list)
155 while (list != NULL) {
156 cairo_test_list_t *next = list->next;
163 is_running_under_debugger (void)
165 #if HAVE_UNISTD_H && HAVE_LIBGEN_H && __linux__
168 sprintf (buf, "/proc/%d/exe", getppid ());
169 if (readlink (buf, buf, sizeof (buf)) != -1 &&
170 strncmp (basename (buf), "gdb", 3) == 0)
176 if (RUNNING_ON_VALGRIND)
183 static cairo_test_status_t
184 _cairo_test_wait (pid_t pid)
188 if (waitpid (pid, &exitcode, 0) != pid)
189 return CAIRO_TEST_CRASHED;
191 if (WIFSIGNALED (exitcode)) {
192 switch (WTERMSIG (exitcode)) {
197 return CAIRO_TEST_UNTESTED;
199 return CAIRO_TEST_CRASHED;
203 return WEXITSTATUS (exitcode);
207 static cairo_test_status_t
208 _cairo_test_runner_preamble (cairo_test_runner_t *runner,
209 cairo_test_context_t *ctx)
212 if (! runner->foreground) {
215 switch ((pid = fork ())) {
217 return CAIRO_TEST_UNTESTED;
220 exit (ctx->test->preamble (ctx));
223 return _cairo_test_wait (pid);
227 return ctx->test->preamble (ctx);
230 static cairo_test_status_t
231 _cairo_test_runner_draw (cairo_test_runner_t *runner,
232 cairo_test_context_t *ctx,
233 const cairo_boilerplate_target_t *target,
234 cairo_bool_t similar,
238 if (! runner->foreground) {
241 switch ((pid = fork ())) {
243 return CAIRO_TEST_UNTESTED;
246 exit (_cairo_test_context_run_for_target (ctx, target,
247 similar, device_offset));
250 return _cairo_test_wait (pid);
254 return _cairo_test_context_run_for_target (ctx, target,
255 similar, device_offset);
259 append_argv (int *argc, char ***argv, const char *str)
279 *argv = xmalloc (olen);
281 olen = sizeof (char *) * (args_to_add + *argc);
282 for (i = 0; i < old_argc; i++) {
283 len = strlen (old_argv[i]) + 1;
285 (*argv)[i] = (char *) *argv + olen;
286 memcpy ((*argv)[i], old_argv[i], len);
292 while ((t = strpbrk (s, " \t,:;")) != NULL) {
296 (*argv)[i] = (char *) *argv + olen;
297 memcpy ((*argv)[i], s, len);
298 (*argv)[i][len] = '\0';
300 olen += sizeof (char *);
309 len = strlen (s) + 1;
311 (*argv)[i] = (char *) *argv + olen;
312 memcpy ((*argv)[i], s, len);
314 olen += sizeof (char *);
320 } while (doit++ == FALSE);
325 usage (const char *argv0)
328 "Usage: %s [-afkxsl] [test-names|keywords ...]\n"
330 "Run the cairo conformance test suite over the given tests (all by default)\n"
331 "The command-line arguments are interpreted as follows:\n"
333 " -a all; run the full set of tests. By default the test suite\n"
334 " skips similar surface and device offset testing.\n"
335 " -f foreground; do not fork\n"
336 " -k match tests by keyword\n"
337 " -l list only; just list selected test case names without executing\n"
338 " -s include slow, long running tests\n"
339 " -x exit on first failure\n"
341 "If test names are given they are used as matches either to a specific\n"
342 "test case or to a keyword, so a command such as\n"
343 "\"%s -k text\" can be used to run all text test cases, and\n"
344 "\"%s text-transform\" to run the individual case.\n",
345 argv0, argv0, argv0);
349 _parse_cmdline (cairo_test_runner_t *runner, int *argc, char **argv[])
354 c = _cairo_getopt (*argc, *argv, ":afklsx");
360 runner->full_test = TRUE;
363 runner->foreground = TRUE;
366 runner->keyword_match = TRUE;
369 runner->list_only = TRUE;
375 runner->exit_on_failure = TRUE;
378 fprintf (stderr, "Internal error: unhandled option: %c\n", c);
391 _runner_init (cairo_test_runner_t *runner)
393 cairo_test_init (&runner->base, "cairo-test-suite", ".");
395 runner->passed = TRUE;
397 runner->fails_preamble = NULL;
398 runner->crashes_preamble = NULL;
399 runner->errors_preamble = NULL;
401 runner->fails_per_target = xcalloc (sizeof (cairo_test_list_t *),
402 runner->base.num_targets);
403 runner->crashes_per_target = xcalloc (sizeof (cairo_test_list_t *),
404 runner->base.num_targets);
405 runner->errors_per_target = xcalloc (sizeof (cairo_test_list_t *),
406 runner->base.num_targets);
407 runner->num_failed_per_target = xcalloc (sizeof (int),
408 runner->base.num_targets);
409 runner->num_error_per_target = xcalloc (sizeof (int),
410 runner->base.num_targets);
411 runner->num_crashed_per_target = xcalloc (sizeof (int),
412 runner->base.num_targets);
416 _runner_print_versions (cairo_test_runner_t *runner)
419 "Compiled against cairo %s, running on %s.\n",
420 CAIRO_VERSION_STRING, cairo_version_string ());
422 "Compiled against pixman %s, running on %s.\n",
423 PIXMAN_VERSION_STRING, pixman_version_string ());
425 fflush (runner->base.log_file);
429 _runner_print_summary (cairo_test_runner_t *runner)
432 "%d Passed, %d Failed [%d crashed, %d expected], %d Skipped\n",
435 runner->num_failed + runner->num_crashed + runner->num_xfailed,
439 runner->num_skipped);
443 _runner_print_details (cairo_test_runner_t *runner)
445 cairo_test_list_t *list;
448 if (runner->crashes_preamble) {
451 for (list = runner->crashes_preamble; list != NULL; list = list->next)
454 _log (&runner->base, "Preamble: %d crashed! -", count);
456 for (list = runner->crashes_preamble; list != NULL; list = list->next) {
457 char *name = cairo_test_get_name (list->test);
458 _log (&runner->base, " %s", name);
461 _log (&runner->base, "\n");
463 if (runner->errors_preamble) {
466 for (list = runner->errors_preamble; list != NULL; list = list->next)
469 _log (&runner->base, "Preamble: %d error -", count);
471 for (list = runner->errors_preamble; list != NULL; list = list->next) {
472 char *name = cairo_test_get_name (list->test);
473 _log (&runner->base, " %s", name);
476 _log (&runner->base, "\n");
478 if (runner->fails_preamble) {
481 for (list = runner->fails_preamble; list != NULL; list = list->next)
484 _log (&runner->base, "Preamble: %d failed -", count);
486 for (list = runner->fails_preamble; list != NULL; list = list->next) {
487 char *name = cairo_test_get_name (list->test);
488 _log (&runner->base, " %s", name);
491 _log (&runner->base, "\n");
494 for (n = 0; n < runner->base.num_targets; n++) {
495 const cairo_boilerplate_target_t *target;
497 target = runner->base.targets_to_test[n];
498 if (runner->num_crashed_per_target[n]) {
499 _log (&runner->base, "%s (%s): %d crashed! -",
501 cairo_boilerplate_content_name (target->content),
502 runner->num_crashed_per_target[n]);
504 for (list = runner->crashes_per_target[n];
508 char *name = cairo_test_get_name (list->test);
509 _log (&runner->base, " %s", name);
512 _log (&runner->base, "\n");
514 if (runner->num_error_per_target[n]) {
515 _log (&runner->base, "%s (%s): %d error -",
517 cairo_boilerplate_content_name (target->content),
518 runner->num_error_per_target[n]);
520 for (list = runner->errors_per_target[n];
524 char *name = cairo_test_get_name (list->test);
525 _log (&runner->base, " %s", name);
528 _log (&runner->base, "\n");
531 if (runner->num_failed_per_target[n]) {
532 _log (&runner->base, "%s (%s): %d failed -",
534 cairo_boilerplate_content_name (target->content),
535 runner->num_failed_per_target[n]);
537 for (list = runner->fails_per_target[n];
541 char *name = cairo_test_get_name (list->test);
542 _log (&runner->base, " %s", name);
545 _log (&runner->base, "\n");
551 _runner_print_results (cairo_test_runner_t *runner)
553 _runner_print_summary (runner);
554 _runner_print_details (runner);
556 if (! runner->passed && ! runner->num_crashed) {
559 "Note: These failures may be due to external factors.\n"
560 "Please read test/README -- \"Getting the elusive zero failures\".\n");
564 static cairo_test_status_t
565 _runner_fini (cairo_test_runner_t *runner)
569 _list_free (runner->crashes_preamble);
570 _list_free (runner->errors_preamble);
571 _list_free (runner->fails_preamble);
573 for (n = 0; n < runner->base.num_targets; n++) {
574 _list_free (runner->crashes_per_target[n]);
575 _list_free (runner->errors_per_target[n]);
576 _list_free (runner->fails_per_target[n]);
578 free (runner->crashes_per_target);
579 free (runner->errors_per_target);
580 free (runner->fails_per_target);
582 free (runner->num_crashed_per_target);
583 free (runner->num_error_per_target);
584 free (runner->num_failed_per_target);
586 cairo_test_fini (&runner->base);
588 if (runner->force_pass)
589 return CAIRO_TEST_SUCCESS;
591 return runner->num_failed + runner->num_crashed ?
593 runner->num_passed + runner->num_xfailed ?
594 CAIRO_TEST_SUCCESS : CAIRO_TEST_UNTESTED;
598 _version_compare (int a, cairo_test_compare_op_t op, int b)
601 case GT: return a > b;
602 case GE: return a >= b;
603 default: return FALSE;
609 _get_required_version (const char *str,
610 cairo_test_compare_op_t *op,
618 if (strncmp (str, ">=", 2) == 0) {
621 } else if (strncmp (str, ">", 1) == 0) {
630 if (sscanf (str, "%d.%d.%d", major, minor, micro) != 3) {
632 if (sscanf (str, "%d.%d", major, minor) != 2)
640 _has_required_cairo_version (const char *str)
642 cairo_test_compare_op_t op;
643 int major, minor, micro;
645 if (! _get_required_version (str + 5 /* advance over "cairo" */,
646 &op, &major, &minor, µ))
648 fprintf (stderr, "unrecognised cairo version requirement '%s'\n", str);
652 return _version_compare (cairo_version (),
654 CAIRO_VERSION_ENCODE (major, minor, micro));
658 _has_required_ghostscript_version (const char *str)
660 #if ! CAIRO_CAN_TEST_PS_SURFACE
664 str += 2; /* advance over "gs" */
670 _has_required_poppler_version (const char *str)
672 #if ! CAIRO_CAN_TEST_PDF_SURFACE
676 str += 7; /* advance over "poppler" */
682 _has_required_rsvg_version (const char *str)
684 #if ! CAIRO_CAN_TEST_SVG_SURFACE
688 str += 4; /* advance over "rsvg" */
694 main (int argc, char **argv)
696 cairo_test_runner_t runner;
697 cairo_test_list_t *test_list;
698 cairo_test_status_t *target_status;
702 char *cairo_tests_env;
705 /* We don't want an assert dialog, we want stderr */
706 _CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE);
707 _CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
710 _cairo_test_runner_register_tests ();
711 tests = _list_reverse (tests);
713 memset (&runner, 0, sizeof (runner));
714 runner.num_device_offsets = 1;
716 if (is_running_under_debugger ())
717 runner.foreground = TRUE;
719 if (getenv ("CAIRO_TEST_MODE")) {
720 const char *env = getenv ("CAIRO_TEST_MODE");
722 if (strstr (env, "full")) {
723 runner.full_test = TRUE;
725 if (strstr (env, "foreground")) {
726 runner.foreground = TRUE;
728 if (strstr (env, "exit-on-failure")) {
729 runner.exit_on_failure = TRUE;
733 if (getenv ("CAIRO_TEST_FORCE_PASS")) {
734 const char *env = getenv ("CAIRO_TEST_FORCE_PASS");
736 runner.force_pass = atoi (env);
739 _parse_cmdline (&runner, &argc, &argv);
741 cairo_tests_env = getenv("CAIRO_TESTS");
742 append_argv (&argc, &argv, cairo_tests_env);
744 if (runner.full_test) {
745 runner.num_device_offsets = 2;
748 target_status = NULL; /* silence the compiler */
749 if (! runner.list_only) {
750 _runner_init (&runner);
751 _runner_print_versions (&runner);
752 target_status = xmalloc (sizeof (cairo_test_status_t) *
753 runner.base.num_targets);
756 for (test_list = tests; test_list != NULL; test_list = test_list->next) {
757 const cairo_test_t *test = test_list->test;
758 cairo_test_context_t ctx;
759 cairo_test_status_t status;
760 cairo_bool_t failed = FALSE, xfailed = FALSE, error = FALSE, crashed = FALSE, skipped = TRUE;
761 cairo_bool_t in_preamble = FALSE;
762 char *name = cairo_test_get_name (test);
765 /* check for restricted runs */
767 cairo_bool_t found = FALSE;
768 const char *keywords = test->keywords;
770 for (i = 0; i < argc; i++) {
771 const char *match = argv[i];
772 cairo_bool_t invert = match[0] == '!';
776 if (runner.keyword_match) {
777 if (keywords != NULL && strstr (keywords, match) != NULL) {
784 /* exact match on test name */
785 if (strcmp (name, match) == 0) {
800 /* check to see if external requirements match */
801 if (test->requirements != NULL) {
802 const char *requirements = test->requirements;
805 str = strstr (requirements, "slow");
806 if (str != NULL && ! runner.slow) {
807 if (runner.list_only)
813 str = strstr (requirements, "cairo");
814 if (str != NULL && ! _has_required_cairo_version (str)) {
815 if (runner.list_only)
821 str = strstr (requirements, "gs");
822 if (str != NULL && ! _has_required_ghostscript_version (str)) {
823 if (runner.list_only)
829 str = strstr (requirements, "poppler");
830 if (str != NULL && ! _has_required_poppler_version (str)) {
831 if (runner.list_only)
837 str = strstr (requirements, "rsvg");
838 if (str != NULL && ! _has_required_rsvg_version (str)) {
839 if (runner.list_only)
846 if (runner.list_only) {
847 printf ("%s ", name);
851 _cairo_test_context_init_for_test (&ctx, &runner.base, test);
852 memset (target_status, 0,
853 sizeof (cairo_test_status_t) * ctx.num_targets);
855 if (ctx.test->preamble != NULL) {
856 status = _cairo_test_runner_preamble (&runner, &ctx);
858 case CAIRO_TEST_SUCCESS:
863 case CAIRO_TEST_XFAILURE:
869 case CAIRO_TEST_FAILURE:
870 runner.fails_preamble = _list_prepend (runner.fails_preamble,
876 case CAIRO_TEST_ERROR:
877 runner.errors_preamble = _list_prepend (runner.errors_preamble,
883 case CAIRO_TEST_NO_MEMORY:
884 case CAIRO_TEST_CRASHED:
885 runner.crashes_preamble = _list_prepend (runner.crashes_preamble,
891 case CAIRO_TEST_UNTESTED:
896 if (ctx.test->draw == NULL)
899 for (n = 0; n < ctx.num_targets; n++) {
900 const cairo_boilerplate_target_t *target;
901 cairo_bool_t target_failed = FALSE,
902 target_xfailed = FALSE,
903 target_error = FALSE,
904 target_crashed = FALSE,
905 target_skipped = TRUE;
906 cairo_test_similar_t has_similar;
908 target = ctx.targets_to_test[n];
910 has_similar = runner.full_test ?
911 cairo_test_target_has_similar (&ctx, target) :
913 for (m = 0; m < runner.num_device_offsets; m++) {
914 int dev_offset = m * 25;
915 cairo_test_similar_t similar;
917 for (similar = DIRECT; similar <= has_similar; similar++) {
918 status = _cairo_test_runner_draw (&runner, &ctx, target,
919 similar, dev_offset);
921 case CAIRO_TEST_SUCCESS:
922 target_skipped = FALSE;
924 case CAIRO_TEST_XFAILURE:
925 target_xfailed = TRUE;
928 case CAIRO_TEST_FAILURE:
929 target_failed = TRUE;
931 case CAIRO_TEST_ERROR:
934 case CAIRO_TEST_NO_MEMORY:
935 case CAIRO_TEST_CRASHED:
936 target_crashed = TRUE;
938 case CAIRO_TEST_UNTESTED:
944 if (target_crashed) {
945 target_status[n] = CAIRO_TEST_CRASHED;
946 runner.num_crashed_per_target[n]++;
947 runner.crashes_per_target[n] = _list_prepend (runner.crashes_per_target[n],
950 } else if (target_error) {
951 target_status[n] = CAIRO_TEST_ERROR;
952 runner.num_error_per_target[n]++;
953 runner.errors_per_target[n] = _list_prepend (runner.errors_per_target[n],
957 } else if (target_failed) {
958 target_status[n] = CAIRO_TEST_FAILURE;
959 runner.num_failed_per_target[n]++;
960 runner.fails_per_target[n] = _list_prepend (runner.fails_per_target[n],
964 } else if (target_xfailed) {
965 target_status[n] = CAIRO_TEST_XFAILURE;
967 } else if (target_skipped) {
968 target_status[n] = CAIRO_TEST_UNTESTED;
970 target_status[n] = CAIRO_TEST_SUCCESS;
976 cairo_test_fini (&ctx);
982 for (n = 0 ; n < runner.base.num_targets; n++) {
983 if (target_status[n] == CAIRO_TEST_CRASHED) {
985 runner.base.targets_to_test[n]->name) == NULL)
987 len += snprintf (targets + len, sizeof (targets) - len,
989 runner.base.targets_to_test[n]->name);
993 targets[len-2] = '\0';
994 _log (&runner.base, "\n%s: CRASH! (%s)\n", name, targets);
996 _log (&runner.base, "\n%s: CRASH!\n", name);
998 runner.num_crashed++;
999 runner.passed = FALSE;
1001 if (! in_preamble) {
1003 for (n = 0 ; n < runner.base.num_targets; n++) {
1004 if (target_status[n] == CAIRO_TEST_ERROR) {
1005 if (strstr (targets,
1006 runner.base.targets_to_test[n]->name) == NULL)
1008 len += snprintf (targets + len,
1009 sizeof (targets) - len,
1011 runner.base.targets_to_test[n]->name);
1015 targets[len-2] = '\0';
1016 _log (&runner.base, "%s: ERROR (%s)\n", name, targets);
1018 _log (&runner.base, "%s: ERROR\n", name);
1021 runner.passed = FALSE;
1022 } else if (failed) {
1023 if (! in_preamble) {
1025 for (n = 0 ; n < runner.base.num_targets; n++) {
1026 if (target_status[n] == CAIRO_TEST_FAILURE) {
1027 if (strstr (targets,
1028 runner.base.targets_to_test[n]->name) == NULL)
1030 len += snprintf (targets + len,
1031 sizeof (targets) - len,
1033 runner.base.targets_to_test[n]->name);
1037 targets[len-2] = '\0';
1038 _log (&runner.base, "%s: FAIL (%s)\n", name, targets);
1040 _log (&runner.base, "%s: FAIL\n", name);
1042 runner.num_failed++;
1043 runner.passed = FALSE;
1044 } else if (xfailed) {
1045 _log (&runner.base, "%s: XFAIL\n", name);
1046 runner.num_xfailed++;
1047 } else if (skipped) {
1048 _log (&runner.base, "%s: UNTESTED\n", name);
1049 runner.num_skipped++;
1051 _log (&runner.base, "%s: PASS\n", name);
1052 runner.num_passed++;
1054 fflush (runner.base.log_file);
1058 if (runner.exit_on_failure && ! runner.passed)
1063 if (cairo_tests_env)
1066 if (runner.list_only) {
1068 return CAIRO_TEST_SUCCESS;
1071 for (n = 0 ; n < runner.base.num_targets; n++) {
1072 runner.crashes_per_target[n] = _list_reverse (runner.crashes_per_target[n]);
1073 runner.errors_per_target[n] = _list_reverse (runner.errors_per_target[n]);
1074 runner.fails_per_target[n] = _list_reverse (runner.fails_per_target[n]);
1077 _runner_print_results (&runner);
1079 free (target_status);
1080 return _runner_fini (&runner);
1084 cairo_test_register (cairo_test_t *test)
1086 tests = _list_prepend (tests, test);