mirror of
https://github.com/esphome/esphome.git
synced 2026-06-24 15:10:51 +00:00
102 lines
3.3 KiB
Python
102 lines
3.3 KiB
Python
"""Unit tests for script/merge_component_configs.py deduplication."""
|
|
|
|
from pathlib import Path
|
|
import sys
|
|
|
|
import pytest
|
|
|
|
# Add the script directory to Python path so we can import the module
|
|
sys.path.insert(0, str((Path(__file__).parent / ".." / ".." / "script").resolve()))
|
|
|
|
import merge_component_configs # noqa: E402
|
|
|
|
deduplicate_by_id = merge_component_configs.deduplicate_by_id
|
|
|
|
|
|
def test_identical_duplicate_ids_collapse() -> None:
|
|
"""Two identical items sharing an id collapse to one without error."""
|
|
data = {
|
|
"sensor": [
|
|
{"id": "shared", "platform": "template", "name": "A"},
|
|
{"id": "shared", "platform": "template", "name": "A"},
|
|
]
|
|
}
|
|
result = deduplicate_by_id(data)
|
|
assert result["sensor"] == [{"id": "shared", "platform": "template", "name": "A"}]
|
|
|
|
|
|
def test_conflicting_duplicate_ids_raise() -> None:
|
|
"""Two different items sharing an id is a hard error naming the id."""
|
|
data = {
|
|
"sensor": [
|
|
{"id": "dup", "platform": "template", "name": "A"},
|
|
{"id": "dup", "platform": "template", "name": "B"},
|
|
]
|
|
}
|
|
with pytest.raises(ValueError, match="dup"):
|
|
deduplicate_by_id(data)
|
|
|
|
|
|
def test_intentionally_shared_id_does_not_raise() -> None:
|
|
"""An allowlisted (section, id) may differ across components and collapse."""
|
|
section, id_ = "time", "sntp_time"
|
|
assert (section, id_) in merge_component_configs.INTENTIONALLY_SHARED_IDS
|
|
data = {
|
|
section: [
|
|
{"id": id_, "platform": "sntp"},
|
|
{"id": id_, "platform": "sntp", "servers": ["a"]},
|
|
]
|
|
}
|
|
result = deduplicate_by_id(data)
|
|
# First occurrence wins, no error raised
|
|
assert result[section] == [{"id": id_, "platform": "sntp"}]
|
|
|
|
|
|
def test_allowlisted_id_in_other_section_still_raises() -> None:
|
|
"""The allowlist is keyed on (section, id): the same id elsewhere conflicts."""
|
|
data = {
|
|
"sensor": [
|
|
{"id": "sntp_time", "platform": "a"},
|
|
{"id": "sntp_time", "platform": "b"},
|
|
]
|
|
}
|
|
with pytest.raises(ValueError, match="sntp_time"):
|
|
deduplicate_by_id(data)
|
|
|
|
|
|
def test_items_without_id_are_preserved() -> None:
|
|
"""Items lacking an id are passed through untouched."""
|
|
data = {"binary_sensor": [{"platform": "gpio"}, {"platform": "gpio"}]}
|
|
result = deduplicate_by_id(data)
|
|
assert result["binary_sensor"] == [{"platform": "gpio"}, {"platform": "gpio"}]
|
|
|
|
|
|
def test_comparison_is_type_sensitive() -> None:
|
|
"""Comparison matches the merge exactly: 5 and "5" are a conflict.
|
|
|
|
The duplicate-id CI guard reuses this function, so a looser (e.g. string
|
|
normalized) comparison would let the guard disagree with the build.
|
|
"""
|
|
data = {
|
|
"sensor": [
|
|
{"id": "dup", "platform": "adc", "pin": 5},
|
|
{"id": "dup", "platform": "adc", "pin": "5"},
|
|
]
|
|
}
|
|
with pytest.raises(ValueError, match="dup"):
|
|
deduplicate_by_id(data)
|
|
|
|
|
|
def test_nested_lists_are_checked() -> None:
|
|
"""Conflicts nested inside dict values are also detected."""
|
|
data = {
|
|
"wrapper": {
|
|
"sensor": [
|
|
{"id": "dup", "value": 1},
|
|
{"id": "dup", "value": 2},
|
|
]
|
|
}
|
|
}
|
|
with pytest.raises(ValueError, match="dup"):
|
|
deduplicate_by_id(data)
|