sdk/python/tests/test_keep_client.py

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