Add devcontainer and ignore new .venv

Author: ArnoutD

.devcontainer/devcontainer.json

@@ -0,0 +1,58 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+  "name": "Python 3",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/python:3.12",
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/pylint:2": {}
+  },
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "git config --global --add safe.directory /workspaces/plugwise_usb-beta && scripts/python-venv.sh && . .venv/bin/activate",
+  // Configure tool-specific properties.
+  // "customizations": {},
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+  // Customizations
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.pylint",
+        "github.vscode-pull-request-github",
+        "ryanluker.vscode-coverage-gutters",
+        "ms-python.vscode-pylance",
+        "donjayamanne.python-extension-pack"
+      ],
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "bash",
+            "icon": "terminal-bash"
+          }
+        },
+        "files.eol": "\n",
+        "editor.tabSize": 4,
+        "python.pythonPath": "/usr/bin/python3",
+        "python.analysis.autoSearchPaths": false,
+        // This makes sure the home assistant types are loaded into the editor
+        "python.analysis.extraPaths": [
+          "/home/vscode/.local/lib/python3.12/site-packages/"
+        ],
+        "python.linting.pylintEnabled": true,
+        "python.linting.enabled": true,
+        "python.formatting.provider": "ruff",
+        "editor.formatOnPaste": false,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": true,
+        "files.trimTrailingWhitespace": true
+      }
+    }
+  },
+  "appPort": 8123
+}

.gitattributes

@@ -0,0 +1,9 @@
+# Autodetect text files
+* text=auto eol=lf
+
+# ...Unless the name matches the following
+# overriding patterns
+
+# Definitively text files
+*.py text
+*.sh lf

.gitignore

@@ -2,8 +2,10 @@ __pycache__
 .vscode
 ha-core
 venv
+.venv
 *.sedbck
 *.swp
 *.rej
 *.orig
 manual_clone_ha
+.coverage

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
         args:
           - --fix
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-executables-have-shebangs
         stages: [manual]

custom_components/plugwise_usb/config_flow.py

@@ -57,6 +57,9 @@ class PlugwiseUSBConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for Plugwise USB."""
 
     VERSION = 1
+    MINOR_VERSION = 0
+
+    # no async_step_zeroconf this USB is physical
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
@@ -83,7 +86,8 @@ async def async_step_user(
             )
             errors, mac_stick = await validate_usb_connection(self.hass, device_path)
             if not errors:
-                await self.async_set_unique_id(mac_stick)
+                await self.async_set_unique_id(unique_id=mac_stick, raise_on_progress=False)
+                self._abort_if_unique_id_configured()
                 return self.async_create_entry(
                     title="Stick", data={CONF_USB_PATH: device_path}
                 )

pyproject.toml

@@ -216,7 +216,6 @@ max-complexity = 25
 
 [tool.pytest]
 addopts = [
-    "--auto",
     "--cov=custom_components"
 ]
 

scripts/tests_and_coverage.sh

@@ -28,12 +28,12 @@ fi
 
 if [ -z "${GITHUB_ACTIONS}" ] || [ "$1" == "linting" ] ; then
     # Black first to ensure nothings roughing up ruff
-    echo "... ruff checking ..." 
+    echo "... ruff checking ..."
     ruff check -fix
 
     # TODO: Skip ruff checks as there are too many for now (mainly missing docstrings)
     # echo "... ruff-ing ..."
     # ruff check --fix plugwise_usb/ tests
-    echo "... ruff format ..." 
+    echo "... ruff format ..."
     ruff format
 fi

tests/conftest.py

@@ -10,6 +10,7 @@
 from pytest_homeassistant_custom_component.common import MockConfigEntry
 
 from homeassistant.core import HomeAssistant
+from plugwise_usb.exceptions import StickError
 
 
 @pytest.fixture
@@ -63,18 +64,57 @@ async def init_integration(
 
 
 @pytest.fixture
-def mock_usb() -> Generator[MagicMock]:
+def mock_usb_stick() -> Generator[MagicMock]:
     """Return a mocked usb_mock."""
 
     with patch(
         "custom_components.plugwise_usb.config_flow.Stick",
+        autospec=True
     ) as mock_usb:
-        mock_usb.return_value.connect = AsyncMock(return_value=None)
-        mock_usb.return_value.initialize = AsyncMock(return_value=None)
-        mock_usb.return_value.disconnect = AsyncMock(return_value=None)
-        mock_usb.return_value.mac_stick = MagicMock(return_value="01:23:45:67:AB")
+        usb = mock_usb.return_value
 
-        yield mock_usb
+        usb.connect = AsyncMock(return_value=None)
+        usb.initialize = AsyncMock(return_value=None)
+        usb.disconnect = AsyncMock(return_value=None)
+        usb.mac_stick = "01:23:45:67:AB"
+
+        yield usb
+
+
+@pytest.fixture
+def mock_usb_stick_error() -> Generator[MagicMock]:
+    """Return a mocked usb_mock."""
+
+    with patch(
+        "custom_components.plugwise_usb.config_flow.Stick",
+        autospec=True
+    ) as mock_usb:
+        usb = mock_usb.return_value
+
+        usb.connect = AsyncMock(side_effect=(StickError))
+        usb.initialize = AsyncMock(return_value=None)
+        usb.disconnect = AsyncMock(return_value=None)
+        usb.mac_stick = "01:23:45:67:AB"
+
+        yield usb
+
+
+@pytest.fixture
+def mock_usb_stick_init_error() -> Generator[MagicMock]:
+    """Return a mocked usb_mock."""
+
+    with patch(
+        "custom_components.plugwise_usb.config_flow.Stick",
+        autospec=True
+    ) as mock_usb:
+        usb = mock_usb.return_value
+
+        usb.connect = AsyncMock(return_value=None)
+        usb.initialize = AsyncMock(side_effect=(StickError))
+        usb.disconnect = AsyncMock(return_value=None)
+        usb.mac_stick = "01:23:45:67:AB"
+
+        yield usb
 
 
 async def setup_integration(hass: HomeAssistant, config_entry: MockConfigEntry) -> None:

tests/test_config_flow.py

@@ -1,6 +1,6 @@
 """Test the Plugwise config flow."""
 
-from unittest.mock import AsyncMock, MagicMock, patch
+from unittest.mock import MagicMock, patch
 
 from custom_components.plugwise_usb.config_flow import CONF_MANUAL_PATH
 from custom_components.plugwise_usb.const import CONF_USB_PATH, DOMAIN
@@ -11,7 +11,6 @@
 from homeassistant.config_entries import SOURCE_USER
 from homeassistant.const import CONF_SOURCE
 from homeassistant.data_entry_flow import FlowResultType, InvalidData
-from plugwise_usb.exceptions import StickError
 
 TEST_USBPORT = "/dev/ttyUSB1"
 TEST_USBPORT2 = "/dev/ttyUSB2"
@@ -29,7 +28,7 @@ def com_port():
 
 
 @patch("serial.tools.list_ports.comports", MagicMock(return_value=[com_port()]))
-async def test_user_flow_select(hass, mock_usb: MagicMock):
+async def test_user_flow_select(hass, mock_usb_stick: MagicMock):
     """Test user flow when USB-stick is selected from list."""
     port = com_port()
     port_select = f"{port}, s/n: {port.serial_number} - {port.manufacturer}"
@@ -78,7 +77,7 @@ async def test_user_flow_manual_selected_show_form(hass):
 
 
 async def test_user_flow_manual(
-    hass, mock_usb: MagicMock, init_integration: MockConfigEntry
+    hass, mock_usb_stick: MagicMock, init_integration: MockConfigEntry
 ):
     """Test user flow when USB-stick is manually entered."""
 
@@ -146,9 +145,7 @@ async def test_empty_connection(hass):
     assert result.get("errors") == {}
 
 
-@patch("plugwise_usb.Stick.connect", AsyncMock(side_effect=(StickError)))
-@patch("plugwise_usb.Stick.initialize", AsyncMock(return_value=None))
-async def test_failed_connect(hass):
+async def test_failed_connect(hass, mock_usb_stick_error: MagicMock):
     """Test we handle failed connection."""
     result = await hass.config_entries.flow.async_init(
         DOMAIN,
@@ -168,9 +165,7 @@ async def test_failed_connect(hass):
     assert result.get("errors") == {"base": "cannot_connect"}
 
 
-@patch("plugwise_usb.Stick.connect", AsyncMock(return_value=None))
-@patch("plugwise_usb.Stick.initialize", AsyncMock(side_effect=(StickError)))
-async def test_failed_initialization(hass):
+async def test_failed_initialization(hass, mock_usb_stick_init_error: MagicMock):
     """Test we handle failed initialization of Plugwise USB-stick."""
     result = await hass.config_entries.flow.async_init(
         DOMAIN,