mirror of
https://github.com/home-assistant/core.git
synced 2025-12-24 12:59:34 +00:00
Additional testing for InfluxDB and some quality improvements (#37181)
* refactoring and added tests to sensor * using caplog and not mocking main setup method in sensor tests
This commit is contained in:
mdegat01
GitHub
453
tests/components/influxdb/test_sensor.py
Normal file
453
tests/components/influxdb/test_sensor.py
Normal file
@@ -0,0 +1,453 @@
|
||||
"""The tests for the InfluxDB sensor."""
|
||||
from dataclasses import dataclass
|
||||
from typing import Dict, List, Type
|
||||
|
||||
from influxdb.exceptions import InfluxDBClientError
|
||||
from influxdb_client.rest import ApiException
|
||||
import pytest
|
||||
from voluptuous import Invalid
|
||||
|
||||
from homeassistant.components.influxdb.const import (
|
||||
API_VERSION_2,
|
||||
DEFAULT_API_VERSION,
|
||||
DOMAIN,
|
||||
TEST_QUERY_V1,
|
||||
TEST_QUERY_V2,
|
||||
)
|
||||
from homeassistant.components.influxdb.sensor import PLATFORM_SCHEMA
|
||||
import homeassistant.components.sensor as sensor
|
||||
from homeassistant.const import STATE_UNKNOWN
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
from tests.async_mock import MagicMock, patch
|
||||
|
||||
INFLUXDB_PATH = "homeassistant.components.influxdb"
|
||||
INFLUXDB_CLIENT_PATH = f"{INFLUXDB_PATH}.sensor.InfluxDBClient"
|
||||
INFLUXDB_SENSOR_PATH = f"{INFLUXDB_PATH}.sensor"
|
||||
|
||||
BASE_V1_CONFIG = {}
|
||||
BASE_V2_CONFIG = {
|
||||
"api_version": API_VERSION_2,
|
||||
"organization": "org",
|
||||
"token": "token",
|
||||
}
|
||||
|
||||
BASE_V1_QUERY = {
|
||||
"queries": [
|
||||
{
|
||||
"name": "test",
|
||||
"measurement": "measurement",
|
||||
"where": "where",
|
||||
"field": "field",
|
||||
}
|
||||
],
|
||||
}
|
||||
BASE_V2_QUERY = {"queries_flux": [{"name": "test", "query": "query"}]}
|
||||
|
||||
|
||||
@dataclass
|
||||
class Record:
|
||||
"""Record in a Table."""
|
||||
|
||||
values: Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class Table:
|
||||
"""Table in an Influx 2 resultset."""
|
||||
|
||||
records: List[Type[Record]]
|
||||
|
||||
|
||||
@pytest.fixture(name="mock_client")
|
||||
def mock_client_fixture(request):
|
||||
"""Patch the InfluxDBClient object with mock for version under test."""
|
||||
if request.param == API_VERSION_2:
|
||||
client_target = f"{INFLUXDB_CLIENT_PATH}V2"
|
||||
else:
|
||||
client_target = INFLUXDB_CLIENT_PATH
|
||||
|
||||
with patch(client_target) as client:
|
||||
yield client
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def mock_influx_platform():
|
||||
"""
|
||||
Mock the influx client and queue in the main platform.
|
||||
|
||||
Successful sensor setup is really independent of the main platform.
|
||||
But since its one integration there is an internal dependency.
|
||||
Mocking the client library there prevents failures and mocking the queue
|
||||
to return `None` on get makes the listener shutdown immediately after initialization.
|
||||
"""
|
||||
with patch(f"{INFLUXDB_PATH}.InfluxDBClient") as mock_v1_client, patch(
|
||||
f"{INFLUXDB_PATH}.InfluxDBClientV2"
|
||||
) as mock_v2_client, patch(
|
||||
f"{INFLUXDB_PATH}.queue.Queue.get", return_value=None
|
||||
) as queue_get:
|
||||
yield (mock_v1_client, mock_v2_client, queue_get)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True, scope="module")
|
||||
def mock_client_close():
|
||||
"""Mock close method of clients at module scope."""
|
||||
with patch(f"{INFLUXDB_CLIENT_PATH}.close") as close_v1, patch(
|
||||
f"{INFLUXDB_CLIENT_PATH}V2.close"
|
||||
) as close_v2:
|
||||
yield (close_v1, close_v2)
|
||||
|
||||
|
||||
def _make_v1_resultset(*args):
|
||||
"""Create a mock V1 resultset."""
|
||||
for arg in args:
|
||||
yield {"value": arg}
|
||||
|
||||
|
||||
def _make_v2_resultset(*args):
|
||||
"""Create a mock V2 resultset."""
|
||||
tables = []
|
||||
|
||||
for arg in args:
|
||||
values = {"_value": arg}
|
||||
record = Record(values)
|
||||
tables.append(Table([record]))
|
||||
|
||||
return tables
|
||||
|
||||
|
||||
def _set_query_mock_v1(mock_influx_client, return_value=None, side_effect=None):
|
||||
"""Set return value or side effect for the V1 client."""
|
||||
query_api = mock_influx_client.return_value.query
|
||||
if side_effect:
|
||||
query_api.side_effect = side_effect
|
||||
|
||||
else:
|
||||
if return_value is None:
|
||||
return_value = []
|
||||
|
||||
def get_return_value(query, **kwargs):
|
||||
"""Return mock for test query, return value otherwise."""
|
||||
if query == TEST_QUERY_V1:
|
||||
return MagicMock()
|
||||
|
||||
query_output = MagicMock()
|
||||
query_output.get_points.return_value = return_value
|
||||
return query_output
|
||||
|
||||
query_api.side_effect = get_return_value
|
||||
|
||||
|
||||
def _set_query_mock_v2(mock_influx_client, return_value=None, side_effect=None):
|
||||
"""Set return value or side effect for the V2 client."""
|
||||
query_api = mock_influx_client.return_value.query_api.return_value.query
|
||||
if side_effect:
|
||||
query_api.side_effect = side_effect
|
||||
else:
|
||||
if return_value is None:
|
||||
return_value = []
|
||||
|
||||
query_api.return_value = return_value
|
||||
|
||||
|
||||
async def _setup(hass, config_ext, queries, expected_sensors):
|
||||
"""Create client and test expected sensors."""
|
||||
config = {
|
||||
DOMAIN: {},
|
||||
sensor.DOMAIN: {"platform": DOMAIN},
|
||||
}
|
||||
influx_config = config[sensor.DOMAIN]
|
||||
influx_config.update(config_ext)
|
||||
influx_config.update(queries)
|
||||
|
||||
assert await async_setup_component(hass, sensor.DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
sensors = []
|
||||
for expected_sensor in expected_sensors:
|
||||
state = hass.states.get(expected_sensor)
|
||||
assert state is not None
|
||||
sensors.append(state)
|
||||
|
||||
return sensors
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries",
|
||||
[
|
||||
(DEFAULT_API_VERSION, BASE_V1_CONFIG, BASE_V1_QUERY),
|
||||
(API_VERSION_2, BASE_V2_CONFIG, BASE_V2_QUERY),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_minimal_config(hass, mock_client, config_ext, queries):
|
||||
"""Test the minimal config and defaults."""
|
||||
await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries",
|
||||
[
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
{
|
||||
"ssl": "true",
|
||||
"host": "host",
|
||||
"port": "9000",
|
||||
"path": "path",
|
||||
"username": "user",
|
||||
"password": "pass",
|
||||
"database": "db",
|
||||
"verify_ssl": "true",
|
||||
"queries": [
|
||||
{
|
||||
"name": "test",
|
||||
"unit_of_measurement": "unit",
|
||||
"measurement": "measurement",
|
||||
"where": "where",
|
||||
"value_template": "value",
|
||||
"database": "db2",
|
||||
"group_function": "fn",
|
||||
"field": "field",
|
||||
}
|
||||
],
|
||||
},
|
||||
{},
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
{
|
||||
"api_version": "2",
|
||||
"ssl": "true",
|
||||
"host": "host",
|
||||
"port": "9000",
|
||||
"path": "path",
|
||||
"token": "token",
|
||||
"organization": "org",
|
||||
"bucket": "bucket",
|
||||
"queries_flux": [
|
||||
{
|
||||
"name": "test",
|
||||
"unit_of_measurement": "unit",
|
||||
"range_start": "start",
|
||||
"range_stop": "end",
|
||||
"group_function": "fn",
|
||||
"bucket": "bucket2",
|
||||
"imports": "import",
|
||||
"query": "query",
|
||||
}
|
||||
],
|
||||
},
|
||||
{},
|
||||
),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_full_config(hass, mock_client, config_ext, queries):
|
||||
"""Test the full config."""
|
||||
await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("config_ext", [(BASE_V1_CONFIG), (BASE_V2_CONFIG)])
|
||||
async def test_config_failure(hass, config_ext):
|
||||
"""Test an invalid config."""
|
||||
config = {"platform": DOMAIN}
|
||||
config.update(config_ext)
|
||||
|
||||
with pytest.raises(Invalid):
|
||||
PLATFORM_SCHEMA(config)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries, set_query_mock, make_resultset",
|
||||
[
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
BASE_V1_QUERY,
|
||||
_set_query_mock_v1,
|
||||
_make_v1_resultset,
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
BASE_V2_QUERY,
|
||||
_set_query_mock_v2,
|
||||
_make_v2_resultset,
|
||||
),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_state_matches_query_result(
|
||||
hass, mock_client, config_ext, queries, set_query_mock, make_resultset
|
||||
):
|
||||
"""Test state of sensor matches respone from query api."""
|
||||
set_query_mock(mock_client, return_value=make_resultset(42))
|
||||
|
||||
sensors = await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
|
||||
assert sensors[0].state == "42"
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries, set_query_mock, make_resultset",
|
||||
[
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
BASE_V1_QUERY,
|
||||
_set_query_mock_v1,
|
||||
_make_v1_resultset,
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
BASE_V2_QUERY,
|
||||
_set_query_mock_v2,
|
||||
_make_v2_resultset,
|
||||
),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_state_matches_first_query_result_for_multiple_return(
|
||||
hass, caplog, mock_client, config_ext, queries, set_query_mock, make_resultset
|
||||
):
|
||||
"""Test state of sensor matches respone from query api."""
|
||||
set_query_mock(mock_client, return_value=make_resultset(42, "not used"))
|
||||
|
||||
sensors = await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
assert sensors[0].state == "42"
|
||||
assert (
|
||||
len([record for record in caplog.records if record.levelname == "WARNING"]) == 1
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries, set_query_mock",
|
||||
[
|
||||
(DEFAULT_API_VERSION, BASE_V1_CONFIG, BASE_V1_QUERY, _set_query_mock_v1,),
|
||||
(API_VERSION_2, BASE_V2_CONFIG, BASE_V2_QUERY, _set_query_mock_v2),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_state_for_no_results(
|
||||
hass, caplog, mock_client, config_ext, queries, set_query_mock
|
||||
):
|
||||
"""Test state of sensor matches respone from query api."""
|
||||
set_query_mock(mock_client)
|
||||
|
||||
sensors = await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
assert sensors[0].state == STATE_UNKNOWN
|
||||
assert (
|
||||
len([record for record in caplog.records if record.levelname == "WARNING"]) == 1
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries, set_query_mock, query_exception",
|
||||
[
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
BASE_V1_QUERY,
|
||||
_set_query_mock_v1,
|
||||
OSError("fail"),
|
||||
),
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
BASE_V1_QUERY,
|
||||
_set_query_mock_v1,
|
||||
InfluxDBClientError("fail"),
|
||||
),
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
BASE_V1_QUERY,
|
||||
_set_query_mock_v1,
|
||||
InfluxDBClientError("fail", code=400),
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
BASE_V2_QUERY,
|
||||
_set_query_mock_v2,
|
||||
OSError("fail"),
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
BASE_V2_QUERY,
|
||||
_set_query_mock_v2,
|
||||
ApiException(),
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
BASE_V2_QUERY,
|
||||
_set_query_mock_v2,
|
||||
ApiException(status=400),
|
||||
),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_error_querying_influx(
|
||||
hass, caplog, mock_client, config_ext, queries, set_query_mock, query_exception
|
||||
):
|
||||
"""Test behavior of sensor when influx returns error."""
|
||||
|
||||
def mock_query_error(query, **kwargs):
|
||||
"""Throw error for any query besides test query."""
|
||||
if query in [TEST_QUERY_V1, TEST_QUERY_V2]:
|
||||
return MagicMock()
|
||||
raise query_exception
|
||||
|
||||
set_query_mock(mock_client, side_effect=mock_query_error)
|
||||
|
||||
sensors = await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
assert sensors[0].state == STATE_UNKNOWN
|
||||
assert (
|
||||
len([record for record in caplog.records if record.levelname == "ERROR"]) == 1
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"mock_client, config_ext, queries, set_query_mock, make_resultset",
|
||||
[
|
||||
(
|
||||
DEFAULT_API_VERSION,
|
||||
BASE_V1_CONFIG,
|
||||
{
|
||||
"queries": [
|
||||
{
|
||||
"name": "test",
|
||||
"measurement": "measurement",
|
||||
"where": "{{ illegal.template }}",
|
||||
"field": "field",
|
||||
}
|
||||
]
|
||||
},
|
||||
_set_query_mock_v1,
|
||||
_make_v1_resultset,
|
||||
),
|
||||
(
|
||||
API_VERSION_2,
|
||||
BASE_V2_CONFIG,
|
||||
{"queries_flux": [{"name": "test", "query": "{{ illegal.template }}"}]},
|
||||
_set_query_mock_v2,
|
||||
_make_v2_resultset,
|
||||
),
|
||||
],
|
||||
indirect=["mock_client"],
|
||||
)
|
||||
async def test_error_rendering_template(
|
||||
hass, caplog, mock_client, config_ext, queries, set_query_mock, make_resultset
|
||||
):
|
||||
"""Test behavior of sensor with error rendering template."""
|
||||
set_query_mock(mock_client, return_value=make_resultset(42))
|
||||
|
||||
sensors = await _setup(hass, config_ext, queries, ["sensor.test"])
|
||||
assert sensors[0].state == STATE_UNKNOWN
|
||||
assert (
|
||||
len([record for record in caplog.records if record.levelname == "ERROR"]) == 1
|
||||
)
|
||||
Reference in New Issue
Block a user