1 /* GLib testing framework runner
2 * Copyright (C) 2007 Sven Herzberg
3 * Copyright (C) 2007 Tim Janik
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
23 #include <glib-unix.h>
33 /* the read buffer size in bytes */
34 #define READ_BUFFER_SIZE 4096
36 /* --- prototypes --- */
37 static int main_selftest (int argc,
39 static void parse_args (gint *argc_p,
42 /* --- variables --- */
43 static GIOChannel *ioc_report = NULL;
44 static gboolean gtester_quiet = FALSE;
45 static gboolean gtester_verbose = FALSE;
46 static gboolean gtester_list_tests = FALSE;
47 static gboolean gtester_selftest = FALSE;
48 static gboolean subtest_running = FALSE;
49 static gint subtest_exitstatus = 0;
50 static gboolean subtest_io_pending = FALSE;
51 static gboolean subtest_quiet = TRUE;
52 static gboolean subtest_verbose = FALSE;
53 static gboolean subtest_mode_fatal = TRUE;
54 static gboolean subtest_mode_perf = FALSE;
55 static gboolean subtest_mode_quick = TRUE;
56 static gboolean subtest_mode_undefined = TRUE;
57 static const gchar *subtest_seedstr = NULL;
58 static gchar *subtest_last_seed = NULL;
59 static GSList *subtest_paths = NULL;
60 static GSList *skipped_paths = NULL;
61 static GSList *subtest_args = NULL;
62 static gboolean testcase_open = FALSE;
63 static guint testcase_count = 0;
64 static guint testcase_fail_count = 0;
65 static const gchar *output_filename = NULL;
66 static guint log_indent = 0;
67 static gint log_fd = -1;
69 /* --- functions --- */
73 static const char spaces[] = " ";
74 int l = sizeof (spaces) - 1;
76 return spaces + l - n;
79 static void G_GNUC_PRINTF (1, 2)
80 test_log_printfe (const char *format,
86 va_start (args, format);
87 result = g_markup_vprintf_escaped (format, args);
90 r = write (log_fd, result, strlen (result));
91 while (r < 0 && errno == EINTR);
98 kill (getpid(), SIGTERM);
103 testcase_close (long double duration,
107 g_return_if_fail (testcase_open > 0);
108 test_log_printfe ("%s<duration>%.6Lf</duration>\n", sindent (log_indent), duration);
109 test_log_printfe ("%s<status exit-status=\"%d\" n-forks=\"%d\" result=\"%s\"/>\n",
110 sindent (log_indent), exit_status, n_forks,
111 exit_status ? "failed" : "success");
113 test_log_printfe ("%s</testcase>\n", sindent (log_indent));
116 g_print ("%s\n", exit_status ? "FAIL" : "OK");
117 if (exit_status && subtest_last_seed)
118 g_print ("GTester: last random seed: %s\n", subtest_last_seed);
120 testcase_fail_count += 1;
121 if (subtest_mode_fatal && exit_status)
126 test_log_msg (GTestLogMsg *msg)
128 switch (msg->log_type)
132 case G_TEST_LOG_NONE:
133 case G_TEST_LOG_START_SUITE:
134 case G_TEST_LOG_STOP_SUITE:
136 case G_TEST_LOG_ERROR:
137 strv = g_strsplit (msg->strings[0], "\n", -1);
138 for (i = 0; strv[i]; i++)
139 test_log_printfe ("%s<error>%s</error>\n", sindent (log_indent), strv[i]);
142 case G_TEST_LOG_START_BINARY:
143 test_log_printfe ("%s<binary file=\"%s\"/>\n", sindent (log_indent), msg->strings[0]);
144 subtest_last_seed = g_strdup (msg->strings[1]);
145 test_log_printfe ("%s<random-seed>%s</random-seed>\n", sindent (log_indent), subtest_last_seed);
147 case G_TEST_LOG_LIST_CASE:
148 g_print ("%s\n", msg->strings[0]);
150 case G_TEST_LOG_START_CASE:
154 gchar *sc = g_strconcat (msg->strings[0], ":", NULL);
155 gchar *sleft = g_strdup_printf ("%-68s", sc);
157 g_print ("%70s ", sleft);
160 g_return_if_fail (testcase_open == 0);
162 test_log_printfe ("%s<testcase path=\"%s\">\n", sindent (log_indent), msg->strings[0]);
165 case G_TEST_LOG_SKIP_CASE:
166 if (FALSE && gtester_verbose) /* enable to debug test case skipping logic */
168 gchar *sc = g_strconcat (msg->strings[0], ":", NULL);
169 gchar *sleft = g_strdup_printf ("%-68s", sc);
171 g_print ("%70s SKIPPED\n", sleft);
174 test_log_printfe ("%s<testcase path=\"%s\" skipped=\"1\"/>\n", sindent (log_indent), msg->strings[0]);
176 case G_TEST_LOG_STOP_CASE:
177 testcase_close (msg->nums[2], (int) msg->nums[0], (int) msg->nums[1]);
179 case G_TEST_LOG_MIN_RESULT:
180 case G_TEST_LOG_MAX_RESULT:
181 test_log_printfe ("%s<performance minimize=\"%d\" maximize=\"%d\" value=\"%.16Lg\">\n",
182 sindent (log_indent), msg->log_type == G_TEST_LOG_MIN_RESULT, msg->log_type == G_TEST_LOG_MAX_RESULT, msg->nums[0]);
183 test_log_printfe ("%s%s\n", sindent (log_indent + 2), msg->strings[0]);
184 test_log_printfe ("%s</performance>\n", sindent (log_indent));
186 case G_TEST_LOG_MESSAGE:
187 test_log_printfe ("%s<message>\n%s\n%s</message>\n", sindent (log_indent), msg->strings[0], sindent (log_indent));
193 child_report_cb (GIOChannel *source,
194 GIOCondition condition,
197 GTestLogBuffer *tlb = data;
198 GIOStatus status = G_IO_STATUS_NORMAL;
199 gboolean first_read_eof = FALSE, first_read = TRUE;
203 guint8 buffer[READ_BUFFER_SIZE];
204 GError *error = NULL;
205 status = g_io_channel_read_chars (source, (gchar*) buffer, sizeof (buffer), &length, &error);
206 if (first_read && (condition & G_IO_IN))
208 /* on some unixes (MacOS) we need to detect non-blocking fd EOF
209 * by an IO_IN select/poll followed by read()==0.
211 first_read_eof = length == 0;
217 g_test_log_buffer_push (tlb, length, buffer);
220 msg = g_test_log_buffer_pop (tlb);
224 g_test_log_msg_free (msg);
229 g_clear_error (&error);
230 /* ignore the io channel status, which will report intermediate EOFs for non blocking fds */
234 /* g_print ("LASTIOSTATE: first_read_eof=%d condition=%d\n", first_read_eof, condition); */
235 if (first_read_eof || (condition & (G_IO_ERR | G_IO_HUP)))
237 /* if there's no data to read and select() reports an error or hangup,
238 * the fd must have been closed remotely
240 subtest_io_pending = FALSE;
243 return TRUE; /* keep polling */
247 child_watch_cb (GPid pid,
251 g_spawn_close_pid (pid);
252 if (WIFEXITED (status)) /* normal exit */
253 subtest_exitstatus = WEXITSTATUS (status);
254 else /* signal or core dump, etc */
255 subtest_exitstatus = 0xffffffff;
256 subtest_running = FALSE;
260 queue_gfree (GSList **slistp,
263 *slistp = g_slist_prepend (*slistp, string);
268 unset_cloexec_fdp (gpointer fdp_data)
270 int r, *fdp = fdp_data;
272 r = fcntl (*fdp, F_SETFD, 0 /* FD_CLOEXEC */);
273 while (r < 0 && errno == EINTR);
277 launch_test_binary (const char *binary,
281 GSList *slist, *free_list = NULL;
282 GError *error = NULL;
286 gint report_pipe[2] = { -1, -1 };
287 guint child_report_cb_id = 0;
288 gboolean loop_pending;
291 if (!g_unix_open_pipe (report_pipe, FD_CLOEXEC, &error))
293 if (subtest_mode_fatal)
294 g_error ("Failed to open pipe for test binary: %s: %s", binary, error->message);
296 g_warning ("Failed to open pipe for test binary: %s: %s", binary, error->message);
297 g_clear_error (&error);
302 for (slist = subtest_args; slist; slist = slist->next)
309 if (!subtest_mode_fatal)
311 if (subtest_mode_quick)
315 if (subtest_mode_perf)
317 if (!subtest_mode_undefined)
319 if (gtester_list_tests)
326 for (slist = subtest_paths; slist; slist = slist->next)
328 for (slist = skipped_paths; slist; slist = slist->next)
332 argv = g_malloc ((argc + 2) * sizeof(gchar *));
334 for (slist = subtest_args; slist; slist = slist->next)
335 argv[i++] = (gchar*) slist->data;
336 /* argv[i++] = "--debug-log"; */
338 argv[i++] = "--quiet";
340 argv[i++] = "--verbose";
341 if (!subtest_mode_fatal)
342 argv[i++] = "--keep-going";
343 if (subtest_mode_quick)
344 argv[i++] = "-m=quick";
346 argv[i++] = "-m=slow";
347 if (subtest_mode_perf)
348 argv[i++] = "-m=perf";
349 if (!subtest_mode_undefined)
350 argv[i++] = "-m=no-undefined";
351 if (gtester_list_tests)
354 argv[i++] = queue_gfree (&free_list, g_strdup_printf ("--seed=%s", subtest_seedstr));
355 argv[i++] = queue_gfree (&free_list, g_strdup_printf ("--GTestLogFD=%u", report_pipe[1]));
357 argv[i++] = queue_gfree (&free_list, g_strdup_printf ("--GTestSkipCount=%u", skip_tests));
358 for (slist = subtest_paths; slist; slist = slist->next)
359 argv[i++] = queue_gfree (&free_list, g_strdup_printf ("-p=%s", (gchar*) slist->data));
360 for (slist = skipped_paths; slist; slist = slist->next)
361 argv[i++] = queue_gfree (&free_list, g_strdup_printf ("-s=%s", (gchar*) slist->data));
364 g_spawn_async_with_pipes (NULL, /* g_get_current_dir() */
367 G_SPAWN_DO_NOT_REAP_CHILD, /* G_SPAWN_SEARCH_PATH */
368 unset_cloexec_fdp, &report_pipe[1], /* pre-exec callback */
370 NULL, /* standard_input */
371 NULL, /* standard_output */
372 NULL, /* standard_error */
374 g_slist_foreach (free_list, (void(*)(void*,void*)) g_free, NULL);
375 g_slist_free (free_list);
377 close (report_pipe[1]);
380 g_print ("(pid=%lu)\n", (unsigned long) pid);
384 close (report_pipe[0]);
385 if (subtest_mode_fatal)
386 g_error ("Failed to execute test binary: %s: %s", argv[0], error->message);
388 g_warning ("Failed to execute test binary: %s: %s", argv[0], error->message);
389 g_clear_error (&error);
395 subtest_running = TRUE;
396 subtest_io_pending = TRUE;
397 tlb = g_test_log_buffer_new();
398 if (report_pipe[0] >= 0)
400 ioc_report = g_io_channel_unix_new (report_pipe[0]);
401 g_io_channel_set_flags (ioc_report, G_IO_FLAG_NONBLOCK, NULL);
402 g_io_channel_set_encoding (ioc_report, NULL, NULL);
403 g_io_channel_set_buffered (ioc_report, FALSE);
404 child_report_cb_id = g_io_add_watch_full (ioc_report, G_PRIORITY_DEFAULT - 1, G_IO_IN | G_IO_ERR | G_IO_HUP, child_report_cb, tlb, NULL);
405 g_io_channel_unref (ioc_report);
407 g_child_watch_add_full (G_PRIORITY_DEFAULT + 1, pid, child_watch_cb, NULL, NULL);
409 loop_pending = g_main_context_pending (NULL);
410 while (subtest_running || /* FALSE once child exits */
411 subtest_io_pending || /* FALSE once ioc_report closes */
412 loop_pending) /* TRUE while idler, etc are running */
414 /* g_print ("LOOPSTATE: subtest_running=%d subtest_io_pending=%d\n", subtest_running, subtest_io_pending); */
415 /* check for unexpected hangs that are not signalled on report_pipe */
416 if (!subtest_running && /* child exited */
417 subtest_io_pending && /* no EOF detected on report_pipe */
418 !loop_pending) /* no IO events pending however */
420 g_main_context_iteration (NULL, TRUE);
421 loop_pending = g_main_context_pending (NULL);
424 if (subtest_io_pending)
425 g_source_remove (child_report_cb_id);
427 close (report_pipe[0]);
428 g_test_log_buffer_free (tlb);
434 launch_test (const char *binary)
436 gboolean success = TRUE;
437 GTimer *btimer = g_timer_new();
438 gboolean need_restart;
442 g_print ("TEST: %s... ", binary);
445 test_log_printfe ("%s<testbinary path=\"%s\">\n", sindent (log_indent), binary);
447 g_timer_start (btimer);
448 subtest_exitstatus = 0;
449 success &= launch_test_binary (binary, testcase_count);
450 success &= subtest_exitstatus == 0;
451 need_restart = testcase_open != 0;
453 testcase_close (0, -256, 0);
454 g_timer_stop (btimer);
455 test_log_printfe ("%s<duration>%.6f</duration>\n", sindent (log_indent), g_timer_elapsed (btimer, NULL));
457 test_log_printfe ("%s</testbinary>\n", sindent (log_indent));
458 g_free (subtest_last_seed);
459 subtest_last_seed = NULL;
462 /* restart test binary, skipping processed test cases */
466 /* count the inability to run a test as a failure */
467 if (!success && testcase_count == 0)
468 testcase_fail_count++;
471 g_print ("%s: %s\n", !success ? "FAIL" : "PASS", binary);
472 g_timer_destroy (btimer);
473 if (subtest_mode_fatal && !success)
478 usage (gboolean just_version)
482 g_print ("gtester version %d.%d.%d\n", GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
485 g_print ("Usage:\n");
486 g_print ("gtester [OPTIONS] testprogram...\n\n");
487 /* 12345678901234567890123456789012345678901234567890123456789012345678901234567890 */
488 g_print ("Help Options:\n");
489 g_print (" -h, --help Show this help message\n\n");
490 g_print ("Utility Options:\n");
491 g_print (" -v, --version Print version informations\n");
492 g_print (" --g-fatal-warnings Make warnings fatal (abort)\n");
493 g_print (" -k, --keep-going Continue running after tests failed\n");
494 g_print (" -l List paths of available test cases\n");
495 g_print (" -m {perf|slow|thorough|quick} Run test cases according to mode\n");
496 g_print (" -m {undefined|no-undefined} Run test cases according to mode\n");
497 g_print (" -p=TESTPATH Only start test cases matching TESTPATH\n");
498 g_print (" -s=TESTPATH Skip test cases matching TESTPATH\n");
499 g_print (" --seed=SEEDSTRING Start tests with random seed SEEDSTRING\n");
500 g_print (" -o=LOGFILE Write the test log to LOGFILE\n");
501 g_print (" -q, --quiet Suppress per test binary output\n");
502 g_print (" --verbose Report success per testcase\n");
506 parse_args (gint *argc_p,
509 guint argc = *argc_p;
510 gchar **argv = *argv_p;
512 /* parse known args */
513 for (i = 1; i < argc; i++)
515 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
517 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
518 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
519 g_log_set_always_fatal (fatal_mask);
522 else if (strcmp (argv[i], "--gtester-selftest") == 0)
524 gtester_selftest = TRUE;
526 break; /* stop parsing regular gtester arguments */
528 else if (strcmp (argv[i], "-h") == 0 || strcmp (argv[i], "--help") == 0)
534 else if (strcmp (argv[i], "-v") == 0 || strcmp (argv[i], "--version") == 0)
540 else if (strcmp (argv[i], "--keep-going") == 0 ||
541 strcmp (argv[i], "-k") == 0)
543 subtest_mode_fatal = FALSE;
546 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
548 gchar *equal = argv[i] + 2;
550 subtest_paths = g_slist_prepend (subtest_paths, equal + 1);
551 else if (i + 1 < argc)
554 subtest_paths = g_slist_prepend (subtest_paths, argv[i]);
558 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
560 gchar *equal = argv[i] + 2;
562 skipped_paths = g_slist_prepend (skipped_paths, equal + 1);
563 else if (i + 1 < argc)
566 skipped_paths = g_slist_prepend (skipped_paths, argv[i]);
570 else if (strcmp ("--test-arg", argv[i]) == 0 || strncmp ("--test-arg=", argv[i], 11) == 0)
572 gchar *equal = argv[i] + 10;
574 subtest_args = g_slist_prepend (subtest_args, equal + 1);
575 else if (i + 1 < argc)
578 subtest_args = g_slist_prepend (subtest_args, argv[i]);
582 else if (strcmp ("-o", argv[i]) == 0 || strncmp ("-o=", argv[i], 3) == 0)
584 gchar *equal = argv[i] + 2;
586 output_filename = equal + 1;
587 else if (i + 1 < argc)
590 output_filename = argv[i];
594 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
596 gchar *equal = argv[i] + 2;
597 const gchar *mode = "";
600 else if (i + 1 < argc)
605 if (strcmp (mode, "perf") == 0)
606 subtest_mode_perf = TRUE;
607 else if (strcmp (mode, "slow") == 0 || strcmp (mode, "thorough") == 0)
608 subtest_mode_quick = FALSE;
609 else if (strcmp (mode, "quick") == 0)
611 subtest_mode_quick = TRUE;
612 subtest_mode_perf = FALSE;
614 else if (strcmp (mode, "undefined") == 0)
615 subtest_mode_undefined = TRUE;
616 else if (strcmp (mode, "no-undefined") == 0)
617 subtest_mode_undefined = FALSE;
619 g_error ("unknown test mode: -m %s", mode);
622 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
624 gtester_quiet = TRUE;
625 gtester_verbose = FALSE;
628 else if (strcmp ("--verbose", argv[i]) == 0)
630 gtester_quiet = FALSE;
631 gtester_verbose = TRUE;
634 else if (strcmp ("-l", argv[i]) == 0)
636 gtester_list_tests = TRUE;
639 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
641 gchar *equal = argv[i] + 6;
643 subtest_seedstr = equal + 1;
644 else if (i + 1 < argc)
647 subtest_seedstr = argv[i];
654 for (i = 1; i < argc; i++)
670 g_set_prgname (argv[0]);
671 parse_args (&argc, &argv);
672 if (gtester_selftest)
673 return main_selftest (argc, argv);
683 log_fd = g_open (output_filename, O_WRONLY | O_CREAT | O_TRUNC, 0666);
685 g_error ("Failed to open log file '%s': %s", output_filename, g_strerror (errno));
688 test_log_printfe ("<?xml version=\"1.0\"?>\n");
689 test_log_printfe ("%s<gtester>\n", sindent (log_indent));
691 for (ui = 1; ui < argc; ui++)
693 const char *binary = argv[ui];
694 launch_test (binary);
695 /* we only get here on success or if !subtest_mode_fatal */
698 test_log_printfe ("%s</gtester>\n", sindent (log_indent));
702 return testcase_fail_count == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
706 fixture_setup (guint *fix,
707 gconstpointer test_data)
709 g_assert_cmphex (*fix, ==, 0);
713 fixture_test (guint *fix,
714 gconstpointer test_data)
716 g_assert_cmphex (*fix, ==, 0xdeadbeef);
717 g_test_message ("This is a test message API test message.");
718 g_test_bug_base ("http://www.example.com/bugtracker/");
720 g_test_bug_base ("http://www.example.com/bugtracker?bugnum=%s;cmd=showbug");
724 fixture_teardown (guint *fix,
725 gconstpointer test_data)
727 g_assert_cmphex (*fix, ==, 0xdeadbeef);
731 main_selftest (int argc,
734 /* gtester main() for --gtester-selftest invocations */
735 g_test_init (&argc, &argv, NULL);
736 g_test_add ("/gtester/fixture-test", guint, NULL, fixture_setup, fixture_test, fixture_teardown);