mirror of
https://github.com/home-assistant/core.git
synced 2025-11-09 10:59:40 +00:00
792 lines
25 KiB
Python
792 lines
25 KiB
Python
"""The test for the sql sensor platform."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import timedelta
|
|
from pathlib import Path
|
|
import sqlite3
|
|
from typing import Any
|
|
from unittest.mock import patch
|
|
|
|
from freezegun.api import FrozenDateTimeFactory
|
|
import pytest
|
|
from sqlalchemy.exc import SQLAlchemyError
|
|
|
|
from homeassistant.components.recorder import CONF_DB_URL, Recorder
|
|
from homeassistant.components.sensor import (
|
|
CONF_STATE_CLASS,
|
|
SensorDeviceClass,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.components.sql.const import (
|
|
CONF_ADVANCED_OPTIONS,
|
|
CONF_COLUMN_NAME,
|
|
CONF_QUERY,
|
|
DOMAIN,
|
|
)
|
|
from homeassistant.components.sql.util import generate_lambda_stmt
|
|
from homeassistant.config_entries import SOURCE_USER
|
|
from homeassistant.const import (
|
|
CONF_DEVICE_CLASS,
|
|
CONF_ICON,
|
|
CONF_NAME,
|
|
CONF_UNIQUE_ID,
|
|
CONF_UNIT_OF_MEASUREMENT,
|
|
CONF_VALUE_TEMPLATE,
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
UnitOfInformation,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import issue_registry as ir
|
|
from homeassistant.setup import async_setup_component
|
|
from homeassistant.util import dt as dt_util
|
|
|
|
from . import (
|
|
YAML_CONFIG,
|
|
YAML_CONFIG_ALL_TEMPLATES,
|
|
YAML_CONFIG_BINARY,
|
|
YAML_CONFIG_FULL_TABLE_SCAN,
|
|
YAML_CONFIG_FULL_TABLE_SCAN_NO_UNIQUE_ID,
|
|
YAML_CONFIG_FULL_TABLE_SCAN_WITH_MULTIPLE_COLUMNS,
|
|
init_integration,
|
|
)
|
|
|
|
from tests.common import MockConfigEntry, async_fire_time_changed
|
|
|
|
|
|
async def test_query_basic(recorder_mock: Recorder, hass: HomeAssistant) -> None:
|
|
"""Test the SQL sensor."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(hass, title="Select value SQL query", options=options)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
|
|
async def test_query_cte(recorder_mock: Recorder, hass: HomeAssistant) -> None:
|
|
"""Test the SQL sensor with CTE."""
|
|
options = {
|
|
CONF_QUERY: "WITH test AS (SELECT 1 AS row_num, 10 AS state) SELECT state FROM test WHERE row_num = 1 LIMIT 1;",
|
|
CONF_COLUMN_NAME: "state",
|
|
}
|
|
await init_integration(hass, title="Select value SQL query CTE", options=options)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query_cte")
|
|
assert state.state == "10"
|
|
assert state.attributes["state"] == 10
|
|
|
|
|
|
async def test_query_value_template(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test the SQL sensor."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5.01 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_ADVANCED_OPTIONS: {
|
|
CONF_VALUE_TEMPLATE: "{{ value | int }}",
|
|
CONF_UNIT_OF_MEASUREMENT: "MiB",
|
|
CONF_DEVICE_CLASS: SensorDeviceClass.DATA_SIZE,
|
|
CONF_STATE_CLASS: SensorStateClass.MEASUREMENT,
|
|
},
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "5"
|
|
assert state.attributes == {
|
|
"device_class": "data_size",
|
|
"friendly_name": "count_tables",
|
|
"state_class": "measurement",
|
|
"unit_of_measurement": "MiB",
|
|
"value": 5.01,
|
|
}
|
|
|
|
|
|
async def test_template_query(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
) -> None:
|
|
"""Test the SQL sensor with a query template."""
|
|
options = {
|
|
CONF_QUERY: "SELECT {% if states('sensor.input1')=='on' %} 5 {% else %} 6 {% endif %} as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_ADVANCED_OPTIONS: {
|
|
CONF_VALUE_TEMPLATE: "{{ value | int }}",
|
|
},
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "6"
|
|
|
|
hass.states.async_set("sensor.input1", "on")
|
|
freezer.tick(timedelta(minutes=1))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "5"
|
|
|
|
|
|
async def test_query_value_template_invalid(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test the SQL sensor."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5.01 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_VALUE_TEMPLATE: "{{ value | dontwork }}",
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "5.01"
|
|
|
|
|
|
async def test_broken_template_query(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
) -> None:
|
|
"""Test the SQL sensor with a query template which is broken."""
|
|
options = {
|
|
CONF_QUERY: "SELECT {{ 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_ADVANCED_OPTIONS: {
|
|
CONF_VALUE_TEMPLATE: "{{ value | int }}",
|
|
},
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert not state
|
|
|
|
|
|
async def test_broken_template_query_2(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test the SQL sensor with a query template."""
|
|
hass.states.async_set("sensor.input1", "5")
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
options = {
|
|
CONF_QUERY: "SELECT {{ states.sensor.input1.state | int / 1000}} as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "0.005"
|
|
|
|
hass.states.async_set("sensor.input1", "on")
|
|
freezer.tick(timedelta(minutes=1))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == "0.005"
|
|
assert (
|
|
"Error rendering query SELECT {{ states.sensor.input1.state | int / 1000}} as value"
|
|
" LIMIT 1;: ValueError: Template error: int got invalid input 'on' when rendering"
|
|
" template 'SELECT {{ states.sensor.input1.state | int / 1000}} as value LIMIT 1;'"
|
|
" but no default was specified" in caplog.text
|
|
)
|
|
|
|
|
|
async def test_query_limit(recorder_mock: Recorder, hass: HomeAssistant) -> None:
|
|
"""Test the SQL sensor with a query containing 'LIMIT' in lowercase."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value limit 1",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(hass, options=options)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
|
|
async def test_query_no_value(
|
|
recorder_mock: Recorder, hass: HomeAssistant, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""Test the SQL sensor with a query that returns no value."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value where 1=2",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
text = "SELECT 5 as value where 1=2 LIMIT 1; returned no results"
|
|
assert text in caplog.text
|
|
|
|
|
|
async def test_query_on_disk_sqlite_no_result(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""Test the SQL sensor with a query that returns no value."""
|
|
db_path = tmp_path / "test.db"
|
|
db_path_str = f"sqlite:///{db_path}"
|
|
|
|
def make_test_db():
|
|
"""Create a test database."""
|
|
conn = sqlite3.connect(db_path)
|
|
conn.execute("CREATE TABLE users (value INTEGER)")
|
|
conn.commit()
|
|
conn.close()
|
|
|
|
await hass.async_add_executor_job(make_test_db)
|
|
|
|
config = {CONF_DB_URL: db_path_str}
|
|
options = {
|
|
CONF_QUERY: "SELECT value from users",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_NAME: "count_users",
|
|
}
|
|
await init_integration(hass, title="count_users", options=options, config=config)
|
|
|
|
state = hass.states.get("sensor.count_users")
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
text = "SELECT value from users LIMIT 1; returned no results"
|
|
assert text in caplog.text
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("url", "expected_patterns", "not_expected_patterns"),
|
|
[
|
|
(
|
|
"sqlite://homeassistant:hunter2@homeassistant.local",
|
|
["sqlite://****:****@homeassistant.local"],
|
|
["sqlite://homeassistant:hunter2@homeassistant.local"],
|
|
),
|
|
(
|
|
"sqlite://homeassistant.local",
|
|
["sqlite://homeassistant.local"],
|
|
[],
|
|
),
|
|
],
|
|
)
|
|
async def test_invalid_url_setup(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
url: str,
|
|
expected_patterns: str,
|
|
not_expected_patterns: str,
|
|
) -> None:
|
|
"""Test invalid db url with redacted credentials."""
|
|
config = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
entry = MockConfigEntry(
|
|
title="count_tables",
|
|
domain=DOMAIN,
|
|
source=SOURCE_USER,
|
|
data={CONF_DB_URL: url},
|
|
options=config,
|
|
entry_id="1",
|
|
version=2,
|
|
)
|
|
|
|
entry.add_to_hass(hass)
|
|
|
|
with patch(
|
|
"homeassistant.components.sql.util.sqlalchemy.create_engine",
|
|
side_effect=SQLAlchemyError(url),
|
|
):
|
|
await hass.config_entries.async_setup(entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
for pattern in not_expected_patterns:
|
|
assert pattern not in caplog.text
|
|
for pattern in expected_patterns:
|
|
assert pattern in caplog.text
|
|
|
|
|
|
async def test_invalid_url_on_update(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test invalid db url with redacted credentials on retry."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
|
|
class MockSession:
|
|
"""Mock session."""
|
|
|
|
def execute(self, query: Any) -> None:
|
|
"""Execute the query."""
|
|
raise SQLAlchemyError("sqlite://homeassistant:hunter2@homeassistant.local")
|
|
|
|
with patch(
|
|
"homeassistant.components.sql.util.scoped_session",
|
|
return_value=MockSession,
|
|
):
|
|
await init_integration(hass, title="count_tables", options=options)
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=1),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
assert "sqlite://****:****@homeassistant.local" in caplog.text
|
|
|
|
|
|
async def test_query_from_yaml(recorder_mock: Recorder, hass: HomeAssistant) -> None:
|
|
"""Test the SQL sensor from yaml config."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.get_value")
|
|
assert state.state == "5"
|
|
|
|
|
|
async def test_templates_with_yaml(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test the SQL sensor from yaml config with templates."""
|
|
|
|
hass.states.async_set("sensor.input1", "on")
|
|
hass.states.async_set("sensor.input2", "on")
|
|
await hass.async_block_till_done()
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG_ALL_TEMPLATES)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.get_values_with_template")
|
|
assert state.state == "5"
|
|
assert state.attributes[CONF_ICON] == "mdi:on"
|
|
assert state.attributes["entity_picture"] == "/local/picture1.jpg"
|
|
|
|
hass.states.async_set("sensor.input1", "off")
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=1),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.get_values_with_template")
|
|
assert state.state == "5"
|
|
assert state.attributes[CONF_ICON] == "mdi:off"
|
|
assert state.attributes["entity_picture"] == "/local/picture2.jpg"
|
|
|
|
hass.states.async_set("sensor.input2", "off")
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=2),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.get_values_with_template")
|
|
assert state.state == STATE_UNAVAILABLE
|
|
assert CONF_ICON not in state.attributes
|
|
assert "entity_picture" not in state.attributes
|
|
|
|
hass.states.async_set("sensor.input1", "on")
|
|
hass.states.async_set("sensor.input2", "on")
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=3),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.get_values_with_template")
|
|
assert state.state == "5"
|
|
assert state.attributes[CONF_ICON] == "mdi:on"
|
|
assert state.attributes["entity_picture"] == "/local/picture1.jpg"
|
|
|
|
|
|
async def test_config_from_old_yaml(
|
|
recorder_mock: Recorder, hass: HomeAssistant, issue_registry: ir.IssueRegistry
|
|
) -> None:
|
|
"""Test the SQL sensor from old yaml config does not create any entity."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "sql",
|
|
CONF_DB_URL: "sqlite://",
|
|
"queries": [
|
|
{
|
|
CONF_NAME: "count_tables",
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
],
|
|
}
|
|
}
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.count_tables")
|
|
assert not state
|
|
issue = issue_registry.async_get_issue(DOMAIN, "sensor_platform_yaml_not_supported")
|
|
assert issue is not None
|
|
assert issue.severity == ir.IssueSeverity.WARNING
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("url", "expected_patterns", "not_expected_patterns"),
|
|
[
|
|
(
|
|
"sqlite://homeassistant:hunter2@homeassistant.local",
|
|
["sqlite://****:****@homeassistant.local"],
|
|
["sqlite://homeassistant:hunter2@homeassistant.local"],
|
|
),
|
|
(
|
|
"sqlite://homeassistant.local",
|
|
["sqlite://homeassistant.local"],
|
|
[],
|
|
),
|
|
],
|
|
)
|
|
async def test_invalid_url_setup_from_yaml(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
url: str,
|
|
expected_patterns: str,
|
|
not_expected_patterns: str,
|
|
) -> None:
|
|
"""Test invalid db url with redacted credentials from yaml setup."""
|
|
config = {
|
|
"sql": {
|
|
CONF_DB_URL: url,
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_NAME: "count_tables",
|
|
}
|
|
}
|
|
|
|
with patch(
|
|
"homeassistant.components.sql.util.sqlalchemy.create_engine",
|
|
side_effect=SQLAlchemyError(url),
|
|
):
|
|
assert await async_setup_component(hass, DOMAIN, config)
|
|
await hass.async_block_till_done()
|
|
|
|
for pattern in not_expected_patterns:
|
|
assert pattern not in caplog.text
|
|
for pattern in expected_patterns:
|
|
assert pattern in caplog.text
|
|
|
|
|
|
async def test_attributes_from_yaml_setup(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test attributes from yaml config."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.get_value")
|
|
|
|
assert state.state == "5"
|
|
assert state.attributes[CONF_DEVICE_CLASS] == SensorDeviceClass.DATA_SIZE
|
|
assert state.attributes[CONF_STATE_CLASS] == SensorStateClass.MEASUREMENT
|
|
assert state.attributes[CONF_UNIT_OF_MEASUREMENT] == UnitOfInformation.MEBIBYTES
|
|
|
|
|
|
async def test_binary_data_from_yaml_setup(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test binary data from yaml config."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG_BINARY)
|
|
await hass.async_block_till_done()
|
|
state = hass.states.get("sensor.get_binary_value")
|
|
assert state.state == "0xd34324324230392032"
|
|
assert state.attributes["test_attr"] == "0xd343aa"
|
|
|
|
|
|
async def test_issue_when_using_old_query(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
issue_registry: ir.IssueRegistry,
|
|
) -> None:
|
|
"""Test we create an issue for an old query that will do a full table scan."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG_FULL_TABLE_SCAN)
|
|
await hass.async_block_till_done()
|
|
assert "Query contains entity_id but does not reference states_meta" in caplog.text
|
|
|
|
assert not hass.states.async_all()
|
|
|
|
config = YAML_CONFIG_FULL_TABLE_SCAN["sql"]
|
|
|
|
unique_id = config[CONF_UNIQUE_ID]
|
|
|
|
issue = issue_registry.async_get_issue(
|
|
DOMAIN, f"entity_id_query_does_full_table_scan_{unique_id}"
|
|
)
|
|
assert issue.translation_placeholders == {CONF_QUERY: config[CONF_QUERY]}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"yaml_config",
|
|
[
|
|
YAML_CONFIG_FULL_TABLE_SCAN_NO_UNIQUE_ID,
|
|
YAML_CONFIG_FULL_TABLE_SCAN_WITH_MULTIPLE_COLUMNS,
|
|
],
|
|
)
|
|
async def test_issue_when_using_old_query_without_unique_id(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
yaml_config: dict[str, Any],
|
|
issue_registry: ir.IssueRegistry,
|
|
) -> None:
|
|
"""Test we create an issue for an old query that will do a full table scan."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, yaml_config)
|
|
await hass.async_block_till_done()
|
|
assert "Query contains entity_id but does not reference states_meta" in caplog.text
|
|
|
|
assert not hass.states.async_all()
|
|
|
|
config = yaml_config["sql"]
|
|
query = config[CONF_QUERY]
|
|
|
|
issue = issue_registry.async_get_issue(
|
|
DOMAIN, f"entity_id_query_does_full_table_scan_{query}"
|
|
)
|
|
assert issue.translation_placeholders == {CONF_QUERY: query}
|
|
|
|
|
|
async def test_no_issue_when_view_has_the_text_entity_id_in_it(
|
|
recorder_mock: Recorder, hass: HomeAssistant, caplog: pytest.LogCaptureFixture
|
|
) -> None:
|
|
"""Test we do not trigger the full table scan issue for a custom view."""
|
|
|
|
with patch(
|
|
"homeassistant.components.sql.sensor.scoped_session",
|
|
):
|
|
await init_integration(
|
|
hass,
|
|
title="Get entity_id",
|
|
options={
|
|
CONF_QUERY: "SELECT value from view_sensor_db_unique_entity_ids;",
|
|
CONF_COLUMN_NAME: "value",
|
|
},
|
|
)
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=1),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
assert (
|
|
"Query contains entity_id but does not reference states_meta" not in caplog.text
|
|
)
|
|
assert hass.states.get("sensor.get_entity_id") is not None
|
|
|
|
|
|
async def test_multiple_sensors_using_same_db(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test multiple sensors using the same db."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
options2 = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(hass, title="Select value SQL query", options=options)
|
|
await init_integration(
|
|
hass, title="Select value SQL query 2", options=options2, entry_id="2"
|
|
)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query_2")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
with patch("sqlalchemy.engine.base.Engine.dispose"):
|
|
await hass.async_stop()
|
|
|
|
|
|
async def test_engine_is_disposed_at_stop(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test we dispose of the engine at stop."""
|
|
config = {CONF_DB_URL: "sqlite:///"}
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
}
|
|
await init_integration(
|
|
hass, title="Select value SQL query", config=config, options=options
|
|
)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
with patch("sqlalchemy.engine.base.Engine.dispose") as mock_engine_dispose:
|
|
await hass.async_stop()
|
|
|
|
assert mock_engine_dispose.call_count == 2
|
|
|
|
|
|
async def test_attributes_from_entry_config(
|
|
recorder_mock: Recorder, hass: HomeAssistant
|
|
) -> None:
|
|
"""Test attributes from entry config."""
|
|
|
|
await init_integration(
|
|
hass,
|
|
title="Get Value - With",
|
|
options={
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_ADVANCED_OPTIONS: {
|
|
CONF_UNIT_OF_MEASUREMENT: "MiB",
|
|
CONF_DEVICE_CLASS: SensorDeviceClass.DATA_SIZE,
|
|
CONF_STATE_CLASS: SensorStateClass.TOTAL,
|
|
},
|
|
},
|
|
entry_id="8693d4782ced4fb1ecca4743f29ab8f1",
|
|
)
|
|
|
|
state = hass.states.get("sensor.get_value_with")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
assert state.attributes[CONF_UNIT_OF_MEASUREMENT] == "MiB"
|
|
assert state.attributes[CONF_DEVICE_CLASS] == SensorDeviceClass.DATA_SIZE
|
|
assert state.attributes[CONF_STATE_CLASS] == SensorStateClass.TOTAL
|
|
|
|
await init_integration(
|
|
hass,
|
|
title="Get Value - Without",
|
|
options={
|
|
CONF_QUERY: "SELECT 6 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_ADVANCED_OPTIONS: {
|
|
CONF_UNIT_OF_MEASUREMENT: "MiB",
|
|
},
|
|
},
|
|
entry_id="7aec7cd8045fba4778bb0621469e3cd9",
|
|
)
|
|
|
|
state = hass.states.get("sensor.get_value_without")
|
|
assert state.state == "6"
|
|
assert state.attributes["value"] == 6
|
|
assert state.attributes[CONF_UNIT_OF_MEASUREMENT] == "MiB"
|
|
assert CONF_DEVICE_CLASS not in state.attributes
|
|
assert CONF_STATE_CLASS not in state.attributes
|
|
|
|
|
|
async def test_query_recover_from_rollback(
|
|
recorder_mock: Recorder,
|
|
hass: HomeAssistant,
|
|
freezer: FrozenDateTimeFactory,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test the SQL sensor."""
|
|
options = {
|
|
CONF_QUERY: "SELECT 5 as value",
|
|
CONF_COLUMN_NAME: "value",
|
|
CONF_UNIQUE_ID: "very_unique_id",
|
|
}
|
|
await init_integration(hass, title="Select value SQL query", options=options)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes["value"] == 5
|
|
|
|
with patch(
|
|
"homeassistant.components.sql.sensor.generate_lambda_stmt",
|
|
return_value=generate_lambda_stmt("Faulty syntax create operational issue"),
|
|
):
|
|
freezer.tick(timedelta(minutes=1))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
assert "sqlite3.OperationalError" in caplog.text
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes.get("value") is None
|
|
|
|
freezer.tick(timedelta(minutes=1))
|
|
async_fire_time_changed(hass)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
state = hass.states.get("sensor.select_value_sql_query")
|
|
assert state.state == "5"
|
|
assert state.attributes.get("value") == 5
|
|
|
|
|
|
async def test_setup_without_recorder(hass: HomeAssistant) -> None:
|
|
"""Test the SQL sensor without recorder."""
|
|
|
|
assert await async_setup_component(hass, DOMAIN, YAML_CONFIG)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.get_value")
|
|
assert state.state == "5"
|
|
|
|
|
|
async def test_availability_blocks_value_template(
|
|
hass: HomeAssistant,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""Test availability blocks value_template from rendering."""
|
|
error = "Error parsing value for sensor.get_value: 'x' is undefined"
|
|
config = YAML_CONFIG
|
|
config["sql"][CONF_VALUE_TEMPLATE] = "{{ x - 0 }}"
|
|
config["sql"]["availability"] = '{{ states("sensor.input1")=="on" }}'
|
|
|
|
hass.states.async_set("sensor.input1", "off")
|
|
await hass.async_block_till_done()
|
|
|
|
assert await async_setup_component(hass, DOMAIN, config)
|
|
await hass.async_block_till_done()
|
|
|
|
assert error not in caplog.text
|
|
|
|
state = hass.states.get("sensor.get_value")
|
|
assert state
|
|
assert state.state == STATE_UNAVAILABLE
|
|
|
|
hass.states.async_set("sensor.input1", "on")
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(
|
|
hass,
|
|
dt_util.utcnow() + timedelta(minutes=1),
|
|
)
|
|
await hass.async_block_till_done(wait_background_tasks=True)
|
|
|
|
assert error in caplog.text
|