Refactor bond unit tests to reduce boilerplate (#38177)
* Refactor bond unit tests to reduce boilerplate * Refactor bond unit tests to reduce boilerplate (PR feedback) * Refactor bond unit tests to reduce boilerplate (PR feedback, nullcontext)
This commit is contained in:
1 parent
34ac4e78af
commit
2d6eb5c05d
3 files changed
+122
-80
No files matched your search
@@ -1,7 +1,8 @@
|
||||
"""Common methods used across tests for Bond."""
|
||||
from asyncio import TimeoutError as AsyncIOTimeoutError
|
||||
from contextlib import nullcontext
|
||||
from datetime import timedelta
|
||||
from typing import Any, Dict
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
from homeassistant import core
|
||||
from homeassistant.components.bond.const import DOMAIN as BOND_DOMAIN
|
||||
@@ -12,19 +13,35 @@ from homeassistant.util import utcnow
|
||||
from tests.async_mock import patch
|
||||
from tests.common import MockConfigEntry, async_fire_time_changed
|
||||
|
||||
MOCK_HUB_VERSION: dict = {"bondid": "test-bond-id"}
|
||||
|
||||
def patch_setup_entry(domain: str, *, enabled: bool = True):
|
||||
"""Patch async_setup_entry for specified domain."""
|
||||
if not enabled:
|
||||
return nullcontext()
|
||||
|
||||
return patch(f"homeassistant.components.bond.{domain}.async_setup_entry")
|
||||
|
||||
|
||||
async def setup_bond_entity(
|
||||
hass: core.HomeAssistant, config_entry: MockConfigEntry, hub_version=None
|
||||
hass: core.HomeAssistant,
|
||||
config_entry: MockConfigEntry,
|
||||
*,
|
||||
patch_version=False,
|
||||
patch_device_ids=False,
|
||||
patch_platforms=False,
|
||||
):
|
||||
"""Set up Bond entity."""
|
||||
if hub_version is None:
|
||||
hub_version = MOCK_HUB_VERSION
|
||||
|
||||
config_entry.add_to_hass(hass)
|
||||
|
||||
with patch("homeassistant.components.bond.Bond.version", return_value=hub_version):
|
||||
with patch_bond_version(enabled=patch_version), patch_bond_device_ids(
|
||||
enabled=patch_device_ids
|
||||
), patch_setup_entry("cover", enabled=patch_platforms), patch_setup_entry(
|
||||
"fan", enabled=patch_platforms
|
||||
), patch_setup_entry(
|
||||
"light", enabled=patch_platforms
|
||||
), patch_setup_entry(
|
||||
"switch", enabled=patch_platforms
|
||||
):
|
||||
return await hass.config_entries.async_setup(config_entry.entry_id)
|
||||
|
||||
|
||||
@@ -36,47 +53,77 @@ async def setup_platform(
|
||||
props: Dict[str, Any] = None,
|
||||
):
|
||||
"""Set up the specified Bond platform."""
|
||||
if not props:
|
||||
props = {}
|
||||
|
||||
mock_entry = MockConfigEntry(
|
||||
domain=BOND_DOMAIN,
|
||||
data={CONF_HOST: "1.1.1.1", CONF_ACCESS_TOKEN: "test-token"},
|
||||
)
|
||||
mock_entry.add_to_hass(hass)
|
||||
|
||||
with patch("homeassistant.components.bond.PLATFORMS", [platform]), patch(
|
||||
"homeassistant.components.bond.Bond.version", return_value=MOCK_HUB_VERSION
|
||||
), patch_bond_device_ids(return_value=[bond_device_id],), patch(
|
||||
"homeassistant.components.bond.Bond.device", return_value=discovered_device
|
||||
), patch_bond_device_state(
|
||||
return_value={}
|
||||
), patch(
|
||||
"homeassistant.components.bond.Bond.device_properties", return_value=props
|
||||
), patch(
|
||||
"homeassistant.components.bond.Bond.device_state", return_value={}
|
||||
):
|
||||
assert await async_setup_component(hass, BOND_DOMAIN, {})
|
||||
await hass.async_block_till_done()
|
||||
with patch("homeassistant.components.bond.PLATFORMS", [platform]):
|
||||
with patch_bond_version(), patch_bond_device_ids(
|
||||
return_value=[bond_device_id]
|
||||
), patch_bond_device(
|
||||
return_value=discovered_device
|
||||
), patch_bond_device_state(), patch_bond_device_properties(
|
||||
return_value=props
|
||||
), patch_bond_device_state():
|
||||
assert await async_setup_component(hass, BOND_DOMAIN, {})
|
||||
await hass.async_block_till_done()
|
||||
|
||||
return mock_entry
|
||||
|
||||
|
||||
def patch_bond_device_ids(return_value=None):
|
||||
"""Patch Bond API devices command."""
|
||||
def patch_bond_version(enabled: bool = True, return_value: Optional[dict] = None):
|
||||
"""Patch Bond API version endpoint."""
|
||||
if not enabled:
|
||||
return nullcontext()
|
||||
|
||||
if return_value is None:
|
||||
return_value = {"bondid": "test-bond-id"}
|
||||
|
||||
return patch(
|
||||
"homeassistant.components.bond.Bond.version", return_value=return_value
|
||||
)
|
||||
|
||||
|
||||
def patch_bond_device_ids(enabled: bool = True, return_value=None, side_effect=None):
|
||||
"""Patch Bond API devices endpoint."""
|
||||
if not enabled:
|
||||
return nullcontext()
|
||||
|
||||
if return_value is None:
|
||||
return_value = []
|
||||
|
||||
return patch(
|
||||
"homeassistant.components.bond.Bond.devices", return_value=return_value,
|
||||
"homeassistant.components.bond.Bond.devices",
|
||||
return_value=return_value,
|
||||
side_effect=side_effect,
|
||||
)
|
||||
|
||||
|
||||
def patch_bond_device(return_value=None):
|
||||
"""Patch Bond API device endpoint."""
|
||||
return patch(
|
||||
"homeassistant.components.bond.Bond.device", return_value=return_value,
|
||||
)
|
||||
|
||||
|
||||
def patch_bond_action():
|
||||
"""Patch Bond API action command."""
|
||||
"""Patch Bond API action endpoint."""
|
||||
return patch("homeassistant.components.bond.Bond.action")
|
||||
|
||||
|
||||
def patch_bond_device_properties(return_value=None):
|
||||
"""Patch Bond API device properties endpoint."""
|
||||
if return_value is None:
|
||||
return_value = {}
|
||||
|
||||
return patch(
|
||||
"homeassistant.components.bond.Bond.device_properties",
|
||||
return_value=return_value,
|
||||
)
|
||||
|
||||
|
||||
def patch_bond_device_state(return_value=None, side_effect=None):
|
||||
"""Patch Bond API device state endpoint."""
|
||||
if return_value is None:
|
||||
|
||||
Reference in new issue
Block a user