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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
#
# Copyright (C) 2019 Red Hat, Inc. All rights reserved.
#
# 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
#
import unittest
from collections import defaultdict
from unittest.mock import Mock, patch
from dasbus.connection import MessageBus, SystemMessageBus, \
SessionMessageBus, AddressedMessageBus
from dasbus.constants import DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER, \
DBUS_NAME_FLAG_ALLOW_REPLACEMENT, DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
from dasbus.error import ErrorMapper
import gi
gi.require_version("Gio", "2.0")
from gi.repository import Gio
class MockMessageBus(MessageBus):
"""Message bus for testing."""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._proxy_factory = Mock()
self._server_factory = Mock()
def _get_connection(self):
return Mock()
def publish_object(self, *args, **kwargs): # pylint: disable=signature-differs
return super().publish_object(
*args, **kwargs, server_factory=self._server_factory
)
def get_proxy(self, *args, **kwargs): # pylint: disable=signature-differs
return super().get_proxy(
*args, **kwargs, proxy_factory=self._proxy_factory
)
class DBusConnectionTestCase(unittest.TestCase):
"""Test DBus connection."""
def setUp(self):
self.message_bus = MockMessageBus()
self.error_mapper = self.message_bus._error_mapper
self.proxy_factory = self.message_bus._proxy_factory
self.server_factory = self.message_bus._server_factory
def test_connection(self):
"""Test the bus connection."""
self.assertIsNotNone(self.message_bus.connection)
self.assertEqual(self.message_bus.connection,
self.message_bus.connection)
self.assertTrue(self.message_bus.check_connection())
def test_failing_connection(self):
"""Test the failing connection."""
self.message_bus._get_connection = Mock(side_effect=IOError())
with self.assertLogs(level='WARN'):
self.assertFalse(self.message_bus.check_connection())
self.message_bus._get_connection = Mock(return_value=None)
self.assertFalse(self.message_bus.check_connection())
def test_error_mapper(self):
"""Test the error mapper."""
error_mapper = ErrorMapper()
message_bus = MockMessageBus(error_mapper=error_mapper)
self.assertEqual(message_bus._error_mapper, error_mapper)
message_bus = MockMessageBus()
self.assertNotEqual(message_bus._error_mapper, error_mapper)
self.assertIsInstance(message_bus._error_mapper, ErrorMapper)
def test_proxy(self):
"""Test the object proxy."""
proxy = self.message_bus.get_proxy(
"service.name",
"/object/path"
)
self.proxy_factory.assert_called_once_with(
self.message_bus,
"service.name",
"/object/path",
error_mapper=self.error_mapper
)
self.assertEqual(proxy, self.proxy_factory.return_value)
def test_interface_proxy(self):
"""Test the interface proxy."""
proxy = self.message_bus.get_proxy(
"service.name",
"/object/path",
"interface.name"
)
self.proxy_factory.assert_called_once_with(
self.message_bus,
"service.name",
"/object/path",
interface_name="interface.name",
error_mapper=self.error_mapper
)
self.assertEqual(proxy, self.proxy_factory.return_value)
def test_bus_proxy(self):
"""Test the bus proxy."""
proxy = self.message_bus.proxy
self.proxy_factory.assert_called_once_with(
self.message_bus,
"org.freedesktop.DBus",
"/org/freedesktop/DBus",
error_mapper=self.error_mapper
)
self.assertIsNotNone(proxy)
self.assertEqual(proxy, self.proxy_factory.return_value)
self.assertEqual(self.message_bus.proxy, self.message_bus.proxy)
def test_register_service(self):
"""Test the service registration."""
self.message_bus.proxy.RequestName.return_value = \
DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
self.message_bus.register_service(
"my.service",
DBUS_NAME_FLAG_ALLOW_REPLACEMENT
)
self.message_bus.proxy.RequestName.assert_called_once_with(
"my.service",
DBUS_NAME_FLAG_ALLOW_REPLACEMENT
)
self.assertIn("my.service", self.message_bus._requested_names)
callback = self.message_bus._registrations["my.service"]
self.assertTrue(callable(callback))
self.message_bus.disconnect()
self.message_bus.proxy.ReleaseName.assert_called_once_with(
"my.service"
)
def test_failed_register_service(self):
"""Test the failing service registration."""
self.message_bus.proxy.RequestName.return_value = \
DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
with self.assertRaises(ConnectionError):
self.message_bus.register_service("my.service")
self.message_bus.proxy.RequestName.assert_called_once_with(
"my.service",
DBUS_NAME_FLAG_ALLOW_REPLACEMENT
)
self.assertNotIn("my.service", self.message_bus._requested_names)
def test_check_service_access(self):
"""Check the service access."""
# The service can be accessed.
self.message_bus.get_proxy("my.service", "/my/object")
# The service cannot be accessed.
self.message_bus.proxy.RequestName.return_value = \
DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
self.message_bus.register_service("my.service")
with self.assertRaises(RuntimeError) as cm:
self.message_bus.get_proxy("my.service", "/my/object")
self.assertEqual(
"Can't access DBus service 'my.service' from the main thread.",
str(cm.exception)
)
def test_publish_object(self):
"""Test the object publishing."""
obj = Mock()
self.message_bus.publish_object("/my/object", obj)
self.server_factory.assert_called_once_with(
self.message_bus,
"/my/object",
obj,
error_mapper=self.error_mapper
)
callback = self.message_bus._registrations["/my/object"]
self.assertTrue(callable(callback))
self.message_bus.disconnect()
callback.assert_called_once_with()
def test_disconnect(self):
"""Test the disconnection."""
# Set up the connection.
self.assertIsNotNone(self.message_bus.connection)
# Create registrations.
callbacks = defaultdict(Mock)
self.message_bus._registrations = {
"my.service.1": callbacks["my.service.1"],
"my.service.2": callbacks["my.service.2"],
"/my/object/1": callbacks["/my/object/1"],
"/my/object/2": callbacks["/my/object/2"],
}
self.message_bus._requested_names = {
"my.service.1",
"my.service.2"
}
# Disconnect.
self.message_bus.disconnect()
self.assertEqual(self.message_bus._connection, None)
self.assertEqual(self.message_bus._registrations, {})
self.assertEqual(self.message_bus._requested_names, set())
for callback in callbacks.values():
callback.assert_called_once_with()
# Do nothing by default.
self.message_bus.disconnect()
def test_remove_single_object(self):
"""Test the disconnection."""
# Set up the connection.
self.assertIsNotNone(self.message_bus.connection)
# Create registrations.
callbacks = defaultdict(Mock)
self.message_bus._registrations = {
"my.service.1": callbacks["my.service.1"],
"my.service.2": callbacks["my.service.2"],
"/my/object/1": callbacks["/my/object/1"],
"/my/object/2": callbacks["/my/object/2"],
}
self.message_bus._requested_names = {
"my.service.1",
"my.service.2"
}
# Disconnect.
self.message_bus.unregister_service("my.service.1")
self.assertEqual(len(self.message_bus._registrations), 3)
# Disconnect.
self.message_bus.unpublish_object("/my/object/2")
self.assertEqual(len(self.message_bus._registrations), 2)
callbacks["my.service.1"].assert_called_once_with()
callbacks["/my/object/2"].assert_called_once_with()
@patch("dasbus.connection.Gio.bus_get_sync")
def test_system_bus(self, getter):
"""Test the system bus."""
message_bus = SystemMessageBus()
self.assertIsNotNone(message_bus.connection)
getter.assert_called_once_with(
Gio.BusType.SYSTEM,
None
)
@patch("dasbus.connection.Gio.bus_get_sync")
def test_session_bus(self, getter):
"""Test the session bus."""
message_bus = SessionMessageBus()
self.assertIsNotNone(message_bus.connection)
getter.assert_called_once_with(
Gio.BusType.SESSION,
None
)
def _check_addressed_connection(self, message_bus, getter, address):
self.assertIsNotNone(message_bus.connection)
self.assertEqual(message_bus.address, address)
getter.assert_called_once_with(
address,
(
Gio.DBusConnectionFlags.AUTHENTICATION_CLIENT |
Gio.DBusConnectionFlags.MESSAGE_BUS_CONNECTION
),
None,
None
)
@patch("dasbus.connection.Gio.DBusConnection.new_for_address_sync")
def test_addressed_bus(self, getter):
"""Test the addressed bus."""
message_bus = AddressedMessageBus("ADDRESS")
self._check_addressed_connection(message_bus, getter, "ADDRESS")
|
