sdk/python/tests/test_keep_client.py

   1 import mock
   2 import os
   3 import socket
   4 import unittest
   5 import urlparse
   6
   7 import arvados
   8 import arvados.retry
   9 import arvados_testutil as tutil
  10 import run_test_server
  11
  12 class KeepTestCase(run_test_server.TestCaseWithServers):
  13     MAIN_SERVER = {}
  14     KEEP_SERVER = {}
  15
  16     @classmethod
  17     def setUpClass(cls):
  18         super(KeepTestCase, cls).setUpClass()
  19         run_test_server.authorize_with("admin")
  20         cls.api_client = arvados.api('v1')
  21         cls.keep_client = arvados.KeepClient(api_client=cls.api_client,
  22                                              proxy='', local_store='')
  23
  24     def test_KeepBasicRWTest(self):
  25         foo_locator = self.keep_client.put('foo')
  26         self.assertRegexpMatches(
  27             foo_locator,
  28             '^acbd18db4cc2f85cedef654fccc4a4d8\+3',
  29             'wrong md5 hash from Keep.put("foo"): ' + foo_locator)
  30         self.assertEqual(self.keep_client.get(foo_locator),
  31                          'foo',
  32                          'wrong content from Keep.get(md5("foo"))')
  33
  34     def test_KeepBinaryRWTest(self):
  35         blob_str = '\xff\xfe\xf7\x00\x01\x02'
  36         blob_locator = self.keep_client.put(blob_str)
  37         self.assertRegexpMatches(
  38             blob_locator,
  39             '^7fc7c53b45e53926ba52821140fef396\+6',
  40             ('wrong locator from Keep.put(<binarydata>):' + blob_locator))
  41         self.assertEqual(self.keep_client.get(blob_locator),
  42                          blob_str,
  43                          'wrong content from Keep.get(md5(<binarydata>))')
  44
  45     def test_KeepLongBinaryRWTest(self):
  46         blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03'
  47         for i in range(0,23):
  48             blob_str = blob_str + blob_str
  49         blob_locator = self.keep_client.put(blob_str)
  50         self.assertRegexpMatches(
  51             blob_locator,
  52             '^84d90fc0d8175dd5dcfab04b999bc956\+67108864',
  53             ('wrong locator from Keep.put(<binarydata>): ' + blob_locator))
  54         self.assertEqual(self.keep_client.get(blob_locator),
  55                          blob_str,
  56                          'wrong content from Keep.get(md5(<binarydata>))')
  57
  58     def test_KeepSingleCopyRWTest(self):
  59         blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03'
  60         blob_locator = self.keep_client.put(blob_str, copies=1)
  61         self.assertRegexpMatches(
  62             blob_locator,
  63             '^c902006bc98a3eb4a3663b65ab4a6fab\+8',
  64             ('wrong locator from Keep.put(<binarydata>): ' + blob_locator))
  65         self.assertEqual(self.keep_client.get(blob_locator),
  66                          blob_str,
  67                          'wrong content from Keep.get(md5(<binarydata>))')
  68
  69     def test_KeepEmptyCollectionTest(self):
  70         blob_locator = self.keep_client.put('', copies=1)
  71         self.assertRegexpMatches(
  72             blob_locator,
  73             '^d41d8cd98f00b204e9800998ecf8427e\+0',
  74             ('wrong locator from Keep.put(""): ' + blob_locator))
  75
  76
  77 class KeepPermissionTestCase(run_test_server.TestCaseWithServers):
  78     MAIN_SERVER = {}
  79     KEEP_SERVER = {'blob_signing_key': 'abcdefghijk0123456789',
  80                    'enforce_permissions': True}
  81
  82     def test_KeepBasicRWTest(self):
  83         run_test_server.authorize_with('active')
  84         keep_client = arvados.KeepClient()
  85         foo_locator = keep_client.put('foo')
  86         self.assertRegexpMatches(
  87             foo_locator,
  88             r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$',
  89             'invalid locator from Keep.put("foo"): ' + foo_locator)
  90         self.assertEqual(keep_client.get(foo_locator),
  91                          'foo',
  92                          'wrong content from Keep.get(md5("foo"))')
  93
  94         # GET with an unsigned locator => NotFound
  95         bar_locator = keep_client.put('bar')
  96         unsigned_bar_locator = "37b51d194a7513e45b56f6524f2d51f2+3"
  97         self.assertRegexpMatches(
  98             bar_locator,
  99             r'^37b51d194a7513e45b56f6524f2d51f2\+3\+A[a-f0-9]+@[a-f0-9]+$',
 100             'invalid locator from Keep.put("bar"): ' + bar_locator)
 101         self.assertRaises(arvados.errors.NotFoundError,
 102                           keep_client.get,
 103                           unsigned_bar_locator)
 104
 105         # GET from a different user => NotFound
 106         run_test_server.authorize_with('spectator')
 107         self.assertRaises(arvados.errors.NotFoundError,
 108                           arvados.Keep.get,
 109                           bar_locator)
 110
 111         # Unauthenticated GET for a signed locator => NotFound
 112         # Unauthenticated GET for an unsigned locator => NotFound
 113         keep_client.api_token = ''
 114         self.assertRaises(arvados.errors.NotFoundError,
 115                           keep_client.get,
 116                           bar_locator)
 117         self.assertRaises(arvados.errors.NotFoundError,
 118                           keep_client.get,
 119                           unsigned_bar_locator)
 120
 121
 122 # KeepOptionalPermission: starts Keep with --permission-key-file
 123 # but not --enforce-permissions (i.e. generate signatures on PUT
 124 # requests, but do not require them for GET requests)
 125 #
 126 # All of these requests should succeed when permissions are optional:
 127 # * authenticated request, signed locator
 128 # * authenticated request, unsigned locator
 129 # * unauthenticated request, signed locator
 130 # * unauthenticated request, unsigned locator
 131 class KeepOptionalPermission(run_test_server.TestCaseWithServers):
 132     MAIN_SERVER = {}
 133     KEEP_SERVER = {'blob_signing_key': 'abcdefghijk0123456789',
 134                    'enforce_permissions': False}
 135
 136     @classmethod
 137     def setUpClass(cls):
 138         super(KeepOptionalPermission, cls).setUpClass()
 139         run_test_server.authorize_with("admin")
 140         cls.api_client = arvados.api('v1')
 141
 142     def setUp(self):
 143         super(KeepOptionalPermission, self).setUp()
 144         self.keep_client = arvados.KeepClient(api_client=self.api_client,
 145                                               proxy='', local_store='')
 146
 147     def _put_foo_and_check(self):
 148         signed_locator = self.keep_client.put('foo')
 149         self.assertRegexpMatches(
 150             signed_locator,
 151             r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$',
 152             'invalid locator from Keep.put("foo"): ' + signed_locator)
 153         return signed_locator
 154
 155     def test_KeepAuthenticatedSignedTest(self):
 156         signed_locator = self._put_foo_and_check()
 157         self.assertEqual(self.keep_client.get(signed_locator),
 158                          'foo',
 159                          'wrong content from Keep.get(md5("foo"))')
 160
 161     def test_KeepAuthenticatedUnsignedTest(self):
 162         signed_locator = self._put_foo_and_check()
 163         self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"),
 164                          'foo',
 165                          'wrong content from Keep.get(md5("foo"))')
 166
 167     def test_KeepUnauthenticatedSignedTest(self):
 168         # Check that signed GET requests work even when permissions
 169         # enforcement is off.
 170         signed_locator = self._put_foo_and_check()
 171         self.keep_client.api_token = ''
 172         self.assertEqual(self.keep_client.get(signed_locator),
 173                          'foo',
 174                          'wrong content from Keep.get(md5("foo"))')
 175
 176     def test_KeepUnauthenticatedUnsignedTest(self):
 177         # Since --enforce-permissions is not in effect, GET requests
 178         # need not be authenticated.
 179         signed_locator = self._put_foo_and_check()
 180         self.keep_client.api_token = ''
 181         self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"),
 182                          'foo',
 183                          'wrong content from Keep.get(md5("foo"))')
 184
 185
 186 class KeepProxyTestCase(run_test_server.TestCaseWithServers):
 187     MAIN_SERVER = {}
 188     KEEP_SERVER = {}
 189     KEEP_PROXY_SERVER = {'auth': 'admin'}
 190
 191     @classmethod
 192     def setUpClass(cls):
 193         super(KeepProxyTestCase, cls).setUpClass()
 194         cls.api_client = arvados.api('v1')
 195
 196     def tearDown(self):
 197         arvados.config.settings().pop('ARVADOS_EXTERNAL_CLIENT', None)
 198         super(KeepProxyTestCase, self).tearDown()
 199
 200     def test_KeepProxyTest1(self):
 201         # Will use ARVADOS_KEEP_PROXY environment variable that is set by
 202         # setUpClass().
 203         keep_client = arvados.KeepClient(api_client=self.api_client,
 204                                          local_store='')
 205         baz_locator = keep_client.put('baz')
 206         self.assertRegexpMatches(
 207             baz_locator,
 208             '^73feffa4b7f6bb68e44cf984c85f6e88\+3',
 209             'wrong md5 hash from Keep.put("baz"): ' + baz_locator)
 210         self.assertEqual(keep_client.get(baz_locator),
 211                          'baz',
 212                          'wrong content from Keep.get(md5("baz"))')
 213         self.assertTrue(keep_client.using_proxy)
 214
 215     def test_KeepProxyTest2(self):
 216         # Don't instantiate the proxy directly, but set the X-External-Client
 217         # header.  The API server should direct us to the proxy.
 218         arvados.config.settings()['ARVADOS_EXTERNAL_CLIENT'] = 'true'
 219         keep_client = arvados.KeepClient(api_client=self.api_client,
 220                                          proxy='', local_store='')
 221         baz_locator = keep_client.put('baz2')
 222         self.assertRegexpMatches(
 223             baz_locator,
 224             '^91f372a266fe2bf2823cb8ec7fda31ce\+4',
 225             'wrong md5 hash from Keep.put("baz2"): ' + baz_locator)
 226         self.assertEqual(keep_client.get(baz_locator),
 227                          'baz2',
 228                          'wrong content from Keep.get(md5("baz2"))')
 229         self.assertTrue(keep_client.using_proxy)
 230
 231
 232 class KeepClientServiceTestCase(unittest.TestCase):
 233     def mock_keep_services(self, *services):
 234         api_client = mock.MagicMock(name='api_client')
 235         api_client.keep_services().accessible().execute.return_value = {
 236             'items_available': len(services),
 237             'items': [{
 238                     'uuid': 'zzzzz-bi6l4-mockservice{:04x}'.format(index),
 239                     'owner_uuid': 'zzzzz-tpzed-mockownerabcdef',
 240                     'service_host': host,
 241                     'service_port': port,
 242                     'service_ssl_flag': ssl,
 243                     'service_type': servtype,
 244                     } for index, (host, port, ssl, servtype)
 245                       in enumerate(services)],
 246             }
 247         return api_client
 248
 249     def get_service_roots(self, *services):
 250         api_client = self.mock_keep_services(*services)
 251         keep_client = arvados.KeepClient(api_client=api_client)
 252         services = keep_client.shuffled_service_roots('000000')
 253         return [urlparse.urlparse(url) for url in sorted(services)]
 254
 255     def test_ssl_flag_respected_in_roots(self):
 256         services = self.get_service_roots(('keep', 10, False, 'disk'),
 257                                           ('keep', 20, True, 'disk'))
 258         self.assertEqual(10, services[0].port)
 259         self.assertEqual('http', services[0].scheme)
 260         self.assertEqual(20, services[1].port)
 261         self.assertEqual('https', services[1].scheme)
 262
 263     def test_correct_ports_with_ipv6_addresses(self):
 264         service = self.get_service_roots(('100::1', 10, True, 'proxy'))[0]
 265         self.assertEqual('100::1', service.hostname)
 266         self.assertEqual(10, service.port)
 267
 268     # test_get_timeout and test_put_timeout test that
 269     # KeepClient.get and KeepClient.put use the appropriate timeouts
 270     # when connected directly to a Keep server (i.e. non-proxy timeout)
 271
 272     def test_get_timeout(self):
 273         api_client = self.mock_keep_services(('keep', 10, False, 'disk'))
 274         keep_client = arvados.KeepClient(api_client=api_client)
 275         force_timeout = [socket.timeout("timed out")]
 276         with mock.patch('requests.get', side_effect=force_timeout) as mock_request:
 277             with self.assertRaises(arvados.errors.KeepReadError):
 278                 keep_client.get('ffffffffffffffffffffffffffffffff')
 279             self.assertTrue(mock_request.called)
 280             self.assertEqual(
 281                 arvados.KeepClient.DEFAULT_TIMEOUT,
 282                 mock_request.call_args[1]['timeout'])
 283
 284     def test_put_timeout(self):
 285         api_client = self.mock_keep_services(('keep', 10, False, 'disk'))
 286         keep_client = arvados.KeepClient(api_client=api_client)
 287         force_timeout = [socket.timeout("timed out")]
 288         with mock.patch('requests.put', side_effect=force_timeout) as mock_request:
 289             with self.assertRaises(arvados.errors.KeepWriteError):
 290                 keep_client.put('foo')
 291             self.assertTrue(mock_request.called)
 292             self.assertEqual(
 293                 arvados.KeepClient.DEFAULT_TIMEOUT,
 294                 mock_request.call_args[1]['timeout'])
 295
 296     def test_proxy_get_timeout(self):
 297         # Force a timeout, verifying that the requests.get or
 298         # requests.put method was called with the proxy_timeout
 299         # setting rather than the default timeout.
 300         api_client = self.mock_keep_services(('keep', 10, False, 'proxy'))
 301         keep_client = arvados.KeepClient(api_client=api_client)
 302         force_timeout = [socket.timeout("timed out")]
 303         with mock.patch('requests.get', side_effect=force_timeout) as mock_request:
 304             with self.assertRaises(arvados.errors.KeepReadError):
 305                 keep_client.get('ffffffffffffffffffffffffffffffff')
 306             self.assertTrue(mock_request.called)
 307             self.assertEqual(
 308                 arvados.KeepClient.DEFAULT_PROXY_TIMEOUT,
 309                 mock_request.call_args[1]['timeout'])
 310
 311     def test_proxy_put_timeout(self):
 312         # Force a timeout, verifying that the requests.get or
 313         # requests.put method was called with the proxy_timeout
 314         # setting rather than the default timeout.
 315         api_client = self.mock_keep_services(('keep', 10, False, 'proxy'))
 316         keep_client = arvados.KeepClient(api_client=api_client)
 317         force_timeout = [socket.timeout("timed out")]
 318         with mock.patch('requests.put', side_effect=force_timeout) as mock_request:
 319             with self.assertRaises(arvados.errors.KeepWriteError):
 320                 keep_client.put('foo')
 321             self.assertTrue(mock_request.called)
 322             self.assertEqual(
 323                 arvados.KeepClient.DEFAULT_PROXY_TIMEOUT,
 324                 mock_request.call_args[1]['timeout'])
 325
 326
 327 class KeepClientRetryTestMixin(object):
 328     # Testing with a local Keep store won't exercise the retry behavior.
 329     # Instead, our strategy is:
 330     # * Create a client with one proxy specified (pointed at a black
 331     #   hole), so there's no need to instantiate an API client, and
 332     #   all HTTP requests come from one place.
 333     # * Mock httplib's request method to provide simulated responses.
 334     # This lets us test the retry logic extensively without relying on any
 335     # supporting servers, and prevents side effects in case something hiccups.
 336     # To use this mixin, define DEFAULT_EXPECT, DEFAULT_EXCEPTION, and
 337     # run_method().
 338     #
 339     # Test classes must define TEST_PATCHER to a method that mocks
 340     # out appropriate methods in the client.
 341
 342     PROXY_ADDR = 'http://[%s]:65535/' % (tutil.TEST_HOST,)
 343     TEST_DATA = 'testdata'
 344     TEST_LOCATOR = 'ef654c40ab4f1747fc699915d4f70902+8'
 345
 346     def setUp(self):
 347         self.client_kwargs = {'proxy': self.PROXY_ADDR, 'local_store': ''}
 348
 349     def new_client(self, **caller_kwargs):
 350         kwargs = self.client_kwargs.copy()
 351         kwargs.update(caller_kwargs)
 352         return arvados.KeepClient(**kwargs)
 353
 354     def run_method(self, *args, **kwargs):
 355         raise NotImplementedError("test subclasses must define run_method")
 356
 357     def check_success(self, expected=None, *args, **kwargs):
 358         if expected is None:
 359             expected = self.DEFAULT_EXPECT
 360         self.assertEqual(expected, self.run_method(*args, **kwargs))
 361
 362     def check_exception(self, error_class=None, *args, **kwargs):
 363         if error_class is None:
 364             error_class = self.DEFAULT_EXCEPTION
 365         self.assertRaises(error_class, self.run_method, *args, **kwargs)
 366
 367     def test_immediate_success(self):
 368         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 200):
 369             self.check_success()
 370
 371     def test_retry_then_success(self):
 372         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 373             self.check_success(num_retries=3)
 374
 375     def test_no_default_retry(self):
 376         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 377             self.check_exception()
 378
 379     def test_no_retry_after_permanent_error(self):
 380         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 403, 200):
 381             self.check_exception(num_retries=3)
 382
 383     def test_error_after_retries_exhausted(self):
 384         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 500, 200):
 385             self.check_exception(num_retries=1)
 386
 387     def test_num_retries_instance_fallback(self):
 388         self.client_kwargs['num_retries'] = 3
 389         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 390             self.check_success()
 391
 392
 393 @tutil.skip_sleep
 394 class KeepClientRetryGetTestCase(KeepClientRetryTestMixin, unittest.TestCase):
 395     DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_DATA
 396     DEFAULT_EXCEPTION = arvados.errors.KeepReadError
 397     HINTED_LOCATOR = KeepClientRetryTestMixin.TEST_LOCATOR + '+K@xyzzy'
 398     TEST_PATCHER = staticmethod(tutil.mock_get_responses)
 399
 400     def run_method(self, locator=KeepClientRetryTestMixin.TEST_LOCATOR,
 401                    *args, **kwargs):
 402         return self.new_client().get(locator, *args, **kwargs)
 403
 404     def test_specific_exception_when_not_found(self):
 405         with tutil.mock_get_responses(self.DEFAULT_EXPECT, 404, 200):
 406             self.check_exception(arvados.errors.NotFoundError, num_retries=3)
 407
 408     def test_general_exception_with_mixed_errors(self):
 409         # get should raise a NotFoundError if no server returns the block,
 410         # and a high threshold of servers report that it's not found.
 411         # This test rigs up 50/50 disagreement between two servers, and
 412         # checks that it does not become a NotFoundError.
 413         client = self.new_client()
 414         with tutil.mock_get_responses(self.DEFAULT_EXPECT, 404, 500):
 415             with self.assertRaises(arvados.errors.KeepReadError) as exc_check:
 416                 client.get(self.HINTED_LOCATOR)
 417             self.assertNotIsInstance(
 418                 exc_check.exception, arvados.errors.NotFoundError,
 419                 "mixed errors raised NotFoundError")
 420
 421     def test_hint_server_can_succeed_without_retries(self):
 422         with tutil.mock_get_responses(self.DEFAULT_EXPECT, 404, 200, 500):
 423             self.check_success(locator=self.HINTED_LOCATOR)
 424
 425     def test_try_next_server_after_timeout(self):
 426         side_effects = [
 427             socket.timeout("timed out"),
 428             tutil.fake_requests_response(200, self.DEFAULT_EXPECT)]
 429         with mock.patch('requests.get',
 430                         side_effect=iter(side_effects)):
 431             self.check_success(locator=self.HINTED_LOCATOR)
 432
 433     def test_retry_data_with_wrong_checksum(self):
 434         side_effects = (tutil.fake_requests_response(200, s)
 435                         for s in ['baddata', self.TEST_DATA])
 436         with mock.patch('requests.get', side_effect=side_effects):
 437             self.check_success(locator=self.HINTED_LOCATOR)
 438
 439
 440 @tutil.skip_sleep
 441 class KeepClientRetryPutTestCase(KeepClientRetryTestMixin, unittest.TestCase):
 442     DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_LOCATOR
 443     DEFAULT_EXCEPTION = arvados.errors.KeepWriteError
 444     TEST_PATCHER = staticmethod(tutil.mock_put_responses)
 445
 446     def run_method(self, data=KeepClientRetryTestMixin.TEST_DATA,
 447                    copies=1, *args, **kwargs):
 448         return self.new_client().put(data, copies, *args, **kwargs)
 449
 450     def test_do_not_send_multiple_copies_to_same_server(self):
 451         with tutil.mock_put_responses(self.DEFAULT_EXPECT, 200):
 452             self.check_exception(copies=2, num_retries=3)