home-assistant/core
1
0
Fork 1
mirror of https://github.com/home-assistant/core.git synced 2025-07-31 19:25:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Allow raw mqtt payload to be in mqtt publish action (#123900)

Browse Source 
* Publish raw rendered mqtt payload as raw for mqtt publish action

* Move check out of try block

* Only try to eval `bytes` is payload starts with supported string

Co-authored-by: Erik Montnemery <erik@montnemery.com>

* Improve docst

* Add `evaluate_bytes` option to publish action

* Rename to `evaluate_payload`

* Update homeassistant/components/mqtt/strings.json

Co-authored-by: Erik Montnemery <erik@montnemery.com>

* Extend test to assert literal_eval is called or not

---------

Co-authored-by: Erik Montnemery <erik@montnemery.com>
This commit is contained in:
Jan Bouwhuis
2024-08-16 13:34:14 +02:00
committed by GitHub
parent f3e2d06922
commit 183c191d63
5 changed files with 101 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
tests/components/mqtt/test_init.py
View File

@@ -420,6 +420,74 @@ async def test_mqtt_publish_action_call_with_template_payload_renders_template(
mqtt_mock.reset_mock()
@pytest.mark.parametrize(
("attr_payload", "payload", "evaluate_payload", "literal_eval_calls"),
[
("b'\\xde\\xad\\xbe\\xef'", b"\xde\xad\xbe\xef", True, 1),
("b'\\xde\\xad\\xbe\\xef'", "b'\\xde\\xad\\xbe\\xef'", False, 0),
("DEADBEEF", "DEADBEEF", False, 0),
(
"b'\\xde",
"b'\\xde",
True,
1,
), # Bytes literal is invalid, fall back to string
],
)
async def test_mqtt_publish_action_call_with_raw_data(
hass: HomeAssistant,
mqtt_mock_entry: MqttMockHAClientGenerator,
attr_payload: str,
payload: str | bytes,
evaluate_payload: bool,
literal_eval_calls: int,
) -> None:
"""Test the mqtt publish action call raw data.
When `payload` represents a `bytes` object, it should be published
as raw data if `evaluate_payload` is set.
"""
mqtt_mock = await mqtt_mock_entry()
await hass.services.async_call(
mqtt.DOMAIN,
mqtt.SERVICE_PUBLISH,
{
mqtt.ATTR_TOPIC: "test/topic",
mqtt.ATTR_PAYLOAD: attr_payload,
mqtt.ATTR_EVALUATE_PAYLOAD: evaluate_payload,
},
blocking=True,
)
assert mqtt_mock.async_publish.called
assert mqtt_mock.async_publish.call_args[0][1] == payload
with patch(
"homeassistant.components.mqtt.models.literal_eval"
) as literal_eval_mock:
await hass.services.async_call(
mqtt.DOMAIN,
mqtt.SERVICE_PUBLISH,
{
mqtt.ATTR_TOPIC: "test/topic",
mqtt.ATTR_PAYLOAD: attr_payload,
},
blocking=True,
)
literal_eval_mock.assert_not_called()
await hass.services.async_call(
mqtt.DOMAIN,
mqtt.SERVICE_PUBLISH,
{
mqtt.ATTR_TOPIC: "test/topic",
mqtt.ATTR_PAYLOAD: attr_payload,
mqtt.ATTR_EVALUATE_PAYLOAD: evaluate_payload,
},
blocking=True,
)
assert len(literal_eval_mock.mock_calls) == literal_eval_calls
# The use of a payload_template in an mqtt publish action call
# has been deprecated with HA Core 2024.8.0 and will be removed with HA Core 2025.2.0
async def test_publish_action_call_with_bad_payload_template(