Merge pull request #906 from plugwise/bw_snap

Implement snapshot testing

Author: bouwew

CHANGELOG.md

@@ -4,7 +4,8 @@ Versions from 0.40 and up
 
 ## Ongoing
 
-- Fix mypy errors in Core
+- Fix mypy errors in Core (not accepted in HA Core)
+- Introduce Snapshot testing for all platforms (requirement from HA Core)
 
 ## v0.57.6
 

scripts/core-testing.sh

@@ -245,8 +245,24 @@ if [ -z "${GITHUB_ACTIONS}" ] || [ "$1" == "testing" ] ; then
 	if [ ! "${DEBUG}" == "" ] ; then 
         	debug_params="-rpP --log-cli-level=DEBUG"
 	fi
-	# shellcheck disable=SC2086
-	pytest ${debug_params} ${subject} tests/components/${REPO_NAME}/${basedir} --snapshot-update --cov=homeassistant/components/${REPO_NAME}/ --cov-report term-missing || exit
+	# First test if snapshots still valid (silent fail, otherwise will update snapshots)
+	SNAPSHOT_UPDATED=0
+        PYTEST_COMMAND="pytest ${debug_params} ${subject} tests/components/${REPO_NAME}/${basedir} --cov=homeassistant/components/${REPO_NAME}/ --cov-report term-missing"
+	eval "${PYTEST_COMMAND}" || {
+		echo ""
+        echo -e "${CFAIL}Pytest / Snapshot validation failed, re-running to update snapshot ...${CNORM}"
+		# Rerun with --snapshot-update; abort if this also fails
+		eval "${PYTEST_COMMAND} --snapshot-update" || {
+			echo ""
+			echo -e "${CFAIL}Pytest failed, not a snapshot issue ...${CNORM}"
+			exit 1
+		}
+		# Second run succeeded ⇒ mark snapshots updated
+		SNAPSHOT_UPDATED=1
+	} && {
+		echo ""
+        echo -e "${CINFO}Pytest / Snapshot validation passed"
+	}
 fi # testing
 
 if [ -z "${GITHUB_ACTIONS}" ] || [ "$1" == "quality" ] ; then 
@@ -284,6 +300,9 @@ if [ -z "${GITHUB_ACTIONS}" ]; then
 	echo ""
 	cp -r ./homeassistant/components/${REPO_NAME} ../custom_components/
 	cp -r ./tests/components/${REPO_NAME} ../tests/components/
+        if [ "${SNAPSHOT_UPDATED}" == "1" ]; then
+		echo -e "${CWARN}Note: updated snapshots ...${CNORM}"
+	fi
 	echo -e "${CINFO}Removing 'version' from manifest for hassfest-ing, version not allowed in core components${CNORM}"
 	echo ""
 	# shellcheck disable=SC2090

tests/components/plugwise/conftest.py

@@ -1,7 +1,7 @@
 """Setup mocks for the Plugwise integration tests."""
 from __future__ import annotations
 
-from collections.abc import Generator
+from collections.abc import AsyncGenerator, Generator
 import json
 from typing import Any
 from unittest.mock import AsyncMock, MagicMock, patch
@@ -125,6 +125,28 @@ def mock_smile_config_flow() -> Generator[MagicMock]:
         yield api
 
 
+@pytest.fixture
+def platforms(request: pytest.FixtureRequest) -> list[str]:
+    """Fixture for platforms."""
+    return list(request.param)
+
+
+@pytest.fixture
+async def setup_platform(
+    hass: HomeAssistant,
+    mock_config_entry: MockConfigEntry,
+    platforms,
+) -> AsyncGenerator[None]:
+    """Set up one or all platforms."""
+
+    mock_config_entry.add_to_hass(hass)
+
+    with patch(f"homeassistant.components.{DOMAIN}.PLATFORMS", platforms):
+        assert await hass.config_entries.async_setup(mock_config_entry.entry_id)
+        await hass.async_block_till_done()
+        yield mock_config_entry
+
+
 @pytest.fixture
 def mock_smile_adam() -> Generator[MagicMock]:
     """Create a Mock Adam type for testing."""
@@ -187,8 +209,8 @@ def mock_smile_adam_heat_cool(chosen_env: str, cooling_present: bool) -> Generat
 
 
 @pytest.fixture
-def mock_smile_adam_4() -> Generator[MagicMock]:
-    """Create a 4th Mock Adam type for testing."""
+def mock_smile_adam_jip() -> Generator[MagicMock]:
+    """Create a Mock Adam-Jip type for testing."""
     chosen_env = "m_adam_jip"
     data = _read_json(chosen_env, "data")
     with patch(