Branch data Line data Source code
1 : : /* GLib testing framework examples and tests
2 : : *
3 : : * Copyright © 2022 Endless OS Foundation, LLC
4 : : *
5 : : * SPDX-License-Identifier: LGPL-2.1-or-later
6 : : *
7 : : * This library is free software; you can redistribute it and/or
8 : : * modify it under the terms of the GNU Lesser General Public
9 : : * License as published by the Free Software Foundation; either
10 : : * version 2.1 of the License, or (at your option) any later version.
11 : : *
12 : : * This library is distributed in the hope that it will be useful,
13 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 : : * Lesser General Public License for more details.
16 : : *
17 : : * You should have received a copy of the GNU Lesser General
18 : : * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 : : *
20 : : * SPDX-License-Identifier: LGPL-2.1-or-later
21 : : * Author: Philip Withnall <pwithnall@endlessos.org>
22 : : */
23 : :
24 : : #include <gio/gio.h>
25 : : #include <locale.h>
26 : :
27 : : #include "gdbusprivate.h"
28 : :
29 : : static void
30 : 1 : test_dbus_basic (void)
31 : : {
32 : : GTestDBus *bus;
33 : 1 : GDBusConnection *connection = NULL, *connection2 = NULL;
34 : 1 : GDebugControllerDBus *controller = NULL;
35 : : gboolean old_value;
36 : : gboolean debug_enabled;
37 : 1 : GError *local_error = NULL;
38 : :
39 : 1 : g_test_summary ("Smoketest for construction and setting of a #GDebugControllerDBus.");
40 : :
41 : : /* Set up a test session bus and connection. */
42 : 1 : bus = g_test_dbus_new (G_TEST_DBUS_NONE);
43 : 1 : g_test_dbus_up (bus);
44 : :
45 : 1 : connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &local_error);
46 : 1 : g_assert_no_error (local_error);
47 : :
48 : : /* Create a controller for this process. */
49 : 1 : controller = g_debug_controller_dbus_new (connection, NULL, &local_error);
50 : 1 : g_assert_no_error (local_error);
51 : 1 : g_assert_nonnull (controller);
52 : 1 : g_assert_true (G_IS_DEBUG_CONTROLLER_DBUS (controller));
53 : :
54 : : /* Try enabling and disabling debug output from within the process. */
55 : 1 : old_value = g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller));
56 : :
57 : 1 : g_debug_controller_set_debug_enabled (G_DEBUG_CONTROLLER (controller), TRUE);
58 : 1 : g_assert_true (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)));
59 : :
60 : 1 : g_debug_controller_set_debug_enabled (G_DEBUG_CONTROLLER (controller), FALSE);
61 : 1 : g_assert_false (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)));
62 : :
63 : : /* Reset the debug state and check using g_object_get(), to exercise that. */
64 : 1 : g_debug_controller_set_debug_enabled (G_DEBUG_CONTROLLER (controller), old_value);
65 : :
66 : 1 : g_object_get (G_OBJECT (controller),
67 : : "debug-enabled", &debug_enabled,
68 : : "connection", &connection2,
69 : : NULL);
70 : 1 : g_assert_true (debug_enabled == old_value);
71 : 1 : g_assert_true (connection2 == connection);
72 : 1 : g_clear_object (&connection2);
73 : :
74 : 1 : g_debug_controller_dbus_stop (controller);
75 : 1 : while (g_main_context_iteration (NULL, FALSE));
76 : 1 : g_assert_finalize_object (controller);
77 : 1 : g_clear_object (&connection);
78 : :
79 : 1 : g_test_dbus_down (bus);
80 : 1 : g_clear_object (&bus);
81 : 1 : }
82 : :
83 : : static void
84 : 1 : test_dbus_duplicate (void)
85 : : {
86 : : GTestDBus *bus;
87 : 1 : GDBusConnection *connection = NULL;
88 : 1 : GDebugControllerDBus *controller1 = NULL, *controller2 = NULL;
89 : 1 : GError *local_error = NULL;
90 : :
91 : 1 : g_test_summary ("Test that creating a second #GDebugControllerDBus on the same D-Bus connection fails.");
92 : :
93 : : /* Set up a test session bus and connection. */
94 : 1 : bus = g_test_dbus_new (G_TEST_DBUS_NONE);
95 : 1 : g_test_dbus_up (bus);
96 : :
97 : 1 : connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &local_error);
98 : 1 : g_assert_no_error (local_error);
99 : :
100 : : /* Create a controller for this process. */
101 : 1 : controller1 = g_debug_controller_dbus_new (connection, NULL, &local_error);
102 : 1 : g_assert_no_error (local_error);
103 : 1 : g_assert_nonnull (controller1);
104 : :
105 : : /* And try creating a second one. */
106 : 1 : controller2 = g_debug_controller_dbus_new (connection, NULL, &local_error);
107 : 1 : g_assert_error (local_error, G_IO_ERROR, G_IO_ERROR_EXISTS);
108 : 1 : g_assert_null (controller2);
109 : 1 : g_clear_error (&local_error);
110 : :
111 : 1 : g_debug_controller_dbus_stop (controller1);
112 : 1 : while (g_main_context_iteration (NULL, FALSE));
113 : 1 : g_assert_finalize_object (controller1);
114 : 1 : g_clear_object (&connection);
115 : :
116 : 1 : g_test_dbus_down (bus);
117 : 1 : g_clear_object (&bus);
118 : 1 : }
119 : :
120 : : static void
121 : 4 : async_result_cb (GObject *source_object,
122 : : GAsyncResult *result,
123 : : gpointer user_data)
124 : : {
125 : 4 : GAsyncResult **result_out = user_data;
126 : :
127 : 4 : g_assert_null (*result_out);
128 : 4 : *result_out = g_object_ref (result);
129 : :
130 : 4 : g_main_context_wakeup (g_main_context_get_thread_default ());
131 : 4 : }
132 : :
133 : : static gboolean
134 : 1 : authorize_false_cb (GDebugControllerDBus *debug_controller,
135 : : GDBusMethodInvocation *invocation,
136 : : gpointer user_data)
137 : : {
138 : 1 : return FALSE;
139 : : }
140 : :
141 : : static gboolean
142 : 1 : authorize_true_cb (GDebugControllerDBus *debug_controller,
143 : : GDBusMethodInvocation *invocation,
144 : : gpointer user_data)
145 : : {
146 : 1 : return TRUE;
147 : : }
148 : :
149 : : static void
150 : 2 : notify_debug_enabled_cb (GObject *object,
151 : : GParamSpec *pspec,
152 : : gpointer user_data)
153 : : {
154 : 2 : guint *notify_count_out = user_data;
155 : :
156 : 2 : *notify_count_out = *notify_count_out + 1;
157 : 2 : }
158 : :
159 : : static void
160 : 2 : properties_changed_cb (GDBusConnection *connection,
161 : : const gchar *sender_name,
162 : : const gchar *object_path,
163 : : const gchar *interface_name,
164 : : const gchar *signal_name,
165 : : GVariant *parameters,
166 : : gpointer user_data)
167 : : {
168 : 2 : guint *properties_changed_count_out = user_data;
169 : :
170 : 2 : *properties_changed_count_out = *properties_changed_count_out + 1;
171 : 2 : g_main_context_wakeup (g_main_context_get_thread_default ());
172 : 2 : }
173 : :
174 : : static void
175 : 1 : test_dbus_properties (void)
176 : : {
177 : : GTestDBus *bus;
178 : 1 : GDBusConnection *controller_connection = NULL;
179 : 1 : GDBusConnection *remote_connection = NULL;
180 : 1 : GDebugControllerDBus *controller = NULL;
181 : : gboolean old_value;
182 : 1 : GAsyncResult *result = NULL;
183 : 1 : GVariant *reply = NULL;
184 : 1 : GVariant *debug_enabled_variant = NULL;
185 : : gboolean debug_enabled;
186 : 1 : GError *local_error = NULL;
187 : : gulong handler_id;
188 : : gulong notify_id;
189 : 1 : guint notify_count = 0;
190 : : guint properties_changed_id;
191 : 1 : guint properties_changed_count = 0;
192 : :
193 : 1 : g_test_summary ("Test getting and setting properties on a #GDebugControllerDBus.");
194 : :
195 : : /* Set up a test session bus and connection. Set up a separate second
196 : : * connection to simulate a remote peer. */
197 : 1 : bus = g_test_dbus_new (G_TEST_DBUS_NONE);
198 : 1 : g_test_dbus_up (bus);
199 : :
200 : 1 : controller_connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &local_error);
201 : 1 : g_assert_no_error (local_error);
202 : :
203 : 1 : remote_connection = g_dbus_connection_new_for_address_sync (g_test_dbus_get_bus_address (bus),
204 : : G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
205 : : G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
206 : : NULL,
207 : : NULL,
208 : : &local_error);
209 : 1 : g_assert_no_error (local_error);
210 : :
211 : : /* Create a controller for this process. */
212 : 1 : controller = g_debug_controller_dbus_new (controller_connection, NULL, &local_error);
213 : 1 : g_assert_no_error (local_error);
214 : 1 : g_assert_nonnull (controller);
215 : 1 : g_assert_true (G_IS_DEBUG_CONTROLLER_DBUS (controller));
216 : :
217 : 1 : old_value = g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller));
218 : 1 : notify_id = g_signal_connect (controller, "notify::debug-enabled", G_CALLBACK (notify_debug_enabled_cb), ¬ify_count);
219 : :
220 : 1 : properties_changed_id = g_dbus_connection_signal_subscribe (remote_connection,
221 : : g_dbus_connection_get_unique_name (controller_connection),
222 : : DBUS_INTERFACE_PROPERTIES,
223 : : "PropertiesChanged",
224 : : "/org/gtk/Debugging",
225 : : NULL,
226 : : G_DBUS_SIGNAL_FLAGS_NONE,
227 : : properties_changed_cb,
228 : : &properties_changed_count,
229 : : NULL);
230 : :
231 : : /* Get the debug status remotely. */
232 : 1 : g_dbus_connection_call (remote_connection,
233 : : g_dbus_connection_get_unique_name (controller_connection),
234 : : "/org/gtk/Debugging",
235 : : DBUS_INTERFACE_PROPERTIES,
236 : : "Get",
237 : : g_variant_new ("(ss)", "org.gtk.Debugging", "DebugEnabled"),
238 : : G_VARIANT_TYPE ("(v)"),
239 : : G_DBUS_CALL_FLAGS_NONE,
240 : : -1,
241 : : NULL,
242 : : async_result_cb,
243 : : &result);
244 : 1 : g_assert_no_error (local_error);
245 : :
246 : 3 : while (result == NULL)
247 : 2 : g_main_context_iteration (NULL, TRUE);
248 : :
249 : 1 : reply = g_dbus_connection_call_finish (remote_connection, result, &local_error);
250 : 1 : g_assert_no_error (local_error);
251 : 1 : g_clear_object (&result);
252 : :
253 : 1 : g_variant_get (reply, "(v)", &debug_enabled_variant);
254 : 1 : debug_enabled = g_variant_get_boolean (debug_enabled_variant);
255 : 1 : g_assert_true (debug_enabled == old_value);
256 : 1 : g_assert_cmpuint (notify_count, ==, 0);
257 : 1 : g_assert_cmpuint (properties_changed_count, ==, 0);
258 : :
259 : 1 : g_clear_pointer (&debug_enabled_variant, g_variant_unref);
260 : 1 : g_clear_pointer (&reply, g_variant_unref);
261 : :
262 : : /* Set the debug status remotely. The first attempt should fail due to no
263 : : * authorisation handler being connected. The second should fail due to the
264 : : * now-connected handler returning %FALSE. The third attempt should
265 : : * succeed. */
266 : 1 : g_dbus_connection_call (remote_connection,
267 : : g_dbus_connection_get_unique_name (controller_connection),
268 : : "/org/gtk/Debugging",
269 : : "org.gtk.Debugging",
270 : : "SetDebugEnabled",
271 : : g_variant_new ("(b)", !old_value),
272 : : NULL,
273 : : G_DBUS_CALL_FLAGS_NONE,
274 : : -1,
275 : : NULL,
276 : : async_result_cb,
277 : : &result);
278 : :
279 : 5 : while (result == NULL)
280 : 4 : g_main_context_iteration (NULL, TRUE);
281 : :
282 : 1 : reply = g_dbus_connection_call_finish (remote_connection, result, &local_error);
283 : 1 : g_assert_error (local_error, G_DBUS_ERROR, G_DBUS_ERROR_ACCESS_DENIED);
284 : 1 : g_clear_object (&result);
285 : 1 : g_clear_error (&local_error);
286 : :
287 : 1 : g_assert_true (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)) == old_value);
288 : 1 : g_assert_cmpuint (notify_count, ==, 0);
289 : 1 : g_assert_cmpuint (properties_changed_count, ==, 0);
290 : :
291 : 1 : g_clear_pointer (&debug_enabled_variant, g_variant_unref);
292 : 1 : g_clear_pointer (&reply, g_variant_unref);
293 : :
294 : : /* Attach an authorisation handler and try again. */
295 : 1 : handler_id = g_signal_connect (controller, "authorize", G_CALLBACK (authorize_false_cb), NULL);
296 : :
297 : 1 : g_dbus_connection_call (remote_connection,
298 : : g_dbus_connection_get_unique_name (controller_connection),
299 : : "/org/gtk/Debugging",
300 : : "org.gtk.Debugging",
301 : : "SetDebugEnabled",
302 : : g_variant_new ("(b)", !old_value),
303 : : NULL,
304 : : G_DBUS_CALL_FLAGS_NONE,
305 : : -1,
306 : : NULL,
307 : : async_result_cb,
308 : : &result);
309 : :
310 : 5 : while (result == NULL)
311 : 4 : g_main_context_iteration (NULL, TRUE);
312 : :
313 : 1 : reply = g_dbus_connection_call_finish (remote_connection, result, &local_error);
314 : 1 : g_assert_error (local_error, G_DBUS_ERROR, G_DBUS_ERROR_ACCESS_DENIED);
315 : 1 : g_clear_object (&result);
316 : 1 : g_clear_error (&local_error);
317 : :
318 : 1 : g_assert_true (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)) == old_value);
319 : 1 : g_assert_cmpuint (notify_count, ==, 0);
320 : 1 : g_assert_cmpuint (properties_changed_count, ==, 0);
321 : :
322 : 1 : g_clear_pointer (&debug_enabled_variant, g_variant_unref);
323 : 1 : g_clear_pointer (&reply, g_variant_unref);
324 : :
325 : 1 : g_signal_handler_disconnect (controller, handler_id);
326 : 1 : handler_id = 0;
327 : :
328 : : /* Attach another signal handler which will grant access, and try again. */
329 : 1 : handler_id = g_signal_connect (controller, "authorize", G_CALLBACK (authorize_true_cb), NULL);
330 : :
331 : 1 : g_dbus_connection_call (remote_connection,
332 : : g_dbus_connection_get_unique_name (controller_connection),
333 : : "/org/gtk/Debugging",
334 : : "org.gtk.Debugging",
335 : : "SetDebugEnabled",
336 : : g_variant_new ("(b)", !old_value),
337 : : NULL,
338 : : G_DBUS_CALL_FLAGS_NONE,
339 : : -1,
340 : : NULL,
341 : : async_result_cb,
342 : : &result);
343 : :
344 : 5 : while (result == NULL)
345 : 4 : g_main_context_iteration (NULL, TRUE);
346 : :
347 : 1 : reply = g_dbus_connection_call_finish (remote_connection, result, &local_error);
348 : 1 : g_assert_no_error (local_error);
349 : 1 : g_clear_object (&result);
350 : :
351 : 1 : g_assert_true (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)) == !old_value);
352 : 1 : g_assert_cmpuint (notify_count, ==, 1);
353 : 1 : g_assert_cmpuint (properties_changed_count, ==, 1);
354 : :
355 : 1 : g_clear_pointer (&debug_enabled_variant, g_variant_unref);
356 : 1 : g_clear_pointer (&reply, g_variant_unref);
357 : :
358 : 1 : g_signal_handler_disconnect (controller, handler_id);
359 : 1 : handler_id = 0;
360 : :
361 : : /* Set the debug status locally. */
362 : 1 : g_debug_controller_set_debug_enabled (G_DEBUG_CONTROLLER (controller), old_value);
363 : 1 : g_assert_true (g_debug_controller_get_debug_enabled (G_DEBUG_CONTROLLER (controller)) == old_value);
364 : 1 : g_assert_cmpuint (notify_count, ==, 2);
365 : :
366 : 3 : while (properties_changed_count != 2)
367 : 2 : g_main_context_iteration (NULL, TRUE);
368 : :
369 : 1 : g_assert_cmpuint (properties_changed_count, ==, 2);
370 : :
371 : 1 : g_signal_handler_disconnect (controller, notify_id);
372 : 1 : notify_id = 0;
373 : :
374 : 1 : g_dbus_connection_signal_unsubscribe (remote_connection, g_steal_handle_id (&properties_changed_id));
375 : :
376 : 1 : g_debug_controller_dbus_stop (controller);
377 : 1 : while (g_main_context_iteration (NULL, FALSE));
378 : 1 : g_assert_finalize_object (controller);
379 : 1 : g_clear_object (&controller_connection);
380 : 1 : g_clear_object (&remote_connection);
381 : :
382 : 1 : g_test_dbus_down (bus);
383 : 1 : g_clear_object (&bus);
384 : 1 : }
385 : :
386 : : static GLogWriterOutput
387 : 0 : noop_log_writer_cb (GLogLevelFlags log_level,
388 : : const GLogField *fields,
389 : : gsize n_fields,
390 : : gpointer user_data)
391 : : {
392 : 0 : return G_LOG_WRITER_HANDLED;
393 : : }
394 : :
395 : : int
396 : 1 : main (int argc,
397 : : char *argv[])
398 : : {
399 : 1 : setlocale (LC_ALL, "");
400 : 1 : g_test_init (&argc, &argv, NULL);
401 : :
402 : : /* Ignore the log messages, as the debug controller prints one when debug is
403 : : * enabled/disabled, and if debug is enabled then that will escape to stdout. */
404 : 1 : g_log_set_writer_func (noop_log_writer_cb, NULL, NULL);
405 : :
406 : 1 : g_test_add_func ("/debug-controller/dbus/basic", test_dbus_basic);
407 : 1 : g_test_add_func ("/debug-controller/dbus/duplicate", test_dbus_duplicate);
408 : 1 : g_test_add_func ("/debug-controller/dbus/properties", test_dbus_properties);
409 : :
410 : 1 : return g_test_run ();
411 : : }
|
