core/tests/pylint/test_runtime_data.py

"""Tests for pylint hass_enforce_runtime_data plugin."""

from pathlib import Path

import astroid
from pylint.checkers import BaseChecker
from pylint.testutils.unittest_linter import UnittestLinter
import pytest

from . import assert_no_messages, walk_checker


@pytest.mark.parametrize(
    ("code", "module_name"),
    [
        pytest.param(
            """
        hass.data[DATA_KEY] = some_value
        """,
            "homeassistant.components.test",
            id="non_domain_key",
        ),
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "some.other.module",
            id="outside_components",
        ),
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "homeassistant.components.test.config_flow",
            id="config_flow",
        ),
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "homeassistant.components.test.const",
            id="const",
        ),
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "homeassistant.components.test.diagnostics",
            id="diagnostics",
        ),
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "homeassistant.components.test.application_credentials",
            id="application_credentials",
        ),
        pytest.param(
            """
        async def async_unload_entry(hass, entry):
            hass.data[DOMAIN].pop(entry.entry_id)
        """,
            "homeassistant.components.test",
            id="async_unload_entry",
        ),
        pytest.param(
            """
        async def async_remove_entry(hass, entry):
            hass.data[DOMAIN].pop(entry.entry_id)
        """,
            "homeassistant.components.test",
            id="async_remove_entry",
        ),
        pytest.param(
            """
        async def async_migrate_entry(hass, entry):
            old = hass.data[DOMAIN]
        """,
            "homeassistant.components.test",
            id="async_migrate_entry",
        ),
        pytest.param(
            """
        del hass.data[DOMAIN]
        """,
            "homeassistant.components.test",
            id="del_hass_data",
        ),
        pytest.param(
            """
        hass.data[DOMAIN].pop(entry.entry_id)
        """,
            "homeassistant.components.test",
            id="pop_from_hass_data",
        ),
        pytest.param(
            """
        hass.data.pop(DOMAIN)
        """,
            "homeassistant.components.test",
            id="pop_hass_data_domain",
        ),
        pytest.param(
            """
        if DOMAIN in hass.data:
            pass
        """,
            "homeassistant.components.test",
            id="domain_in_hass_data",
        ),
        pytest.param(
            """
        hass.data.setdefault(OTHER_KEY, {})
        """,
            "homeassistant.components.test",
            id="setdefault_non_domain_key",
        ),
    ],
)
def test_enforce_runtime_data(
    linter: UnittestLinter,
    enforce_runtime_data_checker: BaseChecker,
    code: str,
    module_name: str,
) -> None:
    """Good test cases."""
    root_node = astroid.parse(code, module_name)

    with assert_no_messages(linter):
        walk_checker(linter, enforce_runtime_data_checker, root_node)


@pytest.mark.parametrize(
    ("code", "module_name"),
    [
        pytest.param(
            """
        hass.data[DOMAIN] = some_value
        """,
            "homeassistant.components.test",
            id="init_hass_data_domain",
        ),
        pytest.param(
            """
        hass.data[DOMAIN][entry.entry_id] = some_value
        """,
            "homeassistant.components.test",
            id="init_hass_data_domain_nested",
        ),
        pytest.param(
            """
        value = hass.data[DOMAIN]
        """,
            "homeassistant.components.test.sensor",
            id="sensor_hass_data_domain",
        ),
        pytest.param(
            """
        value = self.hass.data[DOMAIN]
        """,
            "homeassistant.components.test.sensor",
            id="self_hass_data_domain",
        ),
        pytest.param(
            """
        async def async_setup_entry(hass, entry):
            hass.data[DOMAIN] = {}
        """,
            "homeassistant.components.test",
            id="async_setup_entry",
        ),
        pytest.param(
            """
        hass.data.setdefault(DOMAIN, {})
        """,
            "homeassistant.components.test",
            id="setdefault_hass_data_domain",
        ),
        pytest.param(
            """
        hass.data.setdefault(DOMAIN, {})[entry.entry_id] = some_value
        """,
            "homeassistant.components.test",
            id="setdefault_hass_data_domain_nested",
        ),
        pytest.param(
            """
        value = hass.data.get(DOMAIN)
        """,
            "homeassistant.components.test.sensor",
            id="get_hass_data_domain",
        ),
        pytest.param(
            """
        value = self.hass.data.setdefault(DOMAIN, {})
        """,
            "homeassistant.components.test.coordinator",
            id="self_setdefault_hass_data_domain",
        ),
    ],
)
def test_enforce_runtime_data_bad(
    linter: UnittestLinter,
    enforce_runtime_data_checker: BaseChecker,
    code: str,
    module_name: str,
) -> None:
    """Bad test cases."""
    root_node = astroid.parse(code, module_name)

    walk_checker(linter, enforce_runtime_data_checker, root_node)
    messages = linter.release_messages()
    assert len(messages) == 1
    assert messages[0].msg_id == "home-assistant-use-runtime-data"


def test_enforce_runtime_data_no_config_flow(
    linter: UnittestLinter,
    enforce_runtime_data_checker: BaseChecker,
    tmp_path: Path,
) -> None:
    """Test that integrations without config_flow.py are not flagged."""
    # Create a fake integration directory without config_flow.py
    integration_dir = tmp_path / "homeassistant" / "components" / "yaml_only"
    integration_dir.mkdir(parents=True)
    init_file = integration_dir / "__init__.py"
    init_file.touch()

    code = """
    hass.data[DOMAIN] = some_value
    """
    root_node = astroid.parse(code, "homeassistant.components.yaml_only")
    root_node.file = str(init_file)

    with assert_no_messages(linter):
        walk_checker(linter, enforce_runtime_data_checker, root_node)


def test_enforce_runtime_data_with_config_flow(
    linter: UnittestLinter,
    enforce_runtime_data_checker: BaseChecker,
    tmp_path: Path,
) -> None:
    """Test that integrations with config_flow.py are flagged."""
    # Create a fake integration directory with config_flow.py
    integration_dir = tmp_path / "homeassistant" / "components" / "modern"
    integration_dir.mkdir(parents=True)
    init_file = integration_dir / "__init__.py"
    init_file.touch()
    (integration_dir / "config_flow.py").touch()

    code = """
    hass.data[DOMAIN] = some_value
    """
    root_node = astroid.parse(code, "homeassistant.components.modern")
    root_node.file = str(init_file)

    walk_checker(linter, enforce_runtime_data_checker, root_node)
    messages = linter.release_messages()
    assert len(messages) == 1
    assert messages[0].msg_id == "home-assistant-use-runtime-data"