mirror of
https://github.com/esphome/esphome.git
synced 2026-10-10 13:33:06 +00:00
79 lines
2.7 KiB
Python
79 lines
2.7 KiB
Python
"""Tests for esphome.build_helpers.ninja."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
from pathlib import Path
|
|
import sys
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from esphome.build_helpers import ninja as ninja_helper
|
|
from esphome.core import EsphomeError
|
|
|
|
|
|
def test_find_ninja_prefers_path(tmp_path: Path) -> None:
|
|
with patch("shutil.which", return_value=str(tmp_path / "ninja")):
|
|
assert ninja_helper.find_ninja() == tmp_path / "ninja"
|
|
|
|
|
|
def test_find_ninja_falls_back_to_wheel(tmp_path: Path) -> None:
|
|
"""Without a PATH entry, the ninja PyPI wheel's binary is used."""
|
|
binary_name = "ninja.exe" if os.name == "nt" else "ninja"
|
|
(tmp_path / binary_name).touch()
|
|
wheel = MagicMock(BIN_DIR=str(tmp_path))
|
|
with (
|
|
patch("shutil.which", return_value=None),
|
|
patch.dict(sys.modules, {"ninja": wheel}),
|
|
):
|
|
assert ninja_helper.find_ninja() == tmp_path / binary_name
|
|
|
|
|
|
def test_find_ninja_package_not_installed() -> None:
|
|
"""A missing ninja package raises the actionable message, not ImportError."""
|
|
with (
|
|
patch("shutil.which", return_value=None),
|
|
patch.dict(sys.modules, {"ninja": None}),
|
|
pytest.raises(EsphomeError, match="ninja not found"),
|
|
):
|
|
ninja_helper.find_ninja()
|
|
|
|
|
|
def test_find_ninja_missing_everywhere(tmp_path: Path) -> None:
|
|
wheel = MagicMock(BIN_DIR=str(tmp_path))
|
|
with (
|
|
patch("shutil.which", return_value=None),
|
|
patch.dict(sys.modules, {"ninja": wheel}),
|
|
pytest.raises(EsphomeError, match="ninja not found"),
|
|
):
|
|
ninja_helper.find_ninja()
|
|
|
|
|
|
def test_escape_ninja_specials() -> None:
|
|
assert ninja_helper.escape("a b:c$d") == "a$ b$:c$$d"
|
|
|
|
|
|
def test_quote_arg_windows_argv_rule() -> None:
|
|
# Backslash runs double only before a quote (subprocess.list2cmdline rule)
|
|
assert ninja_helper.quote_arg('-DX=a\\"b c') == '"-DX=a\\\\\\"b c"'
|
|
assert ninja_helper.quote_arg("a b\\") == '"a b\\\\"'
|
|
|
|
|
|
def test_shell_token_quotes_only_when_needed() -> None:
|
|
assert ninja_helper.shell_token("-Os") == "-Os"
|
|
assert ninja_helper.shell_token("-DP=C:\\x y") == '"-DP=C:\\x y"'
|
|
assert ninja_helper.shell_token("plain", force=True) == '"plain"'
|
|
|
|
|
|
def test_shell_token_quotes_shell_metacharacters() -> None:
|
|
"""Tokens like -DMASK=(1<<3) must not reach /bin/sh -c bare."""
|
|
assert ninja_helper.shell_token("-DMASK=(1<<3)") == '"-DMASK=(1<<3)"'
|
|
assert ninja_helper.shell_token("-DX=a;b") == '"-DX=a;b"'
|
|
assert ninja_helper.shell_token("-DX=$HOME") == '"-DX=$$HOME"'
|
|
|
|
|
|
def test_quote_path_force_quotes() -> None:
|
|
assert ninja_helper.quote_path(Path("a b")) == '"a b"'
|
|
assert ninja_helper.quote_path("simple") == '"simple"'
|