1 /* GIO testing utilities
3 * Copyright (C) 2008-2010 Red Hat, Inc.
4 * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Authors: David Zeuthen <davidz@redhat.com>
22 * Xavier Claessens <xavier.claessens@collabora.co.uk>
33 #include "gdbusconnection.h"
34 #include "gdbusprivate.h"
36 #include "gioenumtypes.h"
37 #include "gtestdbus.h"
42 #define _WIN32_WINNT 0x0500
46 /* -------------------------------------------------------------------------- */
47 /* Utility: Wait until object has a single ref */
56 on_weak_notify_timeout (gpointer user_data)
58 WeakNotifyData *data = user_data;
59 data->timed_out = TRUE;
60 g_main_loop_quit (data->loop);
65 unref_on_idle (gpointer object)
67 g_object_unref (object);
72 _g_object_unref_and_wait_weak_notify (gpointer object)
77 data.loop = g_main_loop_new (NULL, FALSE);
78 data.timed_out = FALSE;
80 g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);
82 /* Drop the ref in an idle callback, this is to make sure the mainloop
83 * is already running when weak notify happens */
84 g_idle_add (unref_on_idle, object);
86 /* Make sure we don't block forever */
87 timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);
89 g_main_loop_run (data.loop);
91 g_source_remove (timeout_id);
95 g_warning ("Weak notify timeout, object ref_count=%d\n",
96 G_OBJECT (object)->ref_count);
99 return data.timed_out;
102 /* -------------------------------------------------------------------------- */
103 /* Utilities to cleanup the mess in the case unit test process crash */
107 /* This could be interesting to expose in public API */
109 _g_test_watcher_add_pid (GPid pid)
111 static gsize started = 0;
114 if (g_once_init_enter (&started))
116 JOBOBJECT_EXTENDED_LIMIT_INFORMATION info;
118 job = CreateJobObjectW (NULL, NULL);
119 memset (&info, 0, sizeof (info));
120 info.BasicLimitInformation.LimitFlags = 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;
122 if (!SetInformationJobObject(job, JobObjectExtendedLimitInformation, &info, sizeof (info)))
123 g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));
125 g_once_init_leave (&started,(gsize)job);
128 job = (HANDLE)started;
130 if (!AssignProcessToJobObject(job, pid))
131 g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
135 _g_test_watcher_remove_pid (GPid pid)
137 /* No need to unassign the process from the job object as the process
138 will be killed anyway */
143 #define ADD_PID_FORMAT "add pid %d\n"
144 #define REMOVE_PID_FORMAT "remove pid %d\n"
147 watch_parent (gint fd)
151 GArray *pids_to_kill;
153 channel = g_io_channel_unix_new (fd);
156 fds[0].events = G_IO_HUP | G_IO_IN;
159 pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));
164 gchar *command = NULL;
167 GError *error = NULL;
169 num_events = g_poll (fds, 1, -1);
173 if (fds[0].revents == G_IO_HUP)
175 /* Parent quit, cleanup the mess and exit */
176 for (n = 0; n < pids_to_kill->len; n++)
178 pid = g_array_index (pids_to_kill, guint, n);
179 g_print ("cleaning up pid %d\n", pid);
183 g_array_unref (pids_to_kill);
184 g_io_channel_shutdown (channel, FALSE, &error);
185 g_assert_no_error (error);
186 g_io_channel_unref (channel);
191 /* Read the command from the input */
192 g_io_channel_read_line (channel, &command, NULL, NULL, &error);
193 g_assert_no_error (error);
195 /* Check for known commands */
196 if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
198 g_array_append_val (pids_to_kill, pid);
200 else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
202 for (n = 0; n < pids_to_kill->len; n++)
204 if (g_array_index (pids_to_kill, guint, n) == pid)
206 g_array_remove_index (pids_to_kill, n);
213 g_warning ("unknown pid %d to remove", pid);
218 g_warning ("unknown command from parent '%s'", command);
229 static gsize started = 0;
230 static GIOChannel *channel = NULL;
232 if (g_once_init_enter (&started))
236 /* fork a child to clean up when we are killed */
237 if (pipe (pipe_fds) != 0)
239 g_warning ("pipe() failed: %m");
240 g_assert_not_reached ();
246 g_warning ("fork() failed: %m");
247 g_assert_not_reached ();
253 watch_parent (pipe_fds[0]);
259 channel = g_io_channel_unix_new (pipe_fds[1]);
262 g_once_init_leave (&started, 1);
269 watcher_send_command (const gchar *command)
272 GError *error = NULL;
274 channel = watcher_init ();
276 g_io_channel_write_chars (channel, command, -1, NULL, &error);
277 g_assert_no_error (error);
279 g_io_channel_flush (channel, &error);
280 g_assert_no_error (error);
283 /* This could be interesting to expose in public API */
285 _g_test_watcher_add_pid (GPid pid)
289 command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
290 watcher_send_command (command);
295 _g_test_watcher_remove_pid (GPid pid)
299 command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
300 watcher_send_command (command);
306 /* -------------------------------------------------------------------------- */
307 /* GTestDBus object implementation */
311 * @short_description: D-Bus testing helper
312 * @include: gio/gio.h
314 * Helper to test D-Bus code wihtout messing up with user' session bus.
317 typedef struct _GTestDBusClass GTestDBusClass;
318 typedef struct _GTestDBusPrivate GTestDBusPrivate;
323 * The #GTestDBus structure contains only private data and
324 * should only be accessed using the provided API.
331 GTestDBusPrivate *priv;
334 struct _GTestDBusClass {
335 GObjectClass parent_class;
338 struct _GTestDBusPrivate
340 GTestDBusFlags flags;
341 GPtrArray *service_dirs;
353 G_DEFINE_TYPE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
356 g_test_dbus_init (GTestDBus *self)
358 self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self), G_TYPE_TEST_DBUS,
361 self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
365 g_test_dbus_dispose (GObject *object)
367 GTestDBus *self = (GTestDBus *) object;
370 g_test_dbus_down (self);
372 G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
376 g_test_dbus_finalize (GObject *object)
378 GTestDBus *self = (GTestDBus *) object;
380 g_ptr_array_unref (self->priv->service_dirs);
381 g_free (self->priv->bus_address);
383 G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
387 g_test_dbus_get_property (GObject *object,
392 GTestDBus *self = (GTestDBus *) object;
397 g_value_set_flags (value, g_test_dbus_get_flags (self));
400 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
406 g_test_dbus_set_property (GObject *object,
411 GTestDBus *self = (GTestDBus *) object;
416 self->priv->flags = g_value_get_flags (value);
419 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
425 g_test_dbus_class_init (GTestDBusClass *klass)
427 GObjectClass *object_class = G_OBJECT_CLASS (klass);
429 object_class->dispose = g_test_dbus_dispose;
430 object_class->finalize = g_test_dbus_finalize;
431 object_class->get_property = g_test_dbus_get_property;
432 object_class->set_property = g_test_dbus_set_property;
434 g_type_class_add_private (object_class, sizeof (GTestDBusPrivate));
439 * #GTestDBusFlags specifying the behaviour of the dbus session
443 g_object_class_install_property (object_class, PROP_FLAGS,
444 g_param_spec_flags ("flags",
445 P_("dbus session flags"),
446 P_("Flags specifying the behaviour of the dbus session"),
447 G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
448 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
449 G_PARAM_STATIC_STRINGS));
454 write_config_file (GTestDBus *self)
458 GFileIOStream *iostream;
460 GError *error = NULL;
462 file = g_file_new_tmp ("g-test-dbus-XXXXXX", &iostream, &error);
463 g_assert_no_error (error);
464 g_object_unref (iostream);
466 contents = g_string_new (NULL);
467 g_string_append (contents,
469 " <type>session</type>\n"
471 " <listen>nonce-tcp:</listen>\n"
473 " <listen>unix:tmpdir=/tmp</listen>\n"
477 for (i = 0; i < self->priv->service_dirs->len; i++)
479 const gchar *path = g_ptr_array_index (self->priv->service_dirs, i);
481 g_string_append_printf (contents,
482 " <servicedir>%s</servicedir>\n", path);
485 g_string_append (contents,
486 " <policy context=\"default\">\n"
487 " <!-- Allow everything to be sent -->\n"
488 " <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
489 " <!-- Allow everything to be received -->\n"
490 " <allow eavesdrop=\"true\"/>\n"
491 " <!-- Allow anyone to own anything -->\n"
492 " <allow own=\"*\"/>\n"
496 g_file_replace_contents (file, contents->str, contents->len,
497 NULL, FALSE, G_FILE_CREATE_NONE, NULL, NULL, &error);
498 g_assert_no_error (error);
500 g_string_free (contents, TRUE);
506 start_daemon (GTestDBus *self)
508 gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
515 GError *error = NULL;
517 /* Write config file and set its path in argv */
518 file = write_config_file (self);
519 config_path = g_file_get_path (file);
520 config_arg = g_strdup_printf ("--config-file=%s", config_path);
521 argv[2] = config_arg;
523 /* Spawn dbus-daemon */
524 g_spawn_async_with_pipes (NULL,
529 /* We Need this to get the pid returned on win32 */
530 | G_SPAWN_DO_NOT_REAP_CHILD
535 &self->priv->bus_pid,
540 g_assert_no_error (error);
542 _g_test_watcher_add_pid (self->priv->bus_pid);
544 /* Read bus address from daemon' stdout */
545 channel = g_io_channel_unix_new (stdout_fd);
546 g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
548 g_assert_no_error (error);
549 self->priv->bus_address[termpos] = '\0';
551 /* start dbus-monitor */
552 if (g_getenv ("G_DBUS_MONITOR") != NULL)
556 command = g_strdup_printf ("dbus-monitor --address %s",
557 self->priv->bus_address);
558 g_spawn_command_line_async (command, NULL);
565 g_io_channel_shutdown (channel, FALSE, &error);
566 g_assert_no_error (error);
567 g_io_channel_unref (channel);
569 g_file_delete (file, NULL, &error);
570 g_assert_no_error (error);
571 g_object_unref (file);
573 g_free (config_path);
578 stop_daemon (GTestDBus *self)
581 if (!TerminateProcess (self->priv->bus_pid, 0))
582 g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
584 kill (self->priv->bus_pid, SIGTERM);
586 _g_test_watcher_remove_pid (self->priv->bus_pid);
587 g_spawn_close_pid (self->priv->bus_pid);
588 self->priv->bus_pid = 0;
590 g_free (self->priv->bus_address);
591 self->priv->bus_address = NULL;
596 * @flags: a #GTestDBusFlags
598 * Create a new #GTestDBus object.
600 * Returns: (transfer full): a new #GTestDBus.
603 g_test_dbus_new (GTestDBusFlags flags)
605 return g_object_new (G_TYPE_TEST_DBUS,
611 * g_test_dbus_get_flags:
612 * @self: a #GTestDBus
614 * Returns: the value of #GTestDBus:flags property
617 g_test_dbus_get_flags (GTestDBus *self)
619 g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
621 return self->priv->flags;
625 * g_test_dbus_get_bus_address:
626 * @self: a #GTestDBus
628 * Get the address on which dbus-daemon is running. if g_test_dbus_up() has not
629 * been called yet, %NULL is returned. This can be used with
630 * g_dbus_connection_new_for_address()
632 * Returns: the address of the bus, or %NULL.
635 g_test_dbus_get_bus_address (GTestDBus *self)
637 g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
639 return self->priv->bus_address;
643 * g_test_dbus_add_service_dir:
644 * @self: a #GTestDBus
645 * @path: path to a directory containing .service files
647 * Add a path where dbus-daemon will lookup for .services files. This can't be
648 * called after g_test_dbus_up().
651 g_test_dbus_add_service_dir (GTestDBus *self,
654 g_return_if_fail (G_IS_TEST_DBUS (self));
655 g_return_if_fail (self->priv->bus_address == NULL);
657 g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
662 * @self: a #GTestDBus
664 * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
665 * call, it is safe for unit tests to start sending messages on the session bug.
667 * If this function is called from setup callback of g_test_add(),
668 * g_test_dbus_down() must be called in its teardown callback.
670 * If this function is called from unit test's main(), then g_test_dbus_down()
671 * must be called after g_test_run().
674 g_test_dbus_up (GTestDBus *self)
676 g_return_if_fail (G_IS_TEST_DBUS (self));
677 g_return_if_fail (self->priv->bus_address == NULL);
678 g_return_if_fail (!self->priv->up);
682 g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
683 self->priv->up = TRUE;
689 * @self: a #GTestDBus
691 * Stop the session bus started by g_test_dbus_up().
693 * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
694 * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
695 * tests wanting to verify behaviour after the session bus has been stopped
696 * can use this function but should still call g_test_dbus_down() when done.
699 g_test_dbus_stop (GTestDBus *self)
701 g_return_if_fail (G_IS_TEST_DBUS (self));
702 g_return_if_fail (self->priv->bus_address != NULL);
709 * @self: a #GTestDBus
711 * Stop the session bus started by g_test_dbus_up().
713 * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
714 * is destroyed. This is done to ensure that the next unit test won't get a
715 * leaked singleton from this test.
718 g_test_dbus_down (GTestDBus *self)
720 GDBusConnection *connection;
722 g_return_if_fail (G_IS_TEST_DBUS (self));
723 g_return_if_fail (self->priv->up);
725 connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
726 if (connection != NULL)
727 g_dbus_connection_set_exit_on_close (connection, FALSE);
729 if (self->priv->bus_address != NULL)
732 if (connection != NULL)
733 _g_object_unref_and_wait_weak_notify (connection);
735 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
736 self->priv->up = FALSE;
742 * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
743 * won't use user's session bus.
745 * This is useful for unit tests that want to verify behaviour when no session
746 * bus is running. It is not necessary to call this if unit test already calls
747 * g_test_dbus_up() before acquiring the session bus.
750 g_test_dbus_unset (void)
752 g_unsetenv ("DISPLAY");
753 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");