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,
318 gchar **xml_data = user_data;
323 result = g_dbus_proxy_call_finish (proxy,
326 g_assert_no_error (error);
327 g_assert (result != NULL);
328 g_variant_get (result, "(s)", &s);
329 *xml_data = g_strdup (s);
330 g_variant_unref (result);
332 g_main_loop_quit (loop);
336 get_nodes_at (GDBusConnection *c,
337 const gchar *object_path)
343 GDBusNodeInfo *node_info;
347 proxy = g_dbus_proxy_new_sync (c,
349 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
350 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
352 g_dbus_connection_get_unique_name (c),
354 "org.freedesktop.DBus.Introspectable",
357 g_assert_no_error (error);
358 g_assert (proxy != NULL);
360 /* do this async to avoid libdbus-1 deadlocks */
362 g_dbus_proxy_call (proxy,
365 G_DBUS_CALL_FLAGS_NONE,
368 (GAsyncReadyCallback) introspect_callback,
370 g_main_loop_run (loop);
371 g_assert (xml_data != NULL);
373 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
374 g_assert_no_error (error);
375 g_assert (node_info != NULL);
377 p = g_ptr_array_new ();
378 for (n = 0; node_info->nodes != NULL && node_info->nodes[n] != NULL; n++)
380 const GDBusNodeInfo *sub_node_info = node_info->nodes[n];
381 g_ptr_array_add (p, g_strdup (sub_node_info->path));
383 g_ptr_array_add (p, NULL);
385 g_object_unref (proxy);
387 g_dbus_node_info_unref (node_info);
389 return (gchar **) g_ptr_array_free (p, FALSE);
393 has_interface (GDBusConnection *c,
394 const gchar *object_path,
395 const gchar *interface_name)
400 GDBusNodeInfo *node_info;
404 proxy = g_dbus_proxy_new_sync (c,
406 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
407 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
409 g_dbus_connection_get_unique_name (c),
411 "org.freedesktop.DBus.Introspectable",
414 g_assert_no_error (error);
415 g_assert (proxy != NULL);
417 /* do this async to avoid libdbus-1 deadlocks */
419 g_dbus_proxy_call (proxy,
422 G_DBUS_CALL_FLAGS_NONE,
425 (GAsyncReadyCallback) introspect_callback,
427 g_main_loop_run (loop);
428 g_assert (xml_data != NULL);
430 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
431 g_assert_no_error (error);
432 g_assert (node_info != NULL);
434 ret = (g_dbus_node_info_lookup_interface (node_info, interface_name) != NULL);
436 g_object_unref (proxy);
438 g_dbus_node_info_unref (node_info);
444 count_interfaces (GDBusConnection *c,
445 const gchar *object_path)
450 GDBusNodeInfo *node_info;
454 proxy = g_dbus_proxy_new_sync (c,
456 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
457 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
459 g_dbus_connection_get_unique_name (c),
461 "org.freedesktop.DBus.Introspectable",
464 g_assert_no_error (error);
465 g_assert (proxy != NULL);
467 /* do this async to avoid libdbus-1 deadlocks */
469 g_dbus_proxy_call (proxy,
472 G_DBUS_CALL_FLAGS_NONE,
475 (GAsyncReadyCallback) introspect_callback,
477 g_main_loop_run (loop);
478 g_assert (xml_data != NULL);
480 node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
481 g_assert_no_error (error);
482 g_assert (node_info != NULL);
485 while (node_info->interfaces != NULL && node_info->interfaces[ret] != NULL)
488 g_object_unref (proxy);
490 g_dbus_node_info_unref (node_info);
496 dyna_create_callback (GDBusProxy *proxy,
504 result = g_dbus_proxy_call_finish (proxy,
507 g_assert_no_error (error);
508 g_assert (result != NULL);
509 g_variant_unref (result);
511 g_main_loop_quit (loop);
514 /* Dynamically create @object_name under /foo/dyna */
516 dyna_create (GDBusConnection *c,
517 const gchar *object_name)
523 object_path = g_strconcat ("/foo/dyna/", object_name, NULL);
526 proxy = g_dbus_proxy_new_sync (c,
528 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
529 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
531 g_dbus_connection_get_unique_name (c),
536 g_assert_no_error (error);
537 g_assert (proxy != NULL);
539 /* do this async to avoid libdbus-1 deadlocks */
540 g_dbus_proxy_call (proxy,
542 g_variant_new ("()"),
543 G_DBUS_CALL_FLAGS_NONE,
546 (GAsyncReadyCallback) dyna_create_callback,
548 g_main_loop_run (loop);
550 g_assert_no_error (error);
552 g_object_unref (proxy);
553 g_free (object_path);
560 guint num_unregistered_calls;
561 guint num_unregistered_subtree_calls;
562 guint num_subtree_nodes;
563 } ObjectRegistrationData;
566 on_object_unregistered (gpointer user_data)
568 ObjectRegistrationData *data = user_data;
570 data->num_unregistered_calls++;
574 on_subtree_unregistered (gpointer user_data)
576 ObjectRegistrationData *data = user_data;
578 data->num_unregistered_subtree_calls++;
582 _g_strv_has_string (const gchar* const * haystack,
587 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
589 if (g_strcmp0 (haystack[n], needle) == 0)
595 /* -------------------- */
598 subtree_enumerate (GDBusConnection *connection,
600 const gchar *object_path,
603 ObjectRegistrationData *data = user_data;
608 p = g_ptr_array_new ();
610 for (n = 0; n < data->num_subtree_nodes; n++)
612 g_ptr_array_add (p, g_strdup_printf ("vp%d", n));
613 g_ptr_array_add (p, g_strdup_printf ("evp%d", n));
615 g_ptr_array_add (p, NULL);
617 nodes = (gchar **) g_ptr_array_free (p, FALSE);
622 /* Only allows certain objects, and aborts on unknowns */
624 subtree_introspect (GDBusConnection *connection,
626 const gchar *object_path,
630 GPtrArray *interfaces;
632 /* VPs implement the Foo interface, EVPs implement the Bar interface. The root
633 * does not implement any interfaces
635 interfaces = g_ptr_array_new ();
636 if (g_str_has_prefix (node, "vp"))
638 g_ptr_array_add (interfaces, (gpointer) &foo_interface_info);
640 else if (g_str_has_prefix (node, "evp"))
642 g_ptr_array_add (interfaces, (gpointer) &bar_interface_info);
644 else if (g_strcmp0 (node, "/") == 0)
650 g_assert_not_reached ();
656 static const GDBusInterfaceVTable *
657 subtree_dispatch (GDBusConnection *connection,
659 const gchar *object_path,
660 const gchar *interface_name,
662 gpointer *out_user_data,
665 if (g_strcmp0 (interface_name, "org.example.Foo") == 0)
671 static const GDBusSubtreeVTable subtree_vtable =
678 /* -------------------- */
681 dynamic_subtree_enumerate (GDBusConnection *connection,
683 const gchar *object_path,
686 GPtrArray *data = user_data;
687 gchar **nodes = g_new (gchar*, data->len + 1);
690 for (n = 0; n < data->len; n++)
692 nodes[n] = g_strdup (g_ptr_array_index (data, n));
694 nodes[data->len] = NULL;
699 /* Allow all objects to be introspected */
701 dynamic_subtree_introspect (GDBusConnection *connection,
703 const gchar *object_path,
707 GPtrArray *interfaces;
709 /* All nodes (including the root node) implements the Dyna interface */
710 interfaces = g_ptr_array_new ();
711 g_ptr_array_add (interfaces, (gpointer) &dyna_interface_info);
716 static const GDBusInterfaceVTable *
717 dynamic_subtree_dispatch (GDBusConnection *connection,
719 const gchar *object_path,
720 const gchar *interface_name,
722 gpointer *out_user_data,
725 *out_user_data = user_data;
726 return &dyna_interface_vtable;
729 static const GDBusSubtreeVTable dynamic_subtree_vtable =
731 dynamic_subtree_enumerate,
732 dynamic_subtree_introspect,
733 dynamic_subtree_dispatch
736 /* -------------------- */
739 test_dispatch_thread_func (gpointer user_data)
741 const gchar *object_path = user_data;
742 GDBusProxy *foo_proxy;
747 const gchar *value_str;
749 foo_proxy = g_dbus_proxy_new_sync (c,
751 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS |
752 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES,
754 g_dbus_connection_get_unique_name (c),
759 g_assert (foo_proxy != NULL);
761 /* generic interfaces */
763 value = g_dbus_proxy_call_sync (foo_proxy,
764 "org.freedesktop.DBus.Peer.Ping",
766 G_DBUS_CALL_FLAGS_NONE,
770 g_assert_no_error (error);
771 g_assert (value != NULL);
772 g_variant_unref (value);
776 value = g_dbus_proxy_call_sync (foo_proxy,
778 g_variant_new ("(s)", "winwinwin"),
779 G_DBUS_CALL_FLAGS_NONE,
783 g_assert_no_error (error);
784 g_assert (value != NULL);
785 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(s)")));
786 g_variant_get (value, "(s)", &value_str);
787 g_assert_cmpstr (value_str, ==, "You passed the string `winwinwin'. Jolly good!");
788 g_variant_unref (value);
791 value = g_dbus_proxy_call_sync (foo_proxy,
794 G_DBUS_CALL_FLAGS_NONE,
798 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_DBUS_ERROR);
799 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.example.SomeError: How do you like them apples, buddy!");
800 g_error_free (error);
801 g_assert (value == NULL);
804 value = g_dbus_proxy_call_sync (foo_proxy,
806 g_variant_new ("(s)", "failfailfail"),
807 G_DBUS_CALL_FLAGS_NONE,
811 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
812 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Signature of message, `s', does not match expected signature `'");
813 g_error_free (error);
814 g_assert (value == NULL);
817 value = g_dbus_proxy_call_sync (foo_proxy,
820 G_DBUS_CALL_FLAGS_NONE,
824 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_UNKNOWN_METHOD);
825 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.UnknownMethod: No such method `NonExistantMethod'");
826 g_error_free (error);
827 g_assert (value == NULL);
829 /* user properties */
831 value = g_dbus_proxy_call_sync (foo_proxy,
832 "org.freedesktop.DBus.Properties.Get",
833 g_variant_new ("(ss)",
836 G_DBUS_CALL_FLAGS_NONE,
840 g_assert_no_error (error);
841 g_assert (value != NULL);
842 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(v)")));
843 g_variant_get (value, "(v)", &inner);
844 g_assert (g_variant_is_of_type (inner, G_VARIANT_TYPE_STRING));
845 g_assert_cmpstr (g_variant_get_string (inner, NULL), ==, "Property `PropertyUno' Is What It Is!");
846 g_variant_unref (value);
849 value = g_dbus_proxy_call_sync (foo_proxy,
850 "org.freedesktop.DBus.Properties.Get",
851 g_variant_new ("(ss)",
854 G_DBUS_CALL_FLAGS_NONE,
858 g_assert (value == NULL);
859 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
860 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: No such property `ThisDoesntExist'");
861 g_error_free (error);
864 value = g_dbus_proxy_call_sync (foo_proxy,
865 "org.freedesktop.DBus.Properties.Get",
866 g_variant_new ("(ss)",
869 G_DBUS_CALL_FLAGS_NONE,
873 g_assert (value == NULL);
874 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
875 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Property `NotReadable' is not readable");
876 g_error_free (error);
879 value = g_dbus_proxy_call_sync (foo_proxy,
880 "org.freedesktop.DBus.Properties.Set",
881 g_variant_new ("(ssv)",
884 g_variant_new_string ("But Writable you are!")),
885 G_DBUS_CALL_FLAGS_NONE,
889 g_assert (value == NULL);
890 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_SPAWN_FILE_INVALID);
891 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!''");
892 g_error_free (error);
895 value = g_dbus_proxy_call_sync (foo_proxy,
896 "org.freedesktop.DBus.Properties.Set",
897 g_variant_new ("(ssv)",
900 g_variant_new_uint32 (42)),
901 G_DBUS_CALL_FLAGS_NONE,
905 g_assert (value == NULL);
906 g_assert_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS);
907 g_assert_cmpstr (error->message, ==, "GDBus.Error:org.freedesktop.DBus.Error.InvalidArgs: Property `NotWritable' is not writable");
908 g_error_free (error);
911 value = g_dbus_proxy_call_sync (foo_proxy,
912 "org.freedesktop.DBus.Properties.GetAll",
913 g_variant_new ("(s)",
915 G_DBUS_CALL_FLAGS_NONE,
919 g_assert_no_error (error);
920 g_assert (value != NULL);
921 g_assert (g_variant_is_of_type (value, G_VARIANT_TYPE ("(a{sv})")));
922 s = g_variant_print (value, TRUE);
923 g_assert_cmpstr (s, ==, "({'PropertyUno': <\"Property `PropertyUno' Is What It Is!\">, 'NotWritable': <\"Property `NotWritable' Is What It Is!\">},)");
925 g_variant_unref (value);
927 g_object_unref (foo_proxy);
929 g_main_loop_quit (loop);
934 test_dispatch (const gchar *object_path)
939 /* run this in a thread to avoid deadlocks */
941 thread = g_thread_create (test_dispatch_thread_func,
942 (gpointer) object_path,
945 g_assert_no_error (error);
946 g_assert (thread != NULL);
947 g_main_loop_run (loop);
948 g_thread_join (thread);
952 test_object_registration (void)
955 ObjectRegistrationData data;
956 GPtrArray *dyna_data;
958 guint boss_foo_reg_id;
959 guint boss_bar_reg_id;
960 guint worker1_foo_reg_id;
961 guint worker2_bar_reg_id;
962 guint intern1_foo_reg_id;
963 guint intern2_bar_reg_id;
964 guint intern2_foo_reg_id;
965 guint intern3_bar_reg_id;
966 guint registration_id;
967 guint subtree_registration_id;
968 guint non_subtree_object_path_foo_reg_id;
969 guint non_subtree_object_path_bar_reg_id;
970 guint dyna_subtree_registration_id;
971 guint num_successful_registrations;
973 data.num_unregistered_calls = 0;
974 data.num_unregistered_subtree_calls = 0;
975 data.num_subtree_nodes = 0;
977 num_successful_registrations = 0;
980 c = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
981 g_assert_no_error (error);
982 g_assert (c != NULL);
984 registration_id = g_dbus_connection_register_object (c,
989 on_object_unregistered,
991 g_assert_no_error (error);
992 g_assert (registration_id > 0);
993 boss_foo_reg_id = registration_id;
994 num_successful_registrations++;
996 registration_id = g_dbus_connection_register_object (c,
1001 on_object_unregistered,
1003 g_assert_no_error (error);
1004 g_assert (registration_id > 0);
1005 boss_bar_reg_id = registration_id;
1006 num_successful_registrations++;
1008 registration_id = g_dbus_connection_register_object (c,
1009 "/foo/boss/worker1",
1010 &foo_interface_info,
1013 on_object_unregistered,
1015 g_assert_no_error (error);
1016 g_assert (registration_id > 0);
1017 worker1_foo_reg_id = registration_id;
1018 num_successful_registrations++;
1020 registration_id = g_dbus_connection_register_object (c,
1021 "/foo/boss/worker2",
1022 &bar_interface_info,
1025 on_object_unregistered,
1027 g_assert_no_error (error);
1028 g_assert (registration_id > 0);
1029 worker2_bar_reg_id = registration_id;
1030 num_successful_registrations++;
1032 registration_id = g_dbus_connection_register_object (c,
1033 "/foo/boss/interns/intern1",
1034 &foo_interface_info,
1037 on_object_unregistered,
1039 g_assert_no_error (error);
1040 g_assert (registration_id > 0);
1041 intern1_foo_reg_id = registration_id;
1042 num_successful_registrations++;
1044 /* ... and try again at another path */
1045 registration_id = g_dbus_connection_register_object (c,
1046 "/foo/boss/interns/intern2",
1047 &bar_interface_info,
1050 on_object_unregistered,
1052 g_assert_no_error (error);
1053 g_assert (registration_id > 0);
1054 intern2_bar_reg_id = registration_id;
1055 num_successful_registrations++;
1057 /* register at the same path/interface - this should fail */
1058 registration_id = g_dbus_connection_register_object (c,
1059 "/foo/boss/interns/intern2",
1060 &bar_interface_info,
1063 on_object_unregistered,
1065 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_EXISTS);
1066 g_assert (!g_dbus_error_is_remote_error (error));
1067 g_error_free (error);
1069 g_assert (registration_id == 0);
1071 /* register at different interface - shouldn't fail */
1072 registration_id = g_dbus_connection_register_object (c,
1073 "/foo/boss/interns/intern2",
1074 &foo_interface_info,
1077 on_object_unregistered,
1079 g_assert_no_error (error);
1080 g_assert (registration_id > 0);
1081 intern2_foo_reg_id = registration_id;
1082 num_successful_registrations++;
1084 /* unregister it via the id */
1085 g_assert (g_dbus_connection_unregister_object (c, registration_id));
1086 g_assert_cmpint (data.num_unregistered_calls, ==, 1);
1087 intern2_foo_reg_id = 0;
1089 /* register it back */
1090 registration_id = g_dbus_connection_register_object (c,
1091 "/foo/boss/interns/intern2",
1092 &foo_interface_info,
1095 on_object_unregistered,
1097 g_assert_no_error (error);
1098 g_assert (registration_id > 0);
1099 intern2_foo_reg_id = registration_id;
1100 num_successful_registrations++;
1102 registration_id = g_dbus_connection_register_object (c,
1103 "/foo/boss/interns/intern3",
1104 &bar_interface_info,
1107 on_object_unregistered,
1109 g_assert_no_error (error);
1110 g_assert (registration_id > 0);
1111 intern3_bar_reg_id = registration_id;
1112 num_successful_registrations++;
1114 /* now register a whole subtree at /foo/boss/executives */
1115 subtree_registration_id = g_dbus_connection_register_subtree (c,
1116 "/foo/boss/executives",
1118 G_DBUS_SUBTREE_FLAGS_NONE,
1120 on_subtree_unregistered,
1122 g_assert_no_error (error);
1123 g_assert (subtree_registration_id > 0);
1124 /* try registering it again.. this should fail */
1125 registration_id = g_dbus_connection_register_subtree (c,
1126 "/foo/boss/executives",
1128 G_DBUS_SUBTREE_FLAGS_NONE,
1130 on_subtree_unregistered,
1132 g_assert_error (error, G_IO_ERROR, G_IO_ERROR_EXISTS);
1133 g_assert (!g_dbus_error_is_remote_error (error));
1134 g_error_free (error);
1136 g_assert (registration_id == 0);
1138 /* unregister it, then register it again */
1139 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 0);
1140 g_assert (g_dbus_connection_unregister_subtree (c, subtree_registration_id));
1141 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 1);
1142 subtree_registration_id = g_dbus_connection_register_subtree (c,
1143 "/foo/boss/executives",
1145 G_DBUS_SUBTREE_FLAGS_NONE,
1147 on_subtree_unregistered,
1149 g_assert_no_error (error);
1150 g_assert (subtree_registration_id > 0);
1152 /* try to register something under /foo/boss/executives - this should work
1153 * because registered subtrees and registered objects can coexist.
1155 * Make the exported object implement *two* interfaces so we can check
1156 * that the right introspection handler is invoked.
1158 registration_id = g_dbus_connection_register_object (c,
1159 "/foo/boss/executives/non_subtree_object",
1160 &bar_interface_info,
1163 on_object_unregistered,
1165 g_assert_no_error (error);
1166 g_assert (registration_id > 0);
1167 non_subtree_object_path_bar_reg_id = registration_id;
1168 num_successful_registrations++;
1169 registration_id = g_dbus_connection_register_object (c,
1170 "/foo/boss/executives/non_subtree_object",
1171 &foo_interface_info,
1174 on_object_unregistered,
1176 g_assert_no_error (error);
1177 g_assert (registration_id > 0);
1178 non_subtree_object_path_foo_reg_id = registration_id;
1179 num_successful_registrations++;
1181 /* now register a dynamic subtree, spawning objects as they are called */
1182 dyna_data = g_ptr_array_new ();
1183 dyna_subtree_registration_id = g_dbus_connection_register_subtree (c,
1185 &dynamic_subtree_vtable,
1186 G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES,
1188 (GDestroyNotify)g_ptr_array_unref,
1190 g_assert_no_error (error);
1191 g_assert (dyna_subtree_registration_id > 0);
1193 /* First assert that we have no nodes in the dynamic subtree */
1194 nodes = get_nodes_at (c, "/foo/dyna");
1195 g_assert (nodes != NULL);
1196 g_assert_cmpint (g_strv_length (nodes), ==, 0);
1198 g_assert_cmpint (count_interfaces (c, "/foo/dyna"), ==, 4);
1200 /* Install three nodes in the dynamic subtree via the dyna_data backdoor and
1201 * assert that they show up correctly in the introspection data */
1202 g_ptr_array_add (dyna_data, "lol");
1203 g_ptr_array_add (dyna_data, "cat");
1204 g_ptr_array_add (dyna_data, "cheezburger");
1205 nodes = get_nodes_at (c, "/foo/dyna");
1206 g_assert (nodes != NULL);
1207 g_assert_cmpint (g_strv_length (nodes), ==, 3);
1208 g_assert_cmpstr (nodes[0], ==, "lol");
1209 g_assert_cmpstr (nodes[1], ==, "cat");
1210 g_assert_cmpstr (nodes[2], ==, "cheezburger");
1212 g_assert_cmpint (count_interfaces (c, "/foo/dyna/lol"), ==, 4);
1213 g_assert_cmpint (count_interfaces (c, "/foo/dyna/cat"), ==, 4);
1214 g_assert_cmpint (count_interfaces (c, "/foo/dyna/cheezburger"), ==, 4);
1216 /* Call a non-existing object path and assert that it has been created */
1217 dyna_create (c, "dynamicallycreated");
1218 nodes = get_nodes_at (c, "/foo/dyna");
1219 g_assert (nodes != NULL);
1220 g_assert_cmpint (g_strv_length (nodes), ==, 4);
1221 g_assert_cmpstr (nodes[0], ==, "lol");
1222 g_assert_cmpstr (nodes[1], ==, "cat");
1223 g_assert_cmpstr (nodes[2], ==, "cheezburger");
1224 g_assert_cmpstr (nodes[3], ==, "dynamicallycreated");
1226 g_assert_cmpint (count_interfaces (c, "/foo/dyna/dynamicallycreated"), ==, 4);
1228 /* now check that the object hierarachy is properly generated... yes, it's a bit
1229 * perverse that we round-trip to the bus to introspect ourselves ;-)
1231 nodes = get_nodes_at (c, "/");
1232 g_assert (nodes != NULL);
1233 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1234 g_assert_cmpstr (nodes[0], ==, "foo");
1236 g_assert_cmpint (count_interfaces (c, "/"), ==, 0);
1238 nodes = get_nodes_at (c, "/foo");
1239 g_assert (nodes != NULL);
1240 g_assert_cmpint (g_strv_length (nodes), ==, 2);
1241 g_assert_cmpstr (nodes[0], ==, "boss");
1242 g_assert_cmpstr (nodes[1], ==, "dyna");
1244 g_assert_cmpint (count_interfaces (c, "/foo"), ==, 0);
1246 nodes = get_nodes_at (c, "/foo/boss");
1247 g_assert (nodes != NULL);
1248 g_assert_cmpint (g_strv_length (nodes), ==, 4);
1249 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "worker1"));
1250 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "worker2"));
1251 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "interns"));
1252 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "executives"));
1254 /* any registered object always implement org.freedesktop.DBus.[Peer,Introspectable,Properties] */
1255 g_assert_cmpint (count_interfaces (c, "/foo/boss"), ==, 5);
1256 g_assert (has_interface (c, "/foo/boss", foo_interface_info.name));
1257 g_assert (has_interface (c, "/foo/boss", bar_interface_info.name));
1259 /* check subtree nodes - we should have only non_subtree_object in /foo/boss/executives
1260 * because data.num_subtree_nodes is 0
1262 nodes = get_nodes_at (c, "/foo/boss/executives");
1263 g_assert (nodes != NULL);
1264 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1265 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1267 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives"), ==, 0);
1269 /* now change data.num_subtree_nodes and check */
1270 data.num_subtree_nodes = 2;
1271 nodes = get_nodes_at (c, "/foo/boss/executives");
1272 g_assert (nodes != NULL);
1273 g_assert_cmpint (g_strv_length (nodes), ==, 5);
1274 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1275 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp0"));
1276 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp1"));
1277 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp0"));
1278 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp1"));
1279 /* check that /foo/boss/executives/non_subtree_object is not handled by the
1280 * subtree handlers - we can do this because objects from subtree handlers
1281 * has exactly one interface and non_subtree_object has two
1283 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/non_subtree_object"), ==, 5);
1284 g_assert (has_interface (c, "/foo/boss/executives/non_subtree_object", foo_interface_info.name));
1285 g_assert (has_interface (c, "/foo/boss/executives/non_subtree_object", bar_interface_info.name));
1286 /* check that the vp and evp objects are handled by the subtree handlers */
1287 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/vp0"), ==, 4);
1288 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/vp1"), ==, 4);
1289 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/evp0"), ==, 4);
1290 g_assert_cmpint (count_interfaces (c, "/foo/boss/executives/evp1"), ==, 4);
1291 g_assert (has_interface (c, "/foo/boss/executives/vp0", foo_interface_info.name));
1292 g_assert (has_interface (c, "/foo/boss/executives/vp1", foo_interface_info.name));
1293 g_assert (has_interface (c, "/foo/boss/executives/evp0", bar_interface_info.name));
1294 g_assert (has_interface (c, "/foo/boss/executives/evp1", bar_interface_info.name));
1296 data.num_subtree_nodes = 3;
1297 nodes = get_nodes_at (c, "/foo/boss/executives");
1298 g_assert (nodes != NULL);
1299 g_assert_cmpint (g_strv_length (nodes), ==, 7);
1300 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1301 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp0"));
1302 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp1"));
1303 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "vp2"));
1304 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp0"));
1305 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp1"));
1306 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "evp2"));
1309 /* check that calls are properly dispatched to the functions in foo_vtable for objects
1310 * implementing the org.example.Foo interface
1312 * We do this for both a regular registered object (/foo/boss) and also for an object
1313 * registered through the subtree mechanism.
1315 test_dispatch ("/foo/boss");
1316 test_dispatch ("/foo/boss/executives/vp0");
1318 /* To prevent from exiting and attaching a D-Bus tool like D-Feet; uncomment: */
1320 g_debug ("Point D-feet or other tool at: %s", session_bus_get_temporary_address());
1321 g_main_loop_run (loop);
1324 /* check that unregistering the subtree handler works */
1325 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 1);
1326 g_assert (g_dbus_connection_unregister_subtree (c, subtree_registration_id));
1327 g_assert_cmpint (data.num_unregistered_subtree_calls, ==, 2);
1328 nodes = get_nodes_at (c, "/foo/boss/executives");
1329 g_assert (nodes != NULL);
1330 g_assert_cmpint (g_strv_length (nodes), ==, 1);
1331 g_assert (_g_strv_has_string ((const gchar* const *) nodes, "non_subtree_object"));
1334 g_assert (g_dbus_connection_unregister_object (c, boss_foo_reg_id));
1335 g_assert (g_dbus_connection_unregister_object (c, boss_bar_reg_id));
1336 g_assert (g_dbus_connection_unregister_object (c, worker1_foo_reg_id));
1337 g_assert (g_dbus_connection_unregister_object (c, worker2_bar_reg_id));
1338 g_assert (g_dbus_connection_unregister_object (c, intern1_foo_reg_id));
1339 g_assert (g_dbus_connection_unregister_object (c, intern2_bar_reg_id));
1340 g_assert (g_dbus_connection_unregister_object (c, intern2_foo_reg_id));
1341 g_assert (g_dbus_connection_unregister_object (c, intern3_bar_reg_id));
1342 g_assert (g_dbus_connection_unregister_object (c, non_subtree_object_path_bar_reg_id));
1343 g_assert (g_dbus_connection_unregister_object (c, non_subtree_object_path_foo_reg_id));
1345 g_assert_cmpint (data.num_unregistered_calls, ==, num_successful_registrations);
1347 /* check that we no longer export any objects - TODO: it looks like there's a bug in
1348 * libdbus-1 here: libdbus still reports the '/foo' object; so disable the test for now
1351 nodes = get_nodes_at (c, "/");
1352 g_assert (nodes != NULL);
1353 g_assert_cmpint (g_strv_length (nodes), ==, 0);
1361 /* ---------------------------------------------------------------------------------------------------- */
1370 g_test_init (&argc, &argv, NULL);
1372 /* all the tests rely on a shared main loop */
1373 loop = g_main_loop_new (NULL, FALSE);
1375 /* all the tests use a session bus with a well-known address that we can bring up and down
1376 * using session_bus_up() and session_bus_down().
1378 g_unsetenv ("DISPLAY");
1379 g_setenv ("DBUS_SESSION_BUS_ADDRESS", session_bus_get_temporary_address (), TRUE);
1383 /* TODO: wait a bit for the bus to come up.. ideally session_bus_up() won't return
1384 * until one can connect to the bus but that's not how things work right now
1386 usleep (500 * 1000);
1388 g_test_add_func ("/gdbus/object-registration", test_object_registration);
1389 /* TODO: check that we spit out correct introspection data */
1390 /* TODO: check that registering a whole subtree works */
1395 session_bus_down ();