Branch data Line data Source code
1 : : /* GLib testing framework examples and tests
2 : : *
3 : : * Copyright (C) 2008-2010 Red Hat, Inc.
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 : : * Author: David Zeuthen <davidz@redhat.com>
21 : : */
22 : :
23 : : #include <gio/gio.h>
24 : : #include <unistd.h>
25 : : #include <string.h>
26 : :
27 : : #include "gdbusprivate.h"
28 : : #include "gdbus-tests.h"
29 : :
30 : : /* all tests rely on a shared mainloop */
31 : : static GMainLoop *loop = NULL;
32 : :
33 : : /* ---------------------------------------------------------------------------------------------------- */
34 : : /* Test introspection parser */
35 : : /* ---------------------------------------------------------------------------------------------------- */
36 : :
37 : : static void
38 : 1 : test_introspection (GDBusProxy *proxy)
39 : : {
40 : : GError *error;
41 : : const gchar *xml_data;
42 : : GDBusNodeInfo *node_info;
43 : : GDBusInterfaceInfo *interface_info;
44 : : GDBusMethodInfo *method_info;
45 : : GDBusSignalInfo *signal_info;
46 : : GVariant *result;
47 : :
48 : 1 : error = NULL;
49 : :
50 : : /*
51 : : * Invoke Introspect(), then parse the output.
52 : : */
53 : 1 : result = g_dbus_proxy_call_sync (proxy,
54 : : DBUS_INTERFACE_INTROSPECTABLE ".Introspect",
55 : : NULL,
56 : : G_DBUS_CALL_FLAGS_NONE,
57 : : -1,
58 : : NULL,
59 : : &error);
60 : 1 : g_assert_no_error (error);
61 : 1 : g_assert (result != NULL);
62 : 1 : g_variant_get (result, "(&s)", &xml_data);
63 : :
64 : 1 : node_info = g_dbus_node_info_new_for_xml (xml_data, &error);
65 : 1 : g_assert_no_error (error);
66 : 1 : g_assert (node_info != NULL);
67 : :
68 : : /* for now we only check a couple of things. TODO: check more things */
69 : :
70 : 1 : interface_info = g_dbus_node_info_lookup_interface (node_info, "com.example.NonExistantInterface");
71 : 1 : g_assert (interface_info == NULL);
72 : :
73 : 1 : interface_info = g_dbus_node_info_lookup_interface (node_info, DBUS_INTERFACE_INTROSPECTABLE);
74 : 1 : g_assert (interface_info != NULL);
75 : 1 : method_info = g_dbus_interface_info_lookup_method (interface_info, "NonExistantMethod");
76 : 1 : g_assert (method_info == NULL);
77 : 1 : method_info = g_dbus_interface_info_lookup_method (interface_info, "Introspect");
78 : 1 : g_assert (method_info != NULL);
79 : 1 : g_assert (method_info->in_args != NULL);
80 : 1 : g_assert (method_info->in_args[0] == NULL);
81 : 1 : g_assert (method_info->out_args != NULL);
82 : 1 : g_assert (method_info->out_args[0] != NULL);
83 : 1 : g_assert (method_info->out_args[1] == NULL);
84 : 1 : g_assert_cmpstr (method_info->out_args[0]->signature, ==, "s");
85 : :
86 : 1 : interface_info = g_dbus_node_info_lookup_interface (node_info, "com.example.Frob");
87 : 1 : g_assert (interface_info != NULL);
88 : 1 : signal_info = g_dbus_interface_info_lookup_signal (interface_info, "TestSignal");
89 : 1 : g_assert (signal_info != NULL);
90 : 1 : g_assert (signal_info->args != NULL);
91 : 1 : g_assert (signal_info->args[0] != NULL);
92 : 1 : g_assert_cmpstr (signal_info->args[0]->signature, ==, "s");
93 : 1 : g_assert (signal_info->args[1] != NULL);
94 : 1 : g_assert_cmpstr (signal_info->args[1]->signature, ==, "o");
95 : 1 : g_assert (signal_info->args[2] != NULL);
96 : 1 : g_assert_cmpstr (signal_info->args[2]->signature, ==, "v");
97 : 1 : g_assert (signal_info->args[3] == NULL);
98 : :
99 : 1 : g_dbus_node_info_unref (node_info);
100 : 1 : g_variant_unref (result);
101 : :
102 : 1 : g_main_loop_quit (loop);
103 : 1 : }
104 : :
105 : : static void
106 : 1 : test_introspection_parser (void)
107 : : {
108 : : GDBusProxy *proxy;
109 : : GDBusConnection *connection;
110 : : GError *error;
111 : :
112 : 1 : error = NULL;
113 : 1 : connection = g_bus_get_sync (G_BUS_TYPE_SESSION,
114 : : NULL,
115 : : &error);
116 : 1 : g_assert_no_error (error);
117 : 1 : error = NULL;
118 : 1 : proxy = g_dbus_proxy_new_sync (connection,
119 : : G_DBUS_PROXY_FLAGS_NONE,
120 : : NULL, /* GDBusInterfaceInfo */
121 : : "com.example.TestService", /* name */
122 : : "/com/example/TestObject", /* object path */
123 : : "com.example.Frob", /* interface */
124 : : NULL, /* GCancellable */
125 : : &error);
126 : 1 : g_assert_no_error (error);
127 : :
128 : : /* this is safe; testserver will exit once the bus goes away */
129 : 1 : g_assert (g_spawn_command_line_async (g_test_get_filename (G_TEST_BUILT, "gdbus-testserver", NULL), NULL));
130 : :
131 : 1 : _g_assert_property_notify (proxy, "g-name-owner");
132 : :
133 : 1 : test_introspection (proxy);
134 : :
135 : 1 : g_object_unref (proxy);
136 : 1 : g_object_unref (connection);
137 : 1 : }
138 : :
139 : : /* check that a parse-generate roundtrip produces identical results
140 : : */
141 : : static void
142 : 1 : test_generate (void)
143 : : {
144 : : GDBusNodeInfo *info;
145 : : GDBusNodeInfo *info2;
146 : : GDBusInterfaceInfo *iinfo;
147 : : GDBusMethodInfo *minfo;
148 : : GDBusSignalInfo *sinfo;
149 : : GDBusArgInfo *arginfo;
150 : : GDBusPropertyInfo *pinfo;
151 : : GDBusAnnotationInfo *aninfo;
152 : 1 : const gchar *data =
153 : : " <node>"
154 : : " <interface name='com.example.Frob'>"
155 : : " <annotation name='foo' value='bar'/>"
156 : : " <method name='PairReturn'>"
157 : : " <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>"
158 : : " <arg type='u' name='somenumber' direction='in'/>"
159 : : " <arg type='s' name='somestring' direction='out'/>"
160 : : " </method>"
161 : : " <signal name='HelloWorld'>"
162 : : " <arg type='s' name='greeting' direction='out'/>"
163 : : " </signal>"
164 : : " <method name='Sleep'>"
165 : : " <arg type='i' name='timeout' direction='in'/>"
166 : : " </method>"
167 : : " <property name='y' type='y' access='readwrite'>"
168 : : " <annotation name='needs-escaping' value='bar<>'"'/>"
169 : : " </property>"
170 : : " </interface>"
171 : : " </node>";
172 : :
173 : : GString *string;
174 : : GString *string2;
175 : : GError *error;
176 : :
177 : 1 : error = NULL;
178 : 1 : info = g_dbus_node_info_new_for_xml (data, &error);
179 : 1 : g_assert_no_error (error);
180 : :
181 : 1 : iinfo = g_dbus_node_info_lookup_interface (info, "com.example.Frob");
182 : 1 : aninfo = iinfo->annotations[0];
183 : 1 : g_assert_cmpstr (aninfo->key, ==, "foo");
184 : 1 : g_assert_cmpstr (aninfo->value, ==, "bar");
185 : 1 : g_assert (iinfo->annotations[1] == NULL);
186 : 1 : minfo = g_dbus_interface_info_lookup_method (iinfo, "PairReturn");
187 : 1 : g_assert_cmpstr (g_dbus_annotation_info_lookup (minfo->annotations, "org.freedesktop.DBus.GLib.Async"), ==, "");
188 : 1 : arginfo = minfo->in_args[0];
189 : 1 : g_assert_cmpstr (arginfo->name, ==, "somenumber");
190 : 1 : g_assert_cmpstr (arginfo->signature, ==, "u");
191 : 1 : g_assert (minfo->in_args[1] == NULL);
192 : 1 : arginfo = minfo->out_args[0];
193 : 1 : g_assert_cmpstr (arginfo->name, ==, "somestring");
194 : 1 : g_assert_cmpstr (arginfo->signature, ==, "s");
195 : 1 : g_assert (minfo->out_args[1] == NULL);
196 : 1 : sinfo = g_dbus_interface_info_lookup_signal (iinfo, "HelloWorld");
197 : 1 : arginfo = sinfo->args[0];
198 : 1 : g_assert_cmpstr (arginfo->name, ==, "greeting");
199 : 1 : g_assert_cmpstr (arginfo->signature, ==, "s");
200 : 1 : g_assert (sinfo->args[1] == NULL);
201 : 1 : pinfo = g_dbus_interface_info_lookup_property (iinfo, "y");
202 : 1 : g_assert_cmpstr (pinfo->signature, ==, "y");
203 : 1 : g_assert_cmpint (pinfo->flags, ==, G_DBUS_PROPERTY_INFO_FLAGS_READABLE |
204 : : G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE);
205 : :
206 : 1 : string = g_string_new ("");
207 : 1 : g_dbus_node_info_generate_xml (info, 2, string);
208 : :
209 : 1 : info2 = g_dbus_node_info_new_for_xml (string->str, &error);
210 : 1 : string2 = g_string_new ("");
211 : 1 : g_dbus_node_info_generate_xml (info2, 2, string2);
212 : :
213 : 1 : g_assert_cmpstr (string->str, ==, string2->str);
214 : 1 : g_string_free (string, TRUE);
215 : 1 : g_string_free (string2, TRUE);
216 : :
217 : 1 : g_dbus_node_info_unref (info);
218 : 1 : g_dbus_node_info_unref (info2);
219 : 1 : }
220 : :
221 : : /* test that omitted direction attributes default to 'out' for signals,
222 : : * and 'in' for methods.
223 : : */
224 : : static void
225 : 1 : test_default_direction (void)
226 : : {
227 : : GDBusNodeInfo *info;
228 : : GDBusInterfaceInfo *iinfo;
229 : : GDBusMethodInfo *minfo;
230 : : GDBusSignalInfo *sinfo;
231 : : GDBusArgInfo *arginfo;
232 : 1 : const gchar *data =
233 : : " <node>"
234 : : " <interface name='com.example.Frob'>"
235 : : " <signal name='HelloWorld'>"
236 : : " <arg type='s' name='greeting'/>"
237 : : " </signal>"
238 : : " <method name='Sleep'>"
239 : : " <arg type='i' name='timeout'/>"
240 : : " </method>"
241 : : " </interface>"
242 : : " </node>";
243 : :
244 : : GError *error;
245 : :
246 : 1 : error = NULL;
247 : 1 : info = g_dbus_node_info_new_for_xml (data, &error);
248 : 1 : g_assert_no_error (error);
249 : :
250 : 1 : iinfo = g_dbus_node_info_lookup_interface (info, "com.example.Frob");
251 : 1 : sinfo = g_dbus_interface_info_lookup_signal (iinfo, "HelloWorld");
252 : 1 : g_assert (sinfo->args != NULL);
253 : 1 : arginfo = sinfo->args[0];
254 : 1 : g_assert_cmpstr (arginfo->name, ==, "greeting");
255 : 1 : g_assert (sinfo->args[1] == NULL);
256 : 1 : minfo = g_dbus_interface_info_lookup_method (iinfo, "Sleep");
257 : 1 : g_assert (minfo->in_args != NULL);
258 : 1 : arginfo = minfo->in_args[0];
259 : 1 : g_assert_cmpstr (arginfo->name, ==, "timeout");
260 : 1 : g_assert (minfo->in_args[1] == NULL);
261 : :
262 : 1 : g_dbus_node_info_unref (info);
263 : 1 : }
264 : :
265 : : static void
266 : 1 : test_extra_data (void)
267 : : {
268 : : GDBusNodeInfo *info;
269 : 1 : const gchar *data =
270 : : " <node>"
271 : : " <interface name='com.example.Frob' version='1.0'>"
272 : : " <doc:doc><doc:description><doc:para>Blah blah</doc:para></doc:description></doc:doc>"
273 : : " <method name='DownloadPackages'>"
274 : : " <arg type='u' name='somenumber' direction='in'>"
275 : : " <doc:doc><doc:summary><doc:para>"
276 : : " See <doc:ulink url='http:///example.com'>example</doc:ulink>"
277 : : " </doc:para></doc:summary></doc:doc>"
278 : : " </arg>"
279 : : " <arg type='s' name='somestring' direction='out'>"
280 : : " <doc:doc><doc:summary><doc:para>"
281 : : " More docs"
282 : : " </doc:para></doc:summary></doc:doc>"
283 : : " </arg>"
284 : : " </method>"
285 : : " <signal name='HelloWorld'>"
286 : : " <arg type='s' name='somestring'/>"
287 : : " </signal>"
288 : : " <method name='Sleep'>"
289 : : " <arg type='i' name='timeout' direction='in'/>"
290 : : " </method>"
291 : : " <property name='y' type='y' access='readwrite'/>"
292 : : " </interface>"
293 : : " </node>";
294 : : GError *error;
295 : :
296 : 1 : error = NULL;
297 : 1 : info = g_dbus_node_info_new_for_xml (data, &error);
298 : 1 : g_assert_no_error (error);
299 : :
300 : 1 : g_dbus_node_info_unref (info);
301 : 1 : }
302 : :
303 : : /* ---------------------------------------------------------------------------------------------------- */
304 : :
305 : : int
306 : 1 : main (int argc,
307 : : char *argv[])
308 : : {
309 : : gint ret;
310 : :
311 : 1 : g_test_init (&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
312 : :
313 : : /* all the tests rely on a shared main loop */
314 : 1 : loop = g_main_loop_new (NULL, FALSE);
315 : :
316 : 1 : g_test_add_func ("/gdbus/introspection-parser", test_introspection_parser);
317 : 1 : g_test_add_func ("/gdbus/introspection-generate", test_generate);
318 : 1 : g_test_add_func ("/gdbus/introspection-default-direction", test_default_direction);
319 : 1 : g_test_add_func ("/gdbus/introspection-extra-data", test_extra_data);
320 : :
321 : 1 : ret = session_bus_run ();
322 : :
323 : 2 : while (g_main_context_iteration (NULL, FALSE));
324 : 1 : g_main_loop_unref (loop);
325 : :
326 : 1 : return ret;
327 : : }
|
