Correct type hints on MQTT tests (#128299)

Author: jbouwh

tests/components/light/common.py

@@ -99,7 +99,7 @@ async def async_turn_on(
     flash: str | None = None,
     effect: str | None = None,
     color_name: str | None = None,
-    white: bool | None = None,
+    white: int | None = None,
 ) -> None:
     """Turn all or specified light on."""
     data = {

tests/components/mqtt/test_binary_sensor.py

@@ -1133,7 +1133,7 @@ async def test_skip_restoring_state_with_over_due_expire_trigger(
 
     freezer.move_to("2022-02-02 12:02:00+01:00")
     domain = binary_sensor.DOMAIN
-    config3 = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][domain])
+    config3: ConfigType = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][domain])
     config3["name"] = "test3"
     config3["expire_after"] = 10
     config3["state_topic"] = "test-topic3"

tests/components/mqtt/test_client.py

@@ -1,9 +1,10 @@
 """The tests for the MQTT client."""
 
 import asyncio
-from datetime import datetime, timedelta
+from datetime import timedelta
 import socket
 import ssl
+import time
 from typing import Any
 from unittest.mock import MagicMock, Mock, call, patch
 
@@ -296,10 +297,13 @@ async def test_subscribe_mqtt_config_entry_disabled(
     mqtt_mock.connected = True
 
     mqtt_config_entry = hass.config_entries.async_entries(mqtt.DOMAIN)[0]
-    assert mqtt_config_entry.state is ConfigEntryState.LOADED
+
+    mqtt_config_entry_state = mqtt_config_entry.state
+    assert mqtt_config_entry_state is ConfigEntryState.LOADED
 
     assert await hass.config_entries.async_unload(mqtt_config_entry.entry_id)
-    assert mqtt_config_entry.state is ConfigEntryState.NOT_LOADED
+    mqtt_config_entry_state = mqtt_config_entry.state
+    assert mqtt_config_entry_state is ConfigEntryState.NOT_LOADED
 
     await hass.config_entries.async_set_disabled_by(
         mqtt_config_entry.entry_id, ConfigEntryDisabler.USER
@@ -1279,7 +1283,7 @@ def _callback(args) -> None:
         callbacks.append(args)
 
     msg = ReceiveMessage(
-        "some-topic", b"test-payload", 1, False, "some-topic", datetime.now()
+        "some-topic", b"test-payload", 1, False, "some-topic", time.monotonic()
     )
     mock_debouncer.clear()
     await mqtt.async_subscribe(hass, "some-topic", _callback)

tests/components/mqtt/test_climate.py

@@ -202,7 +202,7 @@ async def test_set_operation_bad_attr_and_state(
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
     with pytest.raises(vol.Invalid) as excinfo:
-        await common.async_set_hvac_mode(hass, None, ENTITY_CLIMATE)
+        await common.async_set_hvac_mode(hass, None, ENTITY_CLIMATE)  # type:ignore[arg-type]
     assert (
         "expected HVACMode or one of 'off', 'heat', 'cool', 'heat_cool', 'auto', 'dry',"
         " 'fan_only' for dictionary value @ data['hvac_mode']" in str(excinfo.value)
@@ -220,10 +220,9 @@ async def test_set_operation(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
-    assert state.state == "cool"
     mqtt_mock.async_publish.assert_called_once_with("mode-topic", "cool", 0, False)
 
 
@@ -245,7 +244,7 @@ async def test_set_operation_pessimistic(
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == STATE_UNKNOWN
 
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == STATE_UNKNOWN
 
@@ -287,7 +286,7 @@ async def test_set_operation_optimistic(
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
 
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
 
@@ -316,13 +315,13 @@ async def test_set_operation_with_power_command(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
     mqtt_mock.async_publish.assert_has_calls([call("mode-topic", "cool", 0, False)])
     mqtt_mock.async_publish.reset_mock()
 
-    await common.async_set_hvac_mode(hass, "off", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.OFF, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
     mqtt_mock.async_publish.assert_has_calls([call("mode-topic", "off", 0, False)])
@@ -358,12 +357,12 @@ async def test_turn_on_and_off_optimistic_with_power_command(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
     mqtt_mock.async_publish.assert_has_calls([call("mode-topic", "cool", 0, False)])
     mqtt_mock.async_publish.reset_mock()
-    await common.async_set_hvac_mode(hass, "off", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.OFF, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "off"
 
@@ -374,7 +373,7 @@ async def test_turn_on_and_off_optimistic_with_power_command(
     mqtt_mock.async_publish.assert_has_calls([call("power-command", "ON", 0, False)])
     mqtt_mock.async_publish.reset_mock()
 
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
     await common.async_turn_off(hass, ENTITY_CLIMATE)
@@ -433,7 +432,7 @@ async def test_turn_on_and_off_without_power_command(
     else:
         mqtt_mock.async_publish.assert_has_calls([])
 
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
     mqtt_mock.async_publish.reset_mock()
@@ -460,7 +459,7 @@ async def test_set_fan_mode_bad_attr(
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("fan_mode") == "low"
     with pytest.raises(vol.Invalid) as excinfo:
-        await common.async_set_fan_mode(hass, None, ENTITY_CLIMATE)
+        await common.async_set_fan_mode(hass, None, ENTITY_CLIMATE)  # type:ignore[arg-type]
     assert "string value is None for dictionary value @ data['fan_mode']" in str(
         excinfo.value
     )
@@ -555,7 +554,7 @@ async def test_set_swing_mode_bad_attr(
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("swing_mode") == "off"
     with pytest.raises(vol.Invalid) as excinfo:
-        await common.async_set_swing_mode(hass, None, ENTITY_CLIMATE)
+        await common.async_set_swing_mode(hass, None, ENTITY_CLIMATE)  # type:ignore[arg-type]
     assert "string value is None for dictionary value @ data['swing_mode']" in str(
         excinfo.value
     )
@@ -649,7 +648,7 @@ async def test_set_target_temperature(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("temperature") == 21
-    await common.async_set_hvac_mode(hass, "heat", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.HEAT, ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "heat"
     mqtt_mock.async_publish.assert_called_once_with("mode-topic", "heat", 0, False)
@@ -712,7 +711,7 @@ async def test_set_target_temperature_pessimistic(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("temperature") is None
-    await common.async_set_hvac_mode(hass, "heat", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.HEAT, ENTITY_CLIMATE)
     await common.async_set_temperature(hass, temperature=35, entity_id=ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("temperature") is None
@@ -744,7 +743,7 @@ async def test_set_target_temperature_optimistic(
 
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("temperature") == 21
-    await common.async_set_hvac_mode(hass, "heat", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.HEAT, ENTITY_CLIMATE)
     await common.async_set_temperature(hass, temperature=17, entity_id=ENTITY_CLIMATE)
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.attributes.get("temperature") == 17
@@ -1547,14 +1546,14 @@ async def test_set_and_templates(
     assert state.attributes.get("preset_mode") == PRESET_ECO
 
     # Mode
-    await common.async_set_hvac_mode(hass, "cool", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.COOL, ENTITY_CLIMATE)
     mqtt_mock.async_publish.assert_any_call("mode-topic", "mode: cool", 0, False)
     assert mqtt_mock.async_publish.call_count == 1
     mqtt_mock.async_publish.reset_mock()
     state = hass.states.get(ENTITY_CLIMATE)
     assert state.state == "cool"
 
-    await common.async_set_hvac_mode(hass, "off", ENTITY_CLIMATE)
+    await common.async_set_hvac_mode(hass, HVACMode.OFF, ENTITY_CLIMATE)
     mqtt_mock.async_publish.assert_any_call("mode-topic", "mode: off", 0, False)
     assert mqtt_mock.async_publish.call_count == 1
     mqtt_mock.async_publish.reset_mock()

tests/components/mqtt/test_common.py

@@ -72,7 +72,10 @@
 
 type _MqttMessageType = list[tuple[str, str]]
 type _AttributesType = list[tuple[str, Any]]
-type _StateDataType = list[tuple[_MqttMessageType, str | None, _AttributesType | None]]
+type _StateDataType = (
+    list[tuple[_MqttMessageType, str, _AttributesType | None]]
+    | list[tuple[_MqttMessageType, str, None]]
+)
 
 
 def help_all_subscribe_calls(mqtt_client_mock: MqttMockPahoClient) -> list[Any]:
@@ -106,7 +109,7 @@ def help_custom_config(
         )
         base.update(instance)
         entity_instances.append(base)
-    config[mqtt.DOMAIN][mqtt_entity_domain]: list[ConfigType] = entity_instances
+    config[mqtt.DOMAIN][mqtt_entity_domain] = entity_instances
     return config
 
 
@@ -1360,11 +1363,11 @@ async def help_test_entity_debug_info_message(
     mqtt_mock_entry: MqttMockHAClientGenerator,
     domain: str,
     config: ConfigType,
-    service: str,
+    service: str | None,
     command_topic: str | None = None,
     command_payload: str | None = None,
     state_topic: str | object | None = _SENTINEL,
-    state_payload: str | None = None,
+    state_payload: bytes | str | None = None,
     service_parameters: dict[str, Any] | None = None,
 ) -> None:
     """Test debug_info.

tests/components/mqtt/test_config_flow.py

@@ -455,8 +455,6 @@ async def test_hassio_confirm(
     mock_finish_setup: MagicMock,
 ) -> None:
     """Test we can finish a config flow."""
-    mock_try_connection.return_value = True
-
     result = await hass.config_entries.flow.async_init(
         "mqtt",
         data=HassioServiceInfo(
@@ -1027,7 +1025,6 @@ async def test_bad_certificate(
         test_input.pop(mqtt.CONF_CLIENT_KEY)
 
     mqtt_mock = await mqtt_mock_entry()
-    mock_try_connection.return_value = True
     config_entry = hass.config_entries.async_entries(mqtt.DOMAIN)[0]
     # Add at least one advanced option to get the full form
     hass.config_entries.async_update_entry(
@@ -1276,7 +1273,7 @@ async def test_invalid_discovery_prefix(
 
 def get_default(schema: vol.Schema, key: str) -> Any | None:
     """Get default value for key in voluptuous schema."""
-    for schema_key in schema:
+    for schema_key in schema:  # type:ignore[attr-defined]
         if schema_key == key:
             if schema_key.default == vol.UNDEFINED:
                 return None
@@ -1286,7 +1283,7 @@ def get_default(schema: vol.Schema, key: str) -> Any | None:
 
 def get_suggested(schema: vol.Schema, key: str) -> Any | None:
     """Get suggested value for key in voluptuous schema."""
-    for schema_key in schema:
+    for schema_key in schema:  # type:ignore[attr-defined]
         if schema_key == key:
             if (
                 schema_key.description is None

tests/components/mqtt/test_device_trigger.py

@@ -45,7 +45,7 @@ async def test_get_triggers(
     await hass.async_block_till_done()
 
     device_entry = device_registry.async_get_device(identifiers={("mqtt", "0AFFD2")})
-    expected_triggers = [
+    expected_triggers: list[dict[str, Any]] = [
         {
             "platform": "device",
             "domain": DOMAIN,
@@ -165,7 +165,7 @@ async def test_discover_bad_triggers(
     await hass.async_block_till_done()
 
     device_entry = device_registry.async_get_device(identifiers={("mqtt", "0AFFD2")})
-    expected_triggers = [
+    expected_triggers: list[dict[str, Any]] = [
         {
             "platform": "device",
             "domain": DOMAIN,
@@ -226,7 +226,7 @@ async def test_update_remove_triggers(
 
     device_entry = device_registry.async_get_device(identifiers={("mqtt", "0AFFD2")})
     assert device_entry.name == "milk"
-    expected_triggers1 = [
+    expected_triggers1: list[dict[str, Any]] = [
         {
             "platform": "device",
             "domain": DOMAIN,
@@ -1263,7 +1263,7 @@ async def test_entity_device_info_update(
     """Test device registry update."""
     await mqtt_mock_entry()
 
-    config = {
+    config: dict[str, Any] = {
         "automation_type": "trigger",
         "topic": "test-topic",
         "type": "foo",

tests/components/mqtt/test_fan.py

@@ -1486,7 +1486,7 @@ async def test_encoding_subscribable_topics(
     attribute_value: Any,
 ) -> None:
     """Test handling of incoming encoded payload."""
-    config = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][fan.DOMAIN])
+    config: dict[str, Any] = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][fan.DOMAIN])
     config[ATTR_PRESET_MODES] = ["eco", "auto"]
     config[CONF_PRESET_MODE_COMMAND_TOPIC] = "fan/some_preset_mode_command_topic"
     config[CONF_PERCENTAGE_COMMAND_TOPIC] = "fan/some_percentage_command_topic"
@@ -2201,7 +2201,7 @@ async def test_publishing_with_custom_encoding(
 ) -> None:
     """Test publishing MQTT payload with different encoding."""
     domain = fan.DOMAIN
-    config = copy.deepcopy(DEFAULT_CONFIG)
+    config: dict[str, Any] = copy.deepcopy(DEFAULT_CONFIG)
     if topic == "preset_mode_command_topic":
         config[mqtt.DOMAIN][domain]["preset_modes"] = ["auto", "eco"]
 

tests/components/mqtt/test_humidifier.py

@@ -862,7 +862,9 @@ async def test_encoding_subscribable_topics(
     attribute_value: Any,
 ) -> None:
     """Test handling of incoming encoded payload."""
-    config = copy.deepcopy(DEFAULT_CONFIG[mqtt.DOMAIN][humidifier.DOMAIN])
+    config: dict[str, Any] = copy.deepcopy(
+        DEFAULT_CONFIG[mqtt.DOMAIN][humidifier.DOMAIN]
+    )
     config["modes"] = ["eco", "auto"]
     config[CONF_MODE_COMMAND_TOPIC] = "humidifier/some_mode_command_topic"
     await help_test_encoding_subscribable_topics(
@@ -1473,7 +1475,7 @@ async def test_publishing_with_custom_encoding(
 ) -> None:
     """Test publishing MQTT payload with different encoding."""
     domain = humidifier.DOMAIN
-    config = copy.deepcopy(DEFAULT_CONFIG)
+    config: dict[str, Any] = copy.deepcopy(DEFAULT_CONFIG)
     if topic == "mode_command_topic":
         config[mqtt.DOMAIN][domain]["modes"] = ["auto", "eco"]
 

tests/components/mqtt/test_init.py

@@ -230,7 +230,7 @@ async def test_value_template_fails(hass: HomeAssistant) -> None:
     )
     with pytest.raises(MqttValueTemplateException) as exc:
         val_tpl.async_render_with_possible_json_value(
-            '{"some_var": null }', default=100
+            '{"some_var": null }', default="100"
         )
     assert str(exc.value) == (
         "TypeError: unsupported operand type(s) for *: 'NoneType' and 'int' "
@@ -835,7 +835,7 @@ async def test_receiving_message_with_non_utf8_topic_gets_logged(
     msg.payload = b"Payload"
     msg.qos = 2
     msg.retain = True
-    msg.timestamp = time.monotonic()
+    msg.timestamp = time.monotonic()  # type:ignore[assignment]
 
     mqtt_data: MqttData = hass.data["mqtt"]
     assert mqtt_data.client
@@ -1489,7 +1489,7 @@ async def test_debug_info_non_mqtt(
     """Test we get empty debug_info for a device with non MQTT entities."""
     await mqtt_mock_entry()
     domain = "sensor"
-    setup_test_component_platform(hass, domain, mock_sensor_entities)
+    setup_test_component_platform(hass, domain, mock_sensor_entities.values())
 
     config_entry = MockConfigEntry(domain="test", data={})
     config_entry.add_to_hass(hass)