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.1 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, see <http://www.gnu.org/licenses/>.
19 * Authors: David Zeuthen <davidz@redhat.com>
20 * Xavier Claessens <xavier.claessens@collabora.co.uk>
39 #include "gdbusconnection.h"
40 #include "gdbusprivate.h"
42 #include "gioenumtypes.h"
43 #include "gtestdbus.h"
51 /* -------------------------------------------------------------------------- */
52 /* Utility: Wait until object has a single ref */
61 on_weak_notify_timeout (gpointer user_data)
63 WeakNotifyData *data = user_data;
64 data->timed_out = TRUE;
65 g_main_loop_quit (data->loop);
70 unref_on_idle (gpointer object)
72 g_object_unref (object);
77 _g_object_unref_and_wait_weak_notify (gpointer object)
82 data.loop = g_main_loop_new (NULL, FALSE);
83 data.timed_out = FALSE;
85 g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);
87 /* Drop the strong ref held by the caller in an idle callback. This is to
88 * make sure the mainloop is already running when weak notify happens (when
89 * all other strong ref holders have dropped theirs). */
90 g_idle_add (unref_on_idle, object);
92 /* Make sure we don't block forever */
93 timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);
95 g_main_loop_run (data.loop);
99 g_warning ("Weak notify timeout, object ref_count=%d",
100 G_OBJECT (object)->ref_count);
104 g_source_remove (timeout_id);
107 g_main_loop_unref (data.loop);
108 return data.timed_out;
111 /* -------------------------------------------------------------------------- */
112 /* Utilities to cleanup the mess in the case unit test process crash */
116 /* This could be interesting to expose in public API */
118 _g_test_watcher_add_pid (GPid pid)
120 static gsize started = 0;
123 if (g_once_init_enter (&started))
125 JOBOBJECT_EXTENDED_LIMIT_INFORMATION info;
127 job = CreateJobObjectW (NULL, NULL);
128 memset (&info, 0, sizeof (info));
129 info.BasicLimitInformation.LimitFlags = 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;
131 if (!SetInformationJobObject(job, JobObjectExtendedLimitInformation, &info, sizeof (info)))
132 g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));
134 g_once_init_leave (&started,(gsize)job);
137 job = (HANDLE)started;
139 if (!AssignProcessToJobObject(job, pid))
140 g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
144 _g_test_watcher_remove_pid (GPid pid)
146 /* No need to unassign the process from the job object as the process
147 will be killed anyway */
152 #define ADD_PID_FORMAT "add pid %d\n"
153 #define REMOVE_PID_FORMAT "remove pid %d\n"
156 watch_parent (gint fd)
160 GArray *pids_to_kill;
162 channel = g_io_channel_unix_new (fd);
165 fds[0].events = G_IO_HUP | G_IO_IN;
168 pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));
173 gchar *command = NULL;
176 GError *error = NULL;
178 num_events = g_poll (fds, 1, -1);
182 if (fds[0].revents & G_IO_HUP)
184 /* Parent quit, cleanup the mess and exit */
185 for (n = 0; n < pids_to_kill->len; n++)
187 pid = g_array_index (pids_to_kill, guint, n);
188 g_printerr ("cleaning up pid %d\n", pid);
192 g_array_unref (pids_to_kill);
193 g_io_channel_shutdown (channel, FALSE, &error);
194 g_assert_no_error (error);
195 g_io_channel_unref (channel);
200 /* Read the command from the input */
201 g_io_channel_read_line (channel, &command, NULL, NULL, &error);
202 g_assert_no_error (error);
204 /* Check for known commands */
205 if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
207 g_array_append_val (pids_to_kill, pid);
209 else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
211 for (n = 0; n < pids_to_kill->len; n++)
213 if (g_array_index (pids_to_kill, guint, n) == pid)
215 g_array_remove_index (pids_to_kill, n);
222 g_warning ("unknown pid %d to remove", pid);
227 g_warning ("unknown command from parent '%s'", command);
238 static gsize started = 0;
239 static GIOChannel *channel = NULL;
242 if (g_once_init_enter (&started))
246 /* fork a child to clean up when we are killed */
247 if (pipe (pipe_fds) != 0)
250 g_warning ("pipe() failed: %s", g_strerror (errsv));
251 g_assert_not_reached ();
258 g_warning ("fork() failed: %s", g_strerror (errsv));
259 g_assert_not_reached ();
265 watch_parent (pipe_fds[0]);
271 channel = g_io_channel_unix_new (pipe_fds[1]);
274 g_once_init_leave (&started, 1);
281 watcher_send_command (const gchar *command)
284 GError *error = NULL;
286 channel = watcher_init ();
288 g_io_channel_write_chars (channel, command, -1, NULL, &error);
289 g_assert_no_error (error);
291 g_io_channel_flush (channel, &error);
292 g_assert_no_error (error);
295 /* This could be interesting to expose in public API */
297 _g_test_watcher_add_pid (GPid pid)
301 command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
302 watcher_send_command (command);
307 _g_test_watcher_remove_pid (GPid pid)
311 command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
312 watcher_send_command (command);
318 /* -------------------------------------------------------------------------- */
319 /* GTestDBus object implementation */
323 * @short_description: D-Bus testing helper
324 * @include: gio/gio.h
326 * A helper class for testing code which uses D-Bus without touching the user's
329 * Note that #GTestDBus modifies the user’s environment, calling setenv().
330 * This is not thread-safe, so all #GTestDBus calls should be completed before
331 * threads are spawned, or should have appropriate locking to ensure no access
332 * conflicts to environment variables shared between #GTestDBus and other
335 * ## Creating unit tests using GTestDBus
337 * Testing of D-Bus services can be tricky because normally we only ever run
338 * D-Bus services over an existing instance of the D-Bus daemon thus we
339 * usually don't activate D-Bus services that are not yet installed into the
340 * target system. The #GTestDBus object makes this easier for us by taking care
341 * of the lower level tasks such as running a private D-Bus daemon and looking
342 * up uninstalled services in customizable locations, typically in your source
345 * The first thing you will need is a separate service description file for the
346 * D-Bus daemon. Typically a `services` subdirectory of your `tests` directory
347 * is a good place to put this file.
349 * The service file should list your service along with an absolute path to the
350 * uninstalled service executable in your source tree. Using autotools we would
351 * achieve this by adding a file such as `my-server.service.in` in the services
352 * directory and have it processed by configure.
355 * Name=org.gtk.GDBus.Examples.ObjectManager
356 * Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
358 * You will also need to indicate this service directory in your test
359 * fixtures, so you will need to pass the path while compiling your
360 * test cases. Typically this is done with autotools with an added
361 * preprocessor flag specified to compile your tests such as:
363 * -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
365 * Once you have a service definition file which is local to your source tree,
366 * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
368 * An example of a test fixture for D-Bus services can be found
370 * [gdbus-test-fixture.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c)
372 * Note that these examples only deal with isolating the D-Bus aspect of your
373 * service. To successfully run isolated unit tests on your service you may need
374 * some additional modifications to your test case fixture. For example; if your
375 * service uses GSettings and installs a schema then it is important that your test service
376 * not load the schema in the ordinary installed location (chances are that your service
377 * and schema files are not yet installed, or worse; there is an older version of the
378 * schema file sitting in the install location).
380 * Most of the time we can work around these obstacles using the
381 * environment. Since the environment is inherited by the D-Bus daemon
382 * created by #GTestDBus and then in turn inherited by any services the
383 * D-Bus daemon activates, using the setup routine for your fixture is
384 * a practical place to help sandbox your runtime environment. For the
385 * rather typical GSettings case we can work around this by setting
386 * `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
387 * in the above fixture_setup() routine.
389 * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
390 * by compiling the schemas locally as a step before running test cases, an autotools setup might
391 * do the following in the directory holding schemas:
394 * $(GLIB_COMPILE_SCHEMAS) .
396 * CLEANFILES += gschemas.compiled
400 typedef struct _GTestDBusClass GTestDBusClass;
401 typedef struct _GTestDBusPrivate GTestDBusPrivate;
406 * The #GTestDBus structure contains only private data and
407 * should only be accessed using the provided API.
414 GTestDBusPrivate *priv;
417 struct _GTestDBusClass {
418 GObjectClass parent_class;
421 struct _GTestDBusPrivate
423 GTestDBusFlags flags;
424 GPtrArray *service_dirs;
437 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
440 g_test_dbus_init (GTestDBus *self)
442 self->priv = g_test_dbus_get_instance_private (self);
443 self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
447 g_test_dbus_dispose (GObject *object)
449 GTestDBus *self = (GTestDBus *) object;
452 g_test_dbus_down (self);
454 G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
458 g_test_dbus_finalize (GObject *object)
460 GTestDBus *self = (GTestDBus *) object;
462 g_ptr_array_unref (self->priv->service_dirs);
463 g_free (self->priv->bus_address);
465 G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
469 g_test_dbus_get_property (GObject *object,
474 GTestDBus *self = (GTestDBus *) object;
479 g_value_set_flags (value, g_test_dbus_get_flags (self));
482 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
488 g_test_dbus_set_property (GObject *object,
493 GTestDBus *self = (GTestDBus *) object;
498 self->priv->flags = g_value_get_flags (value);
501 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
507 g_test_dbus_class_init (GTestDBusClass *klass)
509 GObjectClass *object_class = G_OBJECT_CLASS (klass);
511 object_class->dispose = g_test_dbus_dispose;
512 object_class->finalize = g_test_dbus_finalize;
513 object_class->get_property = g_test_dbus_get_property;
514 object_class->set_property = g_test_dbus_set_property;
519 * #GTestDBusFlags specifying the behaviour of the D-Bus session.
523 g_object_class_install_property (object_class, PROP_FLAGS,
524 g_param_spec_flags ("flags",
525 P_("D-Bus session flags"),
526 P_("Flags specifying the behaviour of the D-Bus session"),
527 G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
528 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
529 G_PARAM_STATIC_STRINGS));
534 write_config_file (GTestDBus *self)
539 GError *error = NULL;
542 fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
543 g_assert_no_error (error);
545 contents = g_string_new (NULL);
546 g_string_append (contents,
548 " <type>session</type>\n"
550 " <listen>nonce-tcp:</listen>\n"
552 " <listen>unix:tmpdir=/tmp</listen>\n"
556 for (i = 0; i < self->priv->service_dirs->len; i++)
558 const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
560 g_string_append_printf (contents,
561 " <servicedir>%s</servicedir>\n", dir_path);
564 g_string_append (contents,
565 " <policy context=\"default\">\n"
566 " <!-- Allow everything to be sent -->\n"
567 " <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
568 " <!-- Allow everything to be received -->\n"
569 " <allow eavesdrop=\"true\"/>\n"
570 " <!-- Allow anyone to own anything -->\n"
571 " <allow own=\"*\"/>\n"
576 g_file_set_contents_full (path, contents->str, contents->len,
577 G_FILE_SET_CONTENTS_NONE,
579 g_assert_no_error (error);
581 g_string_free (contents, TRUE);
587 start_daemon (GTestDBus *self)
589 const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
595 GError *error = NULL;
597 if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
598 argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
600 /* Write config file and set its path in argv */
601 config_path = write_config_file (self);
602 config_arg = g_strdup_printf ("--config-file=%s", config_path);
603 argv[2] = config_arg;
605 /* Spawn dbus-daemon */
606 g_spawn_async_with_pipes (NULL,
609 /* We Need this to get the pid returned on win32 */
610 G_SPAWN_DO_NOT_REAP_CHILD |
611 G_SPAWN_SEARCH_PATH |
612 /* dbus-daemon will not abuse our descriptors, and
613 * passing this means we can use posix_spawn() for speed */
614 G_SPAWN_LEAVE_DESCRIPTORS_OPEN,
617 &self->priv->bus_pid,
619 &self->priv->bus_stdout_fd,
622 g_assert_no_error (error);
624 _g_test_watcher_add_pid (self->priv->bus_pid);
626 /* Read bus address from daemon' stdout. We have to be careful to avoid
627 * closing the FD, as it is passed to any D-Bus service activated processes,
628 * and if we close it, they will get a SIGPIPE and die when they try to write
629 * to their stdout. */
630 stdout_fd2 = dup (self->priv->bus_stdout_fd);
631 g_assert_cmpint (stdout_fd2, >=, 0);
632 channel = g_io_channel_unix_new (stdout_fd2);
634 g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
636 g_assert_no_error (error);
637 self->priv->bus_address[termpos] = '\0';
639 /* start dbus-monitor */
640 if (g_getenv ("G_DBUS_MONITOR") != NULL)
644 command = g_strdup_printf ("dbus-monitor --address %s",
645 self->priv->bus_address);
646 g_spawn_command_line_async (command, NULL);
649 g_usleep (500 * 1000);
653 g_io_channel_shutdown (channel, FALSE, &error);
654 g_assert_no_error (error);
655 g_io_channel_unref (channel);
657 /* Don't use g_file_delete since it calls into gvfs */
658 if (g_unlink (config_path) != 0)
659 g_assert_not_reached ();
661 g_free (config_path);
666 stop_daemon (GTestDBus *self)
669 if (!TerminateProcess (self->priv->bus_pid, 0))
670 g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
672 kill (self->priv->bus_pid, SIGTERM);
674 _g_test_watcher_remove_pid (self->priv->bus_pid);
675 g_spawn_close_pid (self->priv->bus_pid);
676 self->priv->bus_pid = 0;
677 close (self->priv->bus_stdout_fd);
678 self->priv->bus_stdout_fd = -1;
680 g_free (self->priv->bus_address);
681 self->priv->bus_address = NULL;
686 * @flags: a #GTestDBusFlags
688 * Create a new #GTestDBus object.
690 * Returns: (transfer full): a new #GTestDBus.
693 g_test_dbus_new (GTestDBusFlags flags)
695 return g_object_new (G_TYPE_TEST_DBUS,
701 * g_test_dbus_get_flags:
702 * @self: a #GTestDBus
704 * Get the flags of the #GTestDBus object.
706 * Returns: the value of #GTestDBus:flags property
709 g_test_dbus_get_flags (GTestDBus *self)
711 g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
713 return self->priv->flags;
717 * g_test_dbus_get_bus_address:
718 * @self: a #GTestDBus
720 * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
721 * been called yet, %NULL is returned. This can be used with
722 * g_dbus_connection_new_for_address().
724 * Returns: (nullable): the address of the bus, or %NULL.
727 g_test_dbus_get_bus_address (GTestDBus *self)
729 g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
731 return self->priv->bus_address;
735 * g_test_dbus_add_service_dir:
736 * @self: a #GTestDBus
737 * @path: path to a directory containing .service files
739 * Add a path where dbus-daemon will look up .service files. This can't be
740 * called after g_test_dbus_up().
743 g_test_dbus_add_service_dir (GTestDBus *self,
746 g_return_if_fail (G_IS_TEST_DBUS (self));
747 g_return_if_fail (self->priv->bus_address == NULL);
749 g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
754 * @self: a #GTestDBus
756 * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
757 * call, it is safe for unit tests to start sending messages on the session bus.
759 * If this function is called from setup callback of g_test_add(),
760 * g_test_dbus_down() must be called in its teardown callback.
762 * If this function is called from unit test's main(), then g_test_dbus_down()
763 * must be called after g_test_run().
766 g_test_dbus_up (GTestDBus *self)
768 g_return_if_fail (G_IS_TEST_DBUS (self));
769 g_return_if_fail (self->priv->bus_address == NULL);
770 g_return_if_fail (!self->priv->up);
774 g_test_dbus_unset ();
775 g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
776 self->priv->up = TRUE;
782 * @self: a #GTestDBus
784 * Stop the session bus started by g_test_dbus_up().
786 * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
787 * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
788 * tests wanting to verify behaviour after the session bus has been stopped
789 * can use this function but should still call g_test_dbus_down() when done.
792 g_test_dbus_stop (GTestDBus *self)
794 g_return_if_fail (G_IS_TEST_DBUS (self));
795 g_return_if_fail (self->priv->bus_address != NULL);
802 * @self: a #GTestDBus
804 * Stop the session bus started by g_test_dbus_up().
806 * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
807 * to be destroyed. This is done to ensure that the next unit test won't get a
808 * leaked singleton from this test.
811 g_test_dbus_down (GTestDBus *self)
813 GDBusConnection *connection;
815 g_return_if_fail (G_IS_TEST_DBUS (self));
816 g_return_if_fail (self->priv->up);
818 connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
819 if (connection != NULL)
820 g_dbus_connection_set_exit_on_close (connection, FALSE);
822 if (self->priv->bus_address != NULL)
825 if (connection != NULL)
826 _g_object_unref_and_wait_weak_notify (connection);
828 g_test_dbus_unset ();
829 _g_bus_forget_singleton (G_BUS_TYPE_SESSION);
830 self->priv->up = FALSE;
836 * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
837 * won't use user's session bus.
839 * This is useful for unit tests that want to verify behaviour when no session
840 * bus is running. It is not necessary to call this if unit test already calls
841 * g_test_dbus_up() before acquiring the session bus.
844 g_test_dbus_unset (void)
846 g_unsetenv ("DISPLAY");
847 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
848 g_unsetenv ("DBUS_STARTER_ADDRESS");
849 g_unsetenv ("DBUS_STARTER_BUS_TYPE");
850 /* avoid using XDG_RUNTIME_DIR/bus */
851 g_unsetenv ("XDG_RUNTIME_DIR");