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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
# SPDX-License-Identifier: LGPL-2.1-or-later
# Copyright (C) 2024 igo95862
# This file is part of python-sdbus
# 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.1 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
from __future__ import annotations
from unittest import TestCase
from sdbus.unittest import IsolatedDbusTestCase
from sdbus.utils.inspect import inspect_dbus_bus, inspect_dbus_path
from sdbus.utils.parse import parse_get_managed_objects
from sdbus import (
DbusInterfaceCommon,
DbusInterfaceCommonAsync,
dbus_property,
dbus_property_async,
sd_bus_open_user,
)
TEST_PATH = "/test"
class FooAsync(DbusInterfaceCommonAsync, interface_name="org.foo"):
@dbus_property_async("x")
def foo(self) -> int:
return 1
class BarAsync(DbusInterfaceCommonAsync, interface_name="org.bar"):
@dbus_property_async("x")
def bar(self) -> int:
return 2
class FooBarAsync(FooAsync, BarAsync):
...
class Foo(DbusInterfaceCommon, interface_name="org.foo"):
@dbus_property("x")
def foo(self) -> int:
return 1
class Bar(DbusInterfaceCommon, interface_name="org.bar"):
@dbus_property("x")
def bar(self) -> int:
return 2
class FooBar(Foo, Bar):
...
MANAGED_OBJECTS_COMBINED = {
"/test": {
"org.foo": {"Foo": ("x", 1)},
"org.bar": {"Bar": ("x", 2)},
}
}
MANAGED_OBJECTS_SPLIT = {
"/foo": {
"org.foo": {"Foo": ("x", 1)},
},
"/bar": {
"org.bar": {"Bar": ("x", 2)},
},
}
MANAGED_OBJECTS_BOTH = {**MANAGED_OBJECTS_COMBINED, **MANAGED_OBJECTS_SPLIT}
class TestSdbusUtilsParse(TestCase):
def test_parse_get_managed_objects_async_combined(self) -> None:
parsed_managed = parse_get_managed_objects(
FooBarAsync,
MANAGED_OBJECTS_COMBINED,
)
self.assertEqual(1, len(parsed_managed))
class_type, properties_data = parsed_managed["/test"]
self.assertEqual(FooBarAsync, class_type)
self.assertEqual(properties_data["foo"], 1)
self.assertEqual(properties_data["bar"], 2)
def test_parse_get_managed_objects_block_combined(self) -> None:
parsed_managed = parse_get_managed_objects(
FooBar,
MANAGED_OBJECTS_COMBINED,
)
self.assertEqual(1, len(parsed_managed))
class_type, properties_data = parsed_managed["/test"]
self.assertEqual(FooBar, class_type)
self.assertEqual(properties_data["foo"], 1)
self.assertEqual(properties_data["bar"], 2)
def test_parse_get_managed_objects_async_split(self) -> None:
parsed_managed = parse_get_managed_objects(
[FooAsync, BarAsync],
MANAGED_OBJECTS_SPLIT,
)
self.assertEqual(2, len(parsed_managed))
class_type, properties_data = parsed_managed["/foo"]
self.assertEqual(FooAsync, class_type)
self.assertEqual(properties_data["foo"], 1)
class_type, properties_data = parsed_managed["/bar"]
self.assertEqual(BarAsync, class_type)
self.assertEqual(properties_data["bar"], 2)
def test_parse_get_managed_objects_block_split(self) -> None:
parsed_managed = parse_get_managed_objects(
[Foo, Bar],
MANAGED_OBJECTS_SPLIT,
)
self.assertEqual(2, len(parsed_managed))
class_type, properties_data = parsed_managed["/foo"]
self.assertEqual(Foo, class_type)
self.assertEqual(properties_data["foo"], 1)
class_type, properties_data = parsed_managed["/bar"]
self.assertEqual(Bar, class_type)
self.assertEqual(properties_data["bar"], 2)
def test_parse_get_managed_objects_unknown_interface_error(self) -> None:
with self.assertRaisesRegex(KeyError, "org.foo"):
parse_get_managed_objects(
Bar,
MANAGED_OBJECTS_SPLIT,
)
def test_parse_get_managed_objects_unknown_interface_none_reuse(
self,
) -> None:
parsed_managed = parse_get_managed_objects(
{BarAsync},
MANAGED_OBJECTS_SPLIT,
on_unknown_interface="none",
on_unknown_member="reuse",
)
class_type, properties_data = parsed_managed["/foo"]
self.assertIsNone(class_type)
self.assertEqual(properties_data["Foo"], 1)
class_type, properties_data = parsed_managed["/bar"]
self.assertEqual(BarAsync, class_type)
self.assertEqual(properties_data["bar"], 2)
def test_parse_get_managed_objects_unknown_member_skip(self) -> None:
parsed_managed = parse_get_managed_objects(
[Foo],
MANAGED_OBJECTS_SPLIT,
on_unknown_interface="none",
on_unknown_member="ignore",
)
self.assertEqual(2, len(parsed_managed))
class_type, properties_data = parsed_managed["/foo"]
self.assertEqual(Foo, class_type)
self.assertEqual(properties_data["foo"], 1)
class_type, properties_data = parsed_managed["/bar"]
self.assertIsNone(class_type)
self.assertEqual(0, len(properties_data))
def test_parse_get_managed_objects_interface_subset_single(self) -> None:
parsed_managed = parse_get_managed_objects(
[FooAsync],
MANAGED_OBJECTS_COMBINED,
on_unknown_interface="error",
on_unknown_member="reuse",
use_interface_subsets=True,
)
class_type, properties_data = parsed_managed["/test"]
self.assertIs(class_type, FooAsync)
self.assertEqual(properties_data["foo"], 1)
self.assertEqual(properties_data["Bar"], 2)
def test_parse_get_managed_objects_interface_subset_multiple(self) -> None:
parsed_managed = parse_get_managed_objects(
[FooAsync, FooBarAsync],
# FooBarAsync should be prioritized then both interfaces
# are available on the path.
MANAGED_OBJECTS_BOTH,
on_unknown_interface="none",
on_unknown_member="reuse",
use_interface_subsets=True,
)
class_type, _ = parsed_managed["/test"]
self.assertIs(class_type, FooBarAsync)
class_type, _ = parsed_managed["/foo"]
self.assertIs(class_type, FooAsync)
class_type, _ = parsed_managed["/bar"]
self.assertIsNone(class_type)
class TestSdbusUtilsInspect(IsolatedDbusTestCase):
def test_inspect_dbus_path_block(self) -> None:
proxy = DbusInterfaceCommon("example.org", TEST_PATH)
self.assertEqual(inspect_dbus_path(proxy), TEST_PATH)
new_bus = sd_bus_open_user()
with self.assertRaisesRegex(LookupError, "is not attached to bus"):
inspect_dbus_path(proxy, new_bus)
def test_inspect_dbus_path_async_proxy(self) -> None:
proxy = DbusInterfaceCommonAsync.new_proxy("example.org", TEST_PATH)
self.assertEqual(inspect_dbus_path(proxy), TEST_PATH)
new_bus = sd_bus_open_user()
with self.assertRaisesRegex(LookupError, "is not attached to bus"):
inspect_dbus_path(proxy, new_bus)
def test_inspect_dbus_path_async_local(self) -> None:
local_obj = FooBarAsync()
with self.assertRaisesRegex(
LookupError, "is not exported to any D-Bus",
):
inspect_dbus_path(local_obj)
local_obj.export_to_dbus(TEST_PATH)
self.assertEqual(inspect_dbus_path(local_obj), TEST_PATH)
new_bus = sd_bus_open_user()
with self.assertRaisesRegex(LookupError, "is not attached to bus"):
inspect_dbus_path(local_obj, new_bus)
def test_inspect_attached_bus(self) -> None:
proxy = DbusInterfaceCommon("example.org", TEST_PATH)
self.assertIs(inspect_dbus_bus(proxy), self.bus)
with self.assertRaises(TypeError):
inspect_dbus_bus(object()) # type: ignore[arg-type]
def test_inspect_attached_bus_async(self) -> None:
proxy = DbusInterfaceCommonAsync.new_proxy("example.org", TEST_PATH)
self.assertIs(inspect_dbus_bus(proxy), self.bus)
local_obj = FooBarAsync()
self.assertIsNone(inspect_dbus_bus(local_obj))
local_obj.export_to_dbus("/")
self.assertIs(inspect_dbus_bus(local_obj), self.bus)
|
