Merge pull request #195 from plugwise/asynx-fixes

ArnoutD · web-flow · commit a6c4579f2360 · 2024-11-19T20:09:35.000+01:00
Various fixes to make testing pass in async-branch
diff --git a/custom_components/plugwise_usb/__init__.py b/custom_components/plugwise_usb/__init__.py
@@ -11,13 +11,7 @@
 from plugwise_usb.api import NodeEvent
 from plugwise_usb.exceptions import StickError
 
-from .const import (
-    CONF_USB_PATH,
-    DOMAIN,
-    NODES,
-    PLUGWISE_USB_PLATFORMS,
-    STICK,
-)
+from .const import CONF_USB_PATH, NODES, PLUGWISE_USB_PLATFORMS, STICK
 from .coordinator import PlugwiseUSBDataUpdateCoordinator
 
 _LOGGER = logging.getLogger(__name__)
diff --git a/custom_components/plugwise_usb/binary_sensor.py b/custom_components/plugwise_usb/binary_sensor.py
@@ -16,7 +16,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
-from .const import DOMAIN, NODES, STICK, UNSUB_NODE_LOADED
+from .const import NODES, STICK, UNSUB_NODE_LOADED
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
diff --git a/custom_components/plugwise_usb/config_flow.py b/custom_components/plugwise_usb/config_flow.py
@@ -20,10 +20,8 @@
 @callback
 def plugwise_stick_entries(hass):
     """Return existing connections for Plugwise USB-stick domain."""
-    sticks = []
-    for entry in hass.config_entries.async_entries(DOMAIN):
-        sticks.append(entry.data.get(CONF_USB_PATH))
-    return sticks
+
+    return [entry.data.get(CONF_USB_PATH) for entry in hass.config_entries.async_entries(DOMAIN)]
 
 
 async def validate_usb_connection(
@@ -114,9 +112,7 @@ async def async_step_manual_path(
             step_id="manual_path",
             data_schema=vol.Schema(
                 {
-                    vol.Required(
-                        CONF_USB_PATH, default="/dev/ttyUSB0" or vol.UNDEFINED
-                    ): str
+                    vol.Required(CONF_USB_PATH, default="/dev/ttyUSB0"): str
                 }
             ),
             errors=errors,
diff --git a/custom_components/plugwise_usb/coordinator.py b/custom_components/plugwise_usb/coordinator.py
@@ -1,6 +1,4 @@
 """DataUpdateCoordinator for Plugwise USB-Stick."""
-
-import asyncio
 from collections import Counter
 from datetime import timedelta
 import logging
@@ -53,7 +51,7 @@ def __init__(
     async def async_node_update(self) -> dict[NodeFeature, Any]:
         """Request status update for Plugwise Node."""
         states: dict[NodeFeature, Any] = {}
-        
+
         # Only unique features
         freq_features = Counter(self.async_contexts())
         features = tuple(freq_features.keys())
@@ -63,7 +61,7 @@ async def async_node_update(self) -> dict[NodeFeature, Any]:
         except StickError as err:
             raise ConfigEntryError from err
         except (StickTimeout, NodeTimeout) as err:
-            raise asyncio.TimeoutError from err
+            raise TimeoutError from err
         except NodeError as err:
             raise UpdateFailed from err
 
diff --git a/custom_components/plugwise_usb/entity.py b/custom_components/plugwise_usb/entity.py
@@ -4,11 +4,10 @@
 from collections.abc import Callable
 from dataclasses import dataclass
 import logging
+from typing import Any
 
 from homeassistant.helpers.entity import EntityDescription
-from homeassistant.helpers.update_coordinator import (
-    CoordinatorEntity,
-)
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
 from plugwise_usb.api import PUSHING_FEATURES, NodeFeature, NodeInfo
 
 from .const import DOMAIN
diff --git a/custom_components/plugwise_usb/sensor.py b/custom_components/plugwise_usb/sensor.py
@@ -26,7 +26,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
-from .const import DOMAIN, NODES, STICK, UNSUB_NODE_LOADED
+from .const import NODES, STICK, UNSUB_NODE_LOADED
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
 _LOGGER = logging.getLogger(__name__)
diff --git a/custom_components/plugwise_usb/strings.json b/custom_components/plugwise_usb/strings.json
@@ -15,13 +15,11 @@
       }
     },
     "error": {
+      "already_configured": "This device is already configured",
       "cannot_connect": "Failed to connect",
       "network_down": "Plugwise Zigbee network is down",
       "network_timeout": "Network communication timeout",
       "stick_init": "Initialization of Plugwise USB-stick failed"
-    },
-    "abort": {
-      "already_configured": "This device is already configured"
     }
   },
   "services": {
diff --git a/custom_components/plugwise_usb/switch.py b/custom_components/plugwise_usb/switch.py
@@ -16,7 +16,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from plugwise_usb.api import NodeEvent, NodeFeature
 
-from .const import DOMAIN, NODES, STICK, UNSUB_NODE_LOADED
+from .const import NODES, STICK, UNSUB_NODE_LOADED
 from .coordinator import PlugwiseUSBDataUpdateCoordinator
 from .entity import PlugwiseUSBEntity, PlugwiseUSBEntityDescription
 
diff --git a/custom_components/plugwise_usb/translations/en.json b/custom_components/plugwise_usb/translations/en.json
@@ -15,13 +15,11 @@
       }
     },
     "error": {
+      "already_configured": "This device is already configured",
       "cannot_connect": "Failed to connect",
       "network_down": "Plugwise Zigbee network is down",
       "network_timeout": "Network communication timeout",
       "stick_init": "Initialization of Plugwise USB-stick failed"
-    },
-    "abort": {
-      "already_configured": "This device is already configured"
     }
   },
   "services": {
diff --git a/custom_components/plugwise_usb/translations/nl.json b/custom_components/plugwise_usb/translations/nl.json
@@ -15,13 +15,11 @@
       }
     },
     "error": {
+      "already_configured": "Dit apparaat is al geconfigureerd",
       "cannot_connect": "Verbinden is mislukt",
       "network_down": "Plugwise Zigbee netwerk is onbereikbaar",
       "network_timeout": "Network communicatie timeout",
       "stick_init": "Initaliseren van USB-stick mislukt"
-    },
-    "abort": {
-      "already_configured": "Dit apparaat is al geconfigureerd"
     }
   },
   "services": {
diff --git a/scripts/core-testing.sh b/scripts/core-testing.sh
@@ -211,14 +211,14 @@ if [ -z "${GITHUB_ACTIONS}" ] || [ "$1" == "quality" ] ; then
 	echo ""
 	set +e
 	echo "... ruff-ing component..."
-	ruff --fix homeassistant/components/plugwise_usb/*py || echo "Ruff applied autofixes" 
+	ruff check --fix homeassistant/components/plugwise_usb/*py || echo "Ruff applied autofixes" 
 	echo "... ruff-ing tests..."
-	ruff --fix tests/components/plugwise_usb/*py || echo "Ruff applied autofixes"
+	ruff check --fix tests/components/plugwise_usb/*py || echo "Ruff applied autofixes"
 	set -e
-	echo "... black-ing ..."
-	black homeassistant/components/plugwise_usb/*py tests/components/plugwise_usb/*py || exit
-	echo "... mypy ..."
-	script/run-in-env.sh mypy homeassistant/components/plugwise_usb/*.py || exit
+	# echo "... black-ing ..."
+	# black homeassistant/components/plugwise_usb/*py tests/components/plugwise_usb/*py || exit
+	# echo "... mypy ..."
+	# script/run-in-env.sh mypy homeassistant/components/plugwise_usb/*.py || exit
 	cd ..
 	echo "... markdownlint ..."
 	pre-commit run --all-files --hook-stage manual markdownlint
@@ -244,8 +244,12 @@ if [ -z "${GITHUB_ACTIONS}" ]; then
 	  # shellcheck disable=SC2090
 	  sed -i".sedbck" 's/http.*test-files.pythonhosted.*#//g' ./homeassistant/components/plugwise_usb/manifest.json
 	)
-	echo "Running hassfest for plugwise_usb"
-	python3 -m script.hassfest --requirements --action validate
+
+	# Hassfest already runs on Github
+	if [ -n "${GITHUB_ACTIONS}" ] ; then
+		echo -e "${CINFO}Running hassfest for plugwise${CNORM}"
+		python3 -m script.hassfest --requirements --action validate 
+	fi
 fi
 
 # pylint was removed from 'quality' some time ago
diff --git a/scripts/setup.sh b/scripts/setup.sh
@@ -11,6 +11,7 @@ if [ -f "${my_venv}/bin/activate" ]; then
     # shellcheck disable=SC1091
     . "${my_venv}/bin/activate"
     # Install commit requirements
+    python3 -m ensurepip --upgrade
     pip install uv
     uv pip install wheel
     uv pip install --upgrade -r requirements_commit.txt
diff --git a/tests/components/plugwise_usb/test_config_flow.py b/tests/components/plugwise_usb/test_config_flow.py
@@ -8,7 +8,6 @@
 from homeassistant.components.plugwise_usb.const import CONF_USB_PATH, DOMAIN
 from homeassistant.config_entries import SOURCE_USER
 from homeassistant.const import CONF_SOURCE
-from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResultType, InvalidData
 from plugwise_usb.exceptions import StickError
 
@@ -26,31 +25,7 @@ def com_port():
     return port
 
 
-async def test_form_flow_usb(
-    hass: HomeAssistant,
-    mock_setup_entry: AsyncMock,
-) -> None:
-    """Test we get the form for Plugwise USB product type."""
-    result = await hass.config_entries.flow.async_init(
-        DOMAIN, context={CONF_SOURCE: SOURCE_USER}
-    )
-    assert result.get("type") is FlowResultType.FORM
-    assert result.get("errors") == {}
-    assert result.get("step_id") == "user"
-    assert "flow_id" in result
-
-    result = await hass.config_entries.flow.async_configure(
-        result["flow_id"],
-    )
-    assert result.get("type") is FlowResultType.FORM
-    assert result.get("errors") == {}
-    assert result.get("step_id") == "user"
-
-
 @patch("serial.tools.list_ports.comports", MagicMock(return_value=[com_port()]))
-@patch("plugwise_usb.Stick.connect", AsyncMock(return_value=None))
-@patch("plugwise_usb.Stick.initialize", AsyncMock(return_value=None))
-@patch("plugwise_usb.Stick.disconnect", AsyncMock(return_value=None))
 async def test_user_flow_select(hass):
     """Test user flow when USB-stick is selected from list."""
     port = com_port()
@@ -60,22 +35,37 @@ async def test_user_flow_select(hass):
         DOMAIN,
         context={CONF_SOURCE: SOURCE_USER},
     )
-    result = await hass.config_entries.flow.async_configure(
-        result["flow_id"], user_input={CONF_USB_PATH: port_select}
-    )
     assert result.get("type") is FlowResultType.FORM
-    assert result.get("user_input") == {CONF_USB_PATH: TEST_USBPORT}
+    assert result.get("errors") == {}
+    assert result.get("step_id") == "user"
+    assert "flow_id" in result
 
-    # Retry to ensure configuring the same port is not allowed
-    result = await hass.config_entries.flow.async_init(
-        DOMAIN,
-        context={CONF_SOURCE: SOURCE_USER},
-    )
-    result = await hass.config_entries.flow.async_configure(
-        result["flow_id"], user_input={CONF_USB_PATH: port_select}
-    )
-    assert result.get("type") is FlowResultType.FORM
-    assert result.get("errors") == {"base": "already_configured"}
+    with patch(
+        "homeassistant.components.plugwise_usb.config_flow.Stick",
+    ) as usb_mock:
+        usb_mock.return_value.connect = AsyncMock(return_value=None)
+        usb_mock.return_value.initialize = AsyncMock(return_value=None)
+        usb_mock.return_value.disconnect = AsyncMock(return_value=None)
+        usb_mock.return_value.mac_stick = MagicMock(return_value="01:23:45:67:AB")
+
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input={CONF_USB_PATH: port_select}
+        )
+        await hass.async_block_till_done()
+        assert result.get("type") is FlowResultType.CREATE_ENTRY
+        assert result.get("data") == {CONF_USB_PATH: TEST_USBPORT}
+
+        # Retry to ensure configuring the same port is not allowed
+        result = await hass.config_entries.flow.async_init(
+            DOMAIN,
+            context={CONF_SOURCE: SOURCE_USER},
+        )
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input={CONF_USB_PATH: port_select}
+        )
+        await hass.async_block_till_done()
+        assert result.get("type") is FlowResultType.FORM
+        assert result.get("errors") == {"base": "already_configured"}
 
 
 async def test_user_flow_manual_selected_show_form(hass):
@@ -115,8 +105,9 @@ async def test_user_flow_manual(hass):
             result["flow_id"],
             user_input={CONF_USB_PATH: TEST_USBPORT2},
         )
-    assert result.get("type") is FlowResultType.CREATE_ENTRY
-    assert result.get("user_input") == {CONF_USB_PATH: TEST_USBPORT2}
+        await hass.async_block_till_done()
+        assert result.get("type") is FlowResultType.CREATE_ENTRY
+        assert result.get("data") == {CONF_USB_PATH: TEST_USBPORT2}
 
 
 async def test_invalid_connection(hass):
@@ -129,12 +120,13 @@ async def test_invalid_connection(hass):
         result["flow_id"],
         user_input={CONF_USB_PATH: CONF_MANUAL_PATH},
     )
+    await hass.async_block_till_done()
 
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
         {CONF_USB_PATH: "/dev/null"},
     )
-
+    await hass.async_block_till_done()
     assert result.get("type") is FlowResultType.FORM
     assert result.get("errors") == {"base": "cannot_connect"}
 
@@ -149,6 +141,7 @@ async def test_empty_connection(hass):
         result["flow_id"],
         user_input={CONF_USB_PATH: CONF_MANUAL_PATH},
     )
+    await hass.async_block_till_done()
 
     try:
         result = await hass.config_entries.flow.async_configure(
@@ -175,10 +168,12 @@ async def test_failed_connect(hass):
         result["flow_id"],
         user_input={CONF_USB_PATH: CONF_MANUAL_PATH},
     )
+    await hass.async_block_till_done()
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
         user_input={CONF_USB_PATH: "/dev/null"},
     )
+    await hass.async_block_till_done()
     assert result.get("type") is FlowResultType.FORM
     assert result.get("errors") == {"base": "cannot_connect"}
 
@@ -195,9 +190,11 @@ async def test_failed_initialization(hass):
         result["flow_id"],
         user_input={CONF_USB_PATH: CONF_MANUAL_PATH},
     )
+    await hass.async_block_till_done()
     result = await hass.config_entries.flow.async_configure(
         result["flow_id"],
         user_input={CONF_USB_PATH: "/dev/null"},
     )
+    await hass.async_block_till_done()
     assert result.get("type") is FlowResultType.FORM
     assert result.get("errors") == {"base": "stick_init"}
