test_mqtt_smart_plug_subscribe.py 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. """
  2. Tests for subscribe_plug_to_mqtt — the shared helper that resolves a
  3. SmartPlug row's per-type topic fields (with legacy fallback) and calls
  4. MQTTSmartPlugService.subscribe().
  5. Regression guard for #1010, where the startup-restore code path had
  6. drifted from the create/update routes: it only looked at the legacy
  7. `mqtt_topic` field and silently skipped plugs whose topics were set
  8. only in the newer per-type fields, so the MQTT smart-plug subscription
  9. was lost on every Bambuddy restart until the user re-saved the plug.
  10. """
  11. from types import SimpleNamespace
  12. from unittest.mock import MagicMock
  13. from backend.app.services.mqtt_smart_plug import subscribe_plug_to_mqtt
  14. def _plug(**overrides):
  15. """Build a SmartPlug-shaped record. All fields default to None/defaults."""
  16. defaults = {
  17. "id": 1,
  18. "mqtt_topic": None,
  19. "mqtt_power_topic": None,
  20. "mqtt_power_path": None,
  21. "mqtt_power_multiplier": None,
  22. "mqtt_energy_topic": None,
  23. "mqtt_energy_path": None,
  24. "mqtt_energy_multiplier": None,
  25. "mqtt_energy_total_path": None,
  26. "mqtt_energy_total_multiplier": None,
  27. "mqtt_state_topic": None,
  28. "mqtt_state_path": None,
  29. "mqtt_state_on_value": None,
  30. "mqtt_multiplier": None,
  31. }
  32. defaults.update(overrides)
  33. return SimpleNamespace(**defaults)
  34. def test_per_type_topics_restored_without_legacy_mqtt_topic():
  35. """#1010: plug configured only with per-type topics must still subscribe."""
  36. service = MagicMock()
  37. plug = _plug(
  38. id=42,
  39. mqtt_power_topic="shellies/plug-living/power",
  40. mqtt_power_path="value",
  41. mqtt_state_topic="shellies/plug-living/relay/0",
  42. mqtt_state_on_value="on",
  43. )
  44. topics = subscribe_plug_to_mqtt(service, plug)
  45. service.subscribe.assert_called_once()
  46. kwargs = service.subscribe.call_args.kwargs
  47. assert kwargs["plug_id"] == 42
  48. assert kwargs["power_topic"] == "shellies/plug-living/power"
  49. assert kwargs["power_path"] == "value"
  50. assert kwargs["state_topic"] == "shellies/plug-living/relay/0"
  51. assert kwargs["state_on_value"] == "on"
  52. # energy wasn't configured, so no per-type topic
  53. assert kwargs["energy_topic"] is None
  54. assert set(topics) == {"shellies/plug-living/power", "shellies/plug-living/relay/0"}
  55. def test_legacy_single_topic_falls_back_for_all_data_types():
  56. """Backward-compat: a plug with only the legacy mqtt_topic must still work."""
  57. service = MagicMock()
  58. plug = _plug(
  59. id=7,
  60. mqtt_topic="zigbee2mqtt/shelly-office",
  61. mqtt_power_path="power",
  62. mqtt_energy_path="energy",
  63. mqtt_state_path="state",
  64. mqtt_state_on_value="ON",
  65. mqtt_multiplier=0.001, # legacy
  66. )
  67. topics = subscribe_plug_to_mqtt(service, plug)
  68. kwargs = service.subscribe.call_args.kwargs
  69. assert kwargs["power_topic"] == "zigbee2mqtt/shelly-office"
  70. assert kwargs["energy_topic"] == "zigbee2mqtt/shelly-office"
  71. assert kwargs["state_topic"] == "zigbee2mqtt/shelly-office"
  72. # Legacy multiplier flows through for both power and energy.
  73. assert kwargs["power_multiplier"] == 0.001
  74. assert kwargs["energy_multiplier"] == 0.001
  75. assert topics == ["zigbee2mqtt/shelly-office"]
  76. def test_per_type_multipliers_override_legacy():
  77. service = MagicMock()
  78. plug = _plug(
  79. mqtt_power_topic="t/power",
  80. mqtt_power_multiplier=0.5,
  81. mqtt_energy_topic="t/energy",
  82. mqtt_energy_multiplier=0.25,
  83. mqtt_multiplier=9.0, # should be overridden by per-type values
  84. )
  85. subscribe_plug_to_mqtt(service, plug)
  86. kwargs = service.subscribe.call_args.kwargs
  87. assert kwargs["power_multiplier"] == 0.5
  88. assert kwargs["energy_multiplier"] == 0.25
  89. def test_per_type_topics_beat_legacy_topic_when_both_set():
  90. """If both legacy and per-type topic are set, per-type wins."""
  91. service = MagicMock()
  92. plug = _plug(
  93. mqtt_topic="old/topic",
  94. mqtt_power_topic="new/power",
  95. mqtt_energy_topic="new/energy",
  96. )
  97. subscribe_plug_to_mqtt(service, plug)
  98. kwargs = service.subscribe.call_args.kwargs
  99. assert kwargs["power_topic"] == "new/power"
  100. assert kwargs["energy_topic"] == "new/energy"
  101. # state has no per-type topic set, so it falls back to legacy
  102. assert kwargs["state_topic"] == "old/topic"
  103. def test_no_topics_configured_skips_subscribe():
  104. """Nothing to subscribe to means the service is not touched."""
  105. service = MagicMock()
  106. plug = _plug(id=99) # all fields None
  107. topics = subscribe_plug_to_mqtt(service, plug)
  108. service.subscribe.assert_not_called()
  109. assert topics == []
  110. def test_returns_unique_topic_list_when_same_topic_used_for_multiple_types():
  111. service = MagicMock()
  112. plug = _plug(
  113. mqtt_power_topic="shared/topic",
  114. mqtt_energy_topic="shared/topic",
  115. mqtt_state_topic="shared/topic",
  116. )
  117. topics = subscribe_plug_to_mqtt(service, plug)
  118. assert topics == ["shared/topic"]