/* GLib testing framework examples and tests * * Copyright (C) 2008-2010 Red Hat, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General * Public License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307, USA. * * Author: David Zeuthen */ #include #include #include #include "gdbus-tests.h" /* all tests rely on a shared mainloop */ static GMainLoop *loop = NULL; /* ---------------------------------------------------------------------------------------------------- */ /* Test that the method aspects of GDBusProxy works */ /* ---------------------------------------------------------------------------------------------------- */ static void test_methods (GDBusConnection *connection, const gchar *name, const gchar *name_owner, GDBusProxy *proxy) { GVariant *result; GError *error; const gchar *str; gchar *dbus_error_name; /* check that we can invoke a method */ error = NULL; result = g_dbus_proxy_call_sync (proxy, "HelloWorld", g_variant_new ("(s)", "Hey"), G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "(s)"); g_variant_get (result, "(&s)", &str); g_assert_cmpstr (str, ==, "You greeted me with 'Hey'. Thanks!"); g_variant_unref (result); /* Check that we can completely recover the returned error */ result = g_dbus_proxy_call_sync (proxy, "HelloWorld", g_variant_new ("(s)", "Yo"), G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_error (error, G_IO_ERROR, G_IO_ERROR_DBUS_ERROR); g_assert (g_dbus_error_is_remote_error (error)); g_assert (g_dbus_error_is_remote_error (error)); g_assert (result == NULL); dbus_error_name = g_dbus_error_get_remote_error (error); g_assert_cmpstr (dbus_error_name, ==, "com.example.TestException"); g_free (dbus_error_name); g_assert (g_dbus_error_strip_remote_error (error)); g_assert_cmpstr (error->message, ==, "Yo is not a proper greeting"); g_clear_error (&error); /* Check that we get a timeout if the method handling is taking longer than timeout */ error = NULL; result = g_dbus_proxy_call_sync (proxy, "Sleep", g_variant_new ("(i)", 500 /* msec */), G_DBUS_CALL_FLAGS_NONE, 100 /* msec */, NULL, &error); g_assert_error (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT); g_assert (!g_dbus_error_is_remote_error (error)); g_assert (result == NULL); g_clear_error (&error); /* Check that proxy-default timeouts work. */ g_assert_cmpint (g_dbus_proxy_get_default_timeout (proxy), ==, -1); /* the default timeout is 25000 msec so this should work */ result = g_dbus_proxy_call_sync (proxy, "Sleep", g_variant_new ("(i)", 500 /* msec */), G_DBUS_CALL_FLAGS_NONE, -1, /* use proxy default (e.g. -1 -> e.g. 25000 msec) */ NULL, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "()"); g_variant_unref (result); /* now set the proxy-default timeout to 250 msec and try the 500 msec call - this should FAIL */ g_dbus_proxy_set_default_timeout (proxy, 250); g_assert_cmpint (g_dbus_proxy_get_default_timeout (proxy), ==, 250); result = g_dbus_proxy_call_sync (proxy, "Sleep", g_variant_new ("(i)", 500 /* msec */), G_DBUS_CALL_FLAGS_NONE, -1, /* use proxy default (e.g. 250 msec) */ NULL, &error); g_assert_error (error, G_IO_ERROR, G_IO_ERROR_TIMED_OUT); g_assert (!g_dbus_error_is_remote_error (error)); g_assert (result == NULL); g_clear_error (&error); /* clean up after ourselves */ g_dbus_proxy_set_default_timeout (proxy, -1); } /* ---------------------------------------------------------------------------------------------------- */ /* Test that the property aspects of GDBusProxy works */ /* ---------------------------------------------------------------------------------------------------- */ static void test_properties (GDBusConnection *connection, const gchar *name, const gchar *name_owner, GDBusProxy *proxy) { GError *error; GVariant *variant; GVariant *variant2; GVariant *result; error = NULL; /* * Check that we can read cached properties. * * No need to test all properties - GVariant has already been tested */ variant = g_dbus_proxy_get_cached_property (proxy, "y"); g_assert (variant != NULL); g_assert_cmpint (g_variant_get_byte (variant), ==, 1); g_variant_unref (variant); variant = g_dbus_proxy_get_cached_property (proxy, "o"); g_assert (variant != NULL); g_assert_cmpstr (g_variant_get_string (variant, NULL), ==, "/some/path"); g_variant_unref (variant); /* * Now ask the service to change a property and check that #GDBusProxy::g-property-changed * is received. Also check that the cache is updated. */ variant2 = g_variant_new_byte (42); result = g_dbus_proxy_call_sync (proxy, "FrobSetProperty", g_variant_new ("(sv)", "y", variant2), G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "()"); g_variant_unref (result); _g_assert_signal_received (proxy, "g-properties-changed"); variant = g_dbus_proxy_get_cached_property (proxy, "y"); g_assert (variant != NULL); g_assert_cmpint (g_variant_get_byte (variant), ==, 42); g_variant_unref (variant); g_dbus_proxy_set_cached_property (proxy, "y", g_variant_new_byte (142)); variant = g_dbus_proxy_get_cached_property (proxy, "y"); g_assert (variant != NULL); g_assert_cmpint (g_variant_get_byte (variant), ==, 142); g_variant_unref (variant); g_dbus_proxy_set_cached_property (proxy, "y", NULL); variant = g_dbus_proxy_get_cached_property (proxy, "y"); g_assert (variant == NULL); /* Check that the invalidation feature of the PropertiesChanged() * signal works... First, check that we have a cached value of the * property (from the initial GetAll() call) */ variant = g_dbus_proxy_get_cached_property (proxy, "PropertyThatWillBeInvalidated"); g_assert (variant != NULL); g_assert_cmpstr (g_variant_get_string (variant, NULL), ==, "InitialValue"); g_variant_unref (variant); /* now ask to invalidate the property - this causes a * * PropertiesChanaged("com.example.Frob", * {}, * ["PropertyThatWillBeInvalidated") * * signal to be emitted. This is received before the method reply * for FrobInvalidateProperty *but* since the proxy was created in * the same thread as we're doing this synchronous call, we'll get * the method reply before... */ result = g_dbus_proxy_call_sync (proxy, "FrobInvalidateProperty", NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "()"); g_variant_unref (result); /* ... hence we wait for the g-properties-changed signal to be delivered */ _g_assert_signal_received (proxy, "g-properties-changed"); /* ... and now we finally, check that the cached value has been invalidated */ variant = g_dbus_proxy_get_cached_property (proxy, "PropertyThatWillBeInvalidated"); g_assert (variant == NULL); } /* ---------------------------------------------------------------------------------------------------- */ /* Test that the signal aspects of GDBusProxy works */ /* ---------------------------------------------------------------------------------------------------- */ static void test_proxy_signals_on_signal (GDBusProxy *proxy, const gchar *sender_name, const gchar *signal_name, GVariant *parameters, gpointer user_data) { GString *s = user_data; g_assert_cmpstr (signal_name, ==, "TestSignal"); g_assert_cmpstr (g_variant_get_type_string (parameters), ==, "(sov)"); g_variant_print_string (parameters, s, TRUE); } typedef struct { GMainLoop *internal_loop; GString *s; } TestSignalData; static void test_proxy_signals_on_emit_signal_cb (GDBusProxy *proxy, GAsyncResult *res, gpointer user_data) { TestSignalData *data = user_data; GError *error; GVariant *result; error = NULL; result = g_dbus_proxy_call_finish (proxy, res, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "()"); g_variant_unref (result); /* check that the signal was recieved before we got the method result */ g_assert (strlen (data->s->str) > 0); /* break out of the loop */ g_main_loop_quit (data->internal_loop); } static void test_signals (GDBusConnection *connection, const gchar *name, const gchar *name_owner, GDBusProxy *proxy) { GError *error; GString *s; gulong signal_handler_id; TestSignalData data; GVariant *result; error = NULL; /* * Ask the service to emit a signal and check that we receive it. * * Note that blocking calls don't block in the mainloop so wait for the signal (which * is dispatched before the method reply) */ s = g_string_new (NULL); signal_handler_id = g_signal_connect (proxy, "g-signal", G_CALLBACK (test_proxy_signals_on_signal), s); result = g_dbus_proxy_call_sync (proxy, "EmitSignal", g_variant_new ("(so)", "Accept the next proposition you hear", "/some/path"), G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_no_error (error); g_assert (result != NULL); g_assert_cmpstr (g_variant_get_type_string (result), ==, "()"); g_variant_unref (result); /* check that we haven't received the signal just yet */ g_assert (strlen (s->str) == 0); /* and now wait for the signal */ _g_assert_signal_received (proxy, "g-signal"); g_assert_cmpstr (s->str, ==, "('Accept the next proposition you hear .. in bed!', objectpath '/some/path/in/bed', <'a variant'>)"); g_signal_handler_disconnect (proxy, signal_handler_id); g_string_free (s, TRUE); /* * Now do this async to check the signal is received before the method returns. */ s = g_string_new (NULL); data.internal_loop = g_main_loop_new (NULL, FALSE); data.s = s; signal_handler_id = g_signal_connect (proxy, "g-signal", G_CALLBACK (test_proxy_signals_on_signal), s); g_dbus_proxy_call (proxy, "EmitSignal", g_variant_new ("(so)", "You will make a great programmer", "/some/other/path"), G_DBUS_CALL_FLAGS_NONE, -1, NULL, (GAsyncReadyCallback) test_proxy_signals_on_emit_signal_cb, &data); g_main_loop_run (data.internal_loop); g_main_loop_unref (data.internal_loop); g_assert_cmpstr (s->str, ==, "('You will make a great programmer .. in bed!', objectpath '/some/other/path/in/bed', <'a variant'>)"); g_signal_handler_disconnect (proxy, signal_handler_id); g_string_free (s, TRUE); } static void test_bogus_method_return (GDBusConnection *connection, const gchar *name, const gchar *name_owner, GDBusProxy *proxy) { GError *error = NULL; GVariant *result; result = g_dbus_proxy_call_sync (proxy, "PairReturn", NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, &error); g_assert_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT); g_assert (result == NULL); } /* ---------------------------------------------------------------------------------------------------- */ static const gchar *frob_dbus_interface_xml = "" " " /* Deliberately different from gdbus-testserver.py's definition */ " " " " " " " " " " " " " " " " " " " " " " " " " " ""; static GDBusInterfaceInfo *frob_dbus_interface_info; static void on_proxy_appeared (GDBusConnection *connection, const gchar *name, const gchar *name_owner, GDBusProxy *proxy, gpointer user_data) { test_methods (connection, name, name_owner, proxy); test_properties (connection, name, name_owner, proxy); test_signals (connection, name, name_owner, proxy); /* This is obviously wrong but expected interface is not set so we don't fail... */ g_dbus_proxy_set_cached_property (proxy, "y", g_variant_new_string ("error_me_out!")); g_dbus_proxy_set_cached_property (proxy, "y", g_variant_new_byte (42)); g_dbus_proxy_set_cached_property (proxy, "does-not-exist", g_variant_new_string ("something")); g_dbus_proxy_set_cached_property (proxy, "does-not-exist", NULL); /* Now repeat the method tests, with an expected interface set */ g_dbus_proxy_set_interface_info (proxy, frob_dbus_interface_info); test_methods (connection, name, name_owner, proxy); /* And now one more test where we deliberately set the expected * interface definition incorrectly */ test_bogus_method_return (connection, name, name_owner, proxy); /* Also check that we complain if setting a cached property of the wrong type */ if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) { g_dbus_proxy_set_cached_property (proxy, "y", g_variant_new_string ("error_me_out!")); } g_test_trap_assert_stderr ("*Trying to set property y of type s but according to the expected interface the type is y*"); g_test_trap_assert_failed(); if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) { g_dbus_proxy_set_cached_property (proxy, "does-not-exist", g_variant_new_string ("something")); } g_test_trap_assert_stderr ("*Trying to lookup property does-not-exist which isn't in expected interface com.example.Frob*"); g_test_trap_assert_failed(); /* this should work, however (since the type is correct) */ g_dbus_proxy_set_cached_property (proxy, "y", g_variant_new_byte (42)); g_main_loop_quit (loop); } static void on_proxy_vanished (GDBusConnection *connection, const gchar *name, gpointer user_data) { } static void test_proxy (void) { guint watcher_id; session_bus_up (); /* TODO: wait a bit for the bus to come up.. ideally session_bus_up() won't return * until one can connect to the bus but that's not how things work right now */ usleep (500 * 1000); watcher_id = g_bus_watch_proxy (G_BUS_TYPE_SESSION, "com.example.TestService", G_BUS_NAME_WATCHER_FLAGS_NONE, "/com/example/TestObject", "com.example.Frob", G_TYPE_DBUS_PROXY, G_DBUS_PROXY_FLAGS_NONE, on_proxy_appeared, on_proxy_vanished, NULL, NULL); /* this is safe; testserver will exit once the bus goes away */ g_assert (g_spawn_command_line_async (SRCDIR "/gdbus-testserver.py", NULL)); g_main_loop_run (loop); g_bus_unwatch_proxy (watcher_id); /* tear down bus */ session_bus_down (); } /* ---------------------------------------------------------------------------------------------------- */ int main (int argc, char *argv[]) { gint ret; GDBusNodeInfo *introspection_data = NULL; g_type_init (); g_test_init (&argc, &argv, NULL); introspection_data = g_dbus_node_info_new_for_xml (frob_dbus_interface_xml, NULL); g_assert (introspection_data != NULL); frob_dbus_interface_info = introspection_data->interfaces[0]; /* all the tests rely on a shared main loop */ loop = g_main_loop_new (NULL, FALSE); /* all the tests use a session bus with a well-known address that we can bring up and down * using session_bus_up() and session_bus_down(). */ g_unsetenv ("DISPLAY"); g_setenv ("DBUS_SESSION_BUS_ADDRESS", session_bus_get_temporary_address (), TRUE); g_test_add_func ("/gdbus/proxy", test_proxy); ret = g_test_run(); g_dbus_node_info_unref (introspection_data); return ret; }