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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
"""Test communicating with a the device API."""
from __future__ import annotations
import sys
from http import HTTPStatus
from typing import TYPE_CHECKING
from unittest.mock import patch
import pytest
from httpx import ConnectTimeout
from devolo_plc_api.device_api.factoryreset_pb2 import FactoryResetStart
from devolo_plc_api.device_api.ledsettings_pb2 import LedSettingsGet, LedSettingsSetResponse
from devolo_plc_api.device_api.multiap_pb2 import WifiMultiApGetResponse
from devolo_plc_api.device_api.restart_pb2 import RestartResponse, UptimeGetResponse
from devolo_plc_api.device_api.support_pb2 import SupportInfoDump, SupportInfoDumpResponse
from devolo_plc_api.device_api.updatefirmware_pb2 import UpdateFirmwareCheck, UpdateFirmwareStart
from devolo_plc_api.device_api.wifinetwork_pb2 import (
WifiConnectedStationsGet,
WifiGuestAccessGet,
WifiGuestAccessSetResponse,
WifiNeighborAPsGet,
WifiRepeatedAPsGet,
WifiRepeaterWpsClonePbcStart,
WifiResult,
WifiWpsPbcStart,
)
from devolo_plc_api.exceptions import DevicePasswordProtected, DeviceUnavailable, FeatureNotSupported
from . import DeviceType
if TYPE_CHECKING:
from pytest_httpx import HTTPXMock
from devolo_plc_api import Device
from devolo_plc_api.device_api import ConnectedStationInfo, DeviceApi, NeighborAPInfo, RepeatedAPInfo, SupportInfoItem
@pytest.mark.skipif(sys.version_info < (3, 9), reason="Tests with httpx_mock need at least Python 3.9")
class TestDeviceApi:
"""Test devolo_plc_api.device_api.deviceapi.DeviceApi class."""
@pytest.mark.parametrize("feature", ["[]"])
def test_unsupported_feature(self, device_api: DeviceApi):
"""Test raising on using unsupported feature."""
with pytest.raises(FeatureNotSupported):
device_api.get_led_setting()
@pytest.mark.parametrize("feature", [""])
def test_feature(self, device_api: DeviceApi):
"""Test list of default features."""
assert device_api.features == ["reset", "update", "led", "intmtg"]
@pytest.mark.asyncio
@pytest.mark.parametrize("device_type", [DeviceType.PLC])
@pytest.mark.usefixtures("block_communication", "service_browser")
@pytest.mark.httpx_mock(can_send_already_matched_responses=True)
async def test_wrong_password_type(self, httpx_mock: HTTPXMock, mock_device: Device):
"""Test using different password hash if original password failed."""
await mock_device.async_connect()
assert mock_device.device
mock_device.password = "password"
httpx_mock.add_response(status_code=HTTPStatus.UNAUTHORIZED)
with pytest.raises(DevicePasswordProtected):
await mock_device.device.async_get_wifi_connected_station()
assert mock_device.device.password == "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
httpx_mock.add_response(status_code=HTTPStatus.UNAUTHORIZED)
with pytest.raises(DevicePasswordProtected):
await mock_device.device.async_get_wifi_connected_station()
assert mock_device.device.password == "113459eb7bb31bddee85ade5230d6ad5d8b2fb52879e00a84ff6ae1067a210d3"
await mock_device.async_disconnect()
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["led"])
async def test_async_get_led_setting(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test getting LED settings asynchronously."""
led_setting_get = LedSettingsGet(state=LedSettingsGet.LED_ON)
httpx_mock.add_response(content=led_setting_get.SerializeToString())
assert await device_api.async_get_led_setting()
@pytest.mark.parametrize("feature", ["led"])
def test_get_led_setting(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test getting LED settings synchronously."""
led_setting_get = LedSettingsGet(state=LedSettingsGet.LED_ON)
httpx_mock.add_response(content=led_setting_get.SerializeToString())
assert device_api.get_led_setting()
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["led"])
async def test_async_set_led_setting(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting LED settings asynchronously."""
led_setting_set = LedSettingsSetResponse()
httpx_mock.add_response(content=led_setting_set.SerializeToString())
assert await device_api.async_set_led_setting(enable=True)
@pytest.mark.parametrize("feature", ["led"])
def test_set_led_setting(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting LED settings synchronously."""
led_setting_set = LedSettingsSetResponse()
httpx_mock.add_response(content=led_setting_set.SerializeToString())
assert device_api.set_led_setting(enable=True)
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["multiap"])
async def test_async_get_wifi_multi_ap(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting LED settings asynchronously."""
multi_ap_details = WifiMultiApGetResponse(enabled=True)
httpx_mock.add_response(content=multi_ap_details.SerializeToString())
details = await device_api.async_get_wifi_multi_ap()
assert details.enabled
@pytest.mark.parametrize("feature", ["multiap"])
def test_get_wifi_multi_ap(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting LED settings synchronously."""
multi_ap_details = WifiMultiApGetResponse(enabled=True)
httpx_mock.add_response(content=multi_ap_details.SerializeToString())
details = device_api.get_wifi_multi_ap()
assert details.enabled
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["repeater0"])
async def test_async_get_wifi_repeated_access_points(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, repeated_ap: RepeatedAPInfo
):
"""Test getting AP settings asynchronously."""
wifi_repeated_accesspoints_get = WifiRepeatedAPsGet(repeated_aps=[repeated_ap])
httpx_mock.add_response(content=wifi_repeated_accesspoints_get.SerializeToString())
wifi_repeated_access_points = await device_api.async_get_wifi_repeated_access_points()
assert wifi_repeated_access_points == [repeated_ap]
@pytest.mark.parametrize("feature", ["repeater0"])
def test_get_wifi_repeated_access_points(self, device_api: DeviceApi, httpx_mock: HTTPXMock, repeated_ap: RepeatedAPInfo):
"""Test getting AP settings synchronously."""
wifi_repeated_accesspoints_get = WifiRepeatedAPsGet(repeated_aps=[repeated_ap])
httpx_mock.add_response(content=wifi_repeated_accesspoints_get.SerializeToString())
wifi_repeated_access_points = device_api.get_wifi_repeated_access_points()
assert wifi_repeated_access_points == [repeated_ap]
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["repeater0"])
async def test_async_start_wps_clone(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test starting WPS clone mode asynchronously."""
wps = WifiRepeaterWpsClonePbcStart()
httpx_mock.add_response(content=wps.SerializeToString())
assert await device_api.async_start_wps_clone()
@pytest.mark.parametrize("feature", ["repeater0"])
def test_start_wps_clone(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test starting WPS clone mode synchronously."""
wps = WifiRepeaterWpsClonePbcStart()
httpx_mock.add_response(content=wps.SerializeToString())
assert device_api.start_wps_clone()
@pytest.mark.parametrize("feature", ["reset"])
async def test_async_factory_reset(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test factory reset asynchronously."""
reset = FactoryResetStart()
httpx_mock.add_response(content=reset.SerializeToString())
assert await device_api.async_factory_reset()
@pytest.mark.parametrize("feature", ["reset"])
def test_factory_reset(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test factory reset synchronously."""
reset = FactoryResetStart()
httpx_mock.add_response(content=reset.SerializeToString())
assert device_api.factory_reset()
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["restart"])
async def test_async_restart(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test restarting a device asynchronously."""
restart = RestartResponse()
httpx_mock.add_response(content=restart.SerializeToString())
assert await device_api.async_restart()
@pytest.mark.parametrize("feature", ["restart"])
def test_restart(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test restarting a device synchronously."""
restart = RestartResponse()
httpx_mock.add_response(content=restart.SerializeToString())
assert device_api.restart()
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["restart"])
async def test_async_uptime(self, device_api: DeviceApi, httpx_mock: HTTPXMock, runtime: int):
"""Test getting a device's update asynchronously."""
uptime = UptimeGetResponse(uptime=runtime)
httpx_mock.add_response(content=uptime.SerializeToString())
assert await device_api.async_uptime() == runtime
@pytest.mark.parametrize("feature", ["restart"])
def test_uptime(self, device_api: DeviceApi, httpx_mock: HTTPXMock, runtime: int):
"""Test getting a device's update synchronously."""
uptime = UptimeGetResponse(uptime=runtime)
httpx_mock.add_response(content=uptime.SerializeToString())
assert device_api.uptime() == runtime
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["support"])
async def test_async_get_support_info(self, device_api: DeviceApi, httpx_mock: HTTPXMock, support_item: SupportInfoItem):
"""Test getting a device's support information asynchronously."""
support_info = SupportInfoDumpResponse(info=SupportInfoDump(items=[support_item]))
httpx_mock.add_response(content=support_info.SerializeToString())
assert await device_api.async_get_support_info() == support_info.info
@pytest.mark.parametrize("feature", ["support"])
def test_get_support_info(self, device_api: DeviceApi, httpx_mock: HTTPXMock, support_item: SupportInfoItem):
"""Test getting a device's support information synchronously."""
support_info = SupportInfoDumpResponse(info=SupportInfoDump(items=[support_item]))
httpx_mock.add_response(content=support_info.SerializeToString())
assert device_api.get_support_info() == support_info.info
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["update"])
async def test_async_check_firmware_available(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, firmware_update: UpdateFirmwareCheck
):
"""Test checking for firmware updates asynchronously."""
httpx_mock.add_response(content=firmware_update.SerializeToString())
firmware = await device_api.async_check_firmware_available()
assert firmware == firmware_update
@pytest.mark.parametrize("feature", ["update"])
def test_check_firmware_available(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, firmware_update: UpdateFirmwareCheck
):
"""Test checking for firmware updates synchronously."""
httpx_mock.add_response(content=firmware_update.SerializeToString())
firmware = device_api.check_firmware_available()
assert firmware == firmware_update
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["update"])
async def test_async_start_firmware_update(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test firmware update asynchronously."""
firmware_update = UpdateFirmwareStart(result=UpdateFirmwareStart.UPDATE_STARTED)
httpx_mock.add_response(content=firmware_update.SerializeToString())
assert await device_api.async_start_firmware_update()
@pytest.mark.parametrize("feature", ["update"])
def test_start_firmware_update(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test firmware update synchronously."""
firmware_update = UpdateFirmwareStart(result=UpdateFirmwareStart.UPDATE_STARTED)
httpx_mock.add_response(content=firmware_update.SerializeToString())
assert device_api.start_firmware_update()
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["wifi1"])
async def test_async_get_wifi_connected_station(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, connected_station: ConnectedStationInfo
):
"""Test getting connected wifi clients asynchronously."""
wifi_connected_stations_get = WifiConnectedStationsGet(connected_stations=[connected_station])
httpx_mock.add_response(content=wifi_connected_stations_get.SerializeToString())
connected_stations = await device_api.async_get_wifi_connected_station()
assert connected_stations == [connected_station]
@pytest.mark.parametrize("feature", ["wifi1"])
def test_get_wifi_connected_station(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, connected_station: ConnectedStationInfo
):
"""Test getting connected wifi clients synchronously."""
wifi_connected_stations_get = WifiConnectedStationsGet(connected_stations=[connected_station])
httpx_mock.add_response(content=wifi_connected_stations_get.SerializeToString())
connected_stations = device_api.get_wifi_connected_station()
assert connected_stations == [connected_station]
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["wifi1"])
async def test_async_get_wifi_guest_access(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test getting wifi guest access status asynchronously."""
wifi_guest_access_get = WifiGuestAccessGet(enabled=True)
httpx_mock.add_response(content=wifi_guest_access_get.SerializeToString())
wifi_guest_access = await device_api.async_get_wifi_guest_access()
assert wifi_guest_access == wifi_guest_access_get
@pytest.mark.parametrize("feature", ["wifi1"])
def test_get_wifi_guest_access(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test getting wifi guest access status synchronously."""
wifi_guest_access_get = WifiGuestAccessGet(enabled=True)
httpx_mock.add_response(content=wifi_guest_access_get.SerializeToString())
wifi_guest_access = device_api.get_wifi_guest_access()
assert wifi_guest_access == wifi_guest_access_get
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["wifi1"])
async def test_async_set_wifi_guest_access(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting wifi guest access status asynchronously."""
wifi_guest_access_set = WifiGuestAccessSetResponse(result=WifiResult.WIFI_SUCCESS)
httpx_mock.add_response(content=wifi_guest_access_set.SerializeToString())
assert await device_api.async_set_wifi_guest_access(enable=True)
@pytest.mark.parametrize("feature", ["wifi1"])
def test_set_wifi_guest_access(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test setting wifi guest access status synchronously."""
wifi_guest_access_set = WifiGuestAccessSetResponse(result=WifiResult.WIFI_SUCCESS)
httpx_mock.add_response(content=wifi_guest_access_set.SerializeToString())
assert device_api.set_wifi_guest_access(enable=True)
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["wifi1"])
async def test_async_get_wifi_neighbor_access_points(
self, device_api: DeviceApi, httpx_mock: HTTPXMock, neighbor_ap: NeighborAPInfo
):
"""Test getting neighboring wifi access points asynchronously."""
wifi_neighbor_accesspoints_get = WifiNeighborAPsGet(neighbor_aps=[neighbor_ap])
httpx_mock.add_response(content=wifi_neighbor_accesspoints_get.SerializeToString())
wifi_neighbor_access_points = await device_api.async_get_wifi_neighbor_access_points()
assert wifi_neighbor_access_points == [neighbor_ap]
@pytest.mark.parametrize("feature", ["wifi1"])
def test_get_wifi_neighbor_access_points(self, device_api: DeviceApi, httpx_mock: HTTPXMock, neighbor_ap: NeighborAPInfo):
"""Test getting neighboring wifi access points synchronously."""
wifi_neighbor_accesspoints_get = WifiNeighborAPsGet(neighbor_aps=[neighbor_ap])
httpx_mock.add_response(content=wifi_neighbor_accesspoints_get.SerializeToString())
wifi_neighbor_access_points = device_api.get_wifi_neighbor_access_points()
assert wifi_neighbor_access_points == [neighbor_ap]
@pytest.mark.asyncio
@pytest.mark.parametrize("feature", ["wifi1"])
async def test_async_start_wps(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test starting WPS asynchronously."""
wps = WifiWpsPbcStart(result=WifiResult.WIFI_SUCCESS)
httpx_mock.add_response(content=wps.SerializeToString())
assert await device_api.async_start_wps()
@pytest.mark.parametrize("feature", ["wifi1"])
def test_start_wps(self, device_api: DeviceApi, httpx_mock: HTTPXMock):
"""Test starting WPS synchronously."""
wps = WifiWpsPbcStart(result=WifiResult.WIFI_SUCCESS)
httpx_mock.add_response(content=wps.SerializeToString())
assert device_api.start_wps()
@pytest.mark.asyncio
@pytest.mark.parametrize("device_type", [DeviceType.PLC])
@pytest.mark.usefixtures("block_communication", "service_browser")
async def test_device_unavailable(self, httpx_mock: HTTPXMock, mock_device: Device):
"""Test device being unavailable."""
await mock_device.async_connect()
assert mock_device.device
httpx_mock.add_exception(ConnectTimeout(""), is_reusable=True)
with pytest.raises(DeviceUnavailable), patch("asyncio.sleep"):
await mock_device.device.async_get_wifi_connected_station()
await mock_device.async_disconnect()
assert len(httpx_mock.get_requests()) == 3
@pytest.mark.asyncio
@pytest.mark.parametrize("device_type", [DeviceType.PLC])
@pytest.mark.usefixtures("block_communication", "service_browser")
async def test_attribute_error(self, mock_device: Device):
"""Test raising on calling not existing method."""
await mock_device.async_connect()
assert mock_device.device
with pytest.raises(AttributeError):
mock_device.device.test()
|
