Improve InfluxDB (#5238)
* Revert #4791 and fixes #4696 * Update influxDB based on PR comments * Add migration script * Update influxdb_migrator based on PR comments * Add override_measurement option to influxdb_migrator * Rename value field to state when data is string type * Fix influxdb cloning query
This commit is contained in:
1 parent
e3418f633c
commit
3b9fb6ccf5
3 files changed
+418
-112
No files matched your search
@@ -106,43 +106,52 @@ class TestInfluxDB(unittest.TestCase):
|
||||
"""Test the event listener."""
|
||||
self._setup()
|
||||
|
||||
valid = {'1': 1, '1.0': 1.0, STATE_ON: 1, STATE_OFF: 0, 'str': 'str'}
|
||||
valid = {
|
||||
'1': 1,
|
||||
'1.0': 1.0,
|
||||
STATE_ON: 1,
|
||||
STATE_OFF: 0,
|
||||
'foo': 'foo'
|
||||
}
|
||||
for in_, out in valid.items():
|
||||
state = mock.MagicMock(state=in_, domain='fake',
|
||||
object_id='entity')
|
||||
attrs = {
|
||||
'unit_of_measurement': 'foobars',
|
||||
'longitude': '1.1',
|
||||
'latitude': '2.2'
|
||||
}
|
||||
state = mock.MagicMock(
|
||||
state=in_, domain='fake', object_id='entity', attributes=attrs)
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
|
||||
body = [
|
||||
{
|
||||
'measurement': 'hass.state.count',
|
||||
if isinstance(out, str):
|
||||
body = [{
|
||||
'measurement': 'foobars',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
if isinstance(out, (int, float)):
|
||||
body.append(
|
||||
{
|
||||
'measurement': 'hass.state',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': float(out)
|
||||
}
|
||||
}
|
||||
)
|
||||
'state': out,
|
||||
'longitude': 1.1,
|
||||
'latitude': 2.2
|
||||
},
|
||||
}]
|
||||
|
||||
else:
|
||||
body = [{
|
||||
'measurement': 'foobars',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': out,
|
||||
'longitude': 1.1,
|
||||
'latitude': 2.2
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
)
|
||||
@@ -150,7 +159,40 @@ class TestInfluxDB(unittest.TestCase):
|
||||
mock_client.return_value.write_points.call_args,
|
||||
mock.call(body)
|
||||
)
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_event_listener_no_units(self, mock_client):
|
||||
"""Test the event listener for missing units."""
|
||||
self._setup()
|
||||
|
||||
for unit in (None, ''):
|
||||
if unit:
|
||||
attrs = {'unit_of_measurement': unit}
|
||||
else:
|
||||
attrs = {}
|
||||
state = mock.MagicMock(
|
||||
state=1, domain='fake', entity_id='entity-id',
|
||||
object_id='entity', attributes=attrs)
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
body = [{
|
||||
'measurement': 'entity-id',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
)
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_args,
|
||||
mock.call(body)
|
||||
)
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_event_listener_fail_write(self, mock_client):
|
||||
@@ -165,6 +207,39 @@ class TestInfluxDB(unittest.TestCase):
|
||||
influx_client.exceptions.InfluxDBClientError('foo')
|
||||
self.handler_method(event)
|
||||
|
||||
def test_event_listener_states(self, mock_client):
|
||||
"""Test the event listener against ignored states."""
|
||||
self._setup()
|
||||
|
||||
for state_state in (1, 'unknown', '', 'unavailable'):
|
||||
state = mock.MagicMock(
|
||||
state=state_state, domain='fake', entity_id='entity-id',
|
||||
object_id='entity', attributes={})
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
body = [{
|
||||
'measurement': 'entity-id',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
if state_state == 1:
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
)
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_args,
|
||||
mock.call(body)
|
||||
)
|
||||
else:
|
||||
self.assertFalse(mock_client.return_value.write_points.called)
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_event_listener_blacklist(self, mock_client):
|
||||
"""Test the event listener against a blacklist."""
|
||||
self._setup()
|
||||
@@ -174,34 +249,18 @@ class TestInfluxDB(unittest.TestCase):
|
||||
state=1, domain='fake', entity_id='fake.{}'.format(entity_id),
|
||||
object_id=entity_id, attributes={})
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
|
||||
body = [
|
||||
{
|
||||
'measurement': 'hass.state.count',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': entity_id,
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
}
|
||||
body = [{
|
||||
'measurement': 'fake.{}'.format(entity_id),
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': entity_id,
|
||||
},
|
||||
{
|
||||
'measurement': 'hass.state',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': entity_id,
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
|
||||
if entity_id == 'ok':
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
@@ -212,7 +271,6 @@ class TestInfluxDB(unittest.TestCase):
|
||||
)
|
||||
else:
|
||||
self.assertFalse(mock_client.return_value.write_points.called)
|
||||
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_event_listener_invalid_type(self, mock_client):
|
||||
@@ -229,43 +287,45 @@ class TestInfluxDB(unittest.TestCase):
|
||||
for in_, out in valid.items():
|
||||
attrs = {
|
||||
'unit_of_measurement': 'foobars',
|
||||
'longitude': '1.1',
|
||||
'latitude': '2.2',
|
||||
'invalid_attribute': ['value1', 'value2']
|
||||
}
|
||||
state = mock.MagicMock(
|
||||
state=in_, domain='fake', object_id='entity', attributes=attrs)
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
|
||||
body = [
|
||||
{
|
||||
'measurement': 'hass.state.count',
|
||||
if isinstance(out, str):
|
||||
body = [{
|
||||
'measurement': 'foobars',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
if isinstance(out, (int, float)):
|
||||
body.append(
|
||||
{
|
||||
'measurement': 'hass.state',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': float(out)
|
||||
}
|
||||
}
|
||||
)
|
||||
'state': out,
|
||||
'longitude': 1.1,
|
||||
'latitude': 2.2,
|
||||
'invalid_attribute_str': "['value1', 'value2']"
|
||||
},
|
||||
}]
|
||||
|
||||
else:
|
||||
body = [{
|
||||
'measurement': 'foobars',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': 'entity',
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': float(out),
|
||||
'longitude': 1.1,
|
||||
'latitude': 2.2,
|
||||
'invalid_attribute_str': "['value1', 'value2']"
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
)
|
||||
@@ -273,5 +333,47 @@ class TestInfluxDB(unittest.TestCase):
|
||||
mock_client.return_value.write_points.call_args,
|
||||
mock.call(body)
|
||||
)
|
||||
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_event_listener_default_measurement(self, mock_client):
|
||||
"""Test the event listener with a default measurement."""
|
||||
config = {
|
||||
'influxdb': {
|
||||
'host': 'host',
|
||||
'username': 'user',
|
||||
'password': 'pass',
|
||||
'default_measurement': 'state',
|
||||
'blacklist': ['fake.blacklisted']
|
||||
}
|
||||
}
|
||||
assert setup_component(self.hass, influxdb.DOMAIN, config)
|
||||
self.handler_method = self.hass.bus.listen.call_args_list[0][0][1]
|
||||
|
||||
for entity_id in ('ok', 'blacklisted'):
|
||||
state = mock.MagicMock(
|
||||
state=1, domain='fake', entity_id='fake.{}'.format(entity_id),
|
||||
object_id=entity_id, attributes={})
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
body = [{
|
||||
'measurement': 'state',
|
||||
'tags': {
|
||||
'domain': 'fake',
|
||||
'entity_id': entity_id,
|
||||
},
|
||||
'time': 12345,
|
||||
'fields': {
|
||||
'value': 1,
|
||||
},
|
||||
}]
|
||||
self.handler_method(event)
|
||||
if entity_id == 'ok':
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_count, 1
|
||||
)
|
||||
self.assertEqual(
|
||||
mock_client.return_value.write_points.call_args,
|
||||
mock.call(body)
|
||||
)
|
||||
else:
|
||||
self.assertFalse(mock_client.return_value.write_points.called)
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
Reference in new issue
Block a user