mirror of
https://github.com/esphome/esphome.git
synced 2026-09-27 15:00:24 +00:00
J. Nick Koston
55323596a9
registry_download memoizes per process (failures uncached), so the prefetch and the install share one metadata round-trip per package. The idf ccache env always hands idf.py exactly one canonical spelling: the no-ccache path exports 0 so an unparsable inherited value or a probe-rejected shim cannot enable it, the enabled path exports 1 whatever accepted spelling arrived, and forced-on still runs the resolver for its no-binary warning. An empty env value keeps its historical disable meaning instead of falling to the default policy.
123 lines
4.1 KiB
Python
123 lines
4.1 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
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("raw", "expected"),
|
|
[
|
|
("1", True),
|
|
("enable", True),
|
|
("ON", True),
|
|
("0", False),
|
|
("disable", False),
|
|
("Off", False),
|
|
("maybe", None),
|
|
# ENV KNOB= (Docker/CI) has always read as a disable
|
|
("", False),
|
|
(" ", False),
|
|
],
|
|
)
|
|
def test_parse_enable_env_spelling_tables(
|
|
monkeypatch: pytest.MonkeyPatch, raw: str, expected: bool | None
|
|
) -> None:
|
|
"""cv.boolean's spelling tables plus the 1/0 env convention."""
|
|
monkeypatch.setenv("ESPHOME_CCACHE_ENABLE", raw)
|
|
assert ccache.parse_enable_env("ESPHOME_CCACHE_ENABLE") is expected
|