Improve client mock for Brother tests (home-assistant#155037)

Author: bieniu

tests/components/brother/conftest.py

@@ -2,7 +2,7 @@
 
 from collections.abc import Generator
 from datetime import UTC, datetime
-from unittest.mock import AsyncMock, MagicMock, patch
+from unittest.mock import AsyncMock, patch
 
 from brother import BrotherSensors
 import pytest
@@ -100,23 +100,26 @@ def mock_unload_entry() -> Generator[AsyncMock]:
 
 
 @pytest.fixture
-def mock_brother_client() -> Generator[MagicMock]:
-    """Mock Brother client."""
+def mock_brother() -> Generator[AsyncMock]:
+    """Mock the Brother class."""
     with (
-        patch("homeassistant.components.brother.Brother", autospec=True) as mock_client,
-        patch(
-            "homeassistant.components.brother.config_flow.Brother",
-            new=mock_client,
-        ),
+        patch("homeassistant.components.brother.Brother", autospec=True) as mock_class,
+        patch("homeassistant.components.brother.config_flow.Brother", new=mock_class),
     ):
-        client = mock_client.create.return_value
-        client.async_update.return_value = BROTHER_DATA
-        client.serial = "0123456789"
-        client.mac = "AA:BB:CC:DD:EE:FF"
-        client.model = "HL-L2340DW"
-        client.firmware = "1.2.3"
-
-        yield client
+        yield mock_class
+
+
+@pytest.fixture
+def mock_brother_client(mock_brother: AsyncMock) -> AsyncMock:
+    """Mock Brother client."""
+    client = mock_brother.create.return_value
+    client.async_update.return_value = BROTHER_DATA
+    client.serial = "0123456789"
+    client.mac = "AA:BB:CC:DD:EE:FF"
+    client.model = "HL-L2340DW"
+    client.firmware = "1.2.3"
+
+    return client
 
 
 @pytest.fixture

tests/components/brother/test_config_flow.py

@@ -98,15 +98,14 @@ async def test_errors(
     assert result["errors"] == {"base": base_error}
 
 
-async def test_unsupported_model_error(hass: HomeAssistant) -> None:
+async def test_unsupported_model_error(
+    hass: HomeAssistant, mock_brother: AsyncMock, mock_brother_client: AsyncMock
+) -> None:
     """Test unsupported printer model error."""
-    with patch(
-        "homeassistant.components.brother.Brother.create",
-        new=AsyncMock(side_effect=UnsupportedModelError("error")),
-    ):
-        result = await hass.config_entries.flow.async_init(
-            DOMAIN, context={"source": SOURCE_USER}, data=CONFIG
-        )
+    mock_brother.create.side_effect = UnsupportedModelError("error")
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}, data=CONFIG
+    )
 
     assert result["type"] is FlowResultType.ABORT
     assert result["reason"] == "unsupported_model"
@@ -153,25 +152,24 @@ async def test_zeroconf_exception(
     assert result["reason"] == "cannot_connect"
 
 
-async def test_zeroconf_unsupported_model(hass: HomeAssistant) -> None:
+async def test_zeroconf_unsupported_model(
+    hass: HomeAssistant, mock_brother: AsyncMock, mock_brother_client: AsyncMock
+) -> None:
     """Test unsupported printer model error."""
-    with patch(
-        "homeassistant.components.brother.Brother.create",
-        new=AsyncMock(side_effect=UnsupportedModelError("error")),
-    ):
-        result = await hass.config_entries.flow.async_init(
-            DOMAIN,
-            context={"source": SOURCE_ZEROCONF},
-            data=ZeroconfServiceInfo(
-                ip_address=ip_address("127.0.0.1"),
-                ip_addresses=[ip_address("127.0.0.1")],
-                hostname="example.local.",
-                name="Brother Printer",
-                port=None,
-                properties={"product": "MFC-8660DN"},
-                type="mock_type",
-            ),
-        )
+    mock_brother.create.side_effect = UnsupportedModelError("error")
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN,
+        context={"source": SOURCE_ZEROCONF},
+        data=ZeroconfServiceInfo(
+            ip_address=ip_address("127.0.0.1"),
+            ip_addresses=[ip_address("127.0.0.1")],
+            hostname="example.local.",
+            name="Brother Printer",
+            port=None,
+            properties={"product": "MFC-8660DN"},
+            type="mock_type",
+        ),
+    )
 
     assert result["type"] is FlowResultType.ABORT
     assert result["reason"] == "unsupported_model"

tests/components/brother/test_init.py

@@ -1,6 +1,6 @@
 """Test init of Brother integration."""
 
-from unittest.mock import AsyncMock, patch
+from unittest.mock import AsyncMock
 
 from brother import SnmpError
 import pytest
@@ -45,14 +45,16 @@ async def test_config_not_ready(
 
 @pytest.mark.parametrize("exc", [(SnmpError("SNMP Error")), (ConnectionError)])
 async def test_error_on_init(
-    hass: HomeAssistant, exc: Exception, mock_config_entry: MockConfigEntry
+    hass: HomeAssistant,
+    exc: Exception,
+    mock_config_entry: MockConfigEntry,
+    mock_brother: AsyncMock,
+    mock_brother_client: AsyncMock,
 ) -> None:
     """Test for error on init."""
-    with patch(
-        "homeassistant.components.brother.Brother.create",
-        new=AsyncMock(side_effect=exc),
-    ):
-        await init_integration(hass, mock_config_entry)
+    mock_brother.create.side_effect = exc
+
+    await init_integration(hass, mock_config_entry)
 
     assert mock_config_entry.state is ConfigEntryState.SETUP_RETRY