test_short_payload_guards.py 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. """
  2. Regression tests: parsers must not raise on short payloads.
  3. The dispatcher in `switchbot/adv_parser.py` does not pre-validate
  4. `mfr_data` / `data` length before invoking parsers. A malformed BLE
  5. advertisement (untrusted but range-limited input) should degrade to
  6. an empty dict / None values, not raise an `IndexError` / `ValueError`
  7. that bubbles up to callers.
  8. """
  9. from __future__ import annotations
  10. import pytest
  11. from switchbot.adv_parsers.air_purifier import process_air_purifier
  12. from switchbot.adv_parsers.art_frame import process_art_frame
  13. from switchbot.adv_parsers.blind_tilt import process_woblindtilt
  14. from switchbot.adv_parsers.bot import process_wohand
  15. from switchbot.adv_parsers.bulb import process_color_bulb
  16. from switchbot.adv_parsers.ceiling_light import process_woceiling
  17. from switchbot.adv_parsers.climate_panel import process_climate_panel
  18. from switchbot.adv_parsers.curtain import process_wocurtain
  19. from switchbot.adv_parsers.fan import process_fan, process_standing_fan
  20. from switchbot.adv_parsers.hub2 import process_wohub2
  21. from switchbot.adv_parsers.hub3 import process_hub3
  22. from switchbot.adv_parsers.hubmini_matter import process_hubmini_matter
  23. from switchbot.adv_parsers.humidifier import (
  24. process_evaporative_humidifier,
  25. process_wohumidifier,
  26. )
  27. from switchbot.adv_parsers.keypad import process_wokeypad
  28. from switchbot.adv_parsers.keypad_vision import (
  29. process_keypad_vision,
  30. process_keypad_vision_pro,
  31. )
  32. from switchbot.adv_parsers.light_strip import (
  33. process_candle_warmer_lamp,
  34. process_light,
  35. process_rgbic_light,
  36. process_wostrip,
  37. )
  38. from switchbot.adv_parsers.lock import (
  39. parse_common_data,
  40. process_lock2,
  41. process_locklite,
  42. process_wolock,
  43. process_wolock_pro,
  44. process_wolock_pro_wifi,
  45. )
  46. from switchbot.adv_parsers.meter import process_wosensorth
  47. from switchbot.adv_parsers.motion import process_wopresence
  48. from switchbot.adv_parsers.plug import process_woplugmini
  49. from switchbot.adv_parsers.remote import process_woremote, process_wouniversal_remote
  50. from switchbot.adv_parsers.roller_shade import process_worollershade
  51. from switchbot.adv_parsers.smart_thermostat_radiator import (
  52. process_smart_thermostat_radiator,
  53. )
  54. from switchbot.adv_parsers.vacuum import process_vacuum, process_vacuum_k
  55. EMPTY = b""
  56. SHORT = b"\x00" * 4
  57. @pytest.mark.parametrize(
  58. "parser",
  59. [
  60. process_air_purifier,
  61. process_art_frame,
  62. process_woblindtilt,
  63. process_color_bulb,
  64. process_woceiling,
  65. process_climate_panel,
  66. process_wocurtain,
  67. process_fan,
  68. process_standing_fan,
  69. process_wohub2,
  70. process_hub3,
  71. process_hubmini_matter,
  72. process_evaporative_humidifier,
  73. process_keypad_vision,
  74. process_keypad_vision_pro,
  75. process_wostrip,
  76. process_candle_warmer_lamp,
  77. process_woplugmini,
  78. process_worollershade,
  79. process_smart_thermostat_radiator,
  80. process_vacuum,
  81. process_vacuum_k,
  82. ],
  83. )
  84. @pytest.mark.parametrize("payload", [None, EMPTY, SHORT])
  85. def test_mfr_only_parsers_return_empty_on_short(parser, payload):
  86. """Parsers that read only mfr_data must return {} for short payloads."""
  87. assert parser(None, payload) == {}
  88. @pytest.mark.parametrize("payload", [None, EMPTY, SHORT, b"\x00" * 17])
  89. def test_process_light_short_payload(payload):
  90. """process_light needs cw_offset + 2 bytes (default 18)."""
  91. assert process_light(None, payload) == {}
  92. @pytest.mark.parametrize("payload", [None, EMPTY, SHORT, b"\x00" * 11])
  93. def test_process_rgbic_light_short_payload(payload):
  94. """process_rgbic_light uses cw_offset=10, so needs >= 12 bytes."""
  95. assert process_rgbic_light(None, payload) == {}
  96. @pytest.mark.parametrize(
  97. ("data", "mfr_data"),
  98. [
  99. (None, None),
  100. (EMPTY, None),
  101. (b"\x00\x00", None),
  102. ],
  103. )
  104. def test_process_wohand_short_data(data, mfr_data):
  105. """process_wohand must not crash on short `data`."""
  106. out = process_wohand(data, mfr_data)
  107. # Either an empty dict (both None) or all-None values
  108. assert "isOn" in out or out == {}
  109. assert out.get("battery") in (None, *out.values())
  110. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00"])
  111. def test_process_woremote_short_data(data):
  112. out = process_woremote(data, None)
  113. assert out == {"battery": None}
  114. @pytest.mark.parametrize(
  115. "mfr_data",
  116. [None, EMPTY, b"\x00", b"\x00" * 7],
  117. )
  118. def test_process_wouniversal_remote_short_mfr(mfr_data):
  119. out = process_wouniversal_remote(None, mfr_data)
  120. assert out == {"battery": None, "charging": None}
  121. @pytest.mark.parametrize(
  122. ("data", "mfr_data"),
  123. [
  124. (None, None),
  125. (b"\x00", None),
  126. (None, b"\x00"),
  127. (b"\x00\x00", b"\x00\x00"),
  128. ],
  129. )
  130. def test_process_wokeypad_short(data, mfr_data):
  131. out = process_wokeypad(data, mfr_data)
  132. assert out == {"battery": None, "attempt_state": None}
  133. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00\x00"])
  134. def test_process_wohumidifier_short_data(data):
  135. out = process_wohumidifier(data, None)
  136. assert out == {"isOn": None, "level": None, "switchMode": True}
  137. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00\x00"])
  138. @pytest.mark.parametrize("mfr_data", [None, EMPTY, b"\x00\x00\x00"])
  139. def test_process_wosensorth_short(data, mfr_data):
  140. """process_wosensorth must not crash; returns {} when no usable payload."""
  141. out = process_wosensorth(data, mfr_data)
  142. assert isinstance(out, dict)
  143. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00\x00"])
  144. @pytest.mark.parametrize("mfr_data", [None, EMPTY, b"\x00\x00\x00"])
  145. def test_process_wopresence_short(data, mfr_data):
  146. """process_wopresence must not crash even when both inputs are short."""
  147. out = process_wopresence(data, mfr_data)
  148. assert isinstance(out, dict)
  149. @pytest.mark.parametrize("mfr_data", [None, EMPTY, SHORT])
  150. def test_lock_parsers_short_mfr(mfr_data):
  151. assert process_locklite(None, mfr_data) == {}
  152. assert process_wolock(None, mfr_data) == {}
  153. assert parse_common_data(mfr_data) == {}
  154. assert process_wolock_pro(None, mfr_data) == {}
  155. assert process_wolock_pro_wifi(None, mfr_data) == {}
  156. assert process_lock2(None, mfr_data) == {}
  157. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00"])
  158. def test_blind_tilt_short_data(data):
  159. """blind_tilt with full mfr but short data must not crash on data[2]."""
  160. mfr = b"\x00" * 10
  161. out = process_woblindtilt(data, mfr)
  162. assert out["battery"] is None
  163. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00"])
  164. def test_curtain_short_data_with_long_mfr(data):
  165. """Curtain >=11 path uses data[2] for battery; must not crash on short data."""
  166. mfr = b"\x00" * 11
  167. out = process_wocurtain(data, mfr)
  168. assert out["battery"] is None
  169. @pytest.mark.parametrize("data", [b"\x00\x00\x00\x00", b"\x00" * 5])
  170. def test_curtain_short_data_only(data):
  171. """Curtain data-only path needs len >= 6; shorter -> {}."""
  172. assert process_wocurtain(data, None) == {}
  173. @pytest.mark.parametrize("data", [None, EMPTY, b"\x00\x00"])
  174. def test_roller_shade_short_data(data):
  175. """roller_shade with short data must not crash on data[2]."""
  176. mfr = b"\x00" * 10
  177. out = process_worollershade(data, mfr)
  178. assert out["battery"] is None