sdk/python/tests/test_events.py

   1 import arvados
   2 import arvados.events
   3 import arvados.errors
   4 from datetime import datetime, timedelta, tzinfo
   5 import logging
   6 import logging.handlers
   7 import mock
   8 import Queue
   9 import run_test_server
  10 import StringIO
  11 import tempfile
  12 import threading
  13 import time
  14 import unittest
  15
  16 import arvados_testutil
  17
  18 class WebsocketTest(run_test_server.TestCaseWithServers):
  19     MAIN_SERVER = {}
  20
  21     TIME_PAST = time.time()-3600
  22     TIME_FUTURE = time.time()+3600
  23     MOCK_WS_URL = 'wss://[{}]/'.format(arvados_testutil.TEST_HOST)
  24
  25     def setUp(self):
  26         self.ws = None
  27
  28     def tearDown(self):
  29         try:
  30             if self.ws:
  31                 self.ws.close()
  32         except Exception as e:
  33             print("Error in teardown: ", e)
  34         super(WebsocketTest, self).tearDown()
  35         run_test_server.reset()
  36
  37     def _test_subscribe(self, poll_fallback, expect_type, start_time=None, expected=1):
  38         run_test_server.authorize_with('active')
  39         events = Queue.Queue(100)
  40
  41         # Create ancestor before subscribing.
  42         # When listening with start_time in the past, this should also be retrieved.
  43         # However, when start_time is omitted in subscribe, this should not be fetched.
  44         ancestor = arvados.api('v1').humans().create(body={}).execute()
  45
  46         filters = [['object_uuid', 'is_a', 'arvados#human']]
  47         if start_time:
  48             filters.append(['created_at', '>=', start_time])
  49
  50         self.ws = arvados.events.subscribe(
  51             arvados.api('v1'), filters,
  52             events.put_nowait,
  53             poll_fallback=poll_fallback,
  54             last_log_id=(1 if start_time else None))
  55         self.assertIsInstance(self.ws, expect_type)
  56         self.assertEqual(200, events.get(True, 5)['status'])
  57         human = arvados.api('v1').humans().create(body={}).execute()
  58
  59         log_object_uuids = []
  60         for i in range(0, expected):
  61             log_object_uuids.append(events.get(True, 5)['object_uuid'])
  62
  63         if expected > 0:
  64             self.assertIn(human['uuid'], log_object_uuids)
  65
  66         if expected > 1:
  67             self.assertIn(ancestor['uuid'], log_object_uuids)
  68
  69         with self.assertRaises(Queue.Empty):
  70             # assertEqual just serves to show us what unexpected thing
  71             # comes out of the queue when the assertRaises fails; when
  72             # the test passes, this assertEqual doesn't get called.
  73             self.assertEqual(events.get(True, 2), None)
  74
  75     def test_subscribe_websocket(self):
  76         self._test_subscribe(
  77             poll_fallback=False, expect_type=arvados.events.EventClient, expected=1)
  78
  79     @mock.patch('arvados.events.EventClient.__init__')
  80     def test_subscribe_poll(self, event_client_constr):
  81         event_client_constr.side_effect = Exception('All is well')
  82         self._test_subscribe(
  83             poll_fallback=0.25, expect_type=arvados.events.PollClient, expected=1)
  84
  85     def test_subscribe_poll_retry(self):
  86         api_mock = mock.MagicMock()
  87         n = []
  88         def on_ev(ev):
  89             n.append(ev)
  90
  91         error_mock = mock.MagicMock()
  92         error_mock.resp.status = 0
  93         error_mock._get_reason.return_value = "testing"
  94         api_mock.logs().list().execute.side_effect = (arvados.errors.ApiError(error_mock, ""),
  95                                                       {"items": [{"id": 1}], "items_available": 1},
  96                                                       arvados.errors.ApiError(error_mock, ""),
  97                                                       {"items": [{"id": 1}], "items_available": 1})
  98         pc = arvados.events.PollClient(api_mock, [], on_ev, 15, None)
  99         pc.start()
 100         while len(n) < 2:
 101             time.sleep(.1)
 102         pc.close()
 103
 104     def test_subscribe_websocket_with_start_time_past(self):
 105         self._test_subscribe(
 106             poll_fallback=False, expect_type=arvados.events.EventClient,
 107             start_time=self.localiso(self.TIME_PAST),
 108             expected=2)
 109
 110     @mock.patch('arvados.events.EventClient.__init__')
 111     def test_subscribe_poll_with_start_time_past(self, event_client_constr):
 112         event_client_constr.side_effect = Exception('All is well')
 113         self._test_subscribe(
 114             poll_fallback=0.25, expect_type=arvados.events.PollClient,
 115             start_time=self.localiso(self.TIME_PAST),
 116             expected=2)
 117
 118     def test_subscribe_websocket_with_start_time_future(self):
 119         self._test_subscribe(
 120             poll_fallback=False, expect_type=arvados.events.EventClient,
 121             start_time=self.localiso(self.TIME_FUTURE),
 122             expected=0)
 123
 124     @mock.patch('arvados.events.EventClient.__init__')
 125     def test_subscribe_poll_with_start_time_future(self, event_client_constr):
 126         event_client_constr.side_effect = Exception('All is well')
 127         self._test_subscribe(
 128             poll_fallback=0.25, expect_type=arvados.events.PollClient,
 129             start_time=self.localiso(self.TIME_FUTURE),
 130             expected=0)
 131
 132     def test_subscribe_websocket_with_start_time_past_utc(self):
 133         self._test_subscribe(
 134             poll_fallback=False, expect_type=arvados.events.EventClient,
 135             start_time=self.utciso(self.TIME_PAST),
 136             expected=2)
 137
 138     def test_subscribe_websocket_with_start_time_future_utc(self):
 139         self._test_subscribe(
 140             poll_fallback=False, expect_type=arvados.events.EventClient,
 141             start_time=self.utciso(self.TIME_FUTURE),
 142             expected=0)
 143
 144     def utciso(self, t):
 145         return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(t))
 146
 147     def localiso(self, t):
 148         return time.strftime('%Y-%m-%dT%H:%M:%S', time.localtime(t)) + self.isotz(-time.timezone/60)
 149
 150     def isotz(self, offset):
 151         """Convert minutes-east-of-UTC to ISO8601 time zone designator"""
 152         return '{:+03d}{:02d}'.format(offset/60, offset%60)
 153
 154     # Test websocket reconnection on (un)execpted close
 155     def _test_websocket_reconnect(self, close_unexpected):
 156         run_test_server.authorize_with('active')
 157         events = Queue.Queue(100)
 158
 159         logstream = StringIO.StringIO()
 160         rootLogger = logging.getLogger()
 161         streamHandler = logging.StreamHandler(logstream)
 162         rootLogger.addHandler(streamHandler)
 163
 164         filters = [['object_uuid', 'is_a', 'arvados#human']]
 165         filters.append(['created_at', '>=', self.localiso(self.TIME_PAST)])
 166         self.ws = arvados.events.subscribe(
 167             arvados.api('v1'), filters,
 168             events.put_nowait,
 169             poll_fallback=False,
 170             last_log_id=None)
 171         self.assertIsInstance(self.ws, arvados.events.EventClient)
 172         self.assertEqual(200, events.get(True, 5)['status'])
 173
 174         # create obj
 175         human = arvados.api('v1').humans().create(body={}).execute()
 176
 177         # expect an event
 178         self.assertIn(human['uuid'], events.get(True, 5)['object_uuid'])
 179         with self.assertRaises(Queue.Empty):
 180             self.assertEqual(events.get(True, 2), None)
 181
 182         # close (im)properly
 183         if close_unexpected:
 184             self.ws.close_connection()
 185         else:
 186             self.ws.close()
 187
 188         # create one more obj
 189         human2 = arvados.api('v1').humans().create(body={}).execute()
 190
 191         # (un)expect the object creation event
 192         if close_unexpected:
 193             log_object_uuids = []
 194             for i in range(0, 2):
 195                 event = events.get(True, 5)
 196                 if event.get('object_uuid') != None:
 197                     log_object_uuids.append(event['object_uuid'])
 198             with self.assertRaises(Queue.Empty):
 199                 self.assertEqual(events.get(True, 2), None)
 200             self.assertNotIn(human['uuid'], log_object_uuids)
 201             self.assertIn(human2['uuid'], log_object_uuids)
 202         else:
 203             with self.assertRaises(Queue.Empty):
 204                 self.assertEqual(events.get(True, 2), None)
 205
 206         # verify log message to ensure that an (un)expected close
 207         log_messages = logstream.getvalue()
 208         closeLogFound = log_messages.find("Unexpected close. Reconnecting.")
 209         retryLogFound = log_messages.find("Error during websocket reconnect. Will retry")
 210         if close_unexpected:
 211             self.assertNotEqual(closeLogFound, -1)
 212         else:
 213             self.assertEqual(closeLogFound, -1)
 214         rootLogger.removeHandler(streamHandler)
 215
 216     def test_websocket_reconnect_on_unexpected_close(self):
 217         self._test_websocket_reconnect(True)
 218
 219     def test_websocket_no_reconnect_on_close_by_user(self):
 220         self._test_websocket_reconnect(False)
 221
 222     # Test websocket reconnection retry
 223     @mock.patch('arvados.events._EventClient.connect')
 224     def test_websocket_reconnect_retry(self, event_client_connect):
 225         event_client_connect.side_effect = [None, Exception('EventClient.connect error'), None]
 226
 227         logstream = StringIO.StringIO()
 228         rootLogger = logging.getLogger()
 229         streamHandler = logging.StreamHandler(logstream)
 230         rootLogger.addHandler(streamHandler)
 231
 232         run_test_server.authorize_with('active')
 233         events = Queue.Queue(100)
 234
 235         filters = [['object_uuid', 'is_a', 'arvados#human']]
 236         self.ws = arvados.events.subscribe(
 237             arvados.api('v1'), filters,
 238             events.put_nowait,
 239             poll_fallback=False,
 240             last_log_id=None)
 241         self.assertIsInstance(self.ws, arvados.events.EventClient)
 242
 243         # simulate improper close
 244         self.ws.on_closed()
 245
 246         # verify log messages to ensure retry happened
 247         log_messages = logstream.getvalue()
 248         found = log_messages.find("Error 'EventClient.connect error' during websocket reconnect.")
 249         self.assertNotEqual(found, -1)
 250         rootLogger.removeHandler(streamHandler)
 251
 252     @mock.patch('arvados.events._EventClient')
 253     def test_subscribe_method(self, websocket_client):
 254         filters = [['object_uuid', 'is_a', 'arvados#human']]
 255         client = arvados.events.EventClient(
 256             self.MOCK_WS_URL, [], lambda event: None, None)
 257         client.subscribe(filters[:], 99)
 258         websocket_client().subscribe.assert_called_with(filters, 99)
 259
 260     @mock.patch('arvados.events._EventClient')
 261     def test_unsubscribe(self, websocket_client):
 262         filters = [['object_uuid', 'is_a', 'arvados#human']]
 263         client = arvados.events.EventClient(
 264             self.MOCK_WS_URL, filters[:], lambda event: None, None)
 265         client.unsubscribe(filters[:])
 266         websocket_client().unsubscribe.assert_called_with(filters)
 267
 268     @unittest.expectedFailure
 269     @mock.patch('arvados.events._EventClient')
 270     def test_run_forever(self, websocket_client):
 271         client = arvados.events.EventClient(
 272             self.MOCK_WS_URL, [], lambda event: None, None)
 273         client.run_forever()
 274         websocket_client().run_forever.assert_called_with()
 275
 276
 277 class PollClientTestCase(unittest.TestCase):
 278     class MockLogs(object):
 279         def __init__(self):
 280             self.logs = []
 281             self.lock = threading.Lock()
 282
 283         def add(self, log):
 284             with self.lock:
 285                 self.logs.append(log)
 286
 287         def return_list(self, num_retries=None):
 288             with self.lock:
 289                 retval = self.logs
 290                 self.logs = []
 291             return {'items': retval, 'items_available': len(retval)}
 292
 293
 294     def setUp(self):
 295         self.logs = self.MockLogs()
 296         self.arv = mock.MagicMock(name='arvados.api()')
 297         self.arv.logs().list().execute.side_effect = self.logs.return_list
 298         self.callback_cond = threading.Condition()
 299         self.recv_events = []
 300
 301     def tearDown(self):
 302         if hasattr(self, 'client'):
 303             self.client.close(timeout=None)
 304
 305     def callback(self, event):
 306         with self.callback_cond:
 307             self.recv_events.append(event)
 308             self.callback_cond.notify_all()
 309
 310     def build_client(self, filters=None, callback=None, last_log_id=None, poll_time=99):
 311         if filters is None:
 312             filters = []
 313         if callback is None:
 314             callback = self.callback
 315         self.client = arvados.events.PollClient(
 316             self.arv, filters, callback, poll_time, last_log_id)
 317
 318     def was_filter_used(self, target):
 319         return any(target in call[-1].get('filters', [])
 320                    for call in self.arv.logs().list.call_args_list)
 321
 322     def test_callback(self):
 323         test_log = {'id': 12345, 'testkey': 'testtext'}
 324         self.logs.add({'id': 123})
 325         self.build_client(poll_time=.01)
 326         with self.callback_cond:
 327             self.client.start()
 328             self.callback_cond.wait()
 329             self.logs.add(test_log.copy())
 330             self.callback_cond.wait()
 331         self.client.close(timeout=None)
 332         self.assertIn(test_log, self.recv_events)
 333
 334     def test_subscribe(self):
 335         client_filter = ['kind', '=', 'arvados#test']
 336         self.build_client()
 337         self.client.subscribe([client_filter[:]])
 338         with self.callback_cond:
 339             self.client.start()
 340             self.callback_cond.wait()
 341         self.client.close(timeout=None)
 342         self.assertTrue(self.was_filter_used(client_filter))
 343
 344     def test_unsubscribe(self):
 345         client_filter = ['kind', '=', 'arvados#test']
 346         self.build_client()
 347         self.client.subscribe([client_filter[:]])
 348         self.client.unsubscribe([client_filter[:]])
 349         self.client.start()
 350         self.client.close(timeout=None)
 351         self.assertFalse(self.was_filter_used(client_filter))
 352
 353     def test_run_forever(self):
 354         self.build_client()
 355         with self.callback_cond:
 356             self.client.start()
 357             forever_thread = threading.Thread(target=self.client.run_forever)
 358             forever_thread.start()
 359             self.callback_cond.wait()
 360         self.assertTrue(forever_thread.is_alive())
 361         self.client.close()
 362         forever_thread.join()