mirror of
https://github.com/home-assistant/core
synced 2024-10-04 20:02:40 +00:00
05fc7cfbde
* Enforce namespace use for import conventions
* Include all registries
* Only apply to functions
* Use blacklist
* Rephrase comment
* Add async_entries_for_config_entry
* Typo
* Improve
* More core files
* Revert "More core files"
This reverts commit 9978b93706.
* Revert diagnostics amends
* Include category/floor/label registries
* Performance
* Adjust text
312 lines
8.9 KiB
Python
312 lines
8.9 KiB
Python
"""Tests for pylint hass_imports plugin."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import astroid
|
|
from pylint.checkers import BaseChecker
|
|
import pylint.testutils
|
|
from pylint.testutils.unittest_linter import UnittestLinter
|
|
import pytest
|
|
|
|
from . import assert_adds_messages, assert_no_messages
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("module_name", "import_from", "import_what"),
|
|
[
|
|
(
|
|
"homeassistant.components.pylint_test.sensor",
|
|
"homeassistant.const",
|
|
"CONSTANT",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.sensor",
|
|
"homeassistant.components.pylint_testing",
|
|
"CONSTANT",
|
|
),
|
|
("homeassistant.components.pylint_test.sensor", ".const", "CONSTANT"),
|
|
("homeassistant.components.pylint_test.sensor", ".", "CONSTANT"),
|
|
("homeassistant.components.pylint_test.sensor", "..", "pylint_test"),
|
|
(
|
|
"homeassistant.components.pylint_test.api.hub",
|
|
"homeassistant.const",
|
|
"CONSTANT",
|
|
),
|
|
("homeassistant.components.pylint_test.api.hub", "..const", "CONSTANT"),
|
|
("homeassistant.components.pylint_test.api.hub", "..", "CONSTANT"),
|
|
("homeassistant.components.pylint_test.api.hub", "...", "pylint_test"),
|
|
("tests.components.pylint_test.api.hub", "..const", "CONSTANT"),
|
|
],
|
|
)
|
|
def test_good_import(
|
|
linter: UnittestLinter,
|
|
imports_checker: BaseChecker,
|
|
module_name: str,
|
|
import_from: str,
|
|
import_what: str,
|
|
) -> None:
|
|
"""Ensure good imports pass through ok."""
|
|
|
|
import_node = astroid.extract_node(
|
|
f"from {import_from} import {import_what} #@",
|
|
module_name,
|
|
)
|
|
imports_checker.visit_module(import_node.parent)
|
|
|
|
with assert_no_messages(linter):
|
|
imports_checker.visit_importfrom(import_node)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("module_name", "import_from", "import_what", "error_code"),
|
|
[
|
|
(
|
|
"homeassistant.components.pylint_test.sensor",
|
|
"homeassistant.components.pylint_test.const",
|
|
"CONSTANT",
|
|
"hass-relative-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.sensor",
|
|
"..const",
|
|
"CONSTANT",
|
|
"hass-absolute-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.sensor",
|
|
"...const",
|
|
"CONSTANT",
|
|
"hass-absolute-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.api.hub",
|
|
"homeassistant.components.pylint_test.api.const",
|
|
"CONSTANT",
|
|
"hass-relative-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.api.hub",
|
|
"...const",
|
|
"CONSTANT",
|
|
"hass-absolute-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.api.hub",
|
|
"homeassistant.components",
|
|
"pylint_test",
|
|
"hass-relative-import",
|
|
),
|
|
(
|
|
"homeassistant.components.pylint_test.api.hub",
|
|
"homeassistant.components.pylint_test.const",
|
|
"CONSTANT",
|
|
"hass-relative-import",
|
|
),
|
|
(
|
|
"tests.components.pylint_test.api.hub",
|
|
"tests.components.pylint_test.const",
|
|
"CONSTANT",
|
|
"hass-relative-import",
|
|
),
|
|
(
|
|
"tests.components.pylint_test.api.hub",
|
|
"...const",
|
|
"CONSTANT",
|
|
"hass-absolute-import",
|
|
),
|
|
],
|
|
)
|
|
def test_bad_import(
|
|
linter: UnittestLinter,
|
|
imports_checker: BaseChecker,
|
|
module_name: str,
|
|
import_from: str,
|
|
import_what: str,
|
|
error_code: str,
|
|
) -> None:
|
|
"""Ensure bad imports are rejected."""
|
|
|
|
import_node = astroid.extract_node(
|
|
f"from {import_from} import {import_what} #@",
|
|
module_name,
|
|
)
|
|
imports_checker.visit_module(import_node.parent)
|
|
|
|
with assert_adds_messages(
|
|
linter,
|
|
pylint.testutils.MessageTest(
|
|
msg_id=error_code,
|
|
node=import_node,
|
|
args=None,
|
|
line=1,
|
|
col_offset=0,
|
|
end_line=1,
|
|
end_col_offset=len(import_from) + len(import_what) + 13,
|
|
),
|
|
):
|
|
imports_checker.visit_importfrom(import_node)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("import_node", "module_name"),
|
|
[
|
|
(
|
|
"from homeassistant.components import climate",
|
|
"homeassistant.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.climate import ClimateEntityFeature",
|
|
"homeassistant.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.pylint_test import const",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.pylint_test.const import CONSTANT",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"import homeassistant.components.pylint_test.const as climate",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
],
|
|
)
|
|
def test_good_root_import(
|
|
linter: UnittestLinter,
|
|
imports_checker: BaseChecker,
|
|
import_node: str,
|
|
module_name: str,
|
|
) -> None:
|
|
"""Ensure bad root imports are rejected."""
|
|
|
|
node = astroid.extract_node(
|
|
f"{import_node} #@",
|
|
module_name,
|
|
)
|
|
imports_checker.visit_module(node.parent)
|
|
|
|
with assert_no_messages(linter):
|
|
if import_node.startswith("import"):
|
|
imports_checker.visit_import(node)
|
|
if import_node.startswith("from"):
|
|
imports_checker.visit_importfrom(node)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("import_node", "module_name"),
|
|
[
|
|
(
|
|
"import homeassistant.components.climate.const as climate",
|
|
"homeassistant.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.climate import const",
|
|
"homeassistant.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.climate.const import ClimateEntityFeature",
|
|
"homeassistant.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.climate import const",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"from homeassistant.components.climate.const import CONSTANT",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
(
|
|
"import homeassistant.components.climate.const as climate",
|
|
"tests.components.pylint_test.climate",
|
|
),
|
|
],
|
|
)
|
|
def test_bad_root_import(
|
|
linter: UnittestLinter,
|
|
imports_checker: BaseChecker,
|
|
import_node: str,
|
|
module_name: str,
|
|
) -> None:
|
|
"""Ensure bad root imports are rejected."""
|
|
|
|
node = astroid.extract_node(
|
|
f"{import_node} #@",
|
|
module_name,
|
|
)
|
|
imports_checker.visit_module(node.parent)
|
|
|
|
with assert_adds_messages(
|
|
linter,
|
|
pylint.testutils.MessageTest(
|
|
msg_id="hass-component-root-import",
|
|
node=node,
|
|
args=None,
|
|
line=1,
|
|
col_offset=0,
|
|
end_line=1,
|
|
end_col_offset=len(import_node),
|
|
),
|
|
):
|
|
if import_node.startswith("import"):
|
|
imports_checker.visit_import(node)
|
|
if import_node.startswith("from"):
|
|
imports_checker.visit_importfrom(node)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("import_node", "module_name", "expected_args"),
|
|
[
|
|
(
|
|
"from homeassistant.helpers.issue_registry import async_get",
|
|
"tests.components.pylint_test.climate",
|
|
(
|
|
"async_get",
|
|
"homeassistant.helpers.issue_registry",
|
|
"ir",
|
|
"ir",
|
|
"async_get",
|
|
),
|
|
),
|
|
(
|
|
"from homeassistant.helpers.issue_registry import async_get as async_get_issue_registry",
|
|
"tests.components.pylint_test.climate",
|
|
(
|
|
"async_get",
|
|
"homeassistant.helpers.issue_registry",
|
|
"ir",
|
|
"ir",
|
|
"async_get",
|
|
),
|
|
),
|
|
],
|
|
)
|
|
def test_bad_namespace_import(
|
|
linter: UnittestLinter,
|
|
imports_checker: BaseChecker,
|
|
import_node: str,
|
|
module_name: str,
|
|
expected_args: tuple[str, ...],
|
|
) -> None:
|
|
"""Ensure bad namespace imports are rejected."""
|
|
|
|
node = astroid.extract_node(
|
|
f"{import_node} #@",
|
|
module_name,
|
|
)
|
|
imports_checker.visit_module(node.parent)
|
|
|
|
with assert_adds_messages(
|
|
linter,
|
|
pylint.testutils.MessageTest(
|
|
msg_id="hass-helper-namespace-import",
|
|
node=node,
|
|
args=expected_args,
|
|
line=1,
|
|
col_offset=0,
|
|
end_line=1,
|
|
end_col_offset=len(import_node),
|
|
),
|
|
):
|
|
imports_checker.visit_importfrom(node)
|