Merge branch 'release/0.0.81'

Author: dmulcahey

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   CACHE_VERSION: 1
-  DEFAULT_PYTHON: 3.7
+  DEFAULT_PYTHON: '3.9.14'
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 
 jobs:
@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ['3.8.14', '3.9.14', '3.10.7']
     steps:
       - name: Check out code from GitHub
         uses: actions/checkout@v2
@@ -280,7 +280,7 @@ jobs:
     needs: prepare-base
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ['3.8.14', '3.9.14', '3.10.7']
     name: >-
       Run tests Python ${{ matrix.python-version }}
     steps:

requirements_test_all.txt

@@ -1,4 +1,3 @@
-asynctest
 isort
 black
 flake8
@@ -12,5 +11,6 @@ pylint
 pytest-cov
 pytest-sugar
 pytest-timeout
-pytest
+pytest-asyncio
+pytest>=7.1.3
 zigpy

setup.cfg

@@ -1,4 +1,5 @@
 [tool:pytest]
+asyncio_mode = auto
 testpaths = tests
 norecursedirs = .git testing_config
 

setup.py

@@ -4,7 +4,7 @@
 
 from setuptools import find_packages, setup
 
-VERSION = "0.0.80"
+VERSION = "0.0.81"
 
 
 setup(
@@ -20,6 +20,6 @@
     keywords="zha quirks homeassistant hass",
     packages=find_packages(exclude=["tests"]),
     python_requires=">=3",
-    install_requires=["zigpy>=0.45.1"],
+    install_requires=["zigpy>=0.51.1"],
     tests_require=["pytest"],
 )

tests/common.py

@@ -1,4 +1,5 @@
 """Quirks common helpers."""
+import asyncio
 import datetime
 
 ZCL_IAS_MOTION_COMMAND = b"\t!\x00\x01\x00\x00\x00\x00\x00"
@@ -37,3 +38,17 @@ def utcnow(cls):
         """Return testvalue."""
 
         return cls(1970, 1, 1, 2, 0, 0)
+
+
+async def wait_for_zigpy_tasks() -> None:
+    """Wait for all running zigpy tasks to finish."""
+    tasks = []
+
+    for task in asyncio.all_tasks():
+        coro = task.get_coro()
+
+        # TODO: track tasks within zigpy
+        if "CatchingTaskMixin" in coro.__qualname__:
+            tasks.append(task)
+
+    await asyncio.gather(*tasks)

tests/conftest.py

@@ -1,9 +1,6 @@
 """Fixtures for all tests."""
 
-try:
-    from unittest.mock import AsyncMock as CoroutineMock
-except ImportError:
-    from asynctest import CoroutineMock
+from unittest.mock import AsyncMock
 
 import pytest
 import zigpy.application
@@ -64,6 +61,12 @@ async def load_network_info(self, *args, **kwargs):
     async def permit_with_key(self, *args, **kwargs):
         """Mock permit_with_key."""
 
+    async def reset_network_info(self, *args, **kwargs):
+        """Mock reset_network_info."""
+
+    async def send_packet(self, *args, **kwargs):
+        """Mock send_packet."""
+
     async def start_network(self, *args, **kwargs):
         """Mock start_network."""
 
@@ -73,8 +76,8 @@ async def write_network_info(self, *args, **kwargs):
     async def add_endpoint(self, descriptor):
         """Mock add_endpoint."""
 
-    mrequest = CoroutineMock()
-    request = CoroutineMock(return_value=(foundation.Status.SUCCESS, None))
+    mrequest = AsyncMock()
+    request = AsyncMock(return_value=(foundation.Status.SUCCESS, None))
 
 
 @pytest.fixture(name="MockAppController")

tests/test_kof.py

@@ -10,8 +10,6 @@
 import zhaquirks
 import zhaquirks.kof.kof_mr101z
 
-from tests.conftest import CoroutineMock
-
 zhaquirks.setup()
 
 Default_Response = foundation.GENERAL_COMMANDS[
@@ -35,7 +33,7 @@ class TestCluster(
         }
         client_commands = {}
 
-    ep = CoroutineMock()
+    ep = mock.AsyncMock()
     ep.device.application.get_sequence = mock.MagicMock(return_value=4)
 
     cluster = TestCluster(ep)

tests/test_tuya.py

@@ -31,7 +31,7 @@
 import zhaquirks.tuya.ts0601_trv
 import zhaquirks.tuya.ts0601_valve
 
-from tests.common import ClusterListener, MockDatetime
+from tests.common import ClusterListener, MockDatetime, wait_for_zigpy_tasks
 
 zhaquirks.setup()
 
@@ -222,6 +222,7 @@ async def test_singleswitch_requests(zigpy_device_from_quirk, quirk):
     ) as m1:
 
         rsp = await switch_cluster.command(0x0000)
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             2,
@@ -232,6 +233,7 @@ async def test_singleswitch_requests(zigpy_device_from_quirk, quirk):
         assert rsp.status == 0
 
         rsp = await switch_cluster.command(0x0001)
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             4,
@@ -242,6 +244,7 @@ async def test_singleswitch_requests(zigpy_device_from_quirk, quirk):
         assert rsp.status == 0
 
     rsp = await switch_cluster.command(0x0002)
+    await wait_for_zigpy_tasks()
     assert rsp.status == foundation.Status.UNSUP_CLUSTER_COMMAND
 
 
@@ -1221,6 +1224,7 @@ async def async_success(*args, **kwargs):
 
         hdr, args = tuya_cluster.deserialize(ZCL_TUYA_SET_TIME_REQUEST)
         tuya_cluster.handle_message(hdr, args)
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             21,

tests/test_tuya_dimmer.py

@@ -7,7 +7,7 @@
 
 import zhaquirks
 
-from tests.common import ClusterListener
+from tests.common import ClusterListener, wait_for_zigpy_tasks
 
 zhaquirks.setup()
 
@@ -31,6 +31,7 @@ async def test_command(zigpy_device_from_quirk, quirk):
         tuya_cluster.endpoint, "request", return_value=foundation.Status.SUCCESS
     ) as m1:
         rsp = await switch2_cluster.command(0x0001)
+        await wait_for_zigpy_tasks()
 
         m1.assert_called_with(
             61184,
@@ -42,6 +43,7 @@ async def test_command(zigpy_device_from_quirk, quirk):
         assert rsp.status == foundation.Status.SUCCESS
 
         rsp = await dimmer1_cluster.command(0x0000, 225)
+        await wait_for_zigpy_tasks()
 
         m1.assert_called_with(
             61184,
@@ -63,18 +65,16 @@ async def test_write_attr(zigpy_device_from_quirk, quirk):
     tuya_cluster = dimmer_dev.endpoints[1].tuya_manufacturer
     dimmer1_cluster = dimmer_dev.endpoints[1].level
 
-    async def async_success(*args, **kwargs):
-        return foundation.Status.SUCCESS
-
     with mock.patch.object(
-        tuya_cluster.endpoint, "request", side_effect=async_success
+        tuya_cluster.endpoint, "request", return_value=foundation.Status.SUCCESS
     ) as m1:
 
         (status,) = await dimmer1_cluster.write_attributes(
             {
                 "minimum_level": 25,
             }
         )
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             2,

tests/test_tuya_mcu.py

@@ -119,9 +119,15 @@ async def test_tuya_methods(zigpy_device_from_quirk, quirk):
     tcd_dimmer2_on = TuyaClusterData(
         endpoint_id=2, cluster_attr="on_off", attr_value=1, expect_reply=True
     )
+    tcd_dimmer2_off = TuyaClusterData(
+        endpoint_id=2, cluster_attr="on_off", attr_value=0, expect_reply=True
+    )
     tcd_dimmer2_level = TuyaClusterData(
         endpoint_id=2, cluster_attr="current_level", attr_value=75, expect_reply=True
     )
+    tcd_dimmer2_level0 = TuyaClusterData(
+        endpoint_id=2, cluster_attr="current_level", attr_value=0, expect_reply=True
+    )
 
     result_1 = tuya_cluster.from_cluster_data(tcd_1)
     assert result_1
@@ -158,12 +164,35 @@ async def test_tuya_methods(zigpy_device_from_quirk, quirk):
         assert m1.call_count == 1
 
         # test `move_to_level_with_on_off` quirk (call on_off + current_level)
-        rsp = await dimmer2_cluster.command(0x0004, 75, 1)
+        rsp = await dimmer2_cluster.command(0x0004, 75)
         assert rsp.status == foundation.Status.SUCCESS
         m1.assert_any_call(tcd_dimmer2_on)  # on_off
         m1.assert_called_with(tcd_dimmer2_level)  # current_level
         assert m1.call_count == 3
 
+        # test `move_to_level_with_on_off` quirk (call on_off + current_level)
+        rsp = await dimmer2_cluster.command(
+            0x0004, 75, 0
+        )  # extra args ¿transition time?. Not on_off for sure
+        assert rsp.status == foundation.Status.SUCCESS
+        m1.assert_any_call(tcd_dimmer2_on)  # on_off
+        m1.assert_called_with(tcd_dimmer2_level)  # current_level
+        assert m1.call_count == 5
+
+        # test `move_to_level_with_on_off` quirk (call on_off + current_level)
+        rsp = await dimmer2_cluster.command(0x0004, 0, level=75)
+        assert rsp.status == foundation.Status.SUCCESS
+        m1.assert_any_call(tcd_dimmer2_on)  # on_off
+        m1.assert_called_with(tcd_dimmer2_level)  # current_level
+        assert m1.call_count == 7
+
+        # test `move_to_level_with_on_off` quirk (call on_off + current_level)
+        rsp = await dimmer2_cluster.command(0x0004)
+        assert rsp.status == foundation.Status.SUCCESS
+        m1.assert_any_call(tcd_dimmer2_off)  # on_off
+        m1.assert_called_with(tcd_dimmer2_level0)  # current_level
+        assert m1.call_count == 9
+
 
 async def test_tuya_mcu_classes():
     """Test tuya conversion from Data to ztype and reverse."""

tests/test_tuya_valve.py

@@ -7,11 +7,12 @@
 
 import zhaquirks
 
-from tests.common import ClusterListener
+from tests.common import ClusterListener, wait_for_zigpy_tasks
 
 zhaquirks.setup()
 
 
+@mock.patch("zhaquirks.tuya.mcu.EnchantedDevice.spell", mock.AsyncMock())
 @pytest.mark.parametrize("quirk", (zhaquirks.tuya.ts0601_valve.ParksidePSBZS,))
 async def test_command_psbzs(zigpy_device_from_quirk, quirk):
     """Test executing cluster commands for PARKSIDE water valve."""
@@ -29,6 +30,7 @@ async def test_command_psbzs(zigpy_device_from_quirk, quirk):
     ) as m1:
         rsp = await switch_cluster.command(0x0001)
 
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             2,
@@ -39,24 +41,23 @@ async def test_command_psbzs(zigpy_device_from_quirk, quirk):
         assert rsp.status == foundation.Status.SUCCESS
 
 
+@mock.patch("zhaquirks.tuya.mcu.EnchantedDevice.spell", mock.AsyncMock())
 @pytest.mark.parametrize("quirk", (zhaquirks.tuya.ts0601_valve.ParksidePSBZS,))
 async def test_write_attr_psbzs(zigpy_device_from_quirk, quirk):
     """Test write cluster attributes for PARKSIDE water valve."""
 
     water_valve_dev = zigpy_device_from_quirk(quirk)
     tuya_cluster = water_valve_dev.endpoints[1].tuya_manufacturer
 
-    async def async_success(*args, **kwargs):
-        return foundation.Status.SUCCESS
-
     with mock.patch.object(
-        tuya_cluster.endpoint, "request", side_effect=async_success
+        tuya_cluster.endpoint, "request", return_value=foundation.Status.SUCCESS
     ) as m1:
         (status,) = await tuya_cluster.write_attributes(
             {
                 "timer_duration": 15,
             }
         )
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             2,
@@ -73,6 +74,7 @@ async def async_success(*args, **kwargs):
                 "frost_lock_reset": 0,
             }
         )
+        await wait_for_zigpy_tasks()
         m1.assert_called_with(
             61184,
             4,

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py37, py38, lint, black
+envlist = py38, py39, py310, lint, black
 skip_missing_interpreters = True
 
 [testenv]

zhaquirks/tuya/__init__.py

@@ -255,6 +255,7 @@ async def command(
         manufacturer: Optional[Union[int, t.uint16_t]] = None,
         expect_reply: bool = True,
         tsn: Optional[Union[int, t.uint8_t]] = None,
+        **kwargs: Any,
     ):
         """Override the default Cluster command."""
         self.debug("Setting the NO manufacturer id in command: %s", command_id)
@@ -264,6 +265,7 @@ async def command(
             manufacturer=foundation.ZCLHeader.NO_MANUFACTURER_ID,
             expect_reply=expect_reply,
             tsn=tsn,
+            **kwargs,
         )
 
 
@@ -1280,6 +1282,7 @@ def command(
         manufacturer: Optional[Union[int, t.uint16_t]] = None,
         expect_reply: bool = True,
         tsn: Optional[Union[int, t.uint8_t]] = None,
+        **kwargs: Any,
     ):
         """Override the default Cluster command."""
         _LOGGER.debug(
@@ -1296,7 +1299,14 @@ def command(
             cmd_payload.tsn = 0
             cmd_payload.command_id = TUYA_LEVEL_COMMAND
             cmd_payload.function = 0
-            brightness = (args[0] * 1000) // 255
+
+            if kwargs and "level" in kwargs:
+                level = kwargs["level"]
+            elif args:
+                level = args[0]
+            else:
+                level = 0
+            brightness = (level * 1000) // 255
             val1 = brightness >> 8
             val2 = brightness & 0xFF
             cmd_payload.data = [4, 0, 0, val1, val2]  # Custom Command