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
323 typedef struct _GTestDBusClass GTestDBusClass
;
324 typedef struct _GTestDBusPrivate GTestDBusPrivate
;
329 * The #GTestDBus structure contains only private data and
330 * should only be accessed using the provided API.
337 GTestDBusPrivate
*priv
;
340 struct _GTestDBusClass
{
341 GObjectClass parent_class
;
344 struct _GTestDBusPrivate
346 GTestDBusFlags flags
;
347 GPtrArray
*service_dirs
;
359 G_DEFINE_TYPE (GTestDBus
, g_test_dbus
, G_TYPE_OBJECT
)
362 g_test_dbus_init (GTestDBus
*self
)
364 self
->priv
= G_TYPE_INSTANCE_GET_PRIVATE ((self
), G_TYPE_TEST_DBUS
,
367 self
->priv
->service_dirs
= g_ptr_array_new_with_free_func (g_free
);
371 g_test_dbus_dispose (GObject
*object
)
373 GTestDBus
*self
= (GTestDBus
*) object
;
376 g_test_dbus_down (self
);
378 G_OBJECT_CLASS (g_test_dbus_parent_class
)->dispose (object
);
382 g_test_dbus_finalize (GObject
*object
)
384 GTestDBus
*self
= (GTestDBus
*) object
;
386 g_ptr_array_unref (self
->priv
->service_dirs
);
387 g_free (self
->priv
->bus_address
);
389 G_OBJECT_CLASS (g_test_dbus_parent_class
)->finalize (object
);
393 g_test_dbus_get_property (GObject
*object
,
398 GTestDBus
*self
= (GTestDBus
*) object
;
403 g_value_set_flags (value
, g_test_dbus_get_flags (self
));
406 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, property_id
, pspec
);
412 g_test_dbus_set_property (GObject
*object
,
417 GTestDBus
*self
= (GTestDBus
*) object
;
422 self
->priv
->flags
= g_value_get_flags (value
);
425 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, property_id
, pspec
);
431 g_test_dbus_class_init (GTestDBusClass
*klass
)
433 GObjectClass
*object_class
= G_OBJECT_CLASS (klass
);
435 object_class
->dispose
= g_test_dbus_dispose
;
436 object_class
->finalize
= g_test_dbus_finalize
;
437 object_class
->get_property
= g_test_dbus_get_property
;
438 object_class
->set_property
= g_test_dbus_set_property
;
440 g_type_class_add_private (object_class
, sizeof (GTestDBusPrivate
));
445 * #GTestDBusFlags specifying the behaviour of the dbus session
449 g_object_class_install_property (object_class
, PROP_FLAGS
,
450 g_param_spec_flags ("flags",
451 P_("dbus session flags"),
452 P_("Flags specifying the behaviour of the dbus session"),
453 G_TYPE_TEST_DBUS_FLAGS
, G_TEST_DBUS_NONE
,
454 G_PARAM_READWRITE
| G_PARAM_CONSTRUCT_ONLY
|
455 G_PARAM_STATIC_STRINGS
));
460 write_config_file (GTestDBus
*self
)
465 GError
*error
= NULL
;
468 fd
= g_file_open_tmp ("g-test-dbus-XXXXXX", &path
, &error
);
469 g_assert_no_error (error
);
471 contents
= g_string_new (NULL
);
472 g_string_append (contents
,
474 " <type>session</type>\n"
476 " <listen>nonce-tcp:</listen>\n"
478 " <listen>unix:tmpdir=/tmp</listen>\n"
482 for (i
= 0; i
< self
->priv
->service_dirs
->len
; i
++)
484 const gchar
*path
= g_ptr_array_index (self
->priv
->service_dirs
, i
);
486 g_string_append_printf (contents
,
487 " <servicedir>%s</servicedir>\n", path
);
490 g_string_append (contents
,
491 " <policy context=\"default\">\n"
492 " <!-- Allow everything to be sent -->\n"
493 " <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
494 " <!-- Allow everything to be received -->\n"
495 " <allow eavesdrop=\"true\"/>\n"
496 " <!-- Allow anyone to own anything -->\n"
497 " <allow own=\"*\"/>\n"
501 g_file_set_contents (path
, contents
->str
, contents
->len
, &error
);
502 g_assert_no_error (error
);
504 g_string_free (contents
, TRUE
);
512 start_daemon (GTestDBus
*self
)
514 gchar
*argv
[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL
};
520 GError
*error
= NULL
;
522 if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL
)
523 argv
[0] = (gchar
*)g_getenv ("G_TEST_DBUS_DAEMON");
525 /* Write config file and set its path in argv */
526 config_path
= write_config_file (self
);
527 config_arg
= g_strdup_printf ("--config-file=%s", config_path
);
528 argv
[2] = config_arg
;
530 /* Spawn dbus-daemon */
531 g_spawn_async_with_pipes (NULL
,
535 /* We Need this to get the pid returned on win32 */
536 G_SPAWN_DO_NOT_REAP_CHILD
|
541 &self
->priv
->bus_pid
,
546 g_assert_no_error (error
);
548 _g_test_watcher_add_pid (self
->priv
->bus_pid
);
550 /* Read bus address from daemon' stdout */
551 channel
= g_io_channel_unix_new (stdout_fd
);
552 g_io_channel_read_line (channel
, &self
->priv
->bus_address
, NULL
,
554 g_assert_no_error (error
);
555 self
->priv
->bus_address
[termpos
] = '\0';
557 /* start dbus-monitor */
558 if (g_getenv ("G_DBUS_MONITOR") != NULL
)
562 command
= g_strdup_printf ("dbus-monitor --address %s",
563 self
->priv
->bus_address
);
564 g_spawn_command_line_async (command
, NULL
);
567 g_usleep (500 * 1000);
571 g_io_channel_shutdown (channel
, FALSE
, &error
);
572 g_assert_no_error (error
);
573 g_io_channel_unref (channel
);
575 /* Don't use g_file_delete since it calls into gvfs */
576 if (g_unlink (config_path
) != 0)
577 g_assert_not_reached ();
579 g_free (config_path
);
584 stop_daemon (GTestDBus
*self
)
587 if (!TerminateProcess (self
->priv
->bus_pid
, 0))
588 g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
590 kill (self
->priv
->bus_pid
, SIGTERM
);
592 _g_test_watcher_remove_pid (self
->priv
->bus_pid
);
593 g_spawn_close_pid (self
->priv
->bus_pid
);
594 self
->priv
->bus_pid
= 0;
596 g_free (self
->priv
->bus_address
);
597 self
->priv
->bus_address
= NULL
;
602 * @flags: a #GTestDBusFlags
604 * Create a new #GTestDBus object.
606 * Returns: (transfer full): a new #GTestDBus.
609 g_test_dbus_new (GTestDBusFlags flags
)
611 return g_object_new (G_TYPE_TEST_DBUS
,
617 * g_test_dbus_get_flags:
618 * @self: a #GTestDBus
620 * Gets the flags of the #GTestDBus object.
622 * Returns: the value of #GTestDBus:flags property
625 g_test_dbus_get_flags (GTestDBus
*self
)
627 g_return_val_if_fail (G_IS_TEST_DBUS (self
), G_TEST_DBUS_NONE
);
629 return self
->priv
->flags
;
633 * g_test_dbus_get_bus_address:
634 * @self: a #GTestDBus
636 * Get the address on which dbus-daemon is running. if g_test_dbus_up() has not
637 * been called yet, %NULL is returned. This can be used with
638 * g_dbus_connection_new_for_address()
640 * Returns: the address of the bus, or %NULL.
643 g_test_dbus_get_bus_address (GTestDBus
*self
)
645 g_return_val_if_fail (G_IS_TEST_DBUS (self
), NULL
);
647 return self
->priv
->bus_address
;
651 * g_test_dbus_add_service_dir:
652 * @self: a #GTestDBus
653 * @path: path to a directory containing .service files
655 * Add a path where dbus-daemon will lookup for .services files. This can't be
656 * called after g_test_dbus_up().
659 g_test_dbus_add_service_dir (GTestDBus
*self
,
662 g_return_if_fail (G_IS_TEST_DBUS (self
));
663 g_return_if_fail (self
->priv
->bus_address
== NULL
);
665 g_ptr_array_add (self
->priv
->service_dirs
, g_strdup (path
));
670 * @self: a #GTestDBus
672 * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
673 * call, it is safe for unit tests to start sending messages on the session bus.
675 * If this function is called from setup callback of g_test_add(),
676 * g_test_dbus_down() must be called in its teardown callback.
678 * If this function is called from unit test's main(), then g_test_dbus_down()
679 * must be called after g_test_run().
682 g_test_dbus_up (GTestDBus
*self
)
684 g_return_if_fail (G_IS_TEST_DBUS (self
));
685 g_return_if_fail (self
->priv
->bus_address
== NULL
);
686 g_return_if_fail (!self
->priv
->up
);
690 g_setenv ("DBUS_SESSION_BUS_ADDRESS", self
->priv
->bus_address
, TRUE
);
691 self
->priv
->up
= TRUE
;
697 * @self: a #GTestDBus
699 * Stop the session bus started by g_test_dbus_up().
701 * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
702 * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
703 * tests wanting to verify behaviour after the session bus has been stopped
704 * can use this function but should still call g_test_dbus_down() when done.
707 g_test_dbus_stop (GTestDBus
*self
)
709 g_return_if_fail (G_IS_TEST_DBUS (self
));
710 g_return_if_fail (self
->priv
->bus_address
!= NULL
);
717 * @self: a #GTestDBus
719 * Stop the session bus started by g_test_dbus_up().
721 * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
722 * is destroyed. This is done to ensure that the next unit test won't get a
723 * leaked singleton from this test.
726 g_test_dbus_down (GTestDBus
*self
)
728 GDBusConnection
*connection
;
730 g_return_if_fail (G_IS_TEST_DBUS (self
));
731 g_return_if_fail (self
->priv
->up
);
733 connection
= _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION
);
734 if (connection
!= NULL
)
735 g_dbus_connection_set_exit_on_close (connection
, FALSE
);
737 if (self
->priv
->bus_address
!= NULL
)
740 if (connection
!= NULL
)
741 _g_object_unref_and_wait_weak_notify (connection
);
743 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
744 self
->priv
->up
= FALSE
;
750 * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
751 * won't use user's session bus.
753 * This is useful for unit tests that want to verify behaviour when no session
754 * bus is running. It is not necessary to call this if unit test already calls
755 * g_test_dbus_up() before acquiring the session bus.
758 g_test_dbus_unset (void)
760 g_unsetenv ("DISPLAY");
761 g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");