Add unit tests for the --json output

Fixed a bug where the protocol was overridden by running ping

lib/solaar/cli/show.py

@@ -185,6 +185,8 @@ def _receiver_json(receiver):
 
 def _device_json(dev):
     """Serialize a device as a JSON-friendly dict, or None if the device is gone."""
+    # Save the protocol before the ping, as it overrides it
+    protocol = float(dev.protocol) if dev.protocol else None
     try:
         online = dev.ping()
     except exceptions.NoSuchDevice:
@@ -195,7 +197,6 @@ def _device_json(dev):
             battery = dev.battery()
         except Exception:
             battery = None
-    protocol = float(dev.protocol) if dev.protocol else None
     receiver = getattr(dev, "receiver", None)
     return {
         "name": dev.name,

tests/solaar/cli/test_show_json.py

@@ -0,0 +1,242 @@
+## Copyright (C) 2024  Solaar Contributors https://pwr-solaar.github.io/Solaar/
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program 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 General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License along
+## with this program; if not, write to the Free Software Foundation, Inc.,
+## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+import json
+
+from dataclasses import dataclass
+from functools import partial
+
+import pytest
+
+from logitech_receiver import base
+from logitech_receiver import exceptions
+from logitech_receiver import receiver as receiver_mod
+from logitech_receiver.common import Battery
+from logitech_receiver.common import BatteryLevelApproximation
+from logitech_receiver.common import BatteryStatus
+from logitech_receiver.common import NamedInt
+from logitech_receiver.device import Device
+from solaar.cli.show import _battery_json
+from solaar.cli.show import _device_json
+from solaar.cli.show import _json_output
+from solaar.cli.show import _receiver_json
+
+from tests.logitech_receiver import fake_hidpp
+
+
+class LowLevelInterfaceFake:
+    def __init__(self, responses=None):
+        self.responses = responses
+
+    def open_path(self, path) -> int:
+        return fake_hidpp.open_path(path)
+
+    def find_paired_node(self, receiver_path: str, index: int, timeout: int):
+        return None
+
+    def product_information(self, usb_id: int) -> dict:
+        return base.product_information(usb_id)
+
+    def request(self, response, *args, **kwargs):
+        func = partial(fake_hidpp.request, self.responses)
+        return func(response, *args, **kwargs)
+
+    def ping(self, response, *args, **kwargs):
+        func = partial(fake_hidpp.ping, self.responses)
+        return func(response, *args, **kwargs)
+
+    def close(self, *args, **kwargs):
+        pass
+
+
+class FakeReceiver:
+    name = "Nano Receiver"
+    serial = "F14890D2"
+    path = "/dev/hidraw2"
+
+    def device_codename(self, number):
+        return None
+
+    def __contains__(self, dev):
+        return True
+
+
+@dataclass
+class DeviceInfo:
+    path: str
+    vendor_id: int = 1133
+    product_id: int = 0xC534
+
+
+pi_4066 = {"wpid": "4066", "kind": NamedInt(1, "keyboard"), "serial": "5678", "polling": "4ms", "power_switch": "left"}
+
+responses_receiver = [
+    fake_hidpp.Response("000000", 0x8003, "FF"),
+    fake_hidpp.Response("000300", 0x8102),
+]
+
+
+def _keyboard_device():
+    responses = fake_hidpp.replace_number(fake_hidpp.r_keyboard_2, 3)
+    return Device(LowLevelInterfaceFake(responses), FakeReceiver(), 3, True, pi_4066, handle=0x11)
+
+
+def _json_dump(mocker, *args):
+    printed = []
+    mocker.patch("solaar.cli.show.print", side_effect=lambda *a, **kw: printed.append(a[0]))
+    _json_output(*args)
+    return json.loads(printed[-1])
+
+
+def _battery(level, status=BatteryStatus.DISCHARGING, next_level=None, voltage=None):
+    return Battery(level, next_level, status, voltage)
+
+
+def test_battery_json_none():
+    assert _battery_json(None) is None
+
+
+def test_battery_json_percentage():
+    info = _battery_json(_battery(55, voltage=3800))
+    assert info == {
+        "level": 55,
+        "level_kind": "level",
+        "next_level": None,
+        "status": "discharging",
+        "voltage": 3800,
+    }
+
+
+def test_battery_json_approximation():
+    info = _battery_json(_battery(BatteryLevelApproximation.GOOD))
+    assert info["level"] == 50
+    assert info["level_kind"] == "reported"
+
+
+def test_battery_json_full_approximation():
+    info = _battery_json(_battery(BatteryLevelApproximation.FULL, next_level=BatteryLevelApproximation.LOW))
+    assert info["level"] == 90
+    assert info["level_kind"] == "reported"
+    assert info["next_level"] == 20
+
+
+@pytest.mark.parametrize(
+    "status, expected",
+    [
+        (BatteryStatus.DISCHARGING, "discharging"),
+        (BatteryStatus.RECHARGING, "recharging"),
+        (BatteryStatus.ALMOST_FULL, "almost full"),
+        (BatteryStatus.SLOW_RECHARGE, "slow recharge"),
+    ],
+)
+def test_battery_json_status_names(status, expected):
+    assert _battery_json(_battery(50, status))["status"] == expected
+
+
+def test_battery_json_no_status():
+    assert _battery_json(_battery(50, None))["status"] is None
+
+
+def test_receiver_json_none():
+    assert _receiver_json(None) is None
+
+
+def test_receiver_json_info():
+    assert _receiver_json(FakeReceiver()) == {
+        "name": "Nano Receiver",
+        "serial": "F14890D2",
+        "path": "/dev/hidraw2",
+    }
+
+
+def test_device_json_online():
+    info = _device_json(_keyboard_device())
+    assert info["name"] == "Craft Advanced Keyboard"
+    assert info["number"] == 3
+    assert info["receiver"] == {"name": "Nano Receiver", "serial": "F14890D2", "path": "/dev/hidraw2"}
+    assert info["serial"] == "5678"
+    assert info["unitId"] == "12345678"
+    assert info["modelId"] == "1234567890AB"
+    assert info["kind"] == "keyboard"
+    assert info["protocol"] == 4.5
+    assert info["online"] is True
+    assert info["battery"] == {"level": 18, "level_kind": "level", "next_level": 52, "status": None, "voltage": None}
+
+
+def test_device_json_reported_battery(mocker):
+    dev = _keyboard_device()
+    mocker.patch.object(dev, "battery", return_value=_battery(BatteryLevelApproximation.GOOD))
+    info = _device_json(dev)
+    assert info["battery"]["level"] == 50
+    assert info["battery"]["level_kind"] == "reported"
+
+
+def test_device_json_offline_battery_unavailable():
+    pi = {"wpid": "4066", "kind": 1, "serial": None, "polling": "4ms", "power_switch": "left"}
+    dev = Device(LowLevelInterfaceFake([]), FakeReceiver(), 1, True, pi, handle=0x11)
+    info = _device_json(dev)
+    assert info["online"] is False
+    assert info["battery"] is None
+
+
+def test_device_json_no_such_device_returns_none(mocker):
+    dev = _keyboard_device()
+    mocker.patch.object(dev, "ping", side_effect=exceptions.NoSuchDevice())
+    assert _device_json(dev) is None
+
+
+def test_json_output_all_flattens_receiver(mocker):
+    dev = _keyboard_device()
+    r = receiver_mod.create_receiver(LowLevelInterfaceFake(responses_receiver), DeviceInfo("14"), lambda x: x)
+    r._devices[1] = dev
+    mocker.patch.object(r, "count", return_value=1)
+
+    output = _json_dump(mocker, [r], "all", None, None)
+
+    assert "solaar_version" in output
+    assert [d["name"] for d in output["devices"]] == ["Craft Advanced Keyboard"]
+    assert output["devices"][0]["number"] == 3
+
+
+def test_json_output_single_device(mocker):
+    dev = _keyboard_device()
+    find_receiver = mocker.Mock(return_value=None)
+    find_device = mocker.Mock(return_value=iter([dev]))
+
+    output = _json_dump(mocker, [dev], "Craft Advanced Keyboard", find_receiver, find_device)
+
+    assert [d["name"] for d in output["devices"]] == ["Craft Advanced Keyboard"]
+    assert output["devices"][0]["battery"]["level"] == 18
+
+
+def test_json_output_single_device_on_receiver(mocker):
+    dev = _keyboard_device()
+    r = receiver_mod.create_receiver(LowLevelInterfaceFake(responses_receiver), DeviceInfo("14"), lambda x: x)
+    r._devices[1] = dev
+    mocker.patch.object(r, "count", return_value=1)
+    find_receiver = mocker.Mock(return_value=r)
+
+    output = _json_dump(mocker, [r], "Craft Advanced Keyboard", find_receiver, None)
+
+    assert [d["name"] for d in output["devices"]] == ["Craft Advanced Keyboard"]
+
+
+def test_json_output_no_matching_device_raises(mocker):
+    find_receiver = mocker.Mock(return_value=None)
+    find_device = mocker.Mock(return_value=iter([]))
+
+    with pytest.raises(Exception, match="no device found"):
+        _json_output([], "Missing", find_receiver, find_device)