mirror of
https://github.com/esphome/esphome.git
synced 2026-09-28 15:30:21 +00:00
J. Nick Koston
0f7cd3fada
shell_token now picks the quoting style per platform: single quotes on POSIX (sh expands nothing inside them, so backslash runs, $VAR, and backticks reach the compiler exactly as lexed, matching SCons's no-shell spawn) and the CreateProcess argv rule on Windows. A test round-trips every case through a real /bin/sh. The ninja and ccache runnability probes collapse into one tool_version_runs helper in framework_helpers. The registry names a non-dict top-level payload like the inner guards, and the expect layout check also runs on marker hits so a marked install that later lost files fails by name. The ESP-IDF ccache gate defers to resolve_ccache_path so ESPHOME_CCACHE_ENABLE=0 disables ccache there too, with IDF_CCACHE_ENABLE still taking precedence.
100 lines
3.5 KiB
Python
100 lines
3.5 KiB
Python
"""Tests for the shared ccache policy in esphome.build_helpers.ccache."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from esphome.build_helpers import ccache
|
|
|
|
|
|
def test_resolve_opt_out() -> None:
|
|
with patch.dict(os.environ, {"ESPHOME_CCACHE_ENABLE": "0"}):
|
|
assert ccache.resolve_ccache_path() is None
|
|
|
|
|
|
def test_resolve_no_binary(caplog: pytest.LogCaptureFixture) -> None:
|
|
with (
|
|
patch.dict(os.environ, {}, clear=True),
|
|
patch("shutil.which", return_value=None),
|
|
):
|
|
assert ccache.resolve_ccache_path() is None
|
|
assert "no ccache binary" not in caplog.text
|
|
|
|
|
|
def test_resolve_probe_failure() -> None:
|
|
with (
|
|
patch.dict(os.environ, {}, clear=True),
|
|
patch("shutil.which", return_value="/usr/bin/ccache"),
|
|
patch("esphome.framework_helpers.subprocess.run", side_effect=OSError("boom")),
|
|
):
|
|
assert ccache.resolve_ccache_path() is None
|
|
|
|
|
|
def test_resolve_explicit_skips_probe_and_warns_missing(
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
with (
|
|
patch.dict(os.environ, {"ESPHOME_CCACHE_ENABLE": "1"}, clear=True),
|
|
patch("shutil.which", return_value="/usr/bin/ccache"),
|
|
patch.object(ccache, "_ccache_runs", side_effect=AssertionError),
|
|
):
|
|
assert ccache.resolve_ccache_path() == "/usr/bin/ccache"
|
|
with (
|
|
patch.dict(os.environ, {"ESPHOME_CCACHE_ENABLE": "1"}, clear=True),
|
|
patch("shutil.which", return_value=None),
|
|
):
|
|
assert ccache.resolve_ccache_path() is None
|
|
assert "no ccache binary is on PATH" in caplog.text
|
|
|
|
|
|
def test_probe_spawns_with_close_fds_false() -> None:
|
|
with patch("esphome.framework_helpers.subprocess.run") as mock_run:
|
|
assert ccache._ccache_runs("/usr/bin/ccache") is True
|
|
assert mock_run.call_args.kwargs["close_fds"] is False
|
|
|
|
|
|
def test_defaults_env(tmp_path: Path) -> None:
|
|
with (
|
|
patch("esphome.core.CORE", SimpleNamespace(build_path=tmp_path / "b")),
|
|
patch.dict(os.environ, {"CCACHE_NOHASHDIR": "false"}, clear=True),
|
|
):
|
|
env = ccache.ccache_defaults_env(tmp_path / "cache")
|
|
assert env["CCACHE_DIR"] == str(tmp_path / "cache")
|
|
assert env["CCACHE_DEPEND"] == "1"
|
|
assert "CCACHE_NOHASHDIR" not in env # user value respected
|
|
|
|
|
|
def test_defaults_env_requires_build_path() -> None:
|
|
with (
|
|
patch("esphome.core.CORE", SimpleNamespace(build_path=None)),
|
|
pytest.raises(ValueError, match="build_path"),
|
|
):
|
|
ccache.ccache_defaults_env(Path("/x"))
|
|
|
|
|
|
@pytest.mark.parametrize("value", ["no", "off", "false", "0"])
|
|
def test_resolve_opt_out_synonyms(value: str) -> None:
|
|
"""Every recognized falsy spelling disables ccache."""
|
|
with patch.dict(os.environ, {"ESPHOME_CCACHE_ENABLE": value}):
|
|
assert ccache.resolve_ccache_path() is None
|
|
|
|
|
|
def test_resolve_unrecognized_value_warns_and_probes(
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""An unparsable ESPHOME_CCACHE_ENABLE is treated as unset: it must not
|
|
silently enable ccache or skip the runnability probe."""
|
|
with (
|
|
patch.dict(os.environ, {"ESPHOME_CCACHE_ENABLE": "enabled"}),
|
|
patch("shutil.which", return_value="/usr/bin/ccache"),
|
|
patch.object(ccache, "_ccache_runs", return_value=False) as mock_probe,
|
|
):
|
|
assert ccache.resolve_ccache_path() is None
|
|
mock_probe.assert_called_once()
|
|
assert "unrecognized ESPHOME_CCACHE_ENABLE" in caplog.text
|