Reolink test init 100% (#89112)

* Split out reolink tests

* Bring __init__ coverage to 100%

* Improve docstrings

* Use patching and autospec=True for ReolinkHost

* Use fixture

* fix styling

* Parametrize tests

* Update tests/components/reolink/conftest.py

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Apply suggestions from code review

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update test_config_flow.py

* convert to fixture

* review comments

* Update tests/components/reolink/conftest.py

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update tests/components/reolink/conftest.py

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update tests/components/reolink/conftest.py

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* fix tests

* fix imports

* Update test_init.py

* Check if host is logout on reload

---------

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

.coveragerc

@@ -975,7 +975,6 @@ omit =
     homeassistant/components/rejseplanen/sensor.py
     homeassistant/components/remember_the_milk/__init__.py
     homeassistant/components/remote_rpi_gpio/*
-    homeassistant/components/reolink/__init__.py
     homeassistant/components/reolink/binary_sensor.py
     homeassistant/components/reolink/button.py
     homeassistant/components/reolink/camera.py

tests/components/reolink/conftest.py

@@ -0,0 +1,92 @@
+"""Setup the Reolink tests."""
+from collections.abc import Generator
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+
+from homeassistant.components.reolink import const
+from homeassistant.components.reolink.config_flow import DEFAULT_PROTOCOL
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.device_registry import format_mac
+
+from tests.common import MockConfigEntry
+
+TEST_HOST = "1.2.3.4"
+TEST_HOST2 = "4.5.6.7"
+TEST_USERNAME = "admin"
+TEST_USERNAME2 = "username"
+TEST_PASSWORD = "password"
+TEST_PASSWORD2 = "new_password"
+TEST_MAC = "ab:cd:ef:gh:ij:kl"
+TEST_PORT = 1234
+TEST_NVR_NAME = "test_reolink_name"
+TEST_USE_HTTPS = True
+
+
+@pytest.fixture
+def mock_setup_entry() -> Generator[AsyncMock, None, None]:
+    """Override async_setup_entry."""
+    with patch(
+        "homeassistant.components.reolink.async_setup_entry", return_value=True
+    ) as mock_setup_entry:
+        yield mock_setup_entry
+
+
+@pytest.fixture
+def reolink_connect(mock_get_source_ip: None) -> Generator[MagicMock, None, None]:
+    """Mock reolink connection."""
+    with patch(
+        "homeassistant.components.reolink.host.webhook.async_register",
+        return_value=True,
+    ), patch(
+        "homeassistant.components.reolink.host.Host", autospec=True
+    ) as host_mock_class:
+        host_mock = host_mock_class.return_value
+        host_mock.get_host_data.return_value = None
+        host_mock.get_states.return_value = None
+        host_mock.check_new_firmware.return_value = False
+        host_mock.unsubscribe.return_value = True
+        host_mock.logout.return_value = True
+        host_mock.mac_address = TEST_MAC
+        host_mock.onvif_enabled = True
+        host_mock.rtmp_enabled = True
+        host_mock.rtsp_enabled = True
+        host_mock.nvr_name = TEST_NVR_NAME
+        host_mock.port = TEST_PORT
+        host_mock.use_https = TEST_USE_HTTPS
+        host_mock.is_admin = True
+        host_mock.user_level = "admin"
+        host_mock.sw_version_update_required = False
+        host_mock.timeout = 60
+        host_mock.renewtimer = 600
+        yield host_mock
+
+
+@pytest.fixture
+def reolink_platforms(mock_get_source_ip: None) -> Generator[None, None, None]:
+    """Mock reolink entry setup."""
+    with patch("homeassistant.components.reolink.PLATFORMS", return_value=[]):
+        yield
+
+
+@pytest.fixture
+def config_entry(hass: HomeAssistant) -> MockConfigEntry:
+    """Add the reolink mock config entry to hass."""
+    config_entry = MockConfigEntry(
+        domain=const.DOMAIN,
+        unique_id=format_mac(TEST_MAC),
+        data={
+            CONF_HOST: TEST_HOST,
+            CONF_USERNAME: TEST_USERNAME,
+            CONF_PASSWORD: TEST_PASSWORD,
+            CONF_PORT: TEST_PORT,
+            const.CONF_USE_HTTPS: TEST_USE_HTTPS,
+        },
+        options={
+            const.CONF_PROTOCOL: DEFAULT_PROTOCOL,
+        },
+        title=TEST_NVR_NAME,
+    )
+    config_entry.add_to_hass(hass)
+    return config_entry

tests/components/reolink/test_config_flow.py

@@ -1,6 +1,6 @@
 """Test the Reolink config flow."""
 import json
-from unittest.mock import AsyncMock, Mock, patch
+from unittest.mock import MagicMock
 
 import pytest
 from reolink_aio.exceptions import ApiError, CredentialsInvalidError, ReolinkError
@@ -9,61 +9,26 @@ from homeassistant import config_entries, data_entry_flow
 from homeassistant.components import dhcp
 from homeassistant.components.reolink import const
 from homeassistant.components.reolink.config_flow import DEFAULT_PROTOCOL
-from homeassistant.config import async_process_ha_core_config
 from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers import issue_registry as ir
 from homeassistant.helpers.device_registry import format_mac
 
+from .conftest import (
+    TEST_HOST,
+    TEST_HOST2,
+    TEST_MAC,
+    TEST_NVR_NAME,
+    TEST_PASSWORD,
+    TEST_PASSWORD2,
+    TEST_PORT,
+    TEST_USE_HTTPS,
+    TEST_USERNAME,
+    TEST_USERNAME2,
+)
+
 from tests.common import MockConfigEntry
 
-TEST_HOST = "1.2.3.4"
+pytestmark = pytest.mark.usefixtures("mock_setup_entry", "reolink_connect")
-TEST_HOST2 = "4.5.6.7"
-TEST_USERNAME = "admin"
-TEST_USERNAME2 = "username"
-TEST_PASSWORD = "password"
-TEST_PASSWORD2 = "new_password"
-TEST_MAC = "ab:cd:ef:gh:ij:kl"
-TEST_PORT = 1234
-TEST_NVR_NAME = "test_reolink_name"
-TEST_USE_HTTPS = True
-
-
-def get_mock_info(error=None, user_level="admin"):
-    """Return a mock gateway info instance."""
-    host_mock = Mock()
-    if error is None:
-        host_mock.get_host_data = AsyncMock(return_value=None)
-    else:
-        host_mock.get_host_data = AsyncMock(side_effect=error)
-    host_mock.check_new_firmware = AsyncMock(return_value=False)
-    host_mock.unsubscribe = AsyncMock(return_value=True)
-    host_mock.logout = AsyncMock(return_value=True)
-    host_mock.mac_address = TEST_MAC
-    host_mock.onvif_enabled = True
-    host_mock.rtmp_enabled = True
-    host_mock.rtsp_enabled = True
-    host_mock.nvr_name = TEST_NVR_NAME
-    host_mock.port = TEST_PORT
-    host_mock.use_https = TEST_USE_HTTPS
-    host_mock.is_admin = user_level == "admin"
-    host_mock.user_level = user_level
-    host_mock.timeout = 60
-    host_mock.renewtimer = 600
-    host_mock.get_states = AsyncMock(return_value=None)
-    return host_mock
-
-
-@pytest.fixture(name="reolink_connect", autouse=True)
-def reolink_connect_fixture(mock_get_source_ip):
-    """Mock reolink connection and entry setup."""
-    with patch(
-        "homeassistant.components.reolink.host.webhook.async_register",
-        return_value=True,
-    ), patch("homeassistant.components.reolink.PLATFORMS", return_value=[]), patch(
-        "homeassistant.components.reolink.host.Host", return_value=get_mock_info()
-    ):
-        yield
 
 
 async def test_config_flow_manual_success(hass: HomeAssistant) -> None:
@@ -99,7 +64,9 @@ async def test_config_flow_manual_success(hass: HomeAssistant) -> None:
     }
 
 
-async def test_config_flow_errors(hass: HomeAssistant) -> None:
+async def test_config_flow_errors(
+    hass: HomeAssistant, reolink_connect: MagicMock
+) -> None:
     """Successful flow manually initialized by the user after some errors."""
     result = await hass.config_entries.flow.async_init(
         const.DOMAIN, context={"source": config_entries.SOURCE_USER}
@@ -109,81 +76,82 @@ async def test_config_flow_errors(hass: HomeAssistant) -> None:
     assert result["step_id"] == "user"
     assert result["errors"] == {}
 
-    host_mock = get_mock_info(error=ReolinkError("Test error"))
+    reolink_connect.is_admin = False
-    with patch("homeassistant.components.reolink.host.Host", return_value=host_mock):
+    reolink_connect.user_level = "guest"
-        result = await hass.config_entries.flow.async_configure(
+    result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
+        result["flow_id"],
-            {
+        {
-                CONF_USERNAME: TEST_USERNAME,
+            CONF_USERNAME: TEST_USERNAME,
-                CONF_PASSWORD: TEST_PASSWORD,
+            CONF_PASSWORD: TEST_PASSWORD,
-                CONF_HOST: TEST_HOST,
+            CONF_HOST: TEST_HOST,
-            },
+        },
-        )
+    )
-
-    assert result["type"] is data_entry_flow.FlowResultType.FORM
-    assert result["step_id"] == "user"
-    assert result["errors"] == {CONF_HOST: "cannot_connect"}
-
-    host_mock = get_mock_info(user_level="guest")
-    with patch("homeassistant.components.reolink.host.Host", return_value=host_mock):
-        result = await hass.config_entries.flow.async_configure(
-            result["flow_id"],
-            {
-                CONF_USERNAME: TEST_USERNAME,
-                CONF_PASSWORD: TEST_PASSWORD,
-                CONF_HOST: TEST_HOST,
-            },
-        )
 
     assert result["type"] is data_entry_flow.FlowResultType.FORM
     assert result["step_id"] == "user"
     assert result["errors"] == {CONF_USERNAME: "not_admin"}
 
-    host_mock = get_mock_info(error=json.JSONDecodeError("test_error", "test", 1))
+    reolink_connect.is_admin = True
-    with patch("homeassistant.components.reolink.host.Host", return_value=host_mock):
+    reolink_connect.user_level = "admin"
-        result = await hass.config_entries.flow.async_configure(
+    reolink_connect.get_host_data.side_effect = ReolinkError("Test error")
-            result["flow_id"],
+    result = await hass.config_entries.flow.async_configure(
-            {
+        result["flow_id"],
-                CONF_USERNAME: TEST_USERNAME,
+        {
-                CONF_PASSWORD: TEST_PASSWORD,
+            CONF_USERNAME: TEST_USERNAME,
-                CONF_HOST: TEST_HOST,
+            CONF_PASSWORD: TEST_PASSWORD,
-            },
+            CONF_HOST: TEST_HOST,
-        )
+        },
+    )
+
+    assert result["type"] is data_entry_flow.FlowResultType.FORM
+    assert result["step_id"] == "user"
+    assert result["errors"] == {CONF_HOST: "cannot_connect"}
+
+    reolink_connect.get_host_data.side_effect = json.JSONDecodeError(
+        "test_error", "test", 1
+    )
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        {
+            CONF_USERNAME: TEST_USERNAME,
+            CONF_PASSWORD: TEST_PASSWORD,
+            CONF_HOST: TEST_HOST,
+        },
+    )
 
     assert result["type"] is data_entry_flow.FlowResultType.FORM
     assert result["step_id"] == "user"
     assert result["errors"] == {CONF_HOST: "unknown"}
 
-    host_mock = get_mock_info(error=CredentialsInvalidError("Test error"))
+    reolink_connect.get_host_data.side_effect = CredentialsInvalidError("Test error")
-    with patch("homeassistant.components.reolink.host.Host", return_value=host_mock):
+    result = await hass.config_entries.flow.async_configure(
-        result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
-            result["flow_id"],
+        {
-            {
+            CONF_USERNAME: TEST_USERNAME,
-                CONF_USERNAME: TEST_USERNAME,
+            CONF_PASSWORD: TEST_PASSWORD,
-                CONF_PASSWORD: TEST_PASSWORD,
+            CONF_HOST: TEST_HOST,
-                CONF_HOST: TEST_HOST,
+        },
-            },
+    )
-        )
 
     assert result["type"] is data_entry_flow.FlowResultType.FORM
     assert result["step_id"] == "user"
     assert result["errors"] == {CONF_HOST: "invalid_auth"}
 
-    host_mock = get_mock_info(error=ApiError("Test error"))
+    reolink_connect.get_host_data.side_effect = ApiError("Test error")
-    with patch("homeassistant.components.reolink.host.Host", return_value=host_mock):
+    result = await hass.config_entries.flow.async_configure(
-        result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
-            result["flow_id"],
+        {
-            {
+            CONF_USERNAME: TEST_USERNAME,
-                CONF_USERNAME: TEST_USERNAME,
+            CONF_PASSWORD: TEST_PASSWORD,
-                CONF_PASSWORD: TEST_PASSWORD,
+            CONF_HOST: TEST_HOST,
-                CONF_HOST: TEST_HOST,
+        },
-            },
+    )
-        )
 
     assert result["type"] is data_entry_flow.FlowResultType.FORM
     assert result["step_id"] == "user"
     assert result["errors"] == {CONF_HOST: "api_error"}
 
+    reolink_connect.get_host_data.side_effect = None
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
         {
@@ -422,63 +390,3 @@ async def test_dhcp_abort_flow(hass: HomeAssistant) -> None:
 
     assert result["type"] is data_entry_flow.FlowResultType.ABORT
     assert result["reason"] == "already_configured"
-
-
-async def test_http_no_repair_issue(hass: HomeAssistant) -> None:
-    """Test no repairs issue is raised when http local url is used."""
-    config_entry = MockConfigEntry(
-        domain=const.DOMAIN,
-        unique_id=format_mac(TEST_MAC),
-        data={
-            CONF_HOST: TEST_HOST,
-            CONF_USERNAME: TEST_USERNAME,
-            CONF_PASSWORD: TEST_PASSWORD,
-            CONF_PORT: TEST_PORT,
-            const.CONF_USE_HTTPS: TEST_USE_HTTPS,
-        },
-        options={
-            const.CONF_PROTOCOL: DEFAULT_PROTOCOL,
-        },
-        title=TEST_NVR_NAME,
-    )
-    config_entry.add_to_hass(hass)
-
-    await async_process_ha_core_config(
-        hass, {"country": "GB", "internal_url": "http://test_homeassistant_address"}
-    )
-
-    assert await hass.config_entries.async_setup(config_entry.entry_id)
-    await hass.async_block_till_done()
-
-    issue_registry = ir.async_get(hass)
-    assert len(issue_registry.issues) == 0
-
-
-async def test_https_repair_issue(hass: HomeAssistant) -> None:
-    """Test repairs issue is raised when https local url is used."""
-    config_entry = MockConfigEntry(
-        domain=const.DOMAIN,
-        unique_id=format_mac(TEST_MAC),
-        data={
-            CONF_HOST: TEST_HOST,
-            CONF_USERNAME: TEST_USERNAME,
-            CONF_PASSWORD: TEST_PASSWORD,
-            CONF_PORT: TEST_PORT,
-            const.CONF_USE_HTTPS: TEST_USE_HTTPS,
-        },
-        options={
-            const.CONF_PROTOCOL: DEFAULT_PROTOCOL,
-        },
-        title=TEST_NVR_NAME,
-    )
-    config_entry.add_to_hass(hass)
-
-    await async_process_ha_core_config(
-        hass, {"country": "GB", "internal_url": "https://test_homeassistant_address"}
-    )
-
-    assert await hass.config_entries.async_setup(config_entry.entry_id)
-    await hass.async_block_till_done()
-
-    issue_registry = ir.async_get(hass)
-    assert len(issue_registry.issues) == 1

tests/components/reolink/test_init.py

@@ -0,0 +1,116 @@
+"""Test the Reolink init."""
+from typing import Any
+from unittest.mock import AsyncMock, MagicMock, Mock
+
+import pytest
+from reolink_aio.exceptions import ReolinkError
+
+from homeassistant.components.reolink import const
+from homeassistant.config import async_process_ha_core_config
+from homeassistant.config_entries import ConfigEntryState
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import issue_registry as ir
+
+from tests.common import MockConfigEntry
+
+pytestmark = pytest.mark.usefixtures("reolink_connect", "reolink_platforms")
+
+
+@pytest.mark.parametrize(
+    ("attr", "value", "expected"),
+    [
+        (
+            "is_admin",
+            False,
+            ConfigEntryState.SETUP_ERROR,
+        ),
+        (
+            "get_host_data",
+            AsyncMock(side_effect=ReolinkError("Test error")),
+            ConfigEntryState.SETUP_RETRY,
+        ),
+        (
+            "get_host_data",
+            AsyncMock(side_effect=ValueError("Test error")),
+            ConfigEntryState.SETUP_ERROR,
+        ),
+        (
+            "get_states",
+            AsyncMock(side_effect=ReolinkError("Test error")),
+            ConfigEntryState.SETUP_RETRY,
+        ),
+        (
+            "supported",
+            Mock(return_value=False),
+            ConfigEntryState.LOADED,
+        ),
+        (
+            "check_new_firmware",
+            AsyncMock(side_effect=ReolinkError("Test error")),
+            ConfigEntryState.LOADED,
+        ),
+    ],
+)
+async def test_failures_parametrized(
+    hass: HomeAssistant,
+    reolink_connect: MagicMock,
+    config_entry: MockConfigEntry,
+    attr: str,
+    value: Any,
+    expected: ConfigEntryState,
+) -> None:
+    """Test outcomes when changing errors."""
+    setattr(reolink_connect, attr, value)
+    assert await hass.config_entries.async_setup(config_entry.entry_id) is (
+        expected == ConfigEntryState.LOADED
+    )
+    await hass.async_block_till_done()
+
+    assert config_entry.state == expected
+
+
+async def test_entry_reloading(
+    hass: HomeAssistant, config_entry: MockConfigEntry, reolink_connect: MagicMock
+) -> None:
+    """Test the entry is reloaded correctly when settings change."""
+    assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert reolink_connect.logout.call_count == 0
+    assert config_entry.title == "test_reolink_name"
+
+    hass.config_entries.async_update_entry(config_entry, title="New Name")
+    await hass.async_block_till_done()
+
+    assert reolink_connect.logout.call_count == 1
+    assert config_entry.title == "New Name"
+
+
+async def test_http_no_repair_issue(
+    hass: HomeAssistant, config_entry: MockConfigEntry
+) -> None:
+    """Test no repairs issue is raised when http local url is used."""
+    await async_process_ha_core_config(
+        hass, {"country": "GB", "internal_url": "http://test_homeassistant_address"}
+    )
+
+    assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    issue_registry = ir.async_get(hass)
+    assert (const.DOMAIN, "https_webhook") not in issue_registry.issues
+
+
+async def test_https_repair_issue(
+    hass: HomeAssistant, config_entry: MockConfigEntry
+) -> None:
+    """Test repairs issue is raised when https local url is used."""
+    await async_process_ha_core_config(
+        hass, {"country": "GB", "internal_url": "https://test_homeassistant_address"}
+    )
+
+    assert await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    issue_registry = ir.async_get(hass)
+    assert (const.DOMAIN, "https_webhook") in issue_registry.issues