tests: complete testing of common

tests/logitech_receiver/test_common.py

@@ -1,4 +1,5 @@
 import pytest
+import yaml
 
 from lib.logitech_receiver import common
 
@@ -17,16 +18,14 @@ def test_named_int():
 
     assert named_int.name == "pulse"
     assert named_int == 2
+    assert repr(named_int) == "NamedInt(2, 'pulse')"
 
 
 def test_named_int_comparison():
-    default_value = 0
+    named_int = common.NamedInt(0, "entry")
-    default_name = "entry"
+    named_int_equal = common.NamedInt(0, "entry")
-    named_int = common.NamedInt(default_value, default_name)
+    named_int_unequal_name = common.NamedInt(0, "unequal")
-
+    named_int_unequal_value = common.NamedInt(5, "entry")
-    named_int_equal = common.NamedInt(default_value, default_name)
-    named_int_unequal_name = common.NamedInt(default_value, "unequal")
-    named_int_unequal_value = common.NamedInt(5, default_name)
     named_int_unequal = common.NamedInt(2, "unequal")
 
     assert named_int == named_int_equal
@@ -38,6 +37,13 @@ def test_named_int_comparison():
     assert named_int == "entry"
 
 
+def test_named_int_comparison_exception():
+    named_int = common.NamedInt(0, "entry")
+
+    with pytest.raises(TypeError):
+        assert named_int == b"\x00"
+
+
 def test_named_int_conversions():
     named_int = common.NamedInt(2, "two")
 
@@ -45,12 +51,21 @@ def test_named_int_conversions():
     assert str(named_int) == "two"
 
 
-@pytest.fixture
+def test_named_int_yaml():
-def named_ints():
+    named_int = common.NamedInt(2, "two")
-    return common.NamedInts(empty=0, critical=5, low=20, good=50, full=90)
+
+    yaml_string = yaml.dump(named_int)
+
+    assert yaml_string == "!NamedInt {name: two, value: 0x2}\n"
+
+    yaml_load = yaml.safe_load(yaml_string)
+
+    assert yaml_load == named_int
 
 
-def test_named_ints(named_ints):
+def test_named_ints():
+    named_ints = common.NamedInts(empty=0, critical=5, low=20, good=50, full=90)
+
     assert named_ints.empty == 0
     assert named_ints.empty.name == "empty"
     assert named_ints.critical == 5
@@ -73,6 +88,21 @@ def test_named_ints(named_ints):
     assert named_ints[5] == "critical"
     assert named_ints["critical"] == "critical"
     assert named_ints[66] is None
+    assert named_ints["5"] is None
+    assert len(named_ints[:]) == len(named_ints)
+    assert len(named_ints[0:100]) == len(named_ints)
+    assert len(named_ints[5:90]) == 3
+    assert len(named_ints[5:]) == 4
+    assert named_ints[90:5] == []
+
+
+def test_named_ints_fallback():
+    named_ints = common.NamedInts(empty=0, critical=5, low=20, good=50, full=90)
+    named_ints._fallback = lambda x: str(x)
+
+    fallback = named_ints[80]
+
+    assert fallback == common.NamedInt(80, "80")
 
 
 def test_named_ints_list():
@@ -83,7 +113,7 @@ def test_named_ints_list():
     assert 60 not in named_ints_list
 
 
-def test_named_ints_range(named_ints):
+def test_named_ints_range():
     named_ints_range = common.NamedInts.range(0, 5)
 
     assert len(named_ints_range) == 6
@@ -91,6 +121,62 @@ def test_named_ints_range(named_ints):
     assert 6 not in named_ints_range
 
 
+def test_named_ints_flag_names():
+    named_ints_flag_bits = common.NamedInts(one=1, two=2, three=4)
+
+    flags0 = list(named_ints_flag_bits.flag_names(0))
+    flags2 = list(named_ints_flag_bits.flag_names(2))
+    flags5 = list(named_ints_flag_bits.flag_names(5))
+    flags9 = list(named_ints_flag_bits.flag_names(9))
+
+    assert flags0 == []
+    assert flags2 == ["two"]
+    assert flags5 == ["one", "three"]
+    assert flags9 == ["one", "unknown:000008"]
+
+
+def test_named_ints_setitem():
+    named_ints = common.NamedInts(empty=0, critical=5, low=20, good=50, full=90)
+
+    named_ints[55] = "better"
+    named_ints[60] = common.NamedInt(60, "sixty")
+    with pytest.raises(TypeError):
+        named_ints[70] = 70
+    with pytest.raises(ValueError):
+        named_ints[70] = "empty"
+    with pytest.raises(ValueError):
+        named_ints[50] = "new"
+
+    assert named_ints[55] == "better"
+    assert named_ints[60] == "sixty"
+
+
+def test_named_ints_other():
+    named_ints = common.NamedInts(empty=0, critical=5)
+    named_ints_2 = common.NamedInts(good=50)
+
+    union = named_ints.__or__(named_ints_2)
+
+    assert list(named_ints) == [common.NamedInt(0, "empty"), common.NamedInt(5, "critical")]
+    assert len(named_ints) == 2
+    assert repr(named_ints) == "NamedInts(NamedInt(0, 'empty'), NamedInt(5, 'critical'))"
+    assert len(union) == 3
+    assert list(union) == [common.NamedInt(0, "empty"), common.NamedInt(5, "critical"), common.NamedInt(50, "good")]
+
+
+def test_unsorted_named_ints():
+    named_ints = common.UnsortedNamedInts(critical=5, empty=0)
+    named_ints_2 = common.UnsortedNamedInts(good=50)
+
+    union = named_ints.__or__(named_ints_2)
+    unionr = named_ints_2.__or__(named_ints)
+
+    assert len(union) == 3
+    assert list(union) == [common.NamedInt(5, "critical"), common.NamedInt(0, "empty"), common.NamedInt(50, "good")]
+    assert len(unionr) == 3
+    assert list(unionr) == [common.NamedInt(50, "good"), common.NamedInt(5, "critical"), common.NamedInt(0, "empty")]
+
+
 @pytest.mark.parametrize(
     "bytes_input, expected_output",
     [
@@ -122,14 +208,31 @@ def test_int2bytes():
     assert result == expected
 
 
-def test_battery():
+def test_kw_exception():
-    battery = common.Battery(None, None, common.Battery.STATUS.full, None)
+    e = common.KwException(foo=0, bar="bar")
 
-    assert battery.status == common.Battery.STATUS.full
+    assert e.foo == 0
-    assert battery.level == common.Battery.APPROX.full
+    assert e.bar == "bar"
-    assert battery.ok()
+
-    assert battery.charging()
+
-    assert battery.to_str() == "Battery: full (full)"
+@pytest.mark.parametrize(
+    "status, expected_level, expected_ok, expected_charging, expected_string",
+    [
+        (common.Battery.STATUS.full, common.Battery.APPROX.full, True, True, "Battery: full (full)"),
+        (common.Battery.STATUS.almost_full, common.Battery.APPROX.good, True, True, "Battery: good (almost full)"),
+        (common.Battery.STATUS.recharging, common.Battery.APPROX.good, True, True, "Battery: good (recharging)"),
+        (common.Battery.STATUS.slow_recharge, common.Battery.APPROX.low, True, True, "Battery: low (slow recharge)"),
+        (common.Battery.STATUS.discharging, None, True, False, ""),
+    ],
+)
+def test_battery(status, expected_level, expected_ok, expected_charging, expected_string):
+    battery = common.Battery(None, None, status, None)
+
+    assert battery.status == status
+    assert battery.level == expected_level
+    assert battery.ok() == expected_ok
+    assert battery.charging() == expected_charging
+    assert battery.to_str() == expected_string
 
 
 def test_battery_2():

tests/logitech_receiver/test_hidpp20_complex.py

@@ -1,9 +1,13 @@
-from dataclasses import dataclass, field
+from dataclasses import dataclass
-from typing import Any, Optional
+from dataclasses import field
+from typing import Any
+from typing import Optional
 
 import pytest
 
-from lib.logitech_receiver import hidpp20, hidpp20_constants, special_keys
+from lib.logitech_receiver import hidpp20
+from lib.logitech_receiver import hidpp20_constants
+from lib.logitech_receiver import special_keys
 
 
 @dataclass

tests/logitech_receiver/test_hidpp20_simple.py

@@ -1,10 +1,12 @@
 from dataclasses import dataclass
 from functools import partial
-from typing import Any, Optional
+from typing import Any
+from typing import Optional
 from unittest import mock
 
 import pytest
 
+from lib.logitech_receiver import common
 from lib.logitech_receiver import hidpp20
 from lib.logitech_receiver import hidpp20_constants