# -*- coding: utf-8 -*- # Copyright 2015 OpenMarket Ltd # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from synapse.appservice import ApplicationServiceState, AppServiceTransaction from synapse.appservice.scheduler import ( _EventGrouper, _TransactionController, _Recoverer ) from twisted.internet import defer from ..utils import MockClock from mock import Mock from tests import unittest class ApplicationServiceSchedulerTransactionCtrlTestCase(unittest.TestCase): def setUp(self): self.clock = MockClock() self.store = Mock() self.as_api = Mock() self.event_grouper = Mock() self.recoverer = Mock() self.recoverer_fn = Mock(return_value=self.recoverer) self.txnctrl = _TransactionController( clock=self.clock, store=self.store, as_api=self.as_api, event_grouper=self.event_grouper, recoverer_fn=self.recoverer_fn ) def test_poll_single_group_service_up(self): # Test: The AS is up and the txn is successfully sent. service = Mock() events = [Mock(), Mock()] groups = {} groups[service] = events txn_id = "foobar" txn = Mock(id=txn_id, service=service, events=events) # mock methods self.event_grouper.drain_groups = Mock(return_value=groups) self.store.get_appservice_state = Mock( return_value=defer.succeed(ApplicationServiceState.UP) ) txn.send = Mock(return_value=defer.succeed(True)) self.store.create_appservice_txn = Mock( return_value=defer.succeed(txn) ) # actual call self.txnctrl.start_polling() self.store.create_appservice_txn.assert_called_once_with( service=service, events=events # txn made and saved ) self.assertEquals(0, len(self.txnctrl.recoverers)) # no recoverer made txn.complete.assert_called_once_with(self.store) # txn completed def test_poll_single_group_service_down(self): # Test: The AS is down so it shouldn't push; Recoverers will do it. # It should still make a transaction though. service = Mock() events = [Mock(), Mock()] groups = {} groups[service] = events self.event_grouper.drain_groups = Mock(return_value=groups) txn = Mock(id="idhere", service=service, events=events) self.store.get_appservice_state = Mock( return_value=defer.succeed(ApplicationServiceState.DOWN) ) self.store.create_appservice_txn = Mock( return_value=defer.succeed(txn) ) # actual call self.txnctrl.start_polling() self.store.create_appservice_txn.assert_called_once_with( service=service, events=events # txn made and saved ) self.assertEquals(0, txn.send.call_count) # txn not sent though self.assertEquals(0, txn.complete.call_count) # or completed def test_poll_single_group_service_up(self): # Test: The AS is up and the txn is not sent. A Recoverer is made and # started. service = Mock() events = [Mock(), Mock()] groups = {} groups[service] = events txn_id = "foobar" txn = Mock(id=txn_id, service=service, events=events) # mock methods self.event_grouper.drain_groups = Mock(return_value=groups) self.store.get_appservice_state = Mock( return_value=defer.succeed(ApplicationServiceState.UP) ) self.store.set_appservice_state = Mock(return_value=defer.succeed(True)) txn.send = Mock(return_value=defer.succeed(False)) # fails to send self.store.create_appservice_txn = Mock( return_value=defer.succeed(txn) ) # actual call self.txnctrl.start_polling() self.store.create_appservice_txn.assert_called_once_with( service=service, events=events ) self.assertEquals(1, self.recoverer_fn.call_count) # recoverer made self.assertEquals(1, self.recoverer.recover.call_count) # and invoked self.assertEquals(1, len(self.txnctrl.recoverers)) # and stored self.assertEquals(0, txn.complete.call_count) # txn not completed self.store.set_appservice_state.assert_called_once_with( service, ApplicationServiceState.DOWN # service marked as down ) def test_poll_no_groups(self): self.as_api.push_bulk = Mock() self.event_grouper.drain_groups = Mock(return_value={}) self.txnctrl.start_polling() self.assertEquals(0, self.as_api.push_bulk.call_count) class ApplicationServiceSchedulerRecovererTestCase(unittest.TestCase): def setUp(self): self.clock = MockClock() self.as_api = Mock() self.store = Mock() self.service = Mock() self.callback = Mock() self.recoverer = _Recoverer( clock=self.clock, as_api=self.as_api, store=self.store, service=self.service, callback=self.callback, ) def test_recover_single_txn(self): txn = Mock() # return one txn to send, then no more old txns txns = [txn, None] def take_txn(*args, **kwargs): return defer.succeed(txns.pop(0)) self.store.get_oldest_txn = Mock(side_effect=take_txn) self.recoverer.recover() # shouldn't have called anything prior to waiting for exp backoff self.assertEquals(0, self.store.get_oldest_txn.call_count) txn.send = Mock(return_value=True) # wait for exp backoff self.clock.advance_time(2000) self.assertEquals(1, txn.send.call_count) self.assertEquals(1, txn.complete.call_count) # 2 because it needs to get None to know there are no more txns self.assertEquals(2, self.store.get_oldest_txn.call_count) self.callback.assert_called_once_with(self.recoverer) self.assertEquals(self.recoverer.service, self.service) def test_recover_retry_txn(self): txn = Mock() txns = [txn, None] pop_txn = False def take_txn(*args, **kwargs): if pop_txn: return defer.succeed(txns.pop(0)) else: return defer.succeed(txn) self.store.get_oldest_txn = Mock(side_effect=take_txn) self.recoverer.recover() self.assertEquals(0, self.store.get_oldest_txn.call_count) txn.send = Mock(return_value=False) self.clock.advance_time(2000) self.assertEquals(1, txn.send.call_count) self.assertEquals(0, txn.complete.call_count) self.assertEquals(0, self.callback.call_count) self.clock.advance_time(4000) self.assertEquals(2, txn.send.call_count) self.assertEquals(0, txn.complete.call_count) self.assertEquals(0, self.callback.call_count) self.clock.advance_time(8000) self.assertEquals(3, txn.send.call_count) self.assertEquals(0, txn.complete.call_count) self.assertEquals(0, self.callback.call_count) txn.send = Mock(return_value=True) # successfully send the txn pop_txn = True # returns the txn the first time, then no more. self.clock.advance_time(16000) self.assertEquals(1, txn.send.call_count) # new mock reset call count self.assertEquals(1, txn.complete.call_count) self.callback.assert_called_once_with(self.recoverer) class ApplicationServiceSchedulerEventGrouperTestCase(unittest.TestCase): def setUp(self): self.grouper = _EventGrouper() def test_drain_single_event(self): service = Mock() event = Mock() self.grouper.on_receive(service, event) groups = self.grouper.drain_groups() self.assertTrue(service in groups) self.assertEquals([event], groups[service]) self.assertEquals(1, len(groups.keys())) # no more events self.assertEquals(self.grouper.drain_groups(), {}) def test_drain_multiple_events(self): service = Mock() events = [Mock(), Mock(), Mock()] for e in events: self.grouper.on_receive(service, e) groups = self.grouper.drain_groups() self.assertTrue(service in groups) self.assertEquals(events, groups[service]) # no more events self.assertEquals(self.grouper.drain_groups(), {}) def test_drain_multiple_services(self): services = [Mock(), Mock(), Mock()] events_a = [Mock(), Mock()] events_b = [Mock()] events_c = [Mock(), Mock(), Mock(), Mock()] mappings = { services[0]: events_a, services[1]: events_b, services[2]: events_c } for e in events_b: self.grouper.on_receive(services[1], e) for e in events_c: self.grouper.on_receive(services[2], e) for e in events_a: self.grouper.on_receive(services[0], e) groups = self.grouper.drain_groups() for service in services: self.assertTrue(service in groups) self.assertEquals(mappings[service], groups[service]) self.assertEquals(3, len(groups.keys())) # no more events self.assertEquals(self.grouper.drain_groups(), {})