mirror of
https://github.com/esphome/esphome.git
synced 2025-10-30 22:53:59 +00:00
[core] Trigger clean build when components are removed from configuration (#10235)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
J. Nick Koston
GitHub
220
tests/unit_tests/test_writer.py
Normal file
220
tests/unit_tests/test_writer.py
Normal file
@@ -0,0 +1,220 @@
|
||||
"""Test writer module functionality."""
|
||||
|
||||
from collections.abc import Callable
|
||||
from typing import Any
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from esphome.storage_json import StorageJSON
|
||||
from esphome.writer import storage_should_clean, update_storage_json
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def create_storage() -> Callable[..., StorageJSON]:
|
||||
"""Factory fixture to create StorageJSON instances."""
|
||||
|
||||
def _create(
|
||||
loaded_integrations: list[str] | None = None, **kwargs: Any
|
||||
) -> StorageJSON:
|
||||
return StorageJSON(
|
||||
storage_version=kwargs.get("storage_version", 1),
|
||||
name=kwargs.get("name", "test"),
|
||||
friendly_name=kwargs.get("friendly_name", "Test Device"),
|
||||
comment=kwargs.get("comment"),
|
||||
esphome_version=kwargs.get("esphome_version", "2025.1.0"),
|
||||
src_version=kwargs.get("src_version", 1),
|
||||
address=kwargs.get("address", "test.local"),
|
||||
web_port=kwargs.get("web_port", 80),
|
||||
target_platform=kwargs.get("target_platform", "ESP32"),
|
||||
build_path=kwargs.get("build_path", "/build"),
|
||||
firmware_bin_path=kwargs.get("firmware_bin_path", "/firmware.bin"),
|
||||
loaded_integrations=set(loaded_integrations or []),
|
||||
loaded_platforms=kwargs.get("loaded_platforms", set()),
|
||||
no_mdns=kwargs.get("no_mdns", False),
|
||||
framework=kwargs.get("framework", "arduino"),
|
||||
core_platform=kwargs.get("core_platform", "esp32"),
|
||||
)
|
||||
|
||||
return _create
|
||||
|
||||
|
||||
def test_storage_should_clean_when_old_is_none(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is triggered when old storage is None."""
|
||||
new = create_storage(loaded_integrations=["api", "wifi"])
|
||||
assert storage_should_clean(None, new) is True
|
||||
|
||||
|
||||
def test_storage_should_clean_when_src_version_changes(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is triggered when src_version changes."""
|
||||
old = create_storage(loaded_integrations=["api", "wifi"], src_version=1)
|
||||
new = create_storage(loaded_integrations=["api", "wifi"], src_version=2)
|
||||
assert storage_should_clean(old, new) is True
|
||||
|
||||
|
||||
def test_storage_should_clean_when_build_path_changes(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is triggered when build_path changes."""
|
||||
old = create_storage(loaded_integrations=["api", "wifi"], build_path="/build1")
|
||||
new = create_storage(loaded_integrations=["api", "wifi"], build_path="/build2")
|
||||
assert storage_should_clean(old, new) is True
|
||||
|
||||
|
||||
def test_storage_should_clean_when_component_removed(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is triggered when a component is removed."""
|
||||
old = create_storage(
|
||||
loaded_integrations=["api", "wifi", "bluetooth_proxy", "esp32_ble_tracker"]
|
||||
)
|
||||
new = create_storage(loaded_integrations=["api", "wifi", "esp32_ble_tracker"])
|
||||
assert storage_should_clean(old, new) is True
|
||||
|
||||
|
||||
def test_storage_should_clean_when_multiple_components_removed(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is triggered when multiple components are removed."""
|
||||
old = create_storage(
|
||||
loaded_integrations=["api", "wifi", "ota", "web_server", "logger"]
|
||||
)
|
||||
new = create_storage(loaded_integrations=["api", "wifi", "logger"])
|
||||
assert storage_should_clean(old, new) is True
|
||||
|
||||
|
||||
def test_storage_should_not_clean_when_nothing_changes(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is not triggered when nothing changes."""
|
||||
old = create_storage(loaded_integrations=["api", "wifi", "logger"])
|
||||
new = create_storage(loaded_integrations=["api", "wifi", "logger"])
|
||||
assert storage_should_clean(old, new) is False
|
||||
|
||||
|
||||
def test_storage_should_not_clean_when_component_added(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is not triggered when a component is only added."""
|
||||
old = create_storage(loaded_integrations=["api", "wifi"])
|
||||
new = create_storage(loaded_integrations=["api", "wifi", "ota"])
|
||||
assert storage_should_clean(old, new) is False
|
||||
|
||||
|
||||
def test_storage_should_not_clean_when_other_fields_change(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test that clean is not triggered when non-relevant fields change."""
|
||||
old = create_storage(
|
||||
loaded_integrations=["api", "wifi"],
|
||||
friendly_name="Old Name",
|
||||
esphome_version="2024.12.0",
|
||||
)
|
||||
new = create_storage(
|
||||
loaded_integrations=["api", "wifi"],
|
||||
friendly_name="New Name",
|
||||
esphome_version="2025.1.0",
|
||||
)
|
||||
assert storage_should_clean(old, new) is False
|
||||
|
||||
|
||||
def test_storage_edge_case_empty_integrations(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test edge case when old has integrations but new has none."""
|
||||
old = create_storage(loaded_integrations=["api", "wifi"])
|
||||
new = create_storage(loaded_integrations=[])
|
||||
assert storage_should_clean(old, new) is True
|
||||
|
||||
|
||||
def test_storage_edge_case_from_empty_integrations(
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
) -> None:
|
||||
"""Test edge case when old has no integrations but new has some."""
|
||||
old = create_storage(loaded_integrations=[])
|
||||
new = create_storage(loaded_integrations=["api", "wifi"])
|
||||
assert storage_should_clean(old, new) is False
|
||||
|
||||
|
||||
@patch("esphome.writer.clean_build")
|
||||
@patch("esphome.writer.StorageJSON")
|
||||
@patch("esphome.writer.storage_path")
|
||||
@patch("esphome.writer.CORE")
|
||||
def test_update_storage_json_logging_when_old_is_none(
|
||||
mock_core: MagicMock,
|
||||
mock_storage_path: MagicMock,
|
||||
mock_storage_json_class: MagicMock,
|
||||
mock_clean_build: MagicMock,
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Test that update_storage_json doesn't crash when old storage is None.
|
||||
|
||||
This is a regression test for the AttributeError that occurred when
|
||||
old was None and we tried to access old.loaded_integrations.
|
||||
"""
|
||||
# Setup mocks
|
||||
mock_storage_path.return_value = "/test/path"
|
||||
mock_storage_json_class.load.return_value = None # Old storage is None
|
||||
|
||||
new_storage = create_storage(loaded_integrations=["api", "wifi"])
|
||||
new_storage.save = MagicMock() # Mock the save method
|
||||
mock_storage_json_class.from_esphome_core.return_value = new_storage
|
||||
|
||||
# Call the function - should not raise AttributeError
|
||||
with caplog.at_level("INFO"):
|
||||
update_storage_json()
|
||||
|
||||
# Verify clean_build was called
|
||||
mock_clean_build.assert_called_once()
|
||||
|
||||
# Verify the correct log message was used (not the component removal message)
|
||||
assert "Core config or version changed, cleaning build files..." in caplog.text
|
||||
assert "Components removed" not in caplog.text
|
||||
|
||||
# Verify save was called
|
||||
new_storage.save.assert_called_once_with("/test/path")
|
||||
|
||||
|
||||
@patch("esphome.writer.clean_build")
|
||||
@patch("esphome.writer.StorageJSON")
|
||||
@patch("esphome.writer.storage_path")
|
||||
@patch("esphome.writer.CORE")
|
||||
def test_update_storage_json_logging_components_removed(
|
||||
mock_core: MagicMock,
|
||||
mock_storage_path: MagicMock,
|
||||
mock_storage_json_class: MagicMock,
|
||||
mock_clean_build: MagicMock,
|
||||
create_storage: Callable[..., StorageJSON],
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Test that update_storage_json logs removed components correctly."""
|
||||
# Setup mocks
|
||||
mock_storage_path.return_value = "/test/path"
|
||||
|
||||
old_storage = create_storage(loaded_integrations=["api", "wifi", "bluetooth_proxy"])
|
||||
new_storage = create_storage(loaded_integrations=["api", "wifi"])
|
||||
new_storage.save = MagicMock() # Mock the save method
|
||||
|
||||
mock_storage_json_class.load.return_value = old_storage
|
||||
mock_storage_json_class.from_esphome_core.return_value = new_storage
|
||||
|
||||
# Call the function
|
||||
with caplog.at_level("INFO"):
|
||||
update_storage_json()
|
||||
|
||||
# Verify clean_build was called
|
||||
mock_clean_build.assert_called_once()
|
||||
|
||||
# Verify the correct log message was used with component names
|
||||
assert (
|
||||
"Components removed (bluetooth_proxy), cleaning build files..." in caplog.text
|
||||
)
|
||||
assert "Core config or version changed" not in caplog.text
|
||||
|
||||
# Verify save was called
|
||||
new_storage.save.assert_called_once_with("/test/path")
|
||||
Reference in New Issue
Block a user