1 /* GLib testing framework examples and tests
3 * Copyright (C) 2008-2010 Red Hat, Inc.
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
16 * Public 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.
20 * Author: David Zeuthen <davidz@redhat.com>
27 #include "gdbus-tests.h"
29 /* all tests rely on a shared mainloop */
30 static GMainLoop *loop = NULL;
32 static GDBusConnection *c = NULL;
34 /* ---------------------------------------------------------------------------------------------------- */
35 /* Test that we can export objects, the hierarchy is correct and the right handlers are invoked */
36 /* ---------------------------------------------------------------------------------------------------- */
38 static const GDBusArgInfo foo_method1_in_args =
45 static const GDBusArgInfo * const foo_method1_in_arg_pointers[] = {&foo_method1_in_args, NULL};
47 static const GDBusArgInfo foo_method1_out_args =
54 static const GDBusArgInfo * const foo_method1_out_arg_pointers[] = {&foo_method1_out_args, NULL};
56 static const GDBusMethodInfo foo_method_info_method1 =
60 (GDBusArgInfo **) &foo_method1_in_arg_pointers,
61 (GDBusArgInfo **) &foo_method1_out_arg_pointers,
64 static const GDBusMethodInfo foo_method_info_method2 =
72 static const GDBusMethodInfo * const foo_method_info_pointers[] = {&foo_method_info_method1, &foo_method_info_method2, NULL};
74 static const GDBusSignalInfo foo_signal_info =
81 static const GDBusSignalInfo * const foo_signal_info_pointers[] = {&foo_signal_info, NULL};
83 static const GDBusPropertyInfo foo_property_info[] =
89 G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE,
96 G_DBUS_PROPERTY_INFO_FLAGS_READABLE,
103 G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE,
107 static const GDBusPropertyInfo * const foo_property_info_pointers[] =
109 &foo_property_info[0],
110 &foo_property_info[1],
111 &foo_property_info[2],
115 static const GDBusInterfaceInfo foo_interface_info =
119 (GDBusMethodInfo **) &foo_method_info_pointers,
120 (GDBusSignalInfo **) &foo_signal_info_pointers,
121 (GDBusPropertyInfo **)&foo_property_info_pointers,
126 foo_method_call (GDBusConnection *connection,
128 const gchar *object_path,
129 const gchar *interface_name,
130 const gchar *method_name,
131 GVariant *parameters,
132 GDBusMethodInvocation *invocation,
135 if (g_strcmp0 (method_name, "Method1") == 0)
139 g_variant_get (parameters, "(&s)", &input);
140 output = g_strdup_printf ("You passed the string `%s'. Jolly good!", input);
141 g_dbus_method_invocation_return_value (invocation, g_variant_new ("(s)", output));
146 g_dbus_method_invocation_return_dbus_error (invocation,
147 "org.example.SomeError",
148 "How do you like them apples, buddy!");
153 foo_get_property (GDBusConnection *connection,
155 const gchar *object_path,
156 const gchar *interface_name,
157 const gchar *property_name,
163 s = g_strdup_printf ("Property `%s' Is What It Is!", property_name);
164 ret = g_variant_new_string (s);
170 foo_set_property (GDBusConnection *connection,
172 const gchar *object_path,
173 const gchar *interface_name,
174 const gchar *property_name,
180 s = g_variant_print (value, TRUE);
183 G_DBUS_ERROR_SPAWN_FILE_INVALID,
184 "Returning some error instead of writing the value `%s' to the property `%s'",
190 static const GDBusInterfaceVTable foo_vtable =
197 /* -------------------- */
199 static const GDBusMethodInfo bar_method_info[] =
216 static const GDBusMethodInfo * const bar_method_info_pointers[] = {&bar_method_info[0], &bar_method_info[1], NULL};
218 static const GDBusSignalInfo bar_signal_info[] =
227 static const GDBusSignalInfo * const bar_signal_info_pointers[] = {&bar_signal_info[0], NULL};
229 static const GDBusPropertyInfo bar_property_info[] =
235 G_DBUS_PROPERTY_INFO_FLAGS_READABLE,
239 static const GDBusPropertyInfo * const bar_property_info_pointers[] = {&bar_property_info[0], NULL};
241 static const GDBusInterfaceInfo bar_interface_info =
245 (GDBusMethodInfo **) bar_method_info_pointers,
246 (GDBusSignalInfo **) bar_signal_info_pointers,
247 (GDBusPropertyInfo **) bar_property_info_pointers,
251 /* -------------------- */
253 static const GDBusMethodInfo dyna_method_info[] =
263 static const GDBusMethodInfo * const dyna_method_info_pointers[] = {&dyna_method_info[0], NULL};
265 static const GDBusInterfaceInfo dyna_interface_info =
269 (GDBusMethodInfo **) dyna_method_info_pointers,
270 NULL, /* no signals */
271 NULL, /* no properties */
276 dyna_cyber (GDBusConnection *connection,
278 const gchar *object_path,
279 const gchar *interface_name,
280 const gchar *method_name,
281 GVariant *parameters,
282 GDBusMethodInvocation *invocation,
285 GPtrArray *data = user_data;
289 node_name = strrchr (object_path, '/') + 1;
291 /* Add new node if it is not already known */
292 for (n = 0; n < data->len ; n++)
294 if (g_strcmp0 (g_ptr_array_index (data, n), node_name) == 0)
297 g_ptr_array_add (data, g_strdup(node_name));
300 g_dbus_method_invocation_return_value (invocation, NULL);
303 static const GDBusInterfaceVTable dyna_interface_vtable =
310 /* ---------------------------------------------------------------------------------------------------- */
313 introspect_callback (GDBusProxy *proxy,
317 gchar **xml_data = user_data;
322 result = g_dbus_proxy_call_finish (proxy,
325 g_assert_no_error (error);
326 g_assert (result != NULL);
327 g_variant_get (result, "(s)", xml_data);
328 g_variant_unref (result);
330 g_main_loop_quit (loop);
334 get_nodes_at (GDBusConnection *c,
335 const gchar *object_path)
341 GDBusNodeInfo *node_info;
345 proxy = g_dbus_proxy_new_sync (c,
346 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
347 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
349 g_dbus_connection_get_unique_name (c),
351 "org.freedesktop.DBus.Introspectable",
354 g_assert_no_error (error);
355 g_assert (proxy != NULL);
357 /* do this async to avoid libdbus-1 deadlocks */
359 g_dbus_proxy_call (proxy,
362 G_DBUS_CALL_FLAGS_NONE,
365 (GAsyncReadyCallback) introspect_callback,
367 g_main_loop_run (loop);
368 g_assert (xml_data != NULL);
370 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
371 g_assert_no_error (error);
372 g_assert (node_info != NULL);
374 p = g_ptr_array_new ();
375 for (n = 0; node_info->nodes != NULL && node_info->nodes[n] != NULL; n++)
377 const GDBusNodeInfo *sub_node_info = node_info->nodes[n];
378 g_ptr_array_add (p, g_strdup (sub_node_info->path));
380 g_ptr_array_add (p, NULL);
382 g_object_unref (proxy);
384 g_dbus_node_info_unref (node_info);
386 return (gchar **) g_ptr_array_free (p, FALSE);
390 has_interface (GDBusConnection *c,
391 const gchar *object_path,
392 const gchar *interface_name)
397 GDBusNodeInfo *node_info;
401 proxy = g_dbus_proxy_new_sync (c,
402 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
403 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
405 g_dbus_connection_get_unique_name (c),
407 "org.freedesktop.DBus.Introspectable",
410 g_assert_no_error (error);
411 g_assert (proxy != NULL);
413 /* do this async to avoid libdbus-1 deadlocks */
415 g_dbus_proxy_call (proxy,
418 G_DBUS_CALL_FLAGS_NONE,
421 (GAsyncReadyCallback) introspect_callback,
423 g_main_loop_run (loop);
424 g_assert (xml_data != NULL);
426 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
427 g_assert_no_error (error);
428 g_assert (node_info != NULL);
430 ret = (g_dbus_node_info_lookup_interface (node_info, interface_name) != NULL);
432 g_object_unref (proxy);
434 g_dbus_node_info_unref (node_info);
440 count_interfaces (GDBusConnection *c,
441 const gchar *object_path)
446 GDBusNodeInfo *node_info;
450 proxy = g_dbus_proxy_new_sync (c,
451 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
452 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
454 g_dbus_connection_get_unique_name (c),
456 "org.freedesktop.DBus.Introspectable",
459 g_assert_no_error (error);
460 g_assert (proxy != NULL);
462 /* do this async to avoid libdbus-1 deadlocks */
464 g_dbus_proxy_call (proxy,
467 G_DBUS_CALL_FLAGS_NONE,
470 (GAsyncReadyCallback) introspect_callback,
472 g_main_loop_run (loop);
473 g_assert (xml_data != NULL);
475 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
476 g_assert_no_error (error);
477 g_assert (node_info != NULL);
480 while (node_info->interfaces != NULL && node_info->interfaces[ret] != NULL)
483 g_object_unref (proxy);
485 g_dbus_node_info_unref (node_info);
491 dyna_create_callback (GDBusProxy *proxy,
499 result = g_dbus_proxy_call_finish (proxy,
502 g_assert_no_error (error);
503 g_assert (result != NULL);
504 g_variant_unref (result);
506 g_main_loop_quit (loop);
509 /* Dynamically create @object_name under /foo/dyna */
511 dyna_create (GDBusConnection *c,
512 const gchar *object_name)
518 object_path = g_strconcat ("/foo/dyna/", object_name, NULL);
521 proxy = g_dbus_proxy_new_sync (c,
522 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
523 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
525 g_dbus_connection_get_unique_name (c),
530 g_assert_no_error (error);
531 g_assert (proxy != NULL);
533 /* do this async to avoid libdbus-1 deadlocks */
534 g_dbus_proxy_call (proxy,
536 g_variant_new ("()"),
537 G_DBUS_CALL_FLAGS_NONE,
540 (GAsyncReadyCallback) dyna_create_callback,
542 g_main_loop_run (loop);
544 g_assert_no_error (error);
546 g_object_unref (proxy);
547 g_free (object_path);
554 guint num_unregistered_calls;
555 guint num_unregistered_subtree_calls;
556 guint num_subtree_nodes;
557 } ObjectRegistrationData;
560 on_object_unregistered (gpointer user_data)
562 ObjectRegistrationData *data = user_data;
564 data->num_unregistered_calls++;
568 on_subtree_unregistered (gpointer user_data)
570 ObjectRegistrationData *data = user_data;
572 data->num_unregistered_subtree_calls++;
576 _g_strv_has_string (const gchar* const * haystack,
581 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
583 if (g_strcmp0 (haystack[n], needle) == 0)
589 /* -------------------- */
592 subtree_enumerate (GDBusConnection *connection,
594 const gchar *object_path,
597 ObjectRegistrationData *data = user_data;
602 p = g_ptr_array_new ();
604 for (n = 0; n < data->num_subtree_nodes; n++)
606 g_ptr_array_add (p, g_strdup_printf ("vp%d", n));
607 g_ptr_array_add (p, g_strdup_printf ("evp%d", n));
609 g_ptr_array_add (p, NULL);
611 nodes = (gchar **) g_ptr_array_free (p, FALSE);
616 /* Only allows certain objects, and aborts on unknowns */
617 static GDBusInterfaceInfo **
618 subtree_introspect (GDBusConnection *connection,
620 const gchar *object_path,
624 const GDBusInterfaceInfo *interfaces[2] = {
625 NULL /* filled in below */, NULL
628 /* VPs implement the Foo interface, EVPs implement the Bar interface. The root
629 * does not implement any interfaces
635 else if (g_str_has_prefix (node, "vp"))
637 interfaces[0] = &foo_interface_info;
639 else if (g_str_has_prefix (node, "evp"))
641 interfaces[0] = &bar_interface_info;
645 g_assert_not_reached ();
648 return g_memdup (interfaces, 2 * sizeof (void *));
651 static const GDBusInterfaceVTable *
652 subtree_dispatch (GDBusConnection *connection,
654 const gchar *object_path,
655 const gchar *interface_name,
657 gpointer *out_user_data,
660 if (g_strcmp0 (interface_name, "org.example.Foo") == 0)
666 static const GDBusSubtreeVTable subtree_vtable =
673 /* -------------------- */
676 dynamic_subtree_enumerate (GDBusConnection *connection,
678 const gchar *object_path,
681 GPtrArray *data = user_data;
682 gchar **nodes = g_new (gchar*, data->len + 1);
685 for (n = 0; n < data->len; n++)
687 nodes[n] = g_strdup (g_ptr_array_index (data, n));
689 nodes[data->len] = NULL;
694 /* Allow all objects to be introspected */
695 static GDBusInterfaceInfo **
696 dynamic_subtree_introspect (GDBusConnection *connection,
698 const gchar *object_path,
702 const GDBusInterfaceInfo *interfaces[2] = { &dyna_interface_info, NULL };
704 return g_memdup (interfaces, 2 * sizeof (void *));
707 static const GDBusInterfaceVTable *
708 dynamic_subtree_dispatch (GDBusConnection *connection,
710 const gchar *object_path,
711 const gchar *interface_name,
713 gpointer *out_user_data,
716 *out_user_data = user_data;
717 return &dyna_interface_vtable;
720 static const GDBusSubtreeVTable dynamic_subtree_vtable =
722 dynamic_subtree_enumerate,
723 dynamic_subtree_introspect,
724 dynamic_subtree_dispatch
727 /* -------------------- */
730 test_dispatch_thread_func (gpointer user_data)
732 const gchar *object_path = user_data;
733 GDBusProxy *foo_proxy;
738 const gchar *value_str;
740 foo_proxy = g_dbus_proxy_new_sync (c,
741 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS |
742 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES,
744 g_dbus_connection_get_unique_name (c),
749 g_assert (foo_proxy != NULL);
751 /* generic interfaces */
753 value = g_dbus_proxy_call_sync (foo_proxy,
754 "org.freedesktop.DBus.Peer.Ping",
756 G_DBUS_CALL_FLAGS_NONE,
760 g_assert_no_error (error);
761 g_assert (value != NULL);
762 g_variant_unref (value);
766 value = g_dbus_proxy_call_sync (foo_proxy,
768 g_variant_new ("(s)", "winwinwin"),
769 G_DBUS_CALL_FLAGS_NONE,
773 g_assert_no_error (error);
774 g_assert (value != NULL);
775 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(s)")));
776 g_variant_get (value, "(&s)", &value_str);
777 g_assert_cmpstr (value_str, ==, "You passed the string `winwinwin'. Jolly good!");
778 g_variant_unref (value);
781 value = g_dbus_proxy_call_sync (foo_proxy,
784 G_DBUS_CALL_FLAGS_NONE,
788 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_DBUS_ERROR);
789 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.example.SomeError: How do you like them apples, buddy!");
790 g_error_free (error);
791 g_assert (value == NULL);
794 value = g_dbus_proxy_call_sync (foo_proxy,
796 g_variant_new ("(s)", "failfailfail"),
797 G_DBUS_CALL_FLAGS_NONE,
801 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
802 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Type of message, `(s)', does not match expected type `()'");
803 g_error_free (error);
804 g_assert (value == NULL);
807 value = g_dbus_proxy_call_sync (foo_proxy,
810 G_DBUS_CALL_FLAGS_NONE,
814 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_UNKNOWN_METHOD);
815 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.UnknownMethod: No such method `NonExistantMethod'");
816 g_error_free (error);
817 g_assert (value == NULL);
820 value = g_dbus_proxy_call_sync (foo_proxy,
821 "org.example.FooXYZ.NonExistant",
823 G_DBUS_CALL_FLAGS_NONE,
827 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_UNKNOWN_METHOD);
828 g_error_free (error);
829 g_assert (value == NULL);
831 /* user properties */
833 value = g_dbus_proxy_call_sync (foo_proxy,
834 "org.freedesktop.DBus.Properties.Get",
835 g_variant_new ("(ss)",
838 G_DBUS_CALL_FLAGS_NONE,
842 g_assert_no_error (error);
843 g_assert (value != NULL);
844 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(v)")));
845 g_variant_get (value, "(v)", &inner);
846 g_assert (g_variant_is_of_type (inner, G_VARIANT_TYPE_STRING));
847 g_assert_cmpstr (g_variant_get_string (inner, NULL), ==, "Property `PropertyUno' Is What It Is!");
848 g_variant_unref (value);
851 value = g_dbus_proxy_call_sync (foo_proxy,
852 "org.freedesktop.DBus.Properties.Get",
853 g_variant_new ("(ss)",
856 G_DBUS_CALL_FLAGS_NONE,
860 g_assert (value == NULL);
861 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
862 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: No such property `ThisDoesntExist'");
863 g_error_free (error);
866 value = g_dbus_proxy_call_sync (foo_proxy,
867 "org.freedesktop.DBus.Properties.Get",
868 g_variant_new ("(ss)",
871 G_DBUS_CALL_FLAGS_NONE,
875 g_assert (value == NULL);
876 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
877 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Property `NotReadable' is not readable");
878 g_error_free (error);
881 value = g_dbus_proxy_call_sync (foo_proxy,
882 "org.freedesktop.DBus.Properties.Set",
883 g_variant_new ("(ssv)",
886 g_variant_new_string ("But Writable you are!")),
887 G_DBUS_CALL_FLAGS_NONE,
891 g_assert (value == NULL);
892 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_SPAWN_FILE_INVALID);
893 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.Spawn.FileInvalid: Returning some error instead of writing the value `NotReadable' to the property `'But Writable you are!''");
894 g_error_free (error);
897 value = g_dbus_proxy_call_sync (foo_proxy,
898 "org.freedesktop.DBus.Properties.Set",
899 g_variant_new ("(ssv)",
902 g_variant_new_uint32 (42)),
903 G_DBUS_CALL_FLAGS_NONE,
907 g_assert (value == NULL);
908 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
909 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Property `NotWritable' is not writable");
910 g_error_free (error);
913 value = g_dbus_proxy_call_sync (foo_proxy,
914 "org.freedesktop.DBus.Properties.GetAll",
915 g_variant_new ("(s)",
917 G_DBUS_CALL_FLAGS_NONE,
921 g_assert_no_error (error);
922 g_assert (value != NULL);
923 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(a{sv})")));
924 s = g_variant_print (value, TRUE);
925 g_assert_cmpstr (s, ==, "({'PropertyUno': <\"Property `PropertyUno' Is What It Is!\">, 'NotWritable': <\"Property `NotWritable' Is What It Is!\">},)");
927 g_variant_unref (value);
929 g_object_unref (foo_proxy);
931 g_main_loop_quit (loop);
936 test_dispatch (const gchar *object_path)
941 /* run this in a thread to avoid deadlocks */
943 thread = g_thread_create (test_dispatch_thread_func,
944 (gpointer) object_path,
947 g_assert_no_error (error);
948 g_assert (thread != NULL);
949 g_main_loop_run (loop);
950 g_thread_join (thread);
954 test_object_registration (void)
957 ObjectRegistrationData data;
958 GPtrArray *dyna_data;
960 guint boss_foo_reg_id;
961 guint boss_bar_reg_id;
962 guint worker1_foo_reg_id;
963 guint worker1p1_foo_reg_id;
964 guint worker2_bar_reg_id;
965 guint intern1_foo_reg_id;
966 guint intern2_bar_reg_id;
967 guint intern2_foo_reg_id;
968 guint intern3_bar_reg_id;
969 guint registration_id;
970 guint subtree_registration_id;
971 guint non_subtree_object_path_foo_reg_id;
972 guint non_subtree_object_path_bar_reg_id;
973 guint dyna_subtree_registration_id;
974 guint num_successful_registrations;
976 data.num_unregistered_calls = 0;
977 data.num_unregistered_subtree_calls = 0;
978 data.num_subtree_nodes = 0;
980 num_successful_registrations = 0;
983 c = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
984 g_assert_no_error (error);
985 g_assert (c != NULL);
987 registration_id = g_dbus_connection_register_object (c,
989 (GDBusInterfaceInfo *) &foo_interface_info,
992 on_object_unregistered,
994 g_assert_no_error (error);
995 g_assert (registration_id > 0);
996 boss_foo_reg_id = registration_id;
997 num_successful_registrations++;
999 registration_id = g_dbus_connection_register_object (c,
1001 (GDBusInterfaceInfo *) &bar_interface_info,
1004 on_object_unregistered,
1006 g_assert_no_error (error);
1007 g_assert (registration_id > 0);
1008 boss_bar_reg_id = registration_id;
1009 num_successful_registrations++;
1011 registration_id = g_dbus_connection_register_object (c,
1012 "/foo/boss/worker1",
1013 (GDBusInterfaceInfo *) &foo_interface_info,
1016 on_object_unregistered,
1018 g_assert_no_error (error);
1019 g_assert (registration_id > 0);
1020 worker1_foo_reg_id = registration_id;
1021 num_successful_registrations++;
1023 registration_id = g_dbus_connection_register_object (c,
1024 "/foo/boss/worker1p1",
1025 (GDBusInterfaceInfo *) &foo_interface_info,
1028 on_object_unregistered,
1030 g_assert_no_error (error);
1031 g_assert (registration_id > 0);
1032 worker1p1_foo_reg_id = registration_id;
1033 num_successful_registrations++;
1035 registration_id = g_dbus_connection_register_object (c,
1036 "/foo/boss/worker2",
1037 (GDBusInterfaceInfo *) &bar_interface_info,
1040 on_object_unregistered,
1042 g_assert_no_error (error);
1043 g_assert (registration_id > 0);
1044 worker2_bar_reg_id = registration_id;
1045 num_successful_registrations++;
1047 registration_id = g_dbus_connection_register_object (c,
1048 "/foo/boss/interns/intern1",
1049 (GDBusInterfaceInfo *) &foo_interface_info,
1052 on_object_unregistered,
1054 g_assert_no_error (error);
1055 g_assert (registration_id > 0);
1056 intern1_foo_reg_id = registration_id;
1057 num_successful_registrations++;
1059 /* ... and try again at another path */
1060 registration_id = g_dbus_connection_register_object (c,
1061 "/foo/boss/interns/intern2",
1062 (GDBusInterfaceInfo *) &bar_interface_info,
1065 on_object_unregistered,
1067 g_assert_no_error (error);
1068 g_assert (registration_id > 0);
1069 intern2_bar_reg_id = registration_id;
1070 num_successful_registrations++;
1072 /* register at the same path/interface - this should fail */
1073 registration_id = g_dbus_connection_register_object (c,
1074 "/foo/boss/interns/intern2",
1075 (GDBusInterfaceInfo *) &bar_interface_info,
1078 on_object_unregistered,
1080 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_EXISTS);
1081 g_assert (!g_dbus_error_is_remote_error (error));
1082 g_error_free (error);
1084 g_assert (registration_id == 0);
1086 /* register at different interface - shouldn't fail */
1087 registration_id = g_dbus_connection_register_object (c,
1088 "/foo/boss/interns/intern2",
1089 (GDBusInterfaceInfo *) &foo_interface_info,
1092 on_object_unregistered,
1094 g_assert_no_error (error);
1095 g_assert (registration_id > 0);
1096 intern2_foo_reg_id = registration_id;
1097 num_successful_registrations++;
1099 /* unregister it via the id */
1100 g_assert (g_dbus_connection_unregister_object (c, registration_id));
1101 g_assert_cmpint (data.num_unregistered_calls, ==, 1);
1102 intern2_foo_reg_id = 0;
1104 /* register it back */
1105 registration_id = g_dbus_connection_register_object (c,
1106 "/foo/boss/interns/intern2",
1107 (GDBusInterfaceInfo *) &foo_interface_info,
1110 on_object_unregistered,
1112 g_assert_no_error (error);
1113 g_assert (registration_id > 0);
1114 intern2_foo_reg_id = registration_id;
1115 num_successful_registrations++;
1117 registration_id = g_dbus_connection_register_object (c,
1118 "/foo/boss/interns/intern3",
1119 (GDBusInterfaceInfo *) &bar_interface_info,
1122 on_object_unregistered,
1124 g_assert_no_error (error);
1125 g_assert (registration_id > 0);
1126 intern3_bar_reg_id = registration_id;
1127 num_successful_registrations++;
1129 /* now register a whole subtree at /foo/boss/executives */
1130 subtree_registration_id = g_dbus_connection_register_subtree (c,
1131 "/foo/boss/executives",
1133 G_DBUS_SUBTREE_FLAGS_NONE,
1135 on_subtree_unregistered,
1137 g_assert_no_error (error);
1138 g_assert (subtree_registration_id > 0);
1139 /* try registering it again.. this should fail */
1140 registration_id = g_dbus_connection_register_subtree (c,
1141 "/foo/boss/executives",
1143 G_DBUS_SUBTREE_FLAGS_NONE,
1145 on_subtree_unregistered,
1147 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_EXISTS);
1148 g_assert (!g_dbus_error_is_remote_error (error));
1149 g_error_free (error);
1151 g_assert (registration_id == 0);
1153 /* unregister it, then register it again */
1154 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 0);
1155 g_assert (g_dbus_connection_unregister_subtree (c, subtree_registration_id));
1156 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 1);
1157 subtree_registration_id = g_dbus_connection_register_subtree (c,
1158 "/foo/boss/executives",
1160 G_DBUS_SUBTREE_FLAGS_NONE,
1162 on_subtree_unregistered,
1164 g_assert_no_error (error);
1165 g_assert (subtree_registration_id > 0);
1167 /* try to register something under /foo/boss/executives - this should work
1168 * because registered subtrees and registered objects can coexist.
1170 * Make the exported object implement *two* interfaces so we can check
1171 * that the right introspection handler is invoked.
1173 registration_id = g_dbus_connection_register_object (c,
1174 "/foo/boss/executives/non_subtree_object",
1175 (GDBusInterfaceInfo *) &bar_interface_info,
1178 on_object_unregistered,
1180 g_assert_no_error (error);
1181 g_assert (registration_id > 0);
1182 non_subtree_object_path_bar_reg_id = registration_id;
1183 num_successful_registrations++;
1184 registration_id = g_dbus_connection_register_object (c,
1185 "/foo/boss/executives/non_subtree_object",
1186 (GDBusInterfaceInfo *) &foo_interface_info,
1189 on_object_unregistered,
1191 g_assert_no_error (error);
1192 g_assert (registration_id > 0);
1193 non_subtree_object_path_foo_reg_id = registration_id;
1194 num_successful_registrations++;
1196 /* now register a dynamic subtree, spawning objects as they are called */
1197 dyna_data = g_ptr_array_new ();
1198 dyna_subtree_registration_id = g_dbus_connection_register_subtree (c,
1200 &dynamic_subtree_vtable,
1201 G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES,
1203 (GDestroyNotify)g_ptr_array_unref,
1205 g_assert_no_error (error);
1206 g_assert (dyna_subtree_registration_id > 0);
1208 /* First assert that we have no nodes in the dynamic subtree */
1209 nodes = get_nodes_at (c, "/foo/dyna");
1210 g_assert (nodes != NULL);
1211 g_assert_cmpint (g_strv_length (nodes), ==, 0);
1213 g_assert_cmpint (count_interfaces (c, "/foo/dyna"), ==, 4);
1215 /* Install three nodes in the dynamic subtree via the dyna_data backdoor and
1216 * assert that they show up correctly in the introspection data */
1217 g_ptr_array_add (dyna_data, "lol");
1218 g_ptr_array_add (dyna_data, "cat");
1219 g_ptr_array_add (dyna_data, "cheezburger");
1220 nodes = get_nodes_at (c, "/foo/dyna");
1221 g_assert (nodes != NULL);
1222 g_assert_cmpint (g_strv_length (nodes), ==, 3);
1223 g_assert_cmpstr (nodes[0], ==, "lol");
1224 g_assert_cmpstr (nodes[1], ==, "cat");
1225 g_assert_cmpstr (nodes[2], ==, "cheezburger");
1227 g_assert_cmpint (count_interfaces (c, "/foo/dyna/lol"), ==, 4);
1228 g_assert_cmpint (count_interfaces (c, "/foo/dyna/cat"), ==, 4);
1229 g_assert_cmpint (count_interfaces (c, "/foo/dyna/cheezburger"), ==, 4);
1231 /* Call a non-existing object path and assert that it has been created */
1232 dyna_create (c, "dynamicallycreated");
1233 nodes = get_nodes_at (c, "/foo/dyna");
1234 g_assert (nodes != NULL);
1235 g_assert_cmpint (g_strv_length (nodes), ==, 4);
1236 g_assert_cmpstr (nodes[0], ==, "lol");
1237 g_assert_cmpstr (nodes[1], ==, "cat");
1238 g_assert_cmpstr (nodes[2], ==, "cheezburger");
1239 g_assert_cmpstr (nodes[3], ==, "dynamicallycreated");
1241 g_assert_cmpint (count_interfaces (c, "/foo/dyna/dynamicallycreated"), ==, 4);
1243 /* now check that the object hierarachy is properly generated... yes, it's a bit
1244 * perverse that we round-trip to the bus to introspect ourselves ;-)
1246 nodes = get_nodes_at (c, "/");
1247 g_assert (nodes != NULL);
1248 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1249 g_assert_cmpstr (nodes[0], ==, "foo");
1251 g_assert_cmpint (count_interfaces (c, "/"), ==, 0);
1253 nodes = get_nodes_at (c, "/foo");
1254 g_assert (nodes != NULL);
1255 g_assert_cmpint (g_strv_length (nodes), ==, 2);
1256 g_assert_cmpstr (nodes[0], ==, "boss");
1257 g_assert_cmpstr (nodes[1], ==, "dyna");
1259 g_assert_cmpint (count_interfaces (c, "/foo"), ==, 0);
1261 nodes = get_nodes_at (c, "/foo/boss");
1262 g_assert (nodes != NULL);
1263 g_assert_cmpint (g_strv_length (nodes), ==, 5);
1264 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "worker1"));
1265 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "worker1p1"));
1266 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "worker2"));
1267 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "interns"));
1268 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "executives"));
1270 /* any registered object always implement org.freedesktop.DBus.[Peer,Introspectable,Properties] */
1271 g_assert_cmpint (count_interfaces (c, "/foo/boss"), ==, 5);
1272 g_assert (has_interface (c, "/foo/boss", foo_interface_info.name));
1273 g_assert (has_interface (c, "/foo/boss", bar_interface_info.name));
1275 /* check subtree nodes - we should have only non_subtree_object in /foo/boss/executives
1276 * because data.num_subtree_nodes is 0
1278 nodes = get_nodes_at (c, "/foo/boss/executives");
1279 g_assert (nodes != NULL);
1280 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1281 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1283 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives"), ==, 0);
1285 /* now change data.num_subtree_nodes and check */
1286 data.num_subtree_nodes = 2;
1287 nodes = get_nodes_at (c, "/foo/boss/executives");
1288 g_assert (nodes != NULL);
1289 g_assert_cmpint (g_strv_length (nodes), ==, 5);
1290 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1291 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp0"));
1292 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp1"));
1293 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp0"));
1294 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp1"));
1295 /* check that /foo/boss/executives/non_subtree_object is not handled by the
1296 * subtree handlers - we can do this because objects from subtree handlers
1297 * has exactly one interface and non_subtree_object has two
1299 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/non_subtree_object"), ==, 5);
1300 g_assert (has_interface (c, "/foo/boss/executives/non_subtree_object", foo_interface_info.name));
1301 g_assert (has_interface (c, "/foo/boss/executives/non_subtree_object", bar_interface_info.name));
1302 /* check that the vp and evp objects are handled by the subtree handlers */
1303 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/vp0"), ==, 4);
1304 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/vp1"), ==, 4);
1305 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/evp0"), ==, 4);
1306 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/evp1"), ==, 4);
1307 g_assert (has_interface (c, "/foo/boss/executives/vp0", foo_interface_info.name));
1308 g_assert (has_interface (c, "/foo/boss/executives/vp1", foo_interface_info.name));
1309 g_assert (has_interface (c, "/foo/boss/executives/evp0", bar_interface_info.name));
1310 g_assert (has_interface (c, "/foo/boss/executives/evp1", bar_interface_info.name));
1312 data.num_subtree_nodes = 3;
1313 nodes = get_nodes_at (c, "/foo/boss/executives");
1314 g_assert (nodes != NULL);
1315 g_assert_cmpint (g_strv_length (nodes), ==, 7);
1316 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1317 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp0"));
1318 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp1"));
1319 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp2"));
1320 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp0"));
1321 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp1"));
1322 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp2"));
1325 /* This is to check that a bug (rather, class of bugs) in gdbusconnection.c's
1327 * g_dbus_connection_list_registered_unlocked()
1329 * where /foo/boss/worker1 reported a child '1', is now fixed.
1331 nodes = get_nodes_at (c, "/foo/boss/worker1");
1332 g_assert (nodes != NULL);
1333 g_assert_cmpint (g_strv_length (nodes), ==, 0);
1336 /* check that calls are properly dispatched to the functions in foo_vtable for objects
1337 * implementing the org.example.Foo interface
1339 * We do this for both a regular registered object (/foo/boss) and also for an object
1340 * registered through the subtree mechanism.
1342 test_dispatch ("/foo/boss");
1343 test_dispatch ("/foo/boss/executives/vp0");
1345 /* To prevent from exiting and attaching a D-Bus tool like D-Feet; uncomment: */
1347 g_debug ("Point D-feet or other tool at: %s", session_bus_get_temporary_address());
1348 g_main_loop_run (loop);
1351 /* check that unregistering the subtree handler works */
1352 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 1);
1353 g_assert (g_dbus_connection_unregister_subtree (c, subtree_registration_id));
1354 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 2);
1355 nodes = get_nodes_at (c, "/foo/boss/executives");
1356 g_assert (nodes != NULL);
1357 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1358 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1361 g_assert (g_dbus_connection_unregister_object (c, boss_foo_reg_id));
1362 g_assert (g_dbus_connection_unregister_object (c, boss_bar_reg_id));
1363 g_assert (g_dbus_connection_unregister_object (c, worker1_foo_reg_id));
1364 g_assert (g_dbus_connection_unregister_object (c, worker1p1_foo_reg_id));
1365 g_assert (g_dbus_connection_unregister_object (c, worker2_bar_reg_id));
1366 g_assert (g_dbus_connection_unregister_object (c, intern1_foo_reg_id));
1367 g_assert (g_dbus_connection_unregister_object (c, intern2_bar_reg_id));
1368 g_assert (g_dbus_connection_unregister_object (c, intern2_foo_reg_id));
1369 g_assert (g_dbus_connection_unregister_object (c, intern3_bar_reg_id));
1370 g_assert (g_dbus_connection_unregister_object (c, non_subtree_object_path_bar_reg_id));
1371 g_assert (g_dbus_connection_unregister_object (c, non_subtree_object_path_foo_reg_id));
1373 g_assert_cmpint (data.num_unregistered_calls, ==, num_successful_registrations);
1375 /* check that we no longer export any objects - TODO: it looks like there's a bug in
1376 * libdbus-1 here: libdbus still reports the '/foo' object; so disable the test for now
1379 nodes = get_nodes_at (c, "/");
1380 g_assert (nodes != NULL);
1381 g_assert_cmpint (g_strv_length (nodes), ==, 0);
1388 static const GDBusInterfaceInfo test_interface_info1 =
1392 (GDBusMethodInfo **) NULL,
1393 (GDBusSignalInfo **) NULL,
1394 (GDBusPropertyInfo **) NULL,
1398 static const GDBusInterfaceInfo test_interface_info2 =
1401 "org.freedesktop.DBus.Properties",
1402 (GDBusMethodInfo **) NULL,
1403 (GDBusSignalInfo **) NULL,
1404 (GDBusPropertyInfo **) NULL,
1409 check_interfaces (GDBusConnection *c,
1410 const gchar *object_path,
1411 const gchar **interfaces)
1416 GDBusNodeInfo *node_info;
1420 proxy = g_dbus_proxy_new_sync (c,
1421 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
1422 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
1424 g_dbus_connection_get_unique_name (c),
1426 "org.freedesktop.DBus.Introspectable",
1429 g_assert_no_error (error);
1430 g_assert (proxy != NULL);
1432 /* do this async to avoid libdbus-1 deadlocks */
1434 g_dbus_proxy_call (proxy,
1437 G_DBUS_CALL_FLAGS_NONE,
1440 (GAsyncReadyCallback) introspect_callback,
1442 g_main_loop_run (loop);
1443 g_assert (xml_data != NULL);
1445 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
1446 g_assert_no_error (error);
1447 g_assert (node_info != NULL);
1449 g_assert (node_info->interfaces != NULL);
1450 for (i = 0; node_info->interfaces[i]; i++) ;
1452 if (g_strv_length ((gchar**)interfaces) != i - 1)
1454 g_print ("expected ");
1455 for (i = 0; interfaces[i]; i++)
1456 g_print ("%s ", interfaces[i]);
1458 for (i = 0; node_info->interfaces[i]; i++)
1459 g_print ("%s ", node_info->interfaces[i]->name);
1463 g_assert_cmpint (g_strv_length ((gchar**)interfaces), ==, i - 1);
1465 for (i = 0; interfaces[i]; i++)
1467 for (j = 0; node_info->interfaces[j]; j++)
1469 if (strcmp (interfaces[i], node_info->interfaces[j]->name) == 0)
1473 g_assert_not_reached ();
1478 g_object_unref (proxy);
1480 g_dbus_node_info_unref (node_info);
1484 test_registered_interfaces (void)
1488 const gchar *interfaces[] = {
1490 "org.freedesktop.DBus.Properties",
1491 "org.freedesktop.DBus.Introspectable",
1496 c = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
1497 g_assert_no_error (error);
1498 g_assert (c != NULL);
1500 id1 = g_dbus_connection_register_object (c,
1502 (GDBusInterfaceInfo *) &test_interface_info1,
1507 g_assert_no_error (error);
1509 id2 = g_dbus_connection_register_object (c,
1511 (GDBusInterfaceInfo *) &test_interface_info2,
1516 g_assert_no_error (error);
1519 check_interfaces (c, "/test", interfaces);
1521 g_assert (g_dbus_connection_unregister_object (c, id1));
1522 g_assert (g_dbus_connection_unregister_object (c, id2));
1527 /* ---------------------------------------------------------------------------------------------------- */
1536 g_test_init (&argc, &argv, NULL);
1538 /* all the tests rely on a shared main loop */
1539 loop = g_main_loop_new (NULL, FALSE);
1541 /* all the tests use a session bus with a well-known address that we can bring up and down
1542 * using session_bus_up() and session_bus_down().
1544 g_unsetenv ("DISPLAY");
1545 g_setenv ("DBUS_SESSION_BUS_ADDRESS", session_bus_get_temporary_address (), TRUE);
1549 /* TODO: wait a bit for the bus to come up.. ideally session_bus_up() won't return
1550 * until one can connect to the bus but that's not how things work right now
1552 usleep (500 * 1000);
1554 g_test_add_func ("/gdbus/object-registration", test_object_registration);
1555 g_test_add_func ("/gdbus/registered-interfaces", test_registered_interfaces);
1557 /* TODO: check that we spit out correct introspection data */
1558 /* TODO: check that registering a whole subtree works */
1563 session_bus_down ();