Skip external component updates when running logs command (#10756)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

tests/component_tests/conftest.py

@@ -6,6 +6,7 @@ from collections.abc import Callable, Generator
 from pathlib import Path
 import sys
 from typing import Any
+from unittest import mock
 
 import pytest
 
@@ -17,6 +18,7 @@ from esphome.const import (
     PlatformFramework,
 )
 from esphome.types import ConfigType
+from esphome.util import OrderedDict
 
 # Add package root to python path
 here = Path(__file__).parent
@@ -135,3 +137,29 @@ def generate_main() -> Generator[Callable[[str | Path], str]]:
         return CORE.cpp_main_section
 
     yield generator
+
+
+@pytest.fixture
+def mock_clone_or_update() -> Generator[Any]:
+    """Mock git.clone_or_update for testing."""
+    with mock.patch("esphome.git.clone_or_update") as mock_func:
+        # Default return value
+        mock_func.return_value = (Path("/tmp/test"), None)
+        yield mock_func
+
+
+@pytest.fixture
+def mock_load_yaml() -> Generator[Any]:
+    """Mock yaml_util.load_yaml for testing."""
+
+    with mock.patch("esphome.yaml_util.load_yaml") as mock_func:
+        # Default return value
+        mock_func.return_value = OrderedDict({"sensor": []})
+        yield mock_func
+
+
+@pytest.fixture
+def mock_install_meta_finder() -> Generator[Any]:
+    """Mock loader.install_meta_finder for testing."""
+    with mock.patch("esphome.loader.install_meta_finder") as mock_func:
+        yield mock_func

tests/component_tests/external_components/test_init.py

@@ -0,0 +1,134 @@
+"""Tests for the external_components skip_update functionality."""
+
+from pathlib import Path
+from typing import Any
+from unittest.mock import MagicMock
+
+from esphome.components.external_components import do_external_components_pass
+from esphome.const import (
+    CONF_EXTERNAL_COMPONENTS,
+    CONF_REFRESH,
+    CONF_SOURCE,
+    CONF_URL,
+    TYPE_GIT,
+)
+
+
+def test_external_components_skip_update_true(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_install_meta_finder: MagicMock
+) -> None:
+    """Test that external components don't update when skip_update=True."""
+    # Create a components directory structure
+    components_dir = tmp_path / "components"
+    components_dir.mkdir()
+
+    # Create a test component
+    test_component_dir = components_dir / "test_component"
+    test_component_dir.mkdir()
+    (test_component_dir / "__init__.py").write_text("# Test component")
+
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    config: dict[str, Any] = {
+        CONF_EXTERNAL_COMPONENTS: [
+            {
+                CONF_SOURCE: {
+                    "type": TYPE_GIT,
+                    CONF_URL: "https://github.com/test/components",
+                },
+                CONF_REFRESH: "1d",
+                "components": "all",
+            }
+        ]
+    }
+
+    # Call with skip_update=True
+    do_external_components_pass(config, skip_update=True)
+
+    # Verify clone_or_update was called with NEVER_REFRESH
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome import git
+
+    assert call_args.kwargs["refresh"] == git.NEVER_REFRESH
+
+
+def test_external_components_skip_update_false(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_install_meta_finder: MagicMock
+) -> None:
+    """Test that external components update when skip_update=False."""
+    # Create a components directory structure
+    components_dir = tmp_path / "components"
+    components_dir.mkdir()
+
+    # Create a test component
+    test_component_dir = components_dir / "test_component"
+    test_component_dir.mkdir()
+    (test_component_dir / "__init__.py").write_text("# Test component")
+
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    config: dict[str, Any] = {
+        CONF_EXTERNAL_COMPONENTS: [
+            {
+                CONF_SOURCE: {
+                    "type": TYPE_GIT,
+                    CONF_URL: "https://github.com/test/components",
+                },
+                CONF_REFRESH: "1d",
+                "components": "all",
+            }
+        ]
+    }
+
+    # Call with skip_update=False
+    do_external_components_pass(config, skip_update=False)
+
+    # Verify clone_or_update was called with actual refresh value
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome.core import TimePeriodSeconds
+
+    assert call_args.kwargs["refresh"] == TimePeriodSeconds(days=1)
+
+
+def test_external_components_default_no_skip(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_install_meta_finder: MagicMock
+) -> None:
+    """Test that external components update by default when skip_update not specified."""
+    # Create a components directory structure
+    components_dir = tmp_path / "components"
+    components_dir.mkdir()
+
+    # Create a test component
+    test_component_dir = components_dir / "test_component"
+    test_component_dir.mkdir()
+    (test_component_dir / "__init__.py").write_text("# Test component")
+
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    config: dict[str, Any] = {
+        CONF_EXTERNAL_COMPONENTS: [
+            {
+                CONF_SOURCE: {
+                    "type": TYPE_GIT,
+                    CONF_URL: "https://github.com/test/components",
+                },
+                CONF_REFRESH: "1d",
+                "components": "all",
+            }
+        ]
+    }
+
+    # Call without skip_update parameter
+    do_external_components_pass(config)
+
+    # Verify clone_or_update was called with actual refresh value
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome.core import TimePeriodSeconds
+
+    assert call_args.kwargs["refresh"] == TimePeriodSeconds(days=1)

tests/component_tests/packages/test_init.py

@@ -0,0 +1,114 @@
+"""Tests for the packages component skip_update functionality."""
+
+from pathlib import Path
+from typing import Any
+from unittest.mock import MagicMock
+
+from esphome.components.packages import do_packages_pass
+from esphome.const import CONF_FILES, CONF_PACKAGES, CONF_REFRESH, CONF_URL
+from esphome.util import OrderedDict
+
+
+def test_packages_skip_update_true(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_load_yaml: MagicMock
+) -> None:
+    """Test that packages don't update when skip_update=True."""
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    # Create the test yaml file
+    test_file = tmp_path / "test.yaml"
+    test_file.write_text("sensor: []")
+
+    # Set mock_load_yaml to return some valid config
+    mock_load_yaml.return_value = OrderedDict({"sensor": []})
+
+    config: dict[str, Any] = {
+        CONF_PACKAGES: {
+            "test_package": {
+                CONF_URL: "https://github.com/test/repo",
+                CONF_FILES: ["test.yaml"],
+                CONF_REFRESH: "1d",
+            }
+        }
+    }
+
+    # Call with skip_update=True
+    do_packages_pass(config, skip_update=True)
+
+    # Verify clone_or_update was called with NEVER_REFRESH
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome import git
+
+    assert call_args.kwargs["refresh"] == git.NEVER_REFRESH
+
+
+def test_packages_skip_update_false(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_load_yaml: MagicMock
+) -> None:
+    """Test that packages update when skip_update=False."""
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    # Create the test yaml file
+    test_file = tmp_path / "test.yaml"
+    test_file.write_text("sensor: []")
+
+    # Set mock_load_yaml to return some valid config
+    mock_load_yaml.return_value = OrderedDict({"sensor": []})
+
+    config: dict[str, Any] = {
+        CONF_PACKAGES: {
+            "test_package": {
+                CONF_URL: "https://github.com/test/repo",
+                CONF_FILES: ["test.yaml"],
+                CONF_REFRESH: "1d",
+            }
+        }
+    }
+
+    # Call with skip_update=False (default)
+    do_packages_pass(config, skip_update=False)
+
+    # Verify clone_or_update was called with actual refresh value
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome.core import TimePeriodSeconds
+
+    assert call_args.kwargs["refresh"] == TimePeriodSeconds(days=1)
+
+
+def test_packages_default_no_skip(
+    tmp_path: Path, mock_clone_or_update: MagicMock, mock_load_yaml: MagicMock
+) -> None:
+    """Test that packages update by default when skip_update not specified."""
+    # Set up mock to return our tmp_path
+    mock_clone_or_update.return_value = (tmp_path, None)
+
+    # Create the test yaml file
+    test_file = tmp_path / "test.yaml"
+    test_file.write_text("sensor: []")
+
+    # Set mock_load_yaml to return some valid config
+    mock_load_yaml.return_value = OrderedDict({"sensor": []})
+
+    config: dict[str, Any] = {
+        CONF_PACKAGES: {
+            "test_package": {
+                CONF_URL: "https://github.com/test/repo",
+                CONF_FILES: ["test.yaml"],
+                CONF_REFRESH: "1d",
+            }
+        }
+    }
+
+    # Call without skip_update parameter
+    do_packages_pass(config)
+
+    # Verify clone_or_update was called with actual refresh value
+    mock_clone_or_update.assert_called_once()
+    call_args = mock_clone_or_update.call_args
+    from esphome.core import TimePeriodSeconds
+
+    assert call_args.kwargs["refresh"] == TimePeriodSeconds(days=1)