InfluxDB send retry after IOError (#10263)
* Implement data write retry for InfluxDB This adds an optional max_retries parameter to the InfluxDB component to specify if and how often the component should try to send the data if the connection failed due to an IOError. The sending will be scheduled for a retry in 20 seconds as often as the user specified. This can be handy for flaky getwork connections between the DB and Homeassistant or outages like daily DSL reconnects. Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Add unittest for influx write retries Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Add RetryOnError as helper decorator in util Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Add unittests for RetryOnError Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Use RetryOnError decorator in InfluxDB This replaces the scheduling logic in the InfluxDB component with the RetryOnError decorator from homeassistant.util Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Make the linters happy Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de> * Implement a queue limit for the retry decorator. This adds a queue limit to the RetryOnError handler. It limits the number of calls waiting for be retried. If this number is exceeded, every new call will discard the oldest one in the queue. * influxdb: Add the retry queue limit option. * Make the linter happy. * Make pylint happy * Log exception of dropped retry * Move RetryOnError decorator to influxdb component. * Fix bug in logging usage * Fix imports * Add newlines at the end of files. * Remove blank line * Remove blank line
This commit is contained in:
Jan Losinski
Paulus Schoutsen
parent
3dd49b2b95
commit
d0b9f08bf2
2 changed files with 259 additions and 1 deletions
|
|
@ -3,8 +3,13 @@ import unittest
|
|||
import datetime
|
||||
from unittest import mock
|
||||
|
||||
from datetime import timedelta
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
import influxdb as influx_client
|
||||
|
||||
from homeassistant.util import dt as dt_util
|
||||
from homeassistant import core as ha
|
||||
from homeassistant.setup import setup_component
|
||||
import homeassistant.components.influxdb as influxdb
|
||||
from homeassistant.const import EVENT_STATE_CHANGED, STATE_OFF, STATE_ON, \
|
||||
|
|
@ -36,6 +41,7 @@ class TestInfluxDB(unittest.TestCase):
|
|||
'database': 'db',
|
||||
'username': 'user',
|
||||
'password': 'password',
|
||||
'max_retries': 4,
|
||||
'ssl': 'False',
|
||||
'verify_ssl': 'False',
|
||||
}
|
||||
|
|
@ -91,7 +97,7 @@ class TestInfluxDB(unittest.TestCase):
|
|||
influx_client.exceptions.InfluxDBClientError('fake')
|
||||
assert not setup_component(self.hass, influxdb.DOMAIN, config)
|
||||
|
||||
def _setup(self):
|
||||
def _setup(self, **kwargs):
|
||||
"""Setup the client."""
|
||||
config = {
|
||||
'influxdb': {
|
||||
|
|
@ -104,6 +110,7 @@ class TestInfluxDB(unittest.TestCase):
|
|||
}
|
||||
}
|
||||
}
|
||||
config['influxdb'].update(kwargs)
|
||||
assert setup_component(self.hass, influxdb.DOMAIN, config)
|
||||
self.handler_method = self.hass.bus.listen.call_args_list[0][0][1]
|
||||
|
||||
|
|
@ -649,3 +656,164 @@ class TestInfluxDB(unittest.TestCase):
|
|||
mock.call(body)
|
||||
)
|
||||
mock_client.return_value.write_points.reset_mock()
|
||||
|
||||
def test_scheduled_write(self, mock_client):
|
||||
"""Test the event listener to retry after write failures."""
|
||||
self._setup(max_retries=1)
|
||||
|
||||
state = mock.MagicMock(
|
||||
state=1, domain='fake', entity_id='entity.id', object_id='entity',
|
||||
attributes={})
|
||||
event = mock.MagicMock(data={'new_state': state}, time_fired=12345)
|
||||
mock_client.return_value.write_points.side_effect = \
|
||||
IOError('foo')
|
||||
|
||||
start = dt_util.utcnow()
|
||||
|
||||
self.handler_method(event)
|
||||
json_data = mock_client.return_value.write_points.call_args[0][0]
|
||||
self.assertEqual(mock_client.return_value.write_points.call_count, 1)
|
||||
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(mock_client.return_value.write_points.call_count, 2)
|
||||
mock_client.return_value.write_points.assert_called_with(json_data)
|
||||
|
||||
shifted_time = shifted_time + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(mock_client.return_value.write_points.call_count, 2)
|
||||
|
||||
|
||||
class TestRetryOnErrorDecorator(unittest.TestCase):
|
||||
"""Test the RetryOnError decorator."""
|
||||
|
||||
def setUp(self):
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
|
||||
def tearDown(self):
|
||||
"""Clear data."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_no_retry(self):
|
||||
"""Test that it does not retry if configured."""
|
||||
mock_method = MagicMock()
|
||||
wrapped = influxdb.RetryOnError(self.hass)(mock_method)
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 1)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
mock_method.side_effect = Exception()
|
||||
self.assertRaises(Exception, wrapped, 1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 2)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
def test_single_retry(self):
|
||||
"""Test that retry stops after a single try if configured."""
|
||||
mock_method = MagicMock()
|
||||
retryer = influxdb.RetryOnError(self.hass, retry_limit=1)
|
||||
wrapped = retryer(mock_method)
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 1)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
start = dt_util.utcnow()
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(mock_method.call_count, 1)
|
||||
|
||||
mock_method.side_effect = Exception()
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 2)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
for cnt in range(3):
|
||||
start = dt_util.utcnow()
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(mock_method.call_count, 3)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
def test_multi_retry(self):
|
||||
"""Test that multiple retries work."""
|
||||
mock_method = MagicMock()
|
||||
retryer = influxdb.RetryOnError(self.hass, retry_limit=4)
|
||||
wrapped = retryer(mock_method)
|
||||
mock_method.side_effect = Exception()
|
||||
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 1)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
for cnt in range(3):
|
||||
start = dt_util.utcnow()
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(mock_method.call_count, cnt + 2)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
|
||||
def test_max_queue(self):
|
||||
"""Test the maximum queue length."""
|
||||
# make a wrapped method
|
||||
mock_method = MagicMock()
|
||||
retryer = influxdb.RetryOnError(
|
||||
self.hass, retry_limit=4, queue_limit=3)
|
||||
wrapped = retryer(mock_method)
|
||||
mock_method.side_effect = Exception()
|
||||
|
||||
# call it once, call fails, queue fills to 1
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 1)
|
||||
mock_method.assert_called_with(1, 2, test=3)
|
||||
self.assertEqual(len(wrapped._retry_queue), 1)
|
||||
|
||||
# two more calls that failed. queue is 3
|
||||
wrapped(1, 2, test=3)
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 3)
|
||||
self.assertEqual(len(wrapped._retry_queue), 3)
|
||||
|
||||
# another call, queue gets limited to 3
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 4)
|
||||
self.assertEqual(len(wrapped._retry_queue), 3)
|
||||
|
||||
# time passes
|
||||
start = dt_util.utcnow()
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
|
||||
# only the three queued calls where repeated
|
||||
self.assertEqual(mock_method.call_count, 7)
|
||||
self.assertEqual(len(wrapped._retry_queue), 3)
|
||||
|
||||
# another call, queue stays limited
|
||||
wrapped(1, 2, test=3)
|
||||
self.assertEqual(mock_method.call_count, 8)
|
||||
self.assertEqual(len(wrapped._retry_queue), 3)
|
||||
|
||||
# disable the side effect
|
||||
mock_method.side_effect = None
|
||||
|
||||
# time passes, all calls should succeed
|
||||
start = dt_util.utcnow()
|
||||
shifted_time = start + (timedelta(seconds=20 + 1))
|
||||
self.hass.bus.fire(ha.EVENT_TIME_CHANGED,
|
||||
{ha.ATTR_NOW: shifted_time})
|
||||
self.hass.block_till_done()
|
||||
|
||||
# three queued calls succeeded, queue empty.
|
||||
self.assertEqual(mock_method.call_count, 11)
|
||||
self.assertEqual(len(wrapped._retry_queue), 0)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue