anonymousland-synapse/tests/storage/test_background_update.py

78 lines
2.7 KiB
Python
Raw Normal View History

2018-07-09 02:09:20 -04:00
from mock import Mock
2015-11-10 10:51:40 -05:00
from twisted.internet import defer
2018-07-09 02:09:20 -04:00
from tests import unittest
2015-11-10 10:51:40 -05:00
from tests.utils import setup_test_homeserver
2016-02-19 10:34:38 -05:00
2015-11-10 10:51:40 -05:00
class BackgroundUpdateTestCase(unittest.TestCase):
@defer.inlineCallbacks
def setUp(self):
2018-08-13 02:47:46 -04:00
hs = yield setup_test_homeserver(
self.addCleanup
) # type: synapse.server.HomeServer
2015-11-10 10:51:40 -05:00
self.store = hs.get_datastore()
self.clock = hs.get_clock()
self.update_handler = Mock()
yield self.store.register_background_update_handler(
"test_update", self.update_handler
)
# run the real background updates, to get them out the way
# (perhaps we should run them as part of the test HS setup, since we
# run all of the other schema setup stuff there?)
while True:
res = yield self.store.do_next_background_update(1000)
if res is None:
break
2015-11-10 10:51:40 -05:00
@defer.inlineCallbacks
def test_do_background_update(self):
2016-02-19 10:34:38 -05:00
desired_count = 1000
duration_ms = 42
2015-11-10 10:51:40 -05:00
# first step: make a bit of progress
2015-11-10 10:51:40 -05:00
@defer.inlineCallbacks
def update(progress, count):
self.clock.advance_time_msec(count * duration_ms)
progress = {"my_key": progress["my_key"] + 1}
yield self.store.runInteraction(
"update_progress",
self.store._background_update_progress_txn,
"test_update",
progress,
)
defer.returnValue(count)
self.update_handler.side_effect = update
yield self.store.start_background_update("test_update", {"my_key": 1})
self.update_handler.reset_mock()
2018-08-10 09:54:09 -04:00
result = yield self.store.do_next_background_update(duration_ms * desired_count)
2015-11-10 10:51:40 -05:00
self.assertIsNotNone(result)
self.update_handler.assert_called_once_with(
{"my_key": 1}, self.store.DEFAULT_BACKGROUND_BATCH_SIZE
)
# second step: complete the update
2015-11-10 10:51:40 -05:00
@defer.inlineCallbacks
def update(progress, count):
yield self.store._end_background_update("test_update")
defer.returnValue(count)
self.update_handler.side_effect = update
self.update_handler.reset_mock()
2018-08-10 09:54:09 -04:00
result = yield self.store.do_next_background_update(duration_ms * desired_count)
2015-11-10 10:51:40 -05:00
self.assertIsNotNone(result)
2018-08-10 09:54:09 -04:00
self.update_handler.assert_called_once_with({"my_key": 2}, desired_count)
2015-11-10 10:51:40 -05:00
# third step: we don't expect to be called any more
2015-11-10 10:51:40 -05:00
self.update_handler.reset_mock()
2018-08-10 09:54:09 -04:00
result = yield self.store.do_next_background_update(duration_ms * desired_count)
2015-11-10 10:51:40 -05:00
self.assertIsNone(result)
self.assertFalse(self.update_handler.called)