mirror of
https://github.com/esphome/esphome.git
synced 2026-06-24 12:17:23 +00:00
ce5be77ed6
The `vscode --ace` validator resolves an error's range to the deepest matching node, which for a "Component not found" error is the component's value mapping — so the range starts at the first child, and editors underline the children instead of the offending top-level key. Request the key's range for these errors (as already done for "extra keys not allowed"). Backward compatible: only the range for this error type changes.
162 lines
4.3 KiB
Python
162 lines
4.3 KiB
Python
import json
|
|
from pathlib import Path
|
|
from unittest.mock import Mock, patch
|
|
|
|
from esphome import vscode
|
|
|
|
|
|
def _run_repl_test(input_data):
|
|
"""Reusable test function for different input scenarios."""
|
|
input_data.append(_exit())
|
|
with (
|
|
patch("builtins.input", side_effect=input_data),
|
|
patch("sys.stdout") as mock_stdout,
|
|
):
|
|
args = Mock([])
|
|
args.ace = False
|
|
args.substitution = None
|
|
vscode.read_config(args)
|
|
|
|
# Capture printed output
|
|
full_output = "".join(
|
|
call[0][0] for call in mock_stdout.write.call_args_list
|
|
).strip()
|
|
splitted_output = full_output.split("\n")
|
|
return splitted_output[1:] # remove first entry with version info
|
|
|
|
|
|
def _validate(file_path: str):
|
|
return json.dumps({"type": "validate", "file": file_path})
|
|
|
|
|
|
def _file_response(data: str):
|
|
return json.dumps({"type": "file_response", "content": data})
|
|
|
|
|
|
def _read_file(file_path: str):
|
|
return json.dumps({"type": "read_file", "path": file_path})
|
|
|
|
|
|
def _exit():
|
|
return json.dumps({"type": "exit"})
|
|
|
|
|
|
RESULT_NO_ERROR = '{"type": "result", "yaml_errors": [], "validation_errors": []}'
|
|
|
|
|
|
def test_multi_file():
|
|
source_path = str(Path("dir_path", "x.yaml"))
|
|
output_lines = _run_repl_test(
|
|
[
|
|
_validate(source_path),
|
|
# read_file x.yaml
|
|
_file_response("""esphome:
|
|
name: test1
|
|
esp8266:
|
|
board: !secret my_secret_board
|
|
"""),
|
|
# read_file secrets.yaml
|
|
_file_response("""my_secret_board: esp1f"""),
|
|
]
|
|
)
|
|
|
|
expected_lines = [
|
|
_read_file(source_path),
|
|
_read_file(str(Path("dir_path", "secrets.yaml"))),
|
|
RESULT_NO_ERROR,
|
|
]
|
|
|
|
assert output_lines == expected_lines
|
|
|
|
|
|
def test_shows_correct_range_error():
|
|
source_path = str(Path("dir_path", "x.yaml"))
|
|
output_lines = _run_repl_test(
|
|
[
|
|
_validate(source_path),
|
|
# read_file x.yaml
|
|
_file_response("""esphome:
|
|
name: test1
|
|
esp8266:
|
|
broad: !secret my_secret_board # typo here
|
|
"""),
|
|
# read_file secrets.yaml
|
|
_file_response("""my_secret_board: esp1f"""),
|
|
]
|
|
)
|
|
|
|
assert len(output_lines) == 3
|
|
error = json.loads(output_lines[2])
|
|
validation_error = error["validation_errors"][0]
|
|
assert validation_error["message"].startswith("[broad] is an invalid option for")
|
|
range = validation_error["range"]
|
|
assert range["document"] == source_path
|
|
assert range["start_line"] == 3
|
|
assert range["start_col"] == 2
|
|
assert range["end_line"] == 3
|
|
assert range["end_col"] == 7
|
|
|
|
|
|
def test_component_not_found_marks_key():
|
|
source_path = str(Path("dir_path", "x.yaml"))
|
|
output_lines = _run_repl_test(
|
|
[
|
|
_validate(source_path),
|
|
# read_file x.yaml
|
|
_file_response("""esphome:
|
|
name: test1
|
|
esp8266:
|
|
board: esp01_1m
|
|
|
|
apccci:
|
|
id: foo
|
|
"""),
|
|
]
|
|
)
|
|
|
|
error = json.loads(output_lines[-1])
|
|
not_found = next(
|
|
e
|
|
for e in error["validation_errors"]
|
|
if e["message"].startswith("Component not found:")
|
|
)
|
|
assert not_found["message"] == "Component not found: apccci."
|
|
# Range covers the ``apccci`` key, not its child mapping.
|
|
range = not_found["range"]
|
|
assert range["document"] == source_path
|
|
assert range["start_line"] == 5
|
|
assert range["start_col"] == 0
|
|
assert range["end_line"] == 5
|
|
assert range["end_col"] == 6
|
|
|
|
|
|
def test_shows_correct_loaded_file_error():
|
|
source_path = str(Path("dir_path", "x.yaml"))
|
|
output_lines = _run_repl_test(
|
|
[
|
|
_validate(source_path),
|
|
# read_file x.yaml
|
|
_file_response("""esphome:
|
|
name: test1
|
|
|
|
packages:
|
|
board: !include .pkg.esp8266.yaml
|
|
"""),
|
|
# read_file .pkg.esp8266.yaml
|
|
_file_response("""esp8266:
|
|
broad: esp1f # typo here
|
|
"""),
|
|
]
|
|
)
|
|
|
|
assert len(output_lines) == 3
|
|
error = json.loads(output_lines[2])
|
|
validation_error = error["validation_errors"][0]
|
|
assert validation_error["message"].startswith("[broad] is an invalid option for")
|
|
range = validation_error["range"]
|
|
assert range["document"] == str(Path("dir_path", ".pkg.esp8266.yaml"))
|
|
assert range["start_line"] == 1
|
|
assert range["start_col"] == 2
|
|
assert range["end_line"] == 1
|
|
assert range["end_col"] == 7
|