"""The tests for mqtt update component.""" import json from typing import Any from unittest.mock import patch import pytest from homeassistant.components import mqtt, update from homeassistant.components.update import DOMAIN as UPDATE_DOMAIN, SERVICE_INSTALL from homeassistant.const import ATTR_ENTITY_ID, STATE_OFF, STATE_ON, STATE_UNKNOWN from homeassistant.core import HomeAssistant from .common import ( help_custom_config, help_test_availability_when_connection_lost, help_test_availability_without_topic, help_test_custom_availability_payload, help_test_default_availability_payload, help_test_discovery_broken, help_test_discovery_removal, help_test_discovery_update, help_test_discovery_update_attr, help_test_discovery_update_unchanged, help_test_entity_device_info_remove, help_test_entity_device_info_update, help_test_entity_device_info_with_connection, help_test_entity_device_info_with_identifier, help_test_entity_icon_and_entity_picture, help_test_entity_id_update_discovery_update, help_test_reloadable, help_test_setting_attribute_via_mqtt_json_message, help_test_setting_attribute_with_template, help_test_skipped_async_ha_write_state, help_test_unique_id, help_test_unload_config_entry_with_platform, help_test_update_with_json_attrs_bad_json, help_test_update_with_json_attrs_not_dict, ) from tests.common import async_fire_mqtt_message from tests.typing import MqttMockHAClientGenerator, MqttMockPahoClient DEFAULT_CONFIG = { mqtt.DOMAIN: { update.DOMAIN: { "name": "test", "state_topic": "test-topic", "latest_version_topic": "latest-version-topic", "command_topic": "test-topic", "payload_install": "install", } } } @pytest.mark.parametrize( ("hass_config", "device_class"), [ ( { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "latest_version_topic": "test/latest-version", "name": "Test Update", "release_summary": "Test release summary", "release_url": "https://example.com/release", "title": "Test Update Title", "entity_picture": "https://example.com/icon.png", "device_class": "firmware", } } }, "firmware", ), ( { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "latest_version_topic": "test/latest-version", "name": "Test Update", "release_summary": "Test release summary", "release_url": "https://example.com/release", "title": "Test Update Title", "entity_picture": "https://example.com/icon.png", "device_class": None, } } }, None, ), ], ) async def test_run_update_setup( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, device_class: str | None, ) -> None: """Test that it fetches the given payload.""" installed_version_topic = "test/installed-version" latest_version_topic = "test/latest-version" await mqtt_mock_entry() async_fire_mqtt_message(hass, installed_version_topic, "1.9.0") async_fire_mqtt_message(hass, latest_version_topic, "1.9.0") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "1.9.0" assert state.attributes.get("release_summary") == "Test release summary" assert state.attributes.get("release_url") == "https://example.com/release" assert state.attributes.get("title") == "Test Update Title" assert state.attributes.get("entity_picture") == "https://example.com/icon.png" assert state.attributes.get("device_class") == device_class async_fire_mqtt_message(hass, latest_version_topic, "2.0.0") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "latest_version_topic": "test/latest-version", "name": "Test Update", "release_summary": "Test release summary", "release_url": "https://example.com/release", "title": "Test Update Title", "entity_picture": "https://example.com/icon.png", } } } ], ) async def test_run_update_setup_float( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test that it fetches the given payload when the version is parsable as a number.""" installed_version_topic = "test/installed-version" latest_version_topic = "test/latest-version" await mqtt_mock_entry() async_fire_mqtt_message(hass, installed_version_topic, "1.9") async_fire_mqtt_message(hass, latest_version_topic, "1.9") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9" assert state.attributes.get("latest_version") == "1.9" assert state.attributes.get("release_summary") == "Test release summary" assert state.attributes.get("release_url") == "https://example.com/release" assert state.attributes.get("title") == "Test Update Title" assert state.attributes.get("entity_picture") == "https://example.com/icon.png" async_fire_mqtt_message(hass, latest_version_topic, "2.0") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9" assert state.attributes.get("latest_version") == "2.0" @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "value_template": "{{ value_json.installed }}", "latest_version_topic": "test/latest-version", "latest_version_template": "{{ value_json.latest }}", "name": "Test Update", } } } ], ) async def test_value_template( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test that it fetches the given payload with a template.""" installed_version_topic = "test/installed-version" latest_version_topic = "test/latest-version" await mqtt_mock_entry() async_fire_mqtt_message(hass, installed_version_topic, '{"installed":"1.9.0"}') async_fire_mqtt_message(hass, latest_version_topic, '{"latest":"1.9.0"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "1.9.0" assert ( state.attributes.get("entity_picture") == "https://brands.home-assistant.io/_/mqtt/icon.png" ) async_fire_mqtt_message(hass, latest_version_topic, '{"latest":"2.0.0"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/update", "value_template": ( "{\"latest_version\":\"{{ value_json['update']['latest_version'] }}\"," "\"installed_version\":\"{{ value_json['update']['installed_version'] }}\"," "\"update_percentage\":{{ value_json['update'].get('progress', 'null') }}}" ), "name": "Test Update", } } } ], ) async def test_errornous_value_template( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, caplog: pytest.LogCaptureFixture, ) -> None: """Test that it fetches the given payload with a template or handles the exception.""" state_topic = "test/update" await mqtt_mock_entry() # Simulate a template redendering error with payload # without "update" mapping example_payload: dict[str, Any] = { "child_lock": "UNLOCK", "current": 0.02, "energy": 212.92, "indicator_mode": "off/on", "linkquality": 65, "power": 0, "power_outage_memory": "off", "state": "ON", "voltage": 232, } async_fire_mqtt_message(hass, state_topic, json.dumps(example_payload)) await hass.async_block_till_done() assert hass.states.get("update.test_update") is not None assert "Unable to process payload '" in caplog.text # Add update info example_payload["update"] = { "latest_version": "2.0.0", "installed_version": "1.9.0", "progress": 20, } async_fire_mqtt_message(hass, state_topic, json.dumps(example_payload)) await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state is not None assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" assert state.attributes.get("update_percentage") == 20 @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "value_template": "{{ value_json.installed }}", "latest_version_topic": "test/latest-version", "latest_version_template": "{{ value_json.latest }}", "name": "Test Update", } } } ], ) async def test_value_template_float( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test that it fetches the given payload with a template when the version is parsable as a number.""" installed_version_topic = "test/installed-version" latest_version_topic = "test/latest-version" await mqtt_mock_entry() async_fire_mqtt_message(hass, installed_version_topic, '{"installed":"1.9"}') async_fire_mqtt_message(hass, latest_version_topic, '{"latest":"1.9"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9" assert state.attributes.get("latest_version") == "1.9" assert ( state.attributes.get("entity_picture") == "https://brands.home-assistant.io/_/mqtt/icon.png" ) async_fire_mqtt_message(hass, latest_version_topic, '{"latest":"2.0"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9" assert state.attributes.get("latest_version") == "2.0" @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/state-topic", "name": "Test Update", } } } ], ) async def test_empty_json_state_message( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test an empty JSON payload.""" state_topic = "test/state-topic" await mqtt_mock_entry() async_fire_mqtt_message(hass, state_topic, "{}") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_UNKNOWN @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/state-topic", "name": "Test Update", } } } ], ) async def test_invalid_json_state_message( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, caplog: pytest.LogCaptureFixture, ) -> None: """Test an empty JSON payload.""" state_topic = "test/state-topic" await mqtt_mock_entry() async_fire_mqtt_message( hass, state_topic, '{"installed_version":"1.9.0","latest_version":"1.9.0",' '"title":"Test Update 1 Title","release_url":"https://example.com/release1",' '"release_summary":"Test release summary 1",' '"entity_picture": "https://example.com/icon1.png"}', ) await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "1.9.0" assert state.attributes.get("release_summary") == "Test release summary 1" assert state.attributes.get("release_url") == "https://example.com/release1" assert state.attributes.get("title") == "Test Update 1 Title" assert state.attributes.get("entity_picture") == "https://example.com/icon1.png" # Test update schema validation with invalid value in JSON update async_fire_mqtt_message(hass, state_topic, '{"update_percentage":101}') await hass.async_block_till_done() assert ( "Schema violation after processing payload '{\"update_percentage\":101}' on " "topic 'test/state-topic' for entity 'update.test_update': value must be at " "most 100 for dictionary value @ data['update_percentage']" in caplog.text ) @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/state-topic", "name": "Test Update", "display_precision": 1, } } } ], ) async def test_json_state_message( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test whether it fetches data from a JSON payload.""" state_topic = "test/state-topic" await mqtt_mock_entry() async_fire_mqtt_message( hass, state_topic, '{"installed_version":"1.9.0","latest_version":"1.9.0",' '"title":"Test Update 1 Title","release_url":"https://example.com/release1",' '"release_summary":"Test release summary 1",' '"entity_picture": "https://example.com/icon1.png"}', ) await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "1.9.0" assert state.attributes.get("release_summary") == "Test release summary 1" assert state.attributes.get("release_url") == "https://example.com/release1" assert state.attributes.get("title") == "Test Update 1 Title" assert state.attributes.get("entity_picture") == "https://example.com/icon1.png" async_fire_mqtt_message( hass, state_topic, '{"installed_version":"1.9.0","latest_version":"2.0.0",' '"title":"Test Update 2 Title","entity_picture":"https://example.com/icon2.png"}', ) await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" assert state.attributes.get("entity_picture") == "https://example.com/icon2.png" assert state.attributes.get("in_progress") is False assert state.attributes.get("update_percentage") is None # Test in_progress status async_fire_mqtt_message(hass, state_topic, '{"in_progress":true}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" assert state.attributes.get("entity_picture") == "https://example.com/icon2.png" assert state.attributes.get("in_progress") is True assert state.attributes.get("update_percentage") is None async_fire_mqtt_message(hass, state_topic, '{"in_progress":false}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.attributes.get("in_progress") is False # Test update_percentage status async_fire_mqtt_message(hass, state_topic, '{"update_percentage":51.75}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.attributes.get("in_progress") is True assert state.attributes.get("update_percentage") == 51.75 assert state.attributes.get("display_precision") == 1 async_fire_mqtt_message(hass, state_topic, '{"update_percentage":100}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.attributes.get("in_progress") is True assert state.attributes.get("update_percentage") == 100 async_fire_mqtt_message(hass, state_topic, '{"update_percentage":null}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.attributes.get("in_progress") is False assert state.attributes.get("update_percentage") is None @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/state-topic", "value_template": '{{ {"installed_version": value_json.installed, ' '"latest_version": value_json.latest} | to_json }}', "name": "Test Update", } } } ], ) async def test_json_state_message_with_template( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test whether it fetches data from a JSON payload with template.""" state_topic = "test/state-topic" await mqtt_mock_entry() async_fire_mqtt_message(hass, state_topic, '{"installed":"1.9.0","latest":"1.9.0"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_OFF assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "1.9.0" async_fire_mqtt_message(hass, state_topic, '{"installed":"1.9.0","latest":"2.0.0"}') await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON assert state.attributes.get("installed_version") == "1.9.0" assert state.attributes.get("latest_version") == "2.0.0" @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: { "state_topic": "test/installed-version", "latest_version_topic": "test/latest-version", "command_topic": "test/install-command", "payload_install": "install", "name": "Test Update", } } } ], ) async def test_run_install_service( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test that install service works.""" installed_version_topic = "test/installed-version" latest_version_topic = "test/latest-version" command_topic = "test/install-command" mqtt_mock = await mqtt_mock_entry() async_fire_mqtt_message(hass, installed_version_topic, "1.9.0") async_fire_mqtt_message(hass, latest_version_topic, "2.0.0") await hass.async_block_till_done() state = hass.states.get("update.test_update") assert state.state == STATE_ON await hass.services.async_call( UPDATE_DOMAIN, SERVICE_INSTALL, {ATTR_ENTITY_ID: "update.test_update"}, blocking=True, ) mqtt_mock.async_publish.assert_called_once_with(command_topic, "install", 0, False) @pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG]) async def test_availability_when_connection_lost( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test availability after MQTT disconnection.""" await help_test_availability_when_connection_lost( hass, mqtt_mock_entry, update.DOMAIN ) @pytest.mark.parametrize("hass_config", [DEFAULT_CONFIG]) async def test_availability_without_topic( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test availability without defined availability topic.""" await help_test_availability_without_topic( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_default_availability_payload( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test availability by default payload with defined topic.""" await help_test_default_availability_payload( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_custom_availability_payload( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test availability by custom payload with defined topic.""" await help_test_custom_availability_payload( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_setting_attribute_via_mqtt_json_message( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test the setting of attribute via MQTT with JSON payload.""" await help_test_setting_attribute_via_mqtt_json_message( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_setting_attribute_with_template( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test the setting of attribute via MQTT with JSON payload.""" await help_test_setting_attribute_with_template( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_update_with_json_attrs_not_dict( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, caplog: pytest.LogCaptureFixture, ) -> None: """Test attributes get extracted from a JSON result.""" await help_test_update_with_json_attrs_not_dict( hass, mqtt_mock_entry, caplog, update.DOMAIN, DEFAULT_CONFIG ) async def test_update_with_json_attrs_bad_json( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, caplog: pytest.LogCaptureFixture, ) -> None: """Test attributes get extracted from a JSON result.""" await help_test_update_with_json_attrs_bad_json( hass, mqtt_mock_entry, caplog, update.DOMAIN, DEFAULT_CONFIG ) async def test_discovery_update_attr( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, ) -> None: """Test update of discovered MQTTAttributes.""" await help_test_discovery_update_attr( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) @pytest.mark.parametrize( "hass_config", [ { mqtt.DOMAIN: { update.DOMAIN: [ { "name": "Bear", "state_topic": "installed-topic", "latest_version_topic": "latest-topic", "unique_id": "TOTALLY_UNIQUE", }, { "name": "Milk", "state_topic": "installed-topic", "latest_version_topic": "latest-topic", "unique_id": "TOTALLY_UNIQUE", }, ] } } ], ) async def test_unique_id( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test unique id option only creates one update per unique_id.""" await help_test_unique_id(hass, mqtt_mock_entry, update.DOMAIN) async def test_discovery_removal_update( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test removal of discovered update.""" data = json.dumps(DEFAULT_CONFIG[mqtt.DOMAIN][update.DOMAIN]) await help_test_discovery_removal(hass, mqtt_mock_entry, update.DOMAIN, data) async def test_discovery_update_update( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test update of discovered update.""" config1 = { "name": "Beer", "state_topic": "installed-topic", "latest_version_topic": "latest-topic", } config2 = { "name": "Milk", "state_topic": "installed-topic", "latest_version_topic": "latest-topic", } await help_test_discovery_update( hass, mqtt_mock_entry, update.DOMAIN, config1, config2 ) async def test_discovery_update_unchanged_update( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test update of discovered update.""" data1 = '{ "name": "Beer", "state_topic": "installed-topic", "latest_version_topic": "latest-topic"}' with patch( "homeassistant.components.mqtt.update.MqttUpdate.discovery_update" ) as discovery_update: await help_test_discovery_update_unchanged( hass, mqtt_mock_entry, update.DOMAIN, data1, discovery_update ) @pytest.mark.no_fail_on_log_exception async def test_discovery_broken( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test handling of bad discovery message.""" data1 = '{ "name": "Beer" }' data2 = '{ "name": "Milk", "state_topic": "installed-topic", "latest_version_topic": "latest-topic" }' await help_test_discovery_broken(hass, mqtt_mock_entry, update.DOMAIN, data1, data2) async def test_entity_device_info_with_connection( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test MQTT update device registry integration.""" await help_test_entity_device_info_with_connection( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_entity_device_info_with_identifier( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test MQTT update device registry integration.""" await help_test_entity_device_info_with_identifier( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_entity_device_info_update( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test device registry update.""" await help_test_entity_device_info_update( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_entity_device_info_remove( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test device registry remove.""" await help_test_entity_device_info_remove( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) async def test_entity_id_update_discovery_update( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test MQTT discovery update when entity_id is updated.""" await help_test_entity_id_update_discovery_update( hass, mqtt_mock_entry, update.DOMAIN, DEFAULT_CONFIG ) @pytest.mark.parametrize( "hass_config", [DEFAULT_CONFIG, {"mqtt": [DEFAULT_CONFIG["mqtt"]]}], ids=["platform_key", "listed"], ) async def test_setup_manual_entity_from_yaml( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test setup manual configured MQTT entity.""" await mqtt_mock_entry() platform = update.DOMAIN assert hass.states.get(f"{platform}.test") async def test_unload_entry( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator ) -> None: """Test unloading the config entry.""" domain = update.DOMAIN config = DEFAULT_CONFIG await help_test_unload_config_entry_with_platform( hass, mqtt_mock_entry, domain, config ) async def test_reloadable( hass: HomeAssistant, mqtt_client_mock: MqttMockPahoClient ) -> None: """Test reloading the MQTT platform.""" domain = update.DOMAIN config = DEFAULT_CONFIG await help_test_reloadable(hass, mqtt_client_mock, domain, config) @pytest.mark.parametrize( "hass_config", [ help_custom_config( update.DOMAIN, DEFAULT_CONFIG, ( { "availability_topic": "availability-topic", "json_attributes_topic": "json-attributes-topic", }, ), ) ], ) @pytest.mark.parametrize( ("topic", "payload1", "payload2"), [ ("latest-version-topic", "1.1", "1.2"), ("test-topic", "1.1", "1.2"), ("test-topic", '{"installed_version": "1.1"}', '{"installed_version": "1.2"}'), ("test-topic", '{"latest_version": "1.1"}', '{"latest_version": "1.2"}'), ("test-topic", '{"title": "Update"}', '{"title": "Patch"}'), ("test-topic", '{"release_summary": "bla1"}', '{"release_summary": "bla2"}'), ( "test-topic", '{"release_url": "https://example.com/update?r=1"}', '{"release_url": "https://example.com/update?r=2"}', ), ( "test-topic", '{"entity_picture": "https://example.com/icon1.png"}', '{"entity_picture": "https://example.com/icon2.png"}', ), ("test-topic", '{"in_progress": true}', '{"in_progress": false}'), ("test-topic", '{"update_percentage": 0}', '{"update_percentage": 50}'), ("test-topic", '{"update_percentage": 50}', '{"update_percentage": 100}'), ("test-topic", '{"update_percentage": 100}', '{"update_percentage": null}'), ("availability-topic", "online", "offline"), ("json-attributes-topic", '{"attr1": "val1"}', '{"attr1": "val2"}'), ], ) async def test_skipped_async_ha_write_state( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, topic: str, payload1: str, payload2: str, ) -> None: """Test a write state command is only called when there is change.""" await mqtt_mock_entry() await help_test_skipped_async_ha_write_state(hass, topic, payload1, payload2) VALUE_TEMMPLATES = { "value_template": "state_topic", "latest_version_template": "latest_version_topic", } @pytest.mark.parametrize( "hass_config", [ help_custom_config( update.DOMAIN, DEFAULT_CONFIG, ( { state_topic: "test-topic", value_template: "{{ value_json.some_var * 1 }}", }, ), ) for value_template, state_topic in VALUE_TEMMPLATES.items() ], ids=VALUE_TEMMPLATES, ) async def test_value_template_fails( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, caplog: pytest.LogCaptureFixture, ) -> None: """Test the rendering of MQTT value template fails.""" await mqtt_mock_entry() async_fire_mqtt_message(hass, "test-topic", '{"some_var": null }') assert ( "TypeError: unsupported operand type(s) for *: 'NoneType' and 'int' rendering template" in caplog.text ) async def test_entity_icon_and_entity_picture( hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator, ) -> None: """Test the entity icon or picture setup.""" domain = update.DOMAIN config = DEFAULT_CONFIG await help_test_entity_icon_and_entity_picture( hass, mqtt_mock_entry, domain, config, default_entity_picture="https://brands.home-assistant.io/_/mqtt/icon.png", )