201 lines
6.8 KiB
Python
201 lines
6.8 KiB
Python
import struct
|
|
import sys
|
|
|
|
from typing import Union
|
|
from unittest import mock
|
|
|
|
import pytest
|
|
|
|
from logitech_receiver import base
|
|
from logitech_receiver import exceptions
|
|
from logitech_receiver.base import HIDPP_SHORT_MESSAGE_ID
|
|
from logitech_receiver.common import LOGITECH_VENDOR_ID
|
|
from logitech_receiver.common import BusID
|
|
from logitech_receiver.hidpp10_constants import ErrorCode as Hidpp10Error
|
|
from logitech_receiver.hidpp20_constants import ErrorCode as Hidpp20Error
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"usb_id, expected_name, expected_receiver_kind",
|
|
[
|
|
(0xC548, "Bolt Receiver", "bolt"),
|
|
(0xC52B, "Unifying Receiver", "unifying"),
|
|
(0xC531, "Nano Receiver", "nano"),
|
|
(0xC53F, "Lightspeed Receiver", None),
|
|
(0xC517, "EX100 Receiver 27 Mhz", "27Mhz"),
|
|
],
|
|
)
|
|
def test_product_information(usb_id, expected_name, expected_receiver_kind):
|
|
res = base.product_information(usb_id)
|
|
|
|
assert res["name"] == expected_name
|
|
assert isinstance(res["vendor_id"], int)
|
|
assert isinstance(res["product_id"], int)
|
|
|
|
if expected_receiver_kind:
|
|
assert res["receiver_kind"] == expected_receiver_kind
|
|
|
|
|
|
def test_filter_receivers_known():
|
|
bus_id = 2
|
|
product_id = 0xC548
|
|
|
|
receiver_info = base._filter_receivers(bus_id, LOGITECH_VENDOR_ID, product_id)
|
|
|
|
assert receiver_info["name"] == "Bolt Receiver"
|
|
assert receiver_info["receiver_kind"] == "bolt"
|
|
|
|
|
|
def test_filter_receivers_unknown():
|
|
bus_id = 1
|
|
product_id = 0xC500
|
|
|
|
receiver_info = base._filter_receivers(bus_id, LOGITECH_VENDOR_ID, product_id)
|
|
|
|
assert receiver_info["bus_id"] == bus_id
|
|
assert receiver_info["product_id"] == product_id
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"product_id, bus, hidpp_short, hidpp_long, expected",
|
|
[
|
|
(0xC548, BusID.USB, True, False, {"name": "Bolt Receiver", "usb_interface": 2}),
|
|
(0xC07D, BusID.USB, True, False, {"usb_interface": 1}),
|
|
(0xC07E, BusID.USB, False, True, {"usb_interface": 1}),
|
|
(0xC07E, BusID.BLUETOOTH, False, True, {"bus_id": 5}),
|
|
(0xA07E, BusID.USB, False, True, {"product_id": 0xA07E}),
|
|
(0xA07C, BusID.USB, False, False, None),
|
|
(0xC07F, BusID.USB, None, None, {"usb_interface": 2}),
|
|
(0xC07F, BusID.BLUETOOTH, None, None, None),
|
|
(0xB013, BusID.BLUETOOTH, None, None, {"product_id": 0xB013}),
|
|
],
|
|
)
|
|
def test_filter_products_of_interest(product_id, bus, hidpp_short, hidpp_long, expected):
|
|
receiver_info = base._filter_products_of_interest(
|
|
bus,
|
|
LOGITECH_VENDOR_ID,
|
|
product_id,
|
|
hidpp_short=hidpp_short,
|
|
hidpp_long=hidpp_long,
|
|
)
|
|
|
|
if expected is None:
|
|
assert receiver_info == expected
|
|
else:
|
|
assert all([receiver_info[key] == expected_value for key, expected_value in expected.items()])
|
|
assert receiver_info["vendor_id"] == LOGITECH_VENDOR_ID
|
|
assert receiver_info["product_id"]
|
|
|
|
|
|
def test_match():
|
|
record = {"vendor_id": LOGITECH_VENDOR_ID}
|
|
|
|
res = base._match(record, 0, LOGITECH_VENDOR_ID, 0)
|
|
|
|
assert res is True
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"report_id, sub_id, address, valid_notification",
|
|
[
|
|
(0x1, 0x72, 0x57, True),
|
|
(0x1, 0x40, 0x63, True),
|
|
(0x1, 0x40, 0x71, True),
|
|
(0x1, 0x80, 0x71, False),
|
|
(0x1, 0x00, 0x70, False),
|
|
(0x20, 0x09, 0x71, False),
|
|
(0x1, 0x37, 0x71, False),
|
|
],
|
|
)
|
|
def test_make_notification(report_id, sub_id, address, valid_notification):
|
|
devnumber = 123
|
|
data = bytes([sub_id, address, 0x02, 0x03, 0x04])
|
|
|
|
result = base.make_notification(report_id, devnumber, data)
|
|
|
|
if valid_notification:
|
|
assert isinstance(result, base.HIDPPNotification)
|
|
assert result.report_id == report_id
|
|
assert result.devnumber == devnumber
|
|
assert result.sub_id == sub_id
|
|
assert result.address == address
|
|
assert result.data == bytes([0x02, 0x03, 0x04])
|
|
else:
|
|
assert result is None
|
|
|
|
|
|
def test_get_next_sw_id():
|
|
res1 = base._get_next_sw_id()
|
|
res2 = base._get_next_sw_id()
|
|
|
|
assert res1 == 2
|
|
assert res2 == 3
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"prefix, error_code, return_error, raise_exception",
|
|
[
|
|
(b"\x8f", Hidpp10Error.INVALID_SUB_ID_COMMAND, False, False),
|
|
(b"\x8f", Hidpp10Error.INVALID_SUB_ID_COMMAND, True, False),
|
|
(b"\xff", Hidpp20Error.UNKNOWN, False, True),
|
|
],
|
|
)
|
|
def test_request_errors(
|
|
prefix: bytes, error_code: Union[Hidpp10Error, Hidpp20Error], return_error: bool, raise_exception: bool
|
|
):
|
|
handle = 0
|
|
device_number = 66
|
|
|
|
next_sw_id = 0x02
|
|
reply_data_sw_id = struct.pack("!H", 0x0000 | next_sw_id)
|
|
|
|
with mock.patch(
|
|
"logitech_receiver.base._read",
|
|
return_value=(HIDPP_SHORT_MESSAGE_ID, device_number, prefix + reply_data_sw_id + struct.pack("B", error_code)),
|
|
), mock.patch("logitech_receiver.base._skip_incoming", return_value=None), mock.patch(
|
|
"logitech_receiver.base.write", return_value=None
|
|
), mock.patch("logitech_receiver.base._get_next_sw_id", return_value=next_sw_id):
|
|
if raise_exception:
|
|
with pytest.raises(exceptions.FeatureCallError) as context:
|
|
base.request(handle, device_number, next_sw_id, return_error=return_error)
|
|
assert context.value.number == device_number
|
|
assert context.value.request == next_sw_id
|
|
assert context.value.error == error_code
|
|
assert context.value.params == b""
|
|
|
|
else:
|
|
result = base.request(handle, device_number, next_sw_id, return_error=return_error)
|
|
assert result == (error_code if return_error else None)
|
|
|
|
|
|
@pytest.mark.skipif(sys.platform == "darwin", reason="Test only runs on Linux")
|
|
@pytest.mark.parametrize(
|
|
"simulated_error, expected_result",
|
|
[
|
|
(Hidpp10Error.INVALID_SUB_ID_COMMAND, 1.0),
|
|
(Hidpp10Error.RESOURCE_ERROR, None),
|
|
(Hidpp10Error.CONNECTION_REQUEST_FAILED, None),
|
|
(Hidpp10Error.UNKNOWN_DEVICE, exceptions.NoSuchDevice),
|
|
],
|
|
)
|
|
def test_ping_errors(simulated_error: Hidpp10Error, expected_result):
|
|
handle = 1
|
|
device_number = 1
|
|
|
|
next_sw_id = 0x05
|
|
reply_data_sw_id = struct.pack("!H", 0x0010 | next_sw_id)
|
|
|
|
with mock.patch(
|
|
"logitech_receiver.base._read",
|
|
return_value=(HIDPP_SHORT_MESSAGE_ID, device_number, b"\x8f" + reply_data_sw_id + bytes([simulated_error])),
|
|
), mock.patch("logitech_receiver.base._get_next_sw_id", return_value=next_sw_id):
|
|
if isinstance(expected_result, type) and issubclass(expected_result, Exception):
|
|
with pytest.raises(expected_result) as context:
|
|
base.ping(handle=handle, devnumber=device_number)
|
|
assert context.value.number == device_number
|
|
assert context.value.request == struct.unpack("!H", reply_data_sw_id)[0]
|
|
|
|
else:
|
|
result = base.ping(handle=handle, devnumber=device_number)
|
|
assert result == expected_result
|