Refactor Tuya spell tests (#2941)

This moves spell-related Tuya tests from `test_tuya.py` to `test_tuya_spells.py`.

Author: TheJulianJES

tests/test_tuya.py

@@ -2,26 +2,14 @@
 
 import asyncio
 import datetime
-import itertools
 from unittest import mock
 
 import pytest
-import zigpy
 from zigpy.profiles import zha
 from zigpy.quirks import CustomDevice, get_device
 import zigpy.types as t
 from zigpy.zcl import foundation
-from zigpy.zcl.clusters import CLUSTERS_BY_ID
-from zigpy.zcl.clusters.general import (
-    Basic,
-    GreenPowerProxy,
-    Groups,
-    Identify,
-    OnOff,
-    Ota,
-    PowerConfiguration,
-)
-from zigpy.zcl.clusters.lightlink import LightLink
+from zigpy.zcl.clusters.general import PowerConfiguration
 
 import zhaquirks
 from zhaquirks.const import (
@@ -33,18 +21,9 @@
     ON,
     OUTPUT_CLUSTERS,
     PROFILE_ID,
-    SKIP_CONFIGURATION,
     ZONE_STATUS_CHANGE_COMMAND,
 )
-from zhaquirks.tuya import (
-    TUYA_QUERY_DATA,
-    Data,
-    EnchantedDevice,
-    TuyaEnchantableCluster,
-    TuyaManufClusterAttributes,
-    TuyaNewManufCluster,
-    TuyaZBOnOffAttributeCluster,
-)
+from zhaquirks.tuya import Data, TuyaManufClusterAttributes, TuyaNewManufCluster
 import zhaquirks.tuya.sm0202_motion
 import zhaquirks.tuya.ts011f_plug
 import zhaquirks.tuya.ts0041
@@ -1610,188 +1589,3 @@ async def test_power_config_no_bind(zigpy_device_from_quirk, quirk):
 
         assert len(request_mock.mock_calls) == 0
         assert len(bind_mock.mock_calls) == 0
-
-
-class TuyaTestSpellDevice(EnchantedDevice):
-    """Tuya test spell device."""
-
-    tuya_spell_data_query = True  # enable additional data query spell
-
-    signature = {
-        MODELS_INFO: [("UjqjHq6ZErY23tgs", "zo9WD7q5dbvDj96y")],
-        ENDPOINTS: {
-            1: {
-                PROFILE_ID: zha.PROFILE_ID,
-                DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
-                INPUT_CLUSTERS: [
-                    Basic.cluster_id,
-                    OnOff.cluster_id,
-                    TuyaNewManufCluster.cluster_id,
-                ],
-                OUTPUT_CLUSTERS: [],
-            }
-        },
-    }
-
-    replacement = {
-        ENDPOINTS: {
-            1: {
-                PROFILE_ID: zha.PROFILE_ID,
-                DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
-                INPUT_CLUSTERS: [
-                    Basic.cluster_id,
-                    TuyaZBOnOffAttributeCluster,
-                    TuyaNewManufCluster,
-                ],
-                OUTPUT_CLUSTERS: [],
-            }
-        }
-    }
-
-
-ENCHANTED_QUIRKS = [TuyaTestSpellDevice]
-for manufacturer in zigpy.quirks._DEVICE_REGISTRY._registry.values():
-    for model_quirk_list in manufacturer.values():
-        for quirk_entry in model_quirk_list:
-            if quirk_entry in ENCHANTED_QUIRKS:
-                continue
-            if issubclass(quirk_entry, EnchantedDevice):
-                ENCHANTED_QUIRKS.append(quirk_entry)
-
-del quirk_entry, model_quirk_list, manufacturer
-
-
-@mock.patch("zigpy.zcl.Cluster.bind", mock.AsyncMock())
-async def test_tuya_spell(zigpy_device_from_quirk):
-    """Test that enchanted Tuya devices have their spell applied when binding bindable cluster."""
-    non_bindable_cluster_ids = [
-        Basic.cluster_id,
-        Identify.cluster_id,
-        Groups.cluster_id,
-        Ota.cluster_id,
-        GreenPowerProxy.cluster_id,
-        LightLink.cluster_id,
-    ]
-
-    request_patch = mock.patch("zigpy.zcl.Cluster.request", mock.AsyncMock())
-    with request_patch as request_mock:
-        request_mock.return_value = (foundation.Status.SUCCESS, "done")
-
-        for quirk in ENCHANTED_QUIRKS:
-            device = zigpy_device_from_quirk(quirk)
-            assert isinstance(device, EnchantedDevice)
-
-            # fail if SKIP_CONFIGURATION is set, as that will cause ZHA to not call bind()
-            if getattr(device, SKIP_CONFIGURATION, False):
-                pytest.fail(
-                    f"Enchanted quirk {quirk} has SKIP_CONFIGURATION set. "
-                    f"This is not allowed for enchanted devices."
-                )
-
-            for cluster in itertools.chain(
-                device.endpoints[1].in_clusters.values(),
-                device.endpoints[1].out_clusters.values(),
-            ):
-                # emulate ZHA calling bind() on most default clusters with an unchanged ep_attribute
-                if (
-                    not isinstance(cluster, int)
-                    and cluster.cluster_id not in non_bindable_cluster_ids
-                    and cluster.cluster_id in CLUSTERS_BY_ID
-                    and CLUSTERS_BY_ID[cluster.cluster_id].ep_attribute
-                    == cluster.ep_attribute
-                ):
-                    await cluster.bind()
-
-            # the number of Tuya spells that are allowed to be cast, so the sum of enabled Tuya spells
-            enabled_tuya_spells_num = (
-                device.tuya_spell_read_attributes + device.tuya_spell_data_query
-            )
-
-            # skip if no Tuya spells are enabled,
-            # this case is already handled in the test_tuya_spell_devices_valid() test
-            if enabled_tuya_spells_num == 0:
-                continue
-
-            # check that exactly a Tuya spell was cast
-            if len(request_mock.mock_calls) == 0:
-                pytest.fail(
-                    f"Enchanted quirk {quirk} did not cast a Tuya spell. "
-                    f"One bindable cluster subclassing `TuyaEnchantableCluster` on endpoint 1 needs to be implemented. "
-                    f"Also check that enchanted bindable clusters do not modify their `ep_attribute`, "
-                    f"as ZHA will not call bind() in that case."
-                )
-            # check that no more than one call was made for each enabled spell
-            elif len(request_mock.mock_calls) > enabled_tuya_spells_num:
-                pytest.fail(
-                    f"Enchanted quirk {quirk} cast more than one Tuya spell. "
-                    f"Make sure to only implement one cluster subclassing `TuyaEnchantableCluster` on endpoint 1."
-                )
-
-            # used to check list of mock calls below
-            messages = 0
-
-            # check 'attribute read spell' was cast correctly (if enabled)
-            if device.tuya_spell_read_attributes:
-                assert (
-                    request_mock.mock_calls[messages][1][1]
-                    == foundation.GeneralCommand.Read_Attributes
-                )
-                assert request_mock.mock_calls[messages][1][3] == [4, 0, 1, 5, 7, 65534]
-                messages += 1
-
-            # check 'query data spell' was cast correctly (if enabled)
-            if device.tuya_spell_data_query:
-                assert not request_mock.mock_calls[messages][1][0]
-                assert request_mock.mock_calls[messages][1][1] == TUYA_QUERY_DATA
-                messages += 1
-
-            request_mock.reset_mock()
-
-
-def test_tuya_spell_devices_valid():
-    """Test that all enchanted Tuya devices implement at least one enchanted cluster."""
-
-    for quirk in ENCHANTED_QUIRKS:
-        # check that at least one Tuya spell is enabled for an EnchantedDevice
-        if not quirk.tuya_spell_read_attributes and not quirk.tuya_spell_data_query:
-            pytest.fail(
-                f"Enchanted quirk {quirk} does not have any Tuya spells enabled. "
-                f"Enable at least one Tuya spell by setting `TUYA_SPELL_READ_ATTRIBUTES` or `TUYA_SPELL_DATA_QUERY` "
-                f"or inherit CustomDevice rather than EnchantedDevice."
-            )
-
-        enchanted_clusters = 0  # number of clusters subclassing TuyaEnchantableCluster
-        tuya_cluster_exists = False  # cluster subclassing TuyaNewManufCluster existing
-
-        # iterate over all clusters in the replacement
-        for endpoint_id, endpoint in quirk.replacement[ENDPOINTS].items():
-            if endpoint_id != 1:  # spell is only activated on endpoint 1 for now
-                continue
-            for cluster in endpoint[INPUT_CLUSTERS] + endpoint[OUTPUT_CLUSTERS]:
-                if not isinstance(cluster, int):
-                    # count all clusters which would apply the spell on bind()
-                    if issubclass(cluster, TuyaEnchantableCluster):
-                        enchanted_clusters += 1
-                    # check if there's a valid Tuya cluster where the id wasn't modified
-                    if (
-                        issubclass(cluster, TuyaNewManufCluster)
-                        and cluster.cluster_id == TuyaNewManufCluster.cluster_id
-                    ):
-                        tuya_cluster_exists = True
-
-        # an EnchantedDevice must have exactly one enchanted cluster on endpoint 1
-        if enchanted_clusters == 0:
-            pytest.fail(
-                f"{quirk} does not have a cluster subclassing `TuyaEnchantableCluster` on endpoint 1 "
-                f"as required by the Tuya spell."
-            )
-        elif enchanted_clusters > 1:
-            pytest.fail(
-                f"{quirk} has more than one cluster subclassing `TuyaEnchantableCluster` on endpoint 1"
-            )
-
-        # an EnchantedDevice with the data query spell must also have a cluster subclassing TuyaNewManufCluster
-        if quirk.tuya_spell_data_query and not tuya_cluster_exists:
-            pytest.fail(
-                f"{quirk} set Tuya data query spell but has no cluster subclassing `TuyaNewManufCluster` on endpoint 1"
-            )