summaryrefslogtreecommitdiff
path: root/tests/storage/test_background_update.py
blob: 29289fa9b461b95f53d0fdd91b9c0d72ff580d05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
from tests import unittest
from twisted.internet import defer

from synapse.api.constants import EventTypes
from synapse.types import UserID, RoomID, RoomAlias

from tests.utils import setup_test_homeserver

from mock import Mock

class BackgroundUpdateTestCase(unittest.TestCase):

    @defer.inlineCallbacks
    def setUp(self):
        hs = yield setup_test_homeserver()
        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
        )

    @defer.inlineCallbacks
    def test_do_background_update(self):
        desired_count = 1000;
        duration_ms = 42;

        @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()
        result = yield self.store.do_background_update(
            duration_ms * desired_count
        )
        self.assertIsNotNone(result)
        self.update_handler.assert_called_once_with(
            {"my_key": 1}, self.store.DEFAULT_BACKGROUND_BATCH_SIZE
        )

        @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()
        result = yield self.store.do_background_update(
            duration_ms * desired_count
        )
        self.assertIsNotNone(result)
        self.update_handler.assert_called_once_with(
            {"my_key": 2}, desired_count
        )

        self.update_handler.reset_mock()
        result = yield self.store.do_background_update(
            duration_ms * desired_count
        )
        self.assertIsNone(result)
        self.assertFalse(self.update_handler.called)