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>
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 ref in an idle callback, this is to make sure the mainloop
88 * is already running when weak notify happens */
89 g_idle_add (unref_on_idle
, object
);
91 /* Make sure we don't block forever */
92 timeout_id
= g_timeout_add (30 * 1000, on_weak_notify_timeout
, &data
);
94 g_main_loop_run (data
.loop
);
96 g_source_remove (timeout_id
);
100 g_warning ("Weak notify timeout, object ref_count=%d\n",
101 G_OBJECT (object
)->ref_count
);
104 return data
.timed_out
;
107 /* -------------------------------------------------------------------------- */
108 /* Utilities to cleanup the mess in the case unit test process crash */
112 /* This could be interesting to expose in public API */
114 _g_test_watcher_add_pid (GPid pid
)
116 static gsize started
= 0;
119 if (g_once_init_enter (&started
))
121 JOBOBJECT_EXTENDED_LIMIT_INFORMATION info
;
123 job
= CreateJobObjectW (NULL
, NULL
);
124 memset (&info
, 0, sizeof (info
));
125 info
.BasicLimitInformation
.LimitFlags
= 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;
127 if (!SetInformationJobObject(job
, JobObjectExtendedLimitInformation
, &info
, sizeof (info
)))
128 g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));
130 g_once_init_leave (&started
,(gsize
)job
);
133 job
= (HANDLE
)started
;
135 if (!AssignProcessToJobObject(job
, pid
))
136 g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
140 _g_test_watcher_remove_pid (GPid pid
)
142 /* No need to unassign the process from the job object as the process
143 will be killed anyway */
148 #define ADD_PID_FORMAT "add pid %d\n"
149 #define REMOVE_PID_FORMAT "remove pid %d\n"
152 watch_parent (gint fd
)
156 GArray
*pids_to_kill
;
158 channel
= g_io_channel_unix_new (fd
);
161 fds
[0].events
= G_IO_HUP
| G_IO_IN
;
164 pids_to_kill
= g_array_new (FALSE
, FALSE
, sizeof (guint
));
169 gchar
*command
= NULL
;
172 GError
*error
= NULL
;
174 num_events
= g_poll (fds
, 1, -1);
178 if (fds
[0].revents
== G_IO_HUP
)
180 /* Parent quit, cleanup the mess and exit */
181 for (n
= 0; n
< pids_to_kill
->len
; n
++)
183 pid
= g_array_index (pids_to_kill
, guint
, n
);
184 g_print ("cleaning up pid %d\n", pid
);
188 g_array_unref (pids_to_kill
);
189 g_io_channel_shutdown (channel
, FALSE
, &error
);
190 g_assert_no_error (error
);
191 g_io_channel_unref (channel
);
196 /* Read the command from the input */
197 g_io_channel_read_line (channel
, &command
, NULL
, NULL
, &error
);
198 g_assert_no_error (error
);
200 /* Check for known commands */
201 if (sscanf (command
, ADD_PID_FORMAT
, &pid
) == 1)
203 g_array_append_val (pids_to_kill
, pid
);
205 else if (sscanf (command
, REMOVE_PID_FORMAT
, &pid
) == 1)
207 for (n
= 0; n
< pids_to_kill
->len
; n
++)
209 if (g_array_index (pids_to_kill
, guint
, n
) == pid
)
211 g_array_remove_index (pids_to_kill
, n
);
218 g_warning ("unknown pid %d to remove", pid
);
223 g_warning ("unknown command from parent '%s'", command
);
234 static gsize started
= 0;
235 static GIOChannel
*channel
= NULL
;
237 if (g_once_init_enter (&started
))
241 /* fork a child to clean up when we are killed */
242 if (pipe (pipe_fds
) != 0)
244 g_warning ("pipe() failed: %m");
245 g_assert_not_reached ();
251 g_warning ("fork() failed: %m");
252 g_assert_not_reached ();
258 watch_parent (pipe_fds
[0]);
264 channel
= g_io_channel_unix_new (pipe_fds
[1]);
267 g_once_init_leave (&started
, 1);
274 watcher_send_command (const gchar
*command
)
277 GError
*error
= NULL
;
279 channel
= watcher_init ();
281 g_io_channel_write_chars (channel
, command
, -1, NULL
, &error
);
282 g_assert_no_error (error
);
284 g_io_channel_flush (channel
, &error
);
285 g_assert_no_error (error
);
288 /* This could be interesting to expose in public API */
290 _g_test_watcher_add_pid (GPid pid
)
294 command
= g_strdup_printf (ADD_PID_FORMAT
, (guint
) pid
);
295 watcher_send_command (command
);
300 _g_test_watcher_remove_pid (GPid pid
)
304 command
= g_strdup_printf (REMOVE_PID_FORMAT
, (guint
) pid
);
305 watcher_send_command (command
);
311 /* -------------------------------------------------------------------------- */
312 /* GTestDBus object implementation */
316 * @short_description: D-Bus testing helper
317 * @include: gio/gio.h
319 * A helper class for testing code which uses D-Bus without touching the user's
322 * <refsect2 id="gio-D-Bus-Test-Scaffolding">
323 * <title>Creating unit tests using GTestDBus</title>
325 * Testing of D-Bus services can be tricky because normally we only ever run
326 * D-Bus services over an existing instance of the D-Bus daemon thus we
327 * usually don't activate D-Bus services that are not yet installed into the
328 * target system. The #GTestDBus object makes this easier for us by taking care
329 * of the lower level tasks such as running a private D-Bus daemon and looking
330 * up uninstalled services in customizable locations, typically in your source code tree.
333 * The first thing you will need is a separate service description file for the
334 * D-Bus daemon. Typically a 'services' subdirectory of your 'tests' directory
335 * is a good place to put this file.
338 * The service file should list your service along with an absolute path to the
339 * uninstalled service executable in your source tree. Using autotools we would
340 * achieve this by adding a file such as 'my-server.service.in' in the services
341 * directory and have it processed by configure.
342 * <informalexample><programlisting>
344 * Name=org.gtk.GDBus.Examples.ObjectManager
345 * Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
346 * </programlisting></informalexample>
347 * You will also need to indicate this service directory in your test
348 * fixtures, so you will need to pass the path while compiling your
349 * test cases. Typically this is done with autotools with an added
350 * preprocessor flag specified to compile your tests such as:
351 * <informalexample><programlisting>
352 * -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
353 * </programlisting></informalexample>
356 * Once you have a service definition file which is local to your source tree,
357 * you can proceed to setup a GTest fixture using the GTestDBus scaffolding.
358 * <example id="gdbus-test-fixture">
359 * <title>Test Fixture for D-Bus services</title>
361 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-test-fixture.c">
362 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
368 * Note that these examples only deal with isolating the D-Bus aspect of your
369 * service. To successfully run isolated unit tests on your service you may need
370 * some additional modifications to your test case fixture. For example; if your
371 * service uses GSettings and installs a schema then it is important that your test service
372 * not load the schema in the ordinary installed location (chances are that your service
373 * and schema files are not yet installed, or worse; there is an older version of the
374 * schema file sitting in the install location).
377 * Most of the time we can work around these obstacles using the environment. Since the
378 * environment is inherited by the D-Bus daemon created by GTestDBus and then in turn
379 * inherited by any services the D-Bus daemon activates, using the setup routine for your
380 * fixture is a practical place to help sandbox your runtime environment. For the rather
381 * typical GSettings case we can work around this by setting GSETTINGS_SCHEMA_DIR to the
382 * in tree directory holding your schemas in the above fixture_setup() routine.
385 * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
386 * by compiling the schemas locally as a step before running test cases, an autotools setup might
387 * do the following in the directory holding schemas:
388 * <informalexample><programlisting>
390 * $(GLIB_COMPILE_SCHEMAS) .
392 * CLEANFILES += gschemas.compiled
393 * </programlisting></informalexample>
398 typedef struct _GTestDBusClass GTestDBusClass
;
399 typedef struct _GTestDBusPrivate GTestDBusPrivate
;
404 * The #GTestDBus structure contains only private data and
405 * should only be accessed using the provided API.
412 GTestDBusPrivate
*priv
;
415 struct _GTestDBusClass
{
416 GObjectClass parent_class
;
419 struct _GTestDBusPrivate
421 GTestDBusFlags flags
;
422 GPtrArray
*service_dirs
;
434 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus
, g_test_dbus
, G_TYPE_OBJECT
)
437 g_test_dbus_init (GTestDBus
*self
)
439 self
->priv
= g_test_dbus_get_instance_private (self
);
440 self
->priv
->service_dirs
= g_ptr_array_new_with_free_func (g_free
);
444 g_test_dbus_dispose (GObject
*object
)
446 GTestDBus
*self
= (GTestDBus
*) object
;
449 g_test_dbus_down (self
);
451 G_OBJECT_CLASS (g_test_dbus_parent_class
)->dispose (object
);
455 g_test_dbus_finalize (GObject
*object
)
457 GTestDBus
*self
= (GTestDBus
*) object
;
459 g_ptr_array_unref (self
->priv
->service_dirs
);
460 g_free (self
->priv
->bus_address
);
462 G_OBJECT_CLASS (g_test_dbus_parent_class
)->finalize (object
);
466 g_test_dbus_get_property (GObject
*object
,
471 GTestDBus
*self
= (GTestDBus
*) object
;
476 g_value_set_flags (value
, g_test_dbus_get_flags (self
));
479 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, property_id
, pspec
);
485 g_test_dbus_set_property (GObject
*object
,
490 GTestDBus
*self
= (GTestDBus
*) object
;
495 self
->priv
->flags
= g_value_get_flags (value
);
498 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, property_id
, pspec
);
504 g_test_dbus_class_init (GTestDBusClass
*klass
)
506 GObjectClass
*object_class
= G_OBJECT_CLASS (klass
);
508 object_class
->dispose
= g_test_dbus_dispose
;
509 object_class
->finalize
= g_test_dbus_finalize
;
510 object_class
->get_property
= g_test_dbus_get_property
;
511 object_class
->set_property
= g_test_dbus_set_property
;
516 * #GTestDBusFlags specifying the behaviour of the dbus session
520 g_object_class_install_property (object_class
, PROP_FLAGS
,
521 g_param_spec_flags ("flags",
522 P_("dbus session flags"),
523 P_("Flags specifying the behaviour of the dbus session"),
524 G_TYPE_TEST_DBUS_FLAGS
, G_TEST_DBUS_NONE
,
525 G_PARAM_READWRITE
| G_PARAM_CONSTRUCT_ONLY
|
526 G_PARAM_STATIC_STRINGS
));
531 write_config_file (GTestDBus
*self
)
536 GError
*error
= NULL
;
539 fd
= g_file_open_tmp ("g-test-dbus-XXXXXX", &path
, &error
);
540 g_assert_no_error (error
);
542 contents
= g_string_new (NULL
);
543 g_string_append (contents
,
545 " <type>session</type>\n"
547 " <listen>nonce-tcp:</listen>\n"
549 " <listen>unix:tmpdir=/tmp</listen>\n"
553 for (i
= 0; i
< self
->priv
->service_dirs
->len
; i
++)
555 const gchar
*path
= g_ptr_array_index (self
->priv
->service_dirs
, i
);
557 g_string_append_printf (contents
,
558 " <servicedir>%s</servicedir>\n", path
);
561 g_string_append (contents
,
562 " <policy context=\"default\">\n"
563 " <!-- Allow everything to be sent -->\n"
564 " <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
565 " <!-- Allow everything to be received -->\n"
566 " <allow eavesdrop=\"true\"/>\n"
567 " <!-- Allow anyone to own anything -->\n"
568 " <allow own=\"*\"/>\n"
572 g_file_set_contents (path
, contents
->str
, contents
->len
, &error
);
573 g_assert_no_error (error
);
575 g_string_free (contents
, TRUE
);
583 start_daemon (GTestDBus
*self
)
585 gchar
*argv
[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL
};
591 GError
*error
= NULL
;
593 if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL
)
594 argv
[0] = (gchar
*)g_getenv ("G_TEST_DBUS_DAEMON");
596 /* Write config file and set its path in argv */
597 config_path
= write_config_file (self
);
598 config_arg
= g_strdup_printf ("--config-file=%s", config_path
);
599 argv
[2] = config_arg
;
601 /* Spawn dbus-daemon */
602 g_spawn_async_with_pipes (NULL
,
606 /* We Need this to get the pid returned on win32 */
607 G_SPAWN_DO_NOT_REAP_CHILD
|
612 &self
->priv
->bus_pid
,
617 g_assert_no_error (error
);
619 _g_test_watcher_add_pid (self
->priv
->bus_pid
);
621 /* Read bus address from daemon' stdout */
622 channel
= g_io_channel_unix_new (stdout_fd
);
623 g_io_channel_read_line (channel
, &self
->priv
->bus_address
, NULL
,
625 g_assert_no_error (error
);
626 self
->priv
->bus_address
[termpos
] = '\0';
628 /* start dbus-monitor */
629 if (g_getenv ("G_DBUS_MONITOR") != NULL
)
633 command
= g_strdup_printf ("dbus-monitor --address %s",
634 self
->priv
->bus_address
);
635 g_spawn_command_line_async (command
, NULL
);
638 g_usleep (500 * 1000);
642 g_io_channel_shutdown (channel
, FALSE
, &error
);
643 g_assert_no_error (error
);
644 g_io_channel_unref (channel
);
646 /* Don't use g_file_delete since it calls into gvfs */
647 if (g_unlink (config_path
) != 0)
648 g_assert_not_reached ();
650 g_free (config_path
);
655 stop_daemon (GTestDBus
*self
)
658 if (!TerminateProcess (self
->priv
->bus_pid
, 0))
659 g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
661 kill (self
->priv
->bus_pid
, SIGTERM
);
663 _g_test_watcher_remove_pid (self
->priv
->bus_pid
);
664 g_spawn_close_pid (self
->priv
->bus_pid
);
665 self
->priv
->bus_pid
= 0;
667 g_free (self
->priv
->bus_address
);
668 self
->priv
->bus_address
= NULL
;
673 * @flags: a #GTestDBusFlags
675 * Create a new #GTestDBus object.
677 * Returns: (transfer full): a new #GTestDBus.
680 g_test_dbus_new (GTestDBusFlags flags
)
682 return g_object_new (G_TYPE_TEST_DBUS
,
688 * g_test_dbus_get_flags:
689 * @self: a #GTestDBus
691 * Gets the flags of the #GTestDBus object.
693 * Returns: the value of #GTestDBus:flags property
696 g_test_dbus_get_flags (GTestDBus
*self
)
698 g_return_val_if_fail (G_IS_TEST_DBUS (self
), G_TEST_DBUS_NONE
);
700 return self
->priv
->flags
;
704 * g_test_dbus_get_bus_address:
705 * @self: a #GTestDBus
707 * Get the address on which dbus-daemon is running. if g_test_dbus_up() has not
708 * been called yet, %NULL is returned. This can be used with
709 * g_dbus_connection_new_for_address()
711 * Returns: the address of the bus, or %NULL.
714 g_test_dbus_get_bus_address (GTestDBus
*self
)
716 g_return_val_if_fail (G_IS_TEST_DBUS (self
), NULL
);
718 return self
->priv
->bus_address
;
722 * g_test_dbus_add_service_dir:
723 * @self: a #GTestDBus
724 * @path: path to a directory containing .service files
726 * Add a path where dbus-daemon will lookup for .services files. This can't be
727 * called after g_test_dbus_up().
730 g_test_dbus_add_service_dir (GTestDBus
*self
,
733 g_return_if_fail (G_IS_TEST_DBUS (self
));
734 g_return_if_fail (self
->priv
->bus_address
== NULL
);
736 g_ptr_array_add (self
->priv
->service_dirs
, g_strdup (path
));
741 * @self: a #GTestDBus
743 * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
744 * call, it is safe for unit tests to start sending messages on the session bus.
746 * If this function is called from setup callback of g_test_add(),
747 * g_test_dbus_down() must be called in its teardown callback.
749 * If this function is called from unit test's main(), then g_test_dbus_down()
750 * must be called after g_test_run().
753 g_test_dbus_up (GTestDBus
*self
)
755 g_return_if_fail (G_IS_TEST_DBUS (self
));
756 g_return_if_fail (self
->priv
->bus_address
== NULL
);
757 g_return_if_fail (!self
->priv
->up
);
761 g_setenv ("DBUS_SESSION_BUS_ADDRESS", self
->priv
->bus_address
, TRUE
);
762 self
->priv
->up
= TRUE
;
768 * @self: a #GTestDBus
770 * Stop the session bus started by g_test_dbus_up().
772 * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
773 * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
774 * tests wanting to verify behaviour after the session bus has been stopped
775 * can use this function but should still call g_test_dbus_down() when done.
778 g_test_dbus_stop (GTestDBus
*self
)
780 g_return_if_fail (G_IS_TEST_DBUS (self
));
781 g_return_if_fail (self
->priv
->bus_address
!= NULL
);
788 * @self: a #GTestDBus
790 * Stop the session bus started by g_test_dbus_up().
792 * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
793 * is destroyed. This is done to ensure that the next unit test won't get a
794 * leaked singleton from this test.
797 g_test_dbus_down (GTestDBus
*self
)
799 GDBusConnection
*connection
;
801 g_return_if_fail (G_IS_TEST_DBUS (self
));
802 g_return_if_fail (self
->priv
->up
);
804 connection
= _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION
);
805 if (connection
!= NULL
)
806 g_dbus_connection_set_exit_on_close (connection
, FALSE
);
808 if (self
->priv
->bus_address
!= NULL
)
811 if (connection
!= NULL
)
812 _g_object_unref_and_wait_weak_notify (connection
);
814 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
815 self
->priv
->up
= FALSE
;
821 * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
822 * won't use user's session bus.
824 * This is useful for unit tests that want to verify behaviour when no session
825 * bus is running. It is not necessary to call this if unit test already calls
826 * g_test_dbus_up() before acquiring the session bus.
829 g_test_dbus_unset (void)
831 g_unsetenv ("DISPLAY");
832 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");