Merge branch 'release/0.0.68'

Author: dmulcahey

.gitignore

@@ -8,4 +8,5 @@ build/**/*.*
 .tox
 .idea/*
 .coverage
+htmlcov/
 .mypycache

.isort.cfg

@@ -7,7 +7,7 @@ profile = black
 not_skip = __init__.py
 # will group `import x` and `from x import` of the same module.
 force_sort_within_sections = true
-sections = FUTURE,STDLIB,INBETWEENS,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 default_section = THIRDPARTY
 known_first_party = zhaquirks,tests
 forced_separate = tests

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.0
+    rev: v2.31.1
     hooks:
       - id: pyupgrade
 
@@ -10,23 +10,23 @@ repos:
       - id: autoflake8
 
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
 
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
+    rev: 4.0.1
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-docstrings==1.5.0
-          - pydocstyle==5.1.1
+          - flake8-docstrings==1.6.0
+          - pydocstyle==6.1.1
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.5.2
+    rev: 5.10.1
     hooks:
       - id: isort
 
@@ -36,6 +36,6 @@ repos:
       - id: codespell
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.902
+    rev: v0.942
     hooks:
       - id: mypy

README.md

@@ -422,6 +422,119 @@ If you look at another example for the same device:
 
 You can see a pattern that illustrates how to match a more complex event. In this case the step command is used for the dim up and dim down buttons so we need to match more of the event data to uniquely match the event.
 
+## Testing using unit tests
+
+The tests use the [pytest](https://docs.pytest.org/en/latest/) framework.
+
+### Getting started
+
+To get set up, you need install the test dependencies:
+
+```bash
+pip install -r requirements_test_all.txt
+```
+
+### Running the tests
+
+See the [pytest documentation](https://docs.pytest.org/en/latest/) for details about how to run
+the tests. For example, to run all the `test_tuya.py` tests:
+
+```bash
+$ pytest --disable-warnings tests/test_tuya.py
+Test session starts (platform: linux, Python 3.9.2, pytest 6.2.5, pytest-sugar 0.9.4)
+
+collecting ...
+ tests/test_tuya.py ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓                                                                                                                                                                                                                                                         100% ██████████
+
+Results (3.58s):
+      41 passed
+```
+
+### Writing tests
+
+To add a new test, start by adding a new function to one of the existing test files. You
+can follow the instructions in the [Getting started](https://docs.pytest.org/en/latest/getting-started.html)
+section of the pytest documentation.
+
+### Using fixtures to set things up
+
+In order to write a test, you will need to access an instance of a quirk to run the tests against. Pytest
+provides a useful feature called Fixtures that allow you to write and use the setup code necessary in one
+place, similar to how we use libraries to provide common functions to other code.
+
+You can read more about fixtures [here](https://docs.pytest.org/en/latest/how-to/fixtures.html#how-to-fixtures).
+
+You can find the common fixtures in files named `conftest.py`. Pytest will list them for you as follows:
+
+```bash
+$ pytest --fxitures
+[...]
+--- fixtures defined from tests.conftest ---
+MockAppController
+    App controller mock.
+
+ieee_mock
+    Return a static ieee.
+
+zigpy_device_mock
+    Zigpy device mock.
+
+zigpy_device_from_quirk
+    Create zigpy device from Quirks signature.
+
+[...]
+--- fixtures defined from tests.test_tuya_clusters ---
+TuyaCluster
+    Mock of the new Tuya manufacturer cluster.
+```
+
+Some fixtures such as `app_controller_mock` will provide an object instance that you can
+use directly. Others, such as `zigpy_device_mock` will return a function, which you can
+call to create a customised object during your own setup.
+
+### Testing the quirk signature matching
+
+The fixture `assert_signature_matches_quirk` provides a function that can be
+used to check that a particular device signature matches the corresponding quirk.
+By capturing the signature and adding a few lines to the test file, this means that
+you can verify that your device will be matched against the quirk without needing to
+go through the paring process directly.
+
+You need to capture the device signature and save it. If you have previously started the
+pairing process in Home assistant, you can find the signature under 'Zigbee Device Signature'
+on the device page.
+
+Now you can create a test that checks the signature as follows:
+
+```python
+def test_ts0121_signature(assert_signature_matches_quirk):
+    signature = {
+        "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.Router: 1>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress|RxOnWhenIdle|MainsPowered|FullFunctionDevice: 142>, manufacturer_code=4098, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=False, *is_full_function_device=True, *is_mains_powered=True, *is_receiver_on_when_idle=True, *is_router=True, *is_security_capable=False)",
+        "endpoints": {
+            "1": {
+            "profile_id": 260,
+            "device_type": "0x0051",
+            "in_clusters": [
+                "0x0000",
+                "0x0004",
+                "0x0005",
+                "0x0006",
+                "0x0702",
+                "0x0b04"
+            ],
+            "out_clusters": [
+                "0x000a",
+                "0x0019"
+            ]
+            }
+        },
+        "manufacturer": "_TZ3000_g5xawfcq",
+        "model": "TS0121",
+        "class": "zhaquirks.tuya.ts0121_plug.Plug"
+    }
+    assert_signature_matches_quirk(zhaquirks.tuya.ts0121_plug.Plug, signature)
+```
+
 # Testing new releases
 
 Testing a new release of the zha-quirks package before it is released in Home Assistant.

requirements_test_all.txt

@@ -7,7 +7,7 @@ codecov==2.1.10
 coveralls==2.2.0
 mock-open==1.4.0
 mypy==0.790
-pre-commit==2.8.2
+pre-commit==2.9.2
 pylint==2.6.0
 pytest-aiohttp==0.3.0
 pytest-cov==2.10.1

setup.cfg

@@ -31,7 +31,7 @@ profile = black
 not_skip = __init__.py
 # will group `import x` and `from x import` of the same module.
 force_sort_within_sections = true
-sections = FUTURE,STDLIB,INBETWEENS,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 default_section = THIRDPARTY
 known_first_party = zhaquirks,tests
 forced_separate = tests

setup.py

@@ -1,21 +1,17 @@
 """Setup module for ZHAQuirks."""
 
-from setuptools import find_packages, setup
-
-VERSION = "0.0.67"
+import pathlib
 
+from setuptools import find_packages, setup
 
-def readme():
-    """Print long description."""
-    with open("README.md") as f:
-        return f.read()
+VERSION = "0.0.68"
 
 
 setup(
     name="zha-quirks",
     version=VERSION,
     description="Library implementing Zigpy quirks for ZHA in Home Assistant",
-    long_description=readme(),
+    long_description=(pathlib.Path(__file__).parent / "README.md").read_text(),
     long_description_content_type="text/markdown",
     url="https://github.com/dmulcahey/zha-device-handlers",
     author="David F. Mulcahey",
@@ -24,6 +20,6 @@ def readme():
     keywords="zha quirks homeassistant hass",
     packages=find_packages(exclude=["tests"]),
     python_requires=">=3",
-    install_requires=["zigpy>=0.42.0"],
+    install_requires=["zigpy>=0.44.1"],
     tests_require=["pytest"],
 )

tests/conftest.py

@@ -1,10 +1,16 @@
 """Fixtures for all tests."""
 
-from asynctest import CoroutineMock
+try:
+    from unittest.mock import AsyncMock as CoroutineMock
+except ImportError:
+    from asynctest import CoroutineMock
+
 import pytest
 import zigpy.application
 import zigpy.device
+import zigpy.quirks
 import zigpy.types
+import zigpy.zcl.foundation as foundation
 
 from zhaquirks.const import (
     DEVICE_TYPE,
@@ -31,17 +37,41 @@ async def probe(self, *args):
         """Probe method."""
         return True
 
-    async def shutdown(self):
-        """Mock shutdown."""
-
     async def startup(self, *args):
         """Mock startup."""
 
+    async def shutdown(self, *args):
+        """Mock shutdown."""
+
     async def permit_ncp(self, *args):
         """Mock permit ncp."""
 
+    async def broadcast(self, *args, **kwargs):
+        """Mock broadcast."""
+
+    async def connect(self, *args, **kwargs):
+        """Mock connect."""
+
+    async def disconnect(self, *args, **kwargs):
+        """Mock disconnect."""
+
+    async def force_remove(self, *args, **kwargs):
+        """Mock force_remove."""
+
+    async def load_network_info(self, *args, **kwargs):
+        """Mock load_network_info."""
+
+    async def permit_with_key(self, *args, **kwargs):
+        """Mock permit_with_key."""
+
+    async def start_network(self, *args, **kwargs):
+        """Mock start_network."""
+
+    async def write_network_info(self, *args, **kwargs):
+        """Mock write_network_info."""
+
     mrequest = CoroutineMock()
-    request = CoroutineMock()
+    request = CoroutineMock(return_value=(foundation.Status.SUCCESS, None))
 
 
 @pytest.fixture(name="MockAppController")
@@ -115,3 +145,47 @@ def _dev(quirk, ieee=None, nwk=zigpy.types.NWK(0x1234), apply_quirk=True):
         return device
 
     return _dev
+
+
+@pytest.fixture
+def assert_signature_matches_quirk():
+    """Return a function that can be used to check if a given quirk matches a signature."""
+
+    def _check(quirk, signature):
+        # Check device signature as copied from Zigbee device signature window for the device
+        class FakeDevEndpoint:
+            def __init__(self, endpoint):
+                self.endpoint = endpoint
+
+            def __getattr__(self, key):
+                if key == "device_type":
+                    return int(self.endpoint[key], 16)
+                elif key in ("in_clusters", "out_clusters"):
+                    return [int(cluster_id, 16) for cluster_id in self.endpoint[key]]
+                else:
+                    return self.endpoint[key]
+
+        class FakeDevice:
+            nwk = 0
+
+            def __init__(self, signature):
+                self.endpoints = {
+                    int(id): FakeDevEndpoint(ep)
+                    for id, ep in signature["endpoints"].items()
+                }
+                for attr in ("manufacturer", "model", "ieee"):
+                    setattr(self, attr, signature.get(attr))
+
+            def __getitem__(self, key):
+                # Return item from signature, or None if not given
+                return self.endpoints.get(key)
+
+            def __getattr__(self, key):
+                # Return item from signature, or None if not given
+                return self.endpoints.get(key)
+
+        test_dev = FakeDevice(signature)
+        device = zigpy.quirks.get_device(test_dev)
+        assert isinstance(device, quirk)
+
+    return _check

tests/test_quirks.py

@@ -317,8 +317,8 @@ def _check_range(cluster):
         for clusters_type in (INPUT_CLUSTERS, OUTPUT_CLUSTERS):
             clusters = ep_data.get(clusters_type)
             if clusters is not None:
-                assert all((isinstance(cluster_id, int) for cluster_id in clusters))
-                assert all((0 <= cluster_id <= 0xFFFF for cluster_id in clusters))
+                assert all(isinstance(cluster_id, int) for cluster_id in clusters)
+                assert all(0 <= cluster_id <= 0xFFFF for cluster_id in clusters)
 
         for m_m in (MANUFACTURER, MODEL):
             value = ep_data.get(m_m)