Merge pull request #9 from andrew-codechimp/tests

andrew-codechimp · web-flow · commit ff59a4a6632e · 2025-04-05T14:59:40.000+01:00
Tests
diff --git a/.github/workflows/pull.yaml b/.github/workflows/pull.yaml
@@ -0,0 +1,45 @@
+---
+name: Pull actions
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    name: Validate
+    steps:
+      - uses: "actions/checkout@v4"
+
+      - name: HACS validation
+        uses: "hacs/action@main"
+        with:
+          category: "integration"
+
+      - name: Hassfest validation
+        uses: "home-assistant/actions/hassfest@master"
+
+  tests:
+    runs-on: "ubuntu-latest"
+    name: Run tests
+    steps:
+      - name: Check out code from GitHub
+        uses: "actions/checkout@v4"
+      - name: Setup Python
+        uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.13"
+      - name: Install requirements
+        run: python3 -m pip install -r requirements.txt -r requirements_test.txt
+      - name: Run tests
+        run: |
+          pytest \
+            -qq \
+            --timeout=9 \
+            --durations=10 \
+            -n auto \
+            --cov custom_components.periodic_min_max \
+            -o console_output_style=count \
+            -p no:sugar \
+            tests
diff --git a/.github/workflows/push.yaml b/.github/workflows/push.yaml
@@ -0,0 +1,33 @@
+---
+name: Push actions
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  tests:
+    runs-on: "ubuntu-latest"
+    name: Run tests
+    steps:
+      - name: Check out code from GitHub
+        uses: "actions/checkout@v4"
+      - name: Setup Python
+        uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.13"
+      - name: Install requirements
+        run: python3 -m pip install -r requirements.txt -r requirements_test.txt
+      - name: Run tests
+        run: |
+          pytest \
+            -qq \
+            --timeout=9 \
+            --durations=10 \
+            -n auto \
+            --cov custom_components.periodic_min_max \
+            -o console_output_style=count \
+            -p no:sugar \
+            tests
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -9,7 +9,7 @@
             "type": "python",
             "request": "launch",
             "module": "homeassistant",
-            "justMyCode": false,
+            "justMyCode": true,
             "args": [
                 "--debug",
                 "-c",
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,8 @@
 {
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter"
+        "editor.defaultFormatter": "charliermarsh.ruff"
     },
-    "python.formatting.provider": "none"
+    "terminal.integrated.env.linux": {
+        "PYTHONPATH": "${workspaceRoot}"
+    }
 }
diff --git a/custom_components/periodic_min_max/const.py b/custom_components/periodic_min_max/const.py
@@ -3,6 +3,7 @@
 import json
 from logging import Logger, getLogger
 from pathlib import Path
+
 from homeassistant.const import Platform
 
 LOGGER: Logger = getLogger(__package__)
diff --git a/custom_components/periodic_min_max/sensor.py b/custom_components/periodic_min_max/sensor.py
@@ -96,7 +96,9 @@ async def async_setup_platform(
 
     await async_setup_reload_service(hass, DOMAIN, PLATFORMS)
 
-    async_add_entities([PeriodicMinMaxSensor(hass, entity_id, name, sensor_type, unique_id)])
+    async_add_entities(
+        [PeriodicMinMaxSensor(hass, entity_id, name, sensor_type, unique_id)]
+    )
 
 
 class PeriodicMinMaxSensor(SensorEntity, RestoreEntity):
@@ -136,13 +138,14 @@ def __init__(
         self.max_value: float | None = None
         self._state: Any = None
 
-
     async def async_added_to_hass(self) -> None:
         """Handle added to Hass."""
 
         self.async_on_remove(
             async_track_state_change_event(
-                self.hass, self._source_entity_id, self._async_min_max_sensor_state_listener
+                self.hass,
+                self._source_entity_id,
+                self._async_min_max_sensor_state_listener,
             )
         )
 
@@ -158,18 +161,34 @@ async def async_added_to_hass(self) -> None:
 
         if entry:
             self._unit_of_measurement = entry.unit_of_measurement
-            self._attr_device_class = SensorDeviceClass(entry.device_class) if entry.device_class else None
-            self._attr_icon = entry.icon if entry.icon else entry.original_icon if entry.original_icon else ICON
+            self._attr_device_class = (
+                SensorDeviceClass(entry.device_class) if entry.device_class else None
+            )
+            self._attr_icon = (
+                entry.icon
+                if entry.icon
+                else entry.original_icon
+                if entry.original_icon
+                else ICON
+            )
 
             state = await self.async_get_last_state()
-            if state is not None and state.state not in [STATE_UNKNOWN, STATE_UNAVAILABLE]:
+            if state is not None and state.state not in [
+                STATE_UNKNOWN,
+                STATE_UNAVAILABLE,
+            ]:
                 self._state = float(state.state)
                 self._calc_values()
 
             # Replay current state of source entitiy
             state = self.hass.states.get(self._source_entity_id)
             state_event: Event[EventStateChangedData] = Event(
-                "", {"entity_id": self._source_entity_id, "new_state": state, "old_state": None}
+                "",
+                {
+                    "entity_id": self._source_entity_id,
+                    "new_state": state,
+                    "old_state": None,
+                },
             )
             self._async_min_max_sensor_state_listener(state_event, update_state=False)
 
@@ -259,4 +278,4 @@ async def handle_reset(self) -> None:
         self.min_value = self._state
         self.max_value = self._state
 
-        self.async_write_ha_state()
+        self.async_write_ha_state()
diff --git a/pyproject.toml b/pyproject.toml
@@ -129,3 +129,7 @@ warn_unused_ignores = true
 
 [tool.ruff.lint.mccabe]
 max-complexity = 25
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,2 @@
+[pytest]
+asyncio_mode = auto
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -0,0 +1,3 @@
+homeassistant
+pre-commit
+mypy
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -0,0 +1 @@
+pytest-homeassistant-custom-component
diff --git a/scripts/develop b/scripts/develop
@@ -17,4 +17,7 @@ fi
 export PYTHONPATH="${PYTHONPATH}:${PWD}/custom_components"
 
 # Start Home Assistant
-hass --config "${PWD}/config" --debug
+# debugpy logging, if required: --log-to debugpy
+python3 -Xfrozen_modules=off \
+    -m debugpy --listen localhost:5678 \
+    -m homeassistant --config "${PWD}/config"
diff --git a/scripts/setup b/scripts/setup
@@ -4,4 +4,4 @@ set -e
 
 cd "$(dirname "$0")/.."
 
-python3 -m pip install --requirement requirements.txt
+python3 -m pip install -r requirements.txt -r requirements_dev.txt -r requirements_test.txt
diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,24 @@
+# Why?
+
+While tests aren't required to publish a custom component for Home Assistant, they will generally make development easier because good tests will expose when changes you want to make to the component logic will break expected functionality. Home Assistant uses [`pytest`](https://docs.pytest.org/en/latest/) for its tests, and the tests that have been included are modeled after tests that are written for core Home Assistant integrations. These tests pass with 100% coverage (unless something has changed ;) ) and have comments to help you understand the purpose of different parts of the test.
+
+# Getting Started
+
+To begin, it is recommended to create a virtual environment to install dependencies:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+You can then install the dependencies that will allow you to run tests:
+`pip3 install -r requirements_test.txt.`
+
+This will install `homeassistant`, `pytest`, and `pytest-homeassistant-custom-component`, a plugin which allows you to leverage helpers that are available in Home Assistant for core integration tests.
+
+# Useful commands
+
+Command | Description
+------- | -----------
+`pytest tests/` | This will run all tests in `tests/` and tell you how many passed/failed
+`pytest --durations=10 --cov-report term-missing --cov=custom_components.periodic_min_max tests` | This tells `pytest` that your target module to test is `custom_components.periodic_min_max` so that it can give you a [code coverage](https://en.wikipedia.org/wiki/Code_coverage) summary, including % of code that was executed and the line numbers of missed executions.
+`pytest tests/test_init.py -k test_setup_unload_and_reload_entry` | Runs the `test_setup_unload_and_reload_entry` test function located in `tests/test_init.py`
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1,5 @@
+"""Tests for periodic_min_max integration."""
+
+import pytest
+
+pytestmark = pytest.mark.asyncio
diff --git a/tests/bandit.yaml b/tests/bandit.yaml
@@ -0,0 +1,21 @@
+---
+# https://bandit.readthedocs.io/en/latest/config.html
+
+tests:
+  - B103
+  - B108
+  - B306
+  - B307
+  - B313
+  - B314
+  - B315
+  - B316
+  - B317
+  - B318
+  - B319
+  - B320
+  - B601
+  - B602
+  - B604
+  - B608
+  - B609
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,80 @@
+"""Global fixtures for periodic_min_max integration."""
+
+from __future__ import annotations
+
+from collections.abc import Generator
+from typing import Any
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from homeassistant.config_entries import SOURCE_USER
+from homeassistant.const import (
+    CONF_ENTITY_ID,
+    CONF_NAME,
+    CONF_TYPE,
+)
+from homeassistant.core import HomeAssistant
+from pytest_homeassistant_custom_component.common import MockConfigEntry
+
+from custom_components.periodic_min_max.const import DOMAIN
+
+from .test_sensor import VALUES_NUMERIC
+
+pytest_plugins = "pytest_homeassistant_custom_component"
+
+# This fixture enables loading custom integrations in all tests.
+# Remove to enable selective use of this fixture
+@pytest.fixture(autouse=True)
+def auto_enable_custom_integrations(enable_custom_integrations):
+    """Enable loading custom integrations."""
+    yield
+
+@pytest.fixture
+def mock_setup_entry() -> Generator[AsyncMock]:
+    """Automatically path uuid generator."""
+    with patch(
+        "custom_components.periodic_min_max.async_setup_entry",
+        return_value=True,
+    ) as mock_setup_entry:
+        yield mock_setup_entry
+
+
+@pytest.fixture(name="get_config")
+async def get_config_to_integration_load() -> dict[str, Any]:
+    """Return configuration.
+
+    To override the config, tests can be marked with:
+    @pytest.mark.parametrize("get_config", [{...}])
+    """
+    return {
+        CONF_NAME: "My periodic_min_max sensor",
+        CONF_ENTITY_ID: "sensor.test_monitored",
+        CONF_TYPE: "max",
+    }
+
+
+@pytest.fixture(name="loaded_entry")
+async def load_integration(
+    hass: HomeAssistant, get_config: dict[str, Any]
+) -> MockConfigEntry:
+    """Set up the periodic_min_max integration in Home Assistant."""
+    config_entry = MockConfigEntry(
+        domain=DOMAIN,
+        source=SOURCE_USER,
+        options=get_config,
+        entry_id="1",
+    )
+
+    config_entry.add_to_hass(hass)
+
+    await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    for value in VALUES_NUMERIC:
+        hass.states.async_set(
+            "sensor.test_monitored",
+            str(value),
+        )
+    await hass.async_block_till_done()
+
+    return config_entry
diff --git a/tests/const.py b/tests/const.py
@@ -0,0 +1,4 @@
+"""Constants for periodic_min_max tests."""
+
+# Mock config data to be used across multiple tests
+DEFAULT_NAME = "My Periodic Min Max"
diff --git a/tests/fixtures/configuration.yaml b/tests/fixtures/configuration.yaml
@@ -0,0 +1,5 @@
+sensor:
+  - platform: periodic_min_max
+    entity_id: sensor.test_1
+    name: test
+    type: max
diff --git a/tests/test_config_flow.py b/tests/test_config_flow.py
diff --git a/tests/test_init.py b/tests/test_init.py
diff --git a/tests/test_sensor.py b/tests/test_sensor.py
diff --git a/tests/test_services.py b/tests/test_services.py

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"[python]": {`
`3`		`- "editor.defaultFormatter": "ms-python.black-formatter"`
	`3`	`+ "editor.defaultFormatter": "charliermarsh.ruff"`
`4`	`4`	`},`
`5`		`- "python.formatting.provider": "none"`
	`5`	`+ "terminal.integrated.env.linux": {`
	`6`	`+ "PYTHONPATH": "${workspaceRoot}"`
	`7`	`+ }`
`6`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+homeassistant`
	`2`	`+pre-commit`
	`3`	`+mypy`