1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
# NOTE: This is not strictly needed, but included to get code coverage for
# deferred evaluation of annotations. Do not remove this line.
from __future__ import annotations
import asyncio
from typing import Annotated, no_type_check
import pytest
from dbus_fast import (
DBusError,
ErrorType,
Message,
MessageFlag,
MessageType,
SignatureTree,
Variant,
)
from dbus_fast.aio import MessageBus
from dbus_fast.annotations import DBusDict, DBusSignature, DBusStr, DBusVariant
from dbus_fast.service import ServiceInterface, dbus_method
class ExampleInterface(ServiceInterface):
def __init__(self, name: str) -> None:
super().__init__(name)
@dbus_method()
def echo(self, what: DBusStr) -> DBusStr:
assert type(self) is ExampleInterface
return what
# This one intentionally keeps string-style annotations for coverage purposes.
@no_type_check
@dbus_method()
def echo_multiple(self, what1: "s", what2: "s") -> "ss": # noqa: UP037
assert type(self) is ExampleInterface
return what1, what2
@dbus_method()
def echo_containers(
self,
array: Annotated[list[str], DBusSignature("as")],
variant: DBusVariant,
dict_entries: DBusDict,
struct: Annotated[
tuple[str, tuple[str, tuple[Variant]]], DBusSignature("(s(s(v)))")
],
) -> Annotated[
tuple[
list[str],
Variant,
dict[str, Variant],
tuple[str, tuple[str, tuple[Variant]]],
],
DBusSignature("asva{sv}(s(s(v)))"),
]:
assert type(self) is ExampleInterface
return array, variant, dict_entries, struct
@dbus_method()
def ping(self):
assert type(self) is ExampleInterface
@dbus_method(name="renamed")
def original_name(self):
assert type(self) is ExampleInterface
@dbus_method(disabled=True)
def not_here(self):
assert type(self) is ExampleInterface
@dbus_method()
def throws_unexpected_error(self):
assert type(self) is ExampleInterface
raise Exception("oops")
@dbus_method()
def throws_dbus_error(self):
assert type(self) is ExampleInterface
raise DBusError("test.error", "an error occurred")
class AsyncInterface(ServiceInterface):
def __init__(self, name: str) -> None:
super().__init__(name)
@dbus_method()
async def echo(self, what: DBusStr) -> DBusStr:
assert type(self) is AsyncInterface
return what
@dbus_method()
async def echo_multiple(
self, what1: DBusStr, what2: DBusStr
) -> Annotated[tuple[str, str], DBusSignature("ss")]:
assert type(self) is AsyncInterface
return what1, what2
@dbus_method()
async def echo_containers(
self,
array: Annotated[list[str], DBusSignature("as")],
variant: DBusVariant,
dict_entries: DBusDict,
struct: Annotated[
tuple[str, tuple[str, tuple[Variant]]], DBusSignature("(s(s(v)))")
],
) -> Annotated[
tuple[
list[str],
Variant,
dict[str, Variant],
tuple[str, tuple[str, tuple[Variant]]],
],
DBusSignature("asva{sv}(s(s(v)))"),
]:
assert type(self) is AsyncInterface
return array, variant, dict_entries, struct
@dbus_method()
async def ping(self):
assert type(self) is AsyncInterface
@dbus_method(name="renamed")
async def original_name(self):
assert type(self) is AsyncInterface
@dbus_method(disabled=True)
async def not_here(self):
assert type(self) is AsyncInterface
@dbus_method()
async def throws_unexpected_error(self):
assert type(self) is AsyncInterface
raise Exception("oops")
@dbus_method()
def throws_dbus_error(self):
assert type(self) is AsyncInterface
raise DBusError("test.error", "an error occurred")
@pytest.mark.parametrize("interface_class", [ExampleInterface, AsyncInterface])
@pytest.mark.asyncio
async def test_methods(interface_class):
bus1 = await MessageBus().connect()
bus2 = await MessageBus().connect()
interface = interface_class("test.interface")
export_path = "/test/path"
async def call(
member, signature="", body=[], flags=MessageFlag.NONE, interface=interface.name
):
msg = Message(
destination=bus1.unique_name,
path=export_path,
interface=interface,
member=member,
signature=signature,
body=body,
flags=flags,
)
if flags & MessageFlag.NO_REPLY_EXPECTED:
await bus2.send(msg)
return None
return await bus2.call(msg)
bus1.export(export_path, interface)
body = ["hello world"]
reply = await call("echo", "s", body)
assert reply.message_type == MessageType.METHOD_RETURN, reply.body[0]
assert reply.signature == "s"
assert reply.body == body
body = ["hello", "world"]
reply = await call("echo_multiple", "ss", body)
assert reply.message_type == MessageType.METHOD_RETURN, reply.body[0]
assert reply.signature == "ss"
assert reply.body == body
body = [
["hello", "world"],
Variant("v", Variant("(ss)", ("hello", "world"))),
{"foo": Variant("t", 100)},
("one", ("two", (Variant("s", "three"),))),
]
signature = "asva{sv}(s(s(v)))"
SignatureTree(signature).verify(body)
reply = await call("echo_containers", signature, body)
assert reply.message_type == MessageType.METHOD_RETURN, reply.body[0]
assert reply.signature == signature
assert reply.body == body
# Wrong interface should be a failure
reply = await call(
"echo_containers", signature, body, interface="org.abc.xyz.Props"
)
assert reply.message_type == MessageType.ERROR, reply.body[0]
assert reply.error_name == "org.freedesktop.DBus.Error.UnknownMethod", reply.body[0]
assert reply.body == [
'org.abc.xyz.Props.echo_containers with signature "asva{sv}(s(s(v)))" could not be found'
]
# No interface should result in finding anything that matches the member name
# and the signature
reply = await call("echo_containers", signature, body, interface=None)
assert reply.message_type == MessageType.METHOD_RETURN, reply.body[0]
assert reply.signature == signature
assert reply.body == body
# No interface should result in finding anything that matches the member name
# and the signature, but in this case it will be nothing because
# the signature is wrong
reply = await call("echo_containers", "as", body, interface=None)
assert reply.message_type == MessageType.ERROR, reply.body[0]
assert reply.error_name == "org.freedesktop.DBus.Error.UnknownMethod", reply.body[0]
assert reply.body == ['None.echo_containers with signature "as" could not be found']
reply = await call("ping")
assert reply.message_type == MessageType.METHOD_RETURN, reply.body[0]
assert reply.signature == ""
assert reply.body == []
reply = await call("throws_unexpected_error")
assert reply.message_type == MessageType.ERROR, reply.body[0]
assert reply.error_name == ErrorType.SERVICE_ERROR.value, reply.body[0]
reply = await call("throws_dbus_error")
assert reply.message_type == MessageType.ERROR, reply.body[0]
assert reply.error_name == "test.error", reply.body[0]
assert reply.body == ["an error occurred"]
reply = await call("ping", flags=MessageFlag.NO_REPLY_EXPECTED)
assert reply is None
reply = await call("throws_unexpected_error", flags=MessageFlag.NO_REPLY_EXPECTED)
assert reply is None
reply = await call("throws_dbus_error", flags=MessageFlag.NO_REPLY_EXPECTED)
assert reply is None
reply = await call("does_not_exist")
assert reply.message_type == MessageType.ERROR, reply.body[0]
assert reply.error_name == "org.freedesktop.DBus.Error.UnknownMethod", reply.body[0]
assert reply.body == [
'test.interface.does_not_exist with signature "" could not be found'
]
bus1.disconnect()
bus2.disconnect()
await asyncio.wait_for(bus1.wait_for_disconnect(), timeout=1)
await asyncio.wait_for(bus2.wait_for_disconnect(), timeout=1)
|
