Skip to content

Commit

Permalink
Unit test notifications
Browse files Browse the repository at this point in the history 
Fixes #2711
  • Loading branch information
@MattHag
MattHag committed Dec 23, 2024
1 parent 66d0119 commit 7466d51
Show file tree
Hide file tree
Showing 2 changed files with 250 additions and 2 deletions.
14 changes: 14 additions & 0 deletions tests/logitech_receiver/fake_hidpp.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,7 @@ class Device:
setting_callback: Any = None
sliding = profiles = _backlight = _keys = _remap_keys = _led_effects = _gestures = None
_gestures_lock = threading.Lock()
number = "d1"

read_register = device.Device.read_register
write_register = device.Device.write_register
Expand All @@ -405,6 +406,7 @@ def __post_init__(self):
self.persister = configuration._DeviceEntry()
self.features = hidpp20.FeaturesArray(self)
self.settings = []
self.receiver = []
if self.feature is not None:
self.features = hidpp20.FeaturesArray(self)
self.responses = [
Expand Down Expand Up @@ -435,6 +437,18 @@ def ping(self, handle=None, devnumber=None, long_message=False):
print("PING", self._protocol)
return self._protocol

def handle_notification(self, handle):
pass

def changed(self, *args, **kwargs):
pass

def set_battery_info(self, *args, **kwargs):
pass

def status_string(self):
pass


def match_requests(number, responses, call_args_list):
for i in range(0 - number, 0):
Expand Down
238 changes: 236 additions & 2 deletions tests/logitech_receiver/test_notifications.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
from logitech_receiver.hidpp10_constants import BoltPairingError
from logitech_receiver.hidpp10_constants import PairingError
from logitech_receiver.hidpp10_constants import Registers
from logitech_receiver.hidpp20_constants import SupportedFeature
from logitech_receiver.receiver import Receiver

from . import fake_hidpp


class MockLowLevelInterface:
def open_path(self, path):
Expand All @@ -22,24 +25,255 @@ def ping(self, handle, number, long_message=False):
def request(self, handle, devnumber, request_id, *params, **kwargs):
pass

def find_paired_node(self, receiver_path: str, index: int, timeout: int):
return None

def close(self, device_handle) -> None:
pass


@pytest.mark.parametrize(
"sub_id, notification_data, expected_error, expected_new_device",
[
(Registers.DISCOVERY_STATUS_NOTIFICATION, b"\x01", BoltPairingError.DEVICE_TIMEOUT, None),
(
Registers.DEVICE_DISCOVERY_NOTIFICATION,
b"\x01\x01\x01\x01\x01\x01\x01\x01\x01",
None,
None,
),
(Registers.PAIRING_STATUS_NOTIFICATION, b"\x02", BoltPairingError.FAILED, None),
(Notification.PAIRING_LOCK, b"\x01", PairingError.DEVICE_TIMEOUT, None),
(Notification.PAIRING_LOCK, b"\x02", PairingError.DEVICE_NOT_SUPPORTED, None),
(Notification.PAIRING_LOCK, b"\x03", PairingError.TOO_MANY_DEVICES, None),
(Notification.PAIRING_LOCK, b"\x06", PairingError.SEQUENCE_TIMEOUT, None),
(Registers.PASSKEY_REQUEST_NOTIFICATION, b"\x06", None, None),
(Registers.PASSKEY_PRESSED_NOTIFICATION, b"\x06", None, None),
],
)
def test_process_receiver_notification(sub_id, notification_data, expected_error, expected_new_device):
receiver: Receiver = Receiver(MockLowLevelInterface(), None, {}, True, None, None)
notification = HIDPPNotification(0, 0, sub_id, 0, notification_data)
notification = HIDPPNotification(0, 0, sub_id, 0x02, notification_data)

result = notifications._process_receiver_notification(receiver, notification)
result = notifications.process_receiver_notification(receiver, notification)

assert result
assert receiver.pairing.error == expected_error
assert receiver.pairing.new_device is expected_new_device


@pytest.mark.parametrize(
"hidpp_notification, expected",
[
(HIDPPNotification(0, 0, sub_id=Registers.BATTERY_STATUS, address=0, data=b"0x01"), False),
(HIDPPNotification(0, 0, sub_id=Notification.NO_OPERATION, address=0, data=b"0x01"), False),
(HIDPPNotification(0, 0, sub_id=0x40, address=0, data=b"0x01"), True),
],
)
def test_process_device_notification(hidpp_notification, expected):
device = fake_hidpp.Device()

result = notifications.process_device_notification(device, hidpp_notification)

assert result == expected


@pytest.mark.parametrize(
"hidpp_notification, expected",
[
(HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.DJ_PAIRING, address=0, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.CONNECTED, address=0, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.RAW_INPUT, address=0, data=b"0x01"), None),
],
)
def test_process_dj_notification(hidpp_notification, expected):
device = fake_hidpp.Device()

result = notifications._process_dj_notification(device, hidpp_notification)

assert result == expected


@pytest.mark.parametrize(
"hidpp_notification, expected",
[
(HIDPPNotification(0, 0, sub_id=Registers.BATTERY_STATUS, address=0, data=b"\x01\x00"), True),
(HIDPPNotification(0, 0, sub_id=Registers.BATTERY_CHARGE, address=0, data=b"0x01\x00"), True),
(HIDPPNotification(0, 0, sub_id=Notification.RAW_INPUT, address=0, data=b"0x01"), None),
],
)
def test_process_hidpp10_custom_notification(hidpp_notification, expected):
device = fake_hidpp.Device()

result = notifications._process_hidpp10_custom_notification(device, hidpp_notification)

assert result == expected


@pytest.mark.parametrize(
"hidpp_notification, expected",
[
(HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.DJ_PAIRING, address=0x00, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.DJ_PAIRING, address=0x02, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.DJ_PAIRING, address=0x03, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.DJ_PAIRING, address=0x03, data=b"0x4040"), True),
(HIDPPNotification(0, 0, sub_id=Notification.RAW_INPUT, address=0x00, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.POWER, address=0x00, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.POWER, address=0x01, data=b"0x01"), True),
(HIDPPNotification(0, 0, sub_id=Notification.PAIRING_LOCK, address=0x01, data=b"0x01"), None),
],
)
def test_process_hidpp10_notification(hidpp_notification, expected):
fake_device = fake_hidpp.Device()
fake_device.receiver = ["rec1", "rec2"]

result = notifications._process_hidpp10_notification(fake_device, hidpp_notification)

assert result == expected


@pytest.mark.parametrize(
"hidpp_notification, feature",
[
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.BATTERY_STATUS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.BATTERY_STATUS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.BATTERY_VOLTAGE,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x05, data=b"0x01"),
SupportedFeature.BATTERY_VOLTAGE,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.UNIFIED_BATTERY,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.UNIFIED_BATTERY,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.ADC_MEASUREMENT,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.ADC_MEASUREMENT,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"01234GOOD"),
SupportedFeature.SOLAR_DASHBOARD,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x10, data=b"01234GOOD"),
SupportedFeature.SOLAR_DASHBOARD,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x20, data=b"01234GOOD"),
SupportedFeature.SOLAR_DASHBOARD,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"01234GOOD"),
SupportedFeature.SOLAR_DASHBOARD,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"CHARGENOTGOOD"),
SupportedFeature.SOLAR_DASHBOARD,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"\x01\x01\x02"),
SupportedFeature.WIRELESS_DEVICE_STATUS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.WIRELESS_DEVICE_STATUS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.TOUCHMOUSE_RAW_POINTS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x10, data=b"0x01"),
SupportedFeature.TOUCHMOUSE_RAW_POINTS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x05, data=b"0x01"),
SupportedFeature.TOUCHMOUSE_RAW_POINTS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.REPROG_CONTROLS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.REPROG_CONTROLS,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.BACKLIGHT2,
),
(
HIDPPNotification(
0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"\x01\x01\x01\x01\x01\x01\x01\x01"
),
SupportedFeature.REPROG_CONTROLS_V4,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x10, data=b"0x01"),
SupportedFeature.REPROG_CONTROLS_V4,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x20, data=b"0x01"),
SupportedFeature.REPROG_CONTROLS_V4,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.HIRES_WHEEL,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x10, data=b"0x01"),
SupportedFeature.HIRES_WHEEL,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x02, data=b"0x01"),
SupportedFeature.HIRES_WHEEL,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.ONBOARD_PROFILES,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x20, data=b"0x01"),
SupportedFeature.ONBOARD_PROFILES,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x00, data=b"0x01"),
SupportedFeature.BRIGHTNESS_CONTROL,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x10, data=b"0x01"),
SupportedFeature.BRIGHTNESS_CONTROL,
),
(
HIDPPNotification(0, 0, sub_id=Notification.CONNECT_DISCONNECT, address=0x20, data=b"0x01"),
SupportedFeature.BRIGHTNESS_CONTROL,
),
],
)
def test_process_feature_notification(mocker, hidpp_notification, feature):
fake_device = fake_hidpp.Device()
fake_device.receiver = ["rec1", "rec2"]

result = notifications._process_feature_notification(fake_device, hidpp_notification, feature)

assert result is True

0 comments on commit 7466d51

Please sign in to comment.