sdk/python/tests/test_keep_client.py

   1 import hashlib
   2 import mock
   3 import os
   4 import pycurl
   5 import random
   6 import re
   7 import socket
   8 import threading
   9 import time
  10 import unittest
  11 import urlparse
  12
  13 import arvados
  14 import arvados.retry
  15 import arvados_testutil as tutil
  16 import keepstub
  17 import run_test_server
  18
  19 class KeepTestCase(run_test_server.TestCaseWithServers):
  20     MAIN_SERVER = {}
  21     KEEP_SERVER = {}
  22
  23     @classmethod
  24     def setUpClass(cls):
  25         super(KeepTestCase, cls).setUpClass()
  26         run_test_server.authorize_with("admin")
  27         cls.api_client = arvados.api('v1')
  28         cls.keep_client = arvados.KeepClient(api_client=cls.api_client,
  29                                              proxy='', local_store='')
  30
  31     def test_KeepBasicRWTest(self):
  32         foo_locator = self.keep_client.put('foo')
  33         self.assertRegexpMatches(
  34             foo_locator,
  35             '^acbd18db4cc2f85cedef654fccc4a4d8\+3',
  36             'wrong md5 hash from Keep.put("foo"): ' + foo_locator)
  37         self.assertEqual(self.keep_client.get(foo_locator),
  38                          'foo',
  39                          'wrong content from Keep.get(md5("foo"))')
  40
  41     def test_KeepBinaryRWTest(self):
  42         blob_str = '\xff\xfe\xf7\x00\x01\x02'
  43         blob_locator = self.keep_client.put(blob_str)
  44         self.assertRegexpMatches(
  45             blob_locator,
  46             '^7fc7c53b45e53926ba52821140fef396\+6',
  47             ('wrong locator from Keep.put(<binarydata>):' + blob_locator))
  48         self.assertEqual(self.keep_client.get(blob_locator),
  49                          blob_str,
  50                          'wrong content from Keep.get(md5(<binarydata>))')
  51
  52     def test_KeepLongBinaryRWTest(self):
  53         blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03'
  54         for i in range(0,23):
  55             blob_str = blob_str + blob_str
  56         blob_locator = self.keep_client.put(blob_str)
  57         self.assertRegexpMatches(
  58             blob_locator,
  59             '^84d90fc0d8175dd5dcfab04b999bc956\+67108864',
  60             ('wrong locator from Keep.put(<binarydata>): ' + blob_locator))
  61         self.assertEqual(self.keep_client.get(blob_locator),
  62                          blob_str,
  63                          'wrong content from Keep.get(md5(<binarydata>))')
  64
  65     def test_KeepSingleCopyRWTest(self):
  66         blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03'
  67         blob_locator = self.keep_client.put(blob_str, copies=1)
  68         self.assertRegexpMatches(
  69             blob_locator,
  70             '^c902006bc98a3eb4a3663b65ab4a6fab\+8',
  71             ('wrong locator from Keep.put(<binarydata>): ' + blob_locator))
  72         self.assertEqual(self.keep_client.get(blob_locator),
  73                          blob_str,
  74                          'wrong content from Keep.get(md5(<binarydata>))')
  75
  76     def test_KeepEmptyCollectionTest(self):
  77         blob_locator = self.keep_client.put('', copies=1)
  78         self.assertRegexpMatches(
  79             blob_locator,
  80             '^d41d8cd98f00b204e9800998ecf8427e\+0',
  81             ('wrong locator from Keep.put(""): ' + blob_locator))
  82
  83     def test_unicode_must_be_ascii(self):
  84         # If unicode type, must only consist of valid ASCII
  85         foo_locator = self.keep_client.put(u'foo')
  86         self.assertRegexpMatches(
  87             foo_locator,
  88             '^acbd18db4cc2f85cedef654fccc4a4d8\+3',
  89             'wrong md5 hash from Keep.put("foo"): ' + foo_locator)
  90
  91         with self.assertRaises(UnicodeEncodeError):
  92             # Error if it is not ASCII
  93             self.keep_client.put(u'\xe2')
  94
  95         with self.assertRaises(arvados.errors.ArgumentError):
  96             # Must be a string type
  97             self.keep_client.put({})
  98
  99 class KeepPermissionTestCase(run_test_server.TestCaseWithServers):
 100     MAIN_SERVER = {}
 101     KEEP_SERVER = {'blob_signing_key': 'abcdefghijk0123456789',
 102                    'enforce_permissions': True}
 103
 104     def test_KeepBasicRWTest(self):
 105         run_test_server.authorize_with('active')
 106         keep_client = arvados.KeepClient()
 107         foo_locator = keep_client.put('foo')
 108         self.assertRegexpMatches(
 109             foo_locator,
 110             r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$',
 111             'invalid locator from Keep.put("foo"): ' + foo_locator)
 112         self.assertEqual(keep_client.get(foo_locator),
 113                          'foo',
 114                          'wrong content from Keep.get(md5("foo"))')
 115
 116         # GET with an unsigned locator => NotFound
 117         bar_locator = keep_client.put('bar')
 118         unsigned_bar_locator = "37b51d194a7513e45b56f6524f2d51f2+3"
 119         self.assertRegexpMatches(
 120             bar_locator,
 121             r'^37b51d194a7513e45b56f6524f2d51f2\+3\+A[a-f0-9]+@[a-f0-9]+$',
 122             'invalid locator from Keep.put("bar"): ' + bar_locator)
 123         self.assertRaises(arvados.errors.NotFoundError,
 124                           keep_client.get,
 125                           unsigned_bar_locator)
 126
 127         # GET from a different user => NotFound
 128         run_test_server.authorize_with('spectator')
 129         self.assertRaises(arvados.errors.NotFoundError,
 130                           arvados.Keep.get,
 131                           bar_locator)
 132
 133         # Unauthenticated GET for a signed locator => NotFound
 134         # Unauthenticated GET for an unsigned locator => NotFound
 135         keep_client.api_token = ''
 136         self.assertRaises(arvados.errors.NotFoundError,
 137                           keep_client.get,
 138                           bar_locator)
 139         self.assertRaises(arvados.errors.NotFoundError,
 140                           keep_client.get,
 141                           unsigned_bar_locator)
 142
 143
 144 # KeepOptionalPermission: starts Keep with --permission-key-file
 145 # but not --enforce-permissions (i.e. generate signatures on PUT
 146 # requests, but do not require them for GET requests)
 147 #
 148 # All of these requests should succeed when permissions are optional:
 149 # * authenticated request, signed locator
 150 # * authenticated request, unsigned locator
 151 # * unauthenticated request, signed locator
 152 # * unauthenticated request, unsigned locator
 153 class KeepOptionalPermission(run_test_server.TestCaseWithServers):
 154     MAIN_SERVER = {}
 155     KEEP_SERVER = {'blob_signing_key': 'abcdefghijk0123456789',
 156                    'enforce_permissions': False}
 157
 158     @classmethod
 159     def setUpClass(cls):
 160         super(KeepOptionalPermission, cls).setUpClass()
 161         run_test_server.authorize_with("admin")
 162         cls.api_client = arvados.api('v1')
 163
 164     def setUp(self):
 165         super(KeepOptionalPermission, self).setUp()
 166         self.keep_client = arvados.KeepClient(api_client=self.api_client,
 167                                               proxy='', local_store='')
 168
 169     def _put_foo_and_check(self):
 170         signed_locator = self.keep_client.put('foo')
 171         self.assertRegexpMatches(
 172             signed_locator,
 173             r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$',
 174             'invalid locator from Keep.put("foo"): ' + signed_locator)
 175         return signed_locator
 176
 177     def test_KeepAuthenticatedSignedTest(self):
 178         signed_locator = self._put_foo_and_check()
 179         self.assertEqual(self.keep_client.get(signed_locator),
 180                          'foo',
 181                          'wrong content from Keep.get(md5("foo"))')
 182
 183     def test_KeepAuthenticatedUnsignedTest(self):
 184         signed_locator = self._put_foo_and_check()
 185         self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"),
 186                          'foo',
 187                          'wrong content from Keep.get(md5("foo"))')
 188
 189     def test_KeepUnauthenticatedSignedTest(self):
 190         # Check that signed GET requests work even when permissions
 191         # enforcement is off.
 192         signed_locator = self._put_foo_and_check()
 193         self.keep_client.api_token = ''
 194         self.assertEqual(self.keep_client.get(signed_locator),
 195                          'foo',
 196                          'wrong content from Keep.get(md5("foo"))')
 197
 198     def test_KeepUnauthenticatedUnsignedTest(self):
 199         # Since --enforce-permissions is not in effect, GET requests
 200         # need not be authenticated.
 201         signed_locator = self._put_foo_and_check()
 202         self.keep_client.api_token = ''
 203         self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"),
 204                          'foo',
 205                          'wrong content from Keep.get(md5("foo"))')
 206
 207
 208 class KeepProxyTestCase(run_test_server.TestCaseWithServers):
 209     MAIN_SERVER = {}
 210     KEEP_SERVER = {}
 211     KEEP_PROXY_SERVER = {}
 212
 213     @classmethod
 214     def setUpClass(cls):
 215         super(KeepProxyTestCase, cls).setUpClass()
 216         run_test_server.authorize_with('active')
 217         cls.api_client = arvados.api('v1')
 218
 219     def tearDown(self):
 220         arvados.config.settings().pop('ARVADOS_EXTERNAL_CLIENT', None)
 221         super(KeepProxyTestCase, self).tearDown()
 222
 223     def test_KeepProxyTest1(self):
 224         # Will use ARVADOS_KEEP_PROXY environment variable that is set by
 225         # setUpClass().
 226         keep_client = arvados.KeepClient(api_client=self.api_client,
 227                                          local_store='')
 228         baz_locator = keep_client.put('baz')
 229         self.assertRegexpMatches(
 230             baz_locator,
 231             '^73feffa4b7f6bb68e44cf984c85f6e88\+3',
 232             'wrong md5 hash from Keep.put("baz"): ' + baz_locator)
 233         self.assertEqual(keep_client.get(baz_locator),
 234                          'baz',
 235                          'wrong content from Keep.get(md5("baz"))')
 236         self.assertTrue(keep_client.using_proxy)
 237
 238     def test_KeepProxyTest2(self):
 239         # Don't instantiate the proxy directly, but set the X-External-Client
 240         # header.  The API server should direct us to the proxy.
 241         arvados.config.settings()['ARVADOS_EXTERNAL_CLIENT'] = 'true'
 242         keep_client = arvados.KeepClient(api_client=self.api_client,
 243                                          proxy='', local_store='')
 244         baz_locator = keep_client.put('baz2')
 245         self.assertRegexpMatches(
 246             baz_locator,
 247             '^91f372a266fe2bf2823cb8ec7fda31ce\+4',
 248             'wrong md5 hash from Keep.put("baz2"): ' + baz_locator)
 249         self.assertEqual(keep_client.get(baz_locator),
 250                          'baz2',
 251                          'wrong content from Keep.get(md5("baz2"))')
 252         self.assertTrue(keep_client.using_proxy)
 253
 254
 255 class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock):
 256     def get_service_roots(self, api_client):
 257         keep_client = arvados.KeepClient(api_client=api_client)
 258         services = keep_client.weighted_service_roots(arvados.KeepLocator('0'*32))
 259         return [urlparse.urlparse(url) for url in sorted(services)]
 260
 261     def test_ssl_flag_respected_in_roots(self):
 262         for ssl_flag in [False, True]:
 263             services = self.get_service_roots(self.mock_keep_services(
 264                 service_ssl_flag=ssl_flag))
 265             self.assertEqual(
 266                 ('https' if ssl_flag else 'http'), services[0].scheme)
 267
 268     def test_correct_ports_with_ipv6_addresses(self):
 269         service = self.get_service_roots(self.mock_keep_services(
 270             service_type='proxy', service_host='100::1', service_port=10, count=1))[0]
 271         self.assertEqual('100::1', service.hostname)
 272         self.assertEqual(10, service.port)
 273
 274     # test_*_timeout verify that KeepClient instructs pycurl to use
 275     # the appropriate connection and read timeouts. They don't care
 276     # whether pycurl actually exhibits the expected timeout behavior
 277     # -- those tests are in the KeepClientTimeout test class.
 278
 279     def test_get_timeout(self):
 280         api_client = self.mock_keep_services(count=1)
 281         force_timeout = socket.timeout("timed out")
 282         with tutil.mock_keep_responses(force_timeout, 0) as mock:
 283             keep_client = arvados.KeepClient(api_client=api_client)
 284             with self.assertRaises(arvados.errors.KeepReadError):
 285                 keep_client.get('ffffffffffffffffffffffffffffffff')
 286             self.assertEqual(
 287                 mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS),
 288                 int(arvados.KeepClient.DEFAULT_TIMEOUT[0]*1000))
 289             self.assertEqual(
 290                 mock.responses[0].getopt(pycurl.TIMEOUT_MS),
 291                 int(arvados.KeepClient.DEFAULT_TIMEOUT[1]*1000))
 292
 293     def test_put_timeout(self):
 294         api_client = self.mock_keep_services(count=1)
 295         force_timeout = socket.timeout("timed out")
 296         with tutil.mock_keep_responses(force_timeout, 0) as mock:
 297             keep_client = arvados.KeepClient(api_client=api_client)
 298             with self.assertRaises(arvados.errors.KeepWriteError):
 299                 keep_client.put('foo')
 300             self.assertEqual(
 301                 mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS),
 302                 int(arvados.KeepClient.DEFAULT_TIMEOUT[0]*1000))
 303             self.assertEqual(
 304                 mock.responses[0].getopt(pycurl.TIMEOUT_MS),
 305                 int(arvados.KeepClient.DEFAULT_TIMEOUT[1]*1000))
 306
 307     def test_proxy_get_timeout(self):
 308         api_client = self.mock_keep_services(service_type='proxy', count=1)
 309         force_timeout = socket.timeout("timed out")
 310         with tutil.mock_keep_responses(force_timeout, 0) as mock:
 311             keep_client = arvados.KeepClient(api_client=api_client)
 312             with self.assertRaises(arvados.errors.KeepReadError):
 313                 keep_client.get('ffffffffffffffffffffffffffffffff')
 314             self.assertEqual(
 315                 mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS),
 316                 int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[0]*1000))
 317             self.assertEqual(
 318                 mock.responses[0].getopt(pycurl.TIMEOUT_MS),
 319                 int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1]*1000))
 320
 321     def test_proxy_put_timeout(self):
 322         api_client = self.mock_keep_services(service_type='proxy', count=1)
 323         force_timeout = socket.timeout("timed out")
 324         with tutil.mock_keep_responses(force_timeout, 0) as mock:
 325             keep_client = arvados.KeepClient(api_client=api_client)
 326             with self.assertRaises(arvados.errors.KeepWriteError):
 327                 keep_client.put('foo')
 328             self.assertEqual(
 329                 mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS),
 330                 int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[0]*1000))
 331             self.assertEqual(
 332                 mock.responses[0].getopt(pycurl.TIMEOUT_MS),
 333                 int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1]*1000))
 334
 335     def check_no_services_error(self, verb, exc_class):
 336         api_client = mock.MagicMock(name='api_client')
 337         api_client.keep_services().accessible().execute.side_effect = (
 338             arvados.errors.ApiError)
 339         keep_client = arvados.KeepClient(api_client=api_client)
 340         with self.assertRaises(exc_class) as err_check:
 341             getattr(keep_client, verb)('d41d8cd98f00b204e9800998ecf8427e+0')
 342         self.assertEqual(0, len(err_check.exception.request_errors()))
 343
 344     def test_get_error_with_no_services(self):
 345         self.check_no_services_error('get', arvados.errors.KeepReadError)
 346
 347     def test_put_error_with_no_services(self):
 348         self.check_no_services_error('put', arvados.errors.KeepWriteError)
 349
 350     def check_errors_from_last_retry(self, verb, exc_class):
 351         api_client = self.mock_keep_services(count=2)
 352         req_mock = tutil.mock_keep_responses(
 353             "retry error reporting test", 500, 500, 403, 403)
 354         with req_mock, tutil.skip_sleep, \
 355                 self.assertRaises(exc_class) as err_check:
 356             keep_client = arvados.KeepClient(api_client=api_client)
 357             getattr(keep_client, verb)('d41d8cd98f00b204e9800998ecf8427e+0',
 358                                        num_retries=3)
 359         self.assertEqual([403, 403], [
 360                 getattr(error, 'status_code', None)
 361                 for error in err_check.exception.request_errors().itervalues()])
 362
 363     def test_get_error_reflects_last_retry(self):
 364         self.check_errors_from_last_retry('get', arvados.errors.KeepReadError)
 365
 366     def test_put_error_reflects_last_retry(self):
 367         self.check_errors_from_last_retry('put', arvados.errors.KeepWriteError)
 368
 369     def test_put_error_does_not_include_successful_puts(self):
 370         data = 'partial failure test'
 371         data_loc = '{}+{}'.format(hashlib.md5(data).hexdigest(), len(data))
 372         api_client = self.mock_keep_services(count=3)
 373         with tutil.mock_keep_responses(data_loc, 200, 500, 500) as req_mock, \
 374                 self.assertRaises(arvados.errors.KeepWriteError) as exc_check:
 375             keep_client = arvados.KeepClient(api_client=api_client)
 376             keep_client.put(data)
 377         self.assertEqual(2, len(exc_check.exception.request_errors()))
 378
 379     def test_proxy_put_with_no_writable_services(self):
 380         data = 'test with no writable services'
 381         data_loc = '{}+{}'.format(hashlib.md5(data).hexdigest(), len(data))
 382         api_client = self.mock_keep_services(service_type='proxy', read_only=True, count=1)
 383         with tutil.mock_keep_responses(data_loc, 200, 500, 500) as req_mock, \
 384                 self.assertRaises(arvados.errors.KeepWriteError) as exc_check:
 385           keep_client = arvados.KeepClient(api_client=api_client)
 386           keep_client.put(data)
 387         self.assertEqual(True, ("no Keep services available" in str(exc_check.exception)))
 388         self.assertEqual(0, len(exc_check.exception.request_errors()))
 389
 390
 391 @tutil.skip_sleep
 392 class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock):
 393
 394     def setUp(self):
 395         # expected_order[i] is the probe order for
 396         # hash=md5(sprintf("%064x",i)) where there are 16 services
 397         # with uuid sprintf("anything-%015x",j) with j in 0..15. E.g.,
 398         # the first probe for the block consisting of 64 "0"
 399         # characters is the service whose uuid is
 400         # "zzzzz-bi6l4-000000000000003", so expected_order[0][0]=='3'.
 401         self.services = 16
 402         self.expected_order = [
 403             list('3eab2d5fc9681074'),
 404             list('097dba52e648f1c3'),
 405             list('c5b4e023f8a7d691'),
 406             list('9d81c02e76a3bf54'),
 407             ]
 408         self.blocks = [
 409             "{:064x}".format(x)
 410             for x in range(len(self.expected_order))]
 411         self.hashes = [
 412             hashlib.md5(self.blocks[x]).hexdigest()
 413             for x in range(len(self.expected_order))]
 414         self.api_client = self.mock_keep_services(count=self.services)
 415         self.keep_client = arvados.KeepClient(api_client=self.api_client)
 416
 417     def test_weighted_service_roots_against_reference_set(self):
 418         # Confirm weighted_service_roots() returns the correct order
 419         for i, hash in enumerate(self.hashes):
 420             roots = self.keep_client.weighted_service_roots(arvados.KeepLocator(hash))
 421             got_order = [
 422                 re.search(r'//\[?keep0x([0-9a-f]+)', root).group(1)
 423                 for root in roots]
 424             self.assertEqual(self.expected_order[i], got_order)
 425
 426     def test_get_probe_order_against_reference_set(self):
 427         self._test_probe_order_against_reference_set(
 428             lambda i: self.keep_client.get(self.hashes[i], num_retries=1))
 429
 430     def test_put_probe_order_against_reference_set(self):
 431         # copies=1 prevents the test from being sensitive to races
 432         # between writer threads.
 433         self._test_probe_order_against_reference_set(
 434             lambda i: self.keep_client.put(self.blocks[i], num_retries=1, copies=1))
 435
 436     def _test_probe_order_against_reference_set(self, op):
 437         for i in range(len(self.blocks)):
 438             with tutil.mock_keep_responses('', *[500 for _ in range(self.services*2)]) as mock, \
 439                  self.assertRaises(arvados.errors.KeepRequestError):
 440                 op(i)
 441             got_order = [
 442                 re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL)).group(1)
 443                 for resp in mock.responses]
 444             self.assertEqual(self.expected_order[i]*2, got_order)
 445
 446     def test_put_probe_order_multiple_copies(self):
 447         for copies in range(2, 4):
 448             for i in range(len(self.blocks)):
 449                 with tutil.mock_keep_responses('', *[500 for _ in range(self.services*3)]) as mock, \
 450                      self.assertRaises(arvados.errors.KeepWriteError):
 451                     self.keep_client.put(self.blocks[i], num_retries=2, copies=copies)
 452                 got_order = [
 453                     re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL)).group(1)
 454                     for resp in mock.responses]
 455                 for pos, expected in enumerate(self.expected_order[i]*3):
 456                     # With C threads racing to make requests, the
 457                     # position of a given server in the sequence of
 458                     # HTTP requests (got_order) should be within C-1
 459                     # positions of that server's position in the
 460                     # reference probe sequence (expected_order).
 461                     close_enough = False
 462                     for diff in range(1-copies, copies):
 463                         if 0 <= pos+diff < len(got_order):
 464                             if expected == got_order[pos+diff]:
 465                                 close_enough = True
 466                     self.assertEqual(
 467                         True, close_enough,
 468                         "With copies={}, got {}, expected {}".format(
 469                             copies, repr(got_order), repr(self.expected_order[i]*3)))
 470
 471     def test_probe_waste_adding_one_server(self):
 472         hashes = [
 473             hashlib.md5("{:064x}".format(x)).hexdigest() for x in range(100)]
 474         initial_services = 12
 475         self.api_client = self.mock_keep_services(count=initial_services)
 476         self.keep_client = arvados.KeepClient(api_client=self.api_client)
 477         probes_before = [
 478             self.keep_client.weighted_service_roots(arvados.KeepLocator(hash)) for hash in hashes]
 479         for added_services in range(1, 12):
 480             api_client = self.mock_keep_services(count=initial_services+added_services)
 481             keep_client = arvados.KeepClient(api_client=api_client)
 482             total_penalty = 0
 483             for hash_index in range(len(hashes)):
 484                 probe_after = keep_client.weighted_service_roots(
 485                     arvados.KeepLocator(hashes[hash_index]))
 486                 penalty = probe_after.index(probes_before[hash_index][0])
 487                 self.assertLessEqual(penalty, added_services)
 488                 total_penalty += penalty
 489             # Average penalty per block should not exceed
 490             # N(added)/N(orig) by more than 20%, and should get closer
 491             # to the ideal as we add data points.
 492             expect_penalty = (
 493                 added_services *
 494                 len(hashes) / initial_services)
 495             max_penalty = (
 496                 expect_penalty *
 497                 (120 - added_services)/100)
 498             min_penalty = (
 499                 expect_penalty * 8/10)
 500             self.assertTrue(
 501                 min_penalty <= total_penalty <= max_penalty,
 502                 "With {}+{} services, {} blocks, penalty {} but expected {}..{}".format(
 503                     initial_services,
 504                     added_services,
 505                     len(hashes),
 506                     total_penalty,
 507                     min_penalty,
 508                     max_penalty))
 509
 510     def check_64_zeros_error_order(self, verb, exc_class):
 511         data = '0' * 64
 512         if verb == 'get':
 513             data = hashlib.md5(data).hexdigest() + '+1234'
 514         # Arbitrary port number:
 515         aport = random.randint(1024,65535)
 516         api_client = self.mock_keep_services(service_port=aport, count=self.services)
 517         keep_client = arvados.KeepClient(api_client=api_client)
 518         with mock.patch('pycurl.Curl') as curl_mock, \
 519              self.assertRaises(exc_class) as err_check:
 520             curl_mock.return_value.side_effect = socket.timeout
 521             getattr(keep_client, verb)(data)
 522         urls = [urlparse.urlparse(url)
 523                 for url in err_check.exception.request_errors()]
 524         self.assertEqual([('keep0x' + c, aport) for c in '3eab2d5fc9681074'],
 525                          [(url.hostname, url.port) for url in urls])
 526
 527     def test_get_error_shows_probe_order(self):
 528         self.check_64_zeros_error_order('get', arvados.errors.KeepReadError)
 529
 530     def test_put_error_shows_probe_order(self):
 531         self.check_64_zeros_error_order('put', arvados.errors.KeepWriteError)
 532
 533
 534 class KeepClientTimeout(unittest.TestCase, tutil.ApiClientMock):
 535     DATA = 'x' * 2**10
 536
 537     class assertTakesBetween(unittest.TestCase):
 538         def __init__(self, tmin, tmax):
 539             self.tmin = tmin
 540             self.tmax = tmax
 541
 542         def __enter__(self):
 543             self.t0 = time.time()
 544
 545         def __exit__(self, *args, **kwargs):
 546             self.assertGreater(time.time() - self.t0, self.tmin)
 547             self.assertLess(time.time() - self.t0, self.tmax)
 548
 549     def setUp(self):
 550         sock = socket.socket()
 551         sock.bind(('0.0.0.0', 0))
 552         self.port = sock.getsockname()[1]
 553         sock.close()
 554         self.server = keepstub.Server(('0.0.0.0', self.port), keepstub.Handler)
 555         self.thread = threading.Thread(target=self.server.serve_forever)
 556         self.thread.daemon = True # Exit thread if main proc exits
 557         self.thread.start()
 558         self.api_client = self.mock_keep_services(
 559             count=1,
 560             service_host='localhost',
 561             service_port=self.port,
 562         )
 563
 564     def tearDown(self):
 565         self.server.shutdown()
 566
 567     def keepClient(self, timeouts=(0.1, 1.0)):
 568         return arvados.KeepClient(
 569             api_client=self.api_client,
 570             timeout=timeouts)
 571
 572     def test_timeout_slow_connect(self):
 573         # Can't simulate TCP delays with our own socket. Leave our
 574         # stub server running uselessly, and try to connect to an
 575         # unroutable IP address instead.
 576         self.api_client = self.mock_keep_services(
 577             count=1,
 578             service_host='240.0.0.0',
 579         )
 580         with self.assertTakesBetween(0.1, 0.5):
 581             with self.assertRaises(arvados.errors.KeepWriteError):
 582                 self.keepClient((0.1, 1)).put(self.DATA, copies=1, num_retries=0)
 583
 584     def test_timeout_slow_request(self):
 585         self.server.setdelays(request=0.2)
 586         self._test_200ms()
 587
 588     def test_timeout_slow_response(self):
 589         self.server.setdelays(response=0.2)
 590         self._test_200ms()
 591
 592     def test_timeout_slow_response_body(self):
 593         self.server.setdelays(response_body=0.2)
 594         self._test_200ms()
 595
 596     def _test_200ms(self):
 597         """Connect should be t<100ms, request should be 200ms <= t < 300ms"""
 598
 599         # Allow 100ms to connect, then 1s for response. Everything
 600         # should work, and everything should take at least 200ms to
 601         # return.
 602         kc = self.keepClient((.1, 1))
 603         with self.assertTakesBetween(.2, .3):
 604             loc = kc.put(self.DATA, copies=1, num_retries=0)
 605         with self.assertTakesBetween(.2, .3):
 606             self.assertEqual(self.DATA, kc.get(loc, num_retries=0))
 607
 608         # Allow 1s to connect, then 100ms for response. Nothing should
 609         # work, and everything should take at least 100ms to return.
 610         kc = self.keepClient((1, .1))
 611         with self.assertTakesBetween(.1, .2):
 612             with self.assertRaises(arvados.errors.KeepReadError):
 613                 kc.get(loc, num_retries=0)
 614         with self.assertTakesBetween(.1, .2):
 615             with self.assertRaises(arvados.errors.KeepWriteError):
 616                 kc.put(self.DATA, copies=1, num_retries=0)
 617
 618
 619 class KeepClientGatewayTestCase(unittest.TestCase, tutil.ApiClientMock):
 620     def mock_disks_and_gateways(self, disks=3, gateways=1):
 621         self.gateways = [{
 622                 'uuid': 'zzzzz-bi6l4-gateway{:08d}'.format(i),
 623                 'owner_uuid': 'zzzzz-tpzed-000000000000000',
 624                 'service_host': 'gatewayhost{}'.format(i),
 625                 'service_port': 12345,
 626                 'service_ssl_flag': True,
 627                 'service_type': 'gateway:test',
 628         } for i in range(gateways)]
 629         self.gateway_roots = [
 630             "https://{service_host}:{service_port}/".format(**gw)
 631             for gw in self.gateways]
 632         self.api_client = self.mock_keep_services(
 633             count=disks, additional_services=self.gateways)
 634         self.keepClient = arvados.KeepClient(api_client=self.api_client)
 635
 636     @mock.patch('pycurl.Curl')
 637     def test_get_with_gateway_hint_first(self, MockCurl):
 638         MockCurl.return_value = tutil.FakeCurl.make(
 639             code=200, body='foo', headers={'Content-Length': 3})
 640         self.mock_disks_and_gateways()
 641         locator = 'acbd18db4cc2f85cedef654fccc4a4d8+3+K@' + self.gateways[0]['uuid']
 642         self.assertEqual('foo', self.keepClient.get(locator))
 643         self.assertEqual(self.gateway_roots[0]+locator,
 644                          MockCurl.return_value.getopt(pycurl.URL))
 645
 646     @mock.patch('pycurl.Curl')
 647     def test_get_with_gateway_hints_in_order(self, MockCurl):
 648         gateways = 4
 649         disks = 3
 650         mocks = [
 651             tutil.FakeCurl.make(code=404, body='')
 652             for _ in range(gateways+disks)
 653         ]
 654         MockCurl.side_effect = tutil.queue_with(mocks)
 655         self.mock_disks_and_gateways(gateways=gateways, disks=disks)
 656         locator = '+'.join(['acbd18db4cc2f85cedef654fccc4a4d8+3'] +
 657                            ['K@'+gw['uuid'] for gw in self.gateways])
 658         with self.assertRaises(arvados.errors.NotFoundError):
 659             self.keepClient.get(locator)
 660         # Gateways are tried first, in the order given.
 661         for i, root in enumerate(self.gateway_roots):
 662             self.assertEqual(root+locator,
 663                              mocks[i].getopt(pycurl.URL))
 664         # Disk services are tried next.
 665         for i in range(gateways, gateways+disks):
 666             self.assertRegexpMatches(
 667                 mocks[i].getopt(pycurl.URL),
 668                 r'keep0x')
 669
 670     @mock.patch('pycurl.Curl')
 671     def test_get_with_remote_proxy_hint(self, MockCurl):
 672         MockCurl.return_value = tutil.FakeCurl.make(
 673             code=200, body='foo', headers={'Content-Length': 3})
 674         self.mock_disks_and_gateways()
 675         locator = 'acbd18db4cc2f85cedef654fccc4a4d8+3+K@xyzzy'
 676         self.assertEqual('foo', self.keepClient.get(locator))
 677         self.assertEqual('https://keep.xyzzy.arvadosapi.com/'+locator,
 678                          MockCurl.return_value.getopt(pycurl.URL))
 679
 680
 681 class KeepClientRetryTestMixin(object):
 682     # Testing with a local Keep store won't exercise the retry behavior.
 683     # Instead, our strategy is:
 684     # * Create a client with one proxy specified (pointed at a black
 685     #   hole), so there's no need to instantiate an API client, and
 686     #   all HTTP requests come from one place.
 687     # * Mock httplib's request method to provide simulated responses.
 688     # This lets us test the retry logic extensively without relying on any
 689     # supporting servers, and prevents side effects in case something hiccups.
 690     # To use this mixin, define DEFAULT_EXPECT, DEFAULT_EXCEPTION, and
 691     # run_method().
 692     #
 693     # Test classes must define TEST_PATCHER to a method that mocks
 694     # out appropriate methods in the client.
 695
 696     PROXY_ADDR = 'http://[%s]:65535/' % (tutil.TEST_HOST,)
 697     TEST_DATA = 'testdata'
 698     TEST_LOCATOR = 'ef654c40ab4f1747fc699915d4f70902+8'
 699
 700     def setUp(self):
 701         self.client_kwargs = {'proxy': self.PROXY_ADDR, 'local_store': ''}
 702
 703     def new_client(self, **caller_kwargs):
 704         kwargs = self.client_kwargs.copy()
 705         kwargs.update(caller_kwargs)
 706         return arvados.KeepClient(**kwargs)
 707
 708     def run_method(self, *args, **kwargs):
 709         raise NotImplementedError("test subclasses must define run_method")
 710
 711     def check_success(self, expected=None, *args, **kwargs):
 712         if expected is None:
 713             expected = self.DEFAULT_EXPECT
 714         self.assertEqual(expected, self.run_method(*args, **kwargs))
 715
 716     def check_exception(self, error_class=None, *args, **kwargs):
 717         if error_class is None:
 718             error_class = self.DEFAULT_EXCEPTION
 719         self.assertRaises(error_class, self.run_method, *args, **kwargs)
 720
 721     def test_immediate_success(self):
 722         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 200):
 723             self.check_success()
 724
 725     def test_retry_then_success(self):
 726         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 727             self.check_success(num_retries=3)
 728
 729     def test_no_default_retry(self):
 730         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 731             self.check_exception()
 732
 733     def test_no_retry_after_permanent_error(self):
 734         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 403, 200):
 735             self.check_exception(num_retries=3)
 736
 737     def test_error_after_retries_exhausted(self):
 738         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 500, 200):
 739             self.check_exception(num_retries=1)
 740
 741     def test_num_retries_instance_fallback(self):
 742         self.client_kwargs['num_retries'] = 3
 743         with self.TEST_PATCHER(self.DEFAULT_EXPECT, 500, 200):
 744             self.check_success()
 745
 746
 747 @tutil.skip_sleep
 748 class KeepClientRetryGetTestCase(KeepClientRetryTestMixin, unittest.TestCase):
 749     DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_DATA
 750     DEFAULT_EXCEPTION = arvados.errors.KeepReadError
 751     HINTED_LOCATOR = KeepClientRetryTestMixin.TEST_LOCATOR + '+K@xyzzy'
 752     TEST_PATCHER = staticmethod(tutil.mock_keep_responses)
 753
 754     def run_method(self, locator=KeepClientRetryTestMixin.TEST_LOCATOR,
 755                    *args, **kwargs):
 756         return self.new_client().get(locator, *args, **kwargs)
 757
 758     def test_specific_exception_when_not_found(self):
 759         with tutil.mock_keep_responses(self.DEFAULT_EXPECT, 404, 200):
 760             self.check_exception(arvados.errors.NotFoundError, num_retries=3)
 761
 762     def test_general_exception_with_mixed_errors(self):
 763         # get should raise a NotFoundError if no server returns the block,
 764         # and a high threshold of servers report that it's not found.
 765         # This test rigs up 50/50 disagreement between two servers, and
 766         # checks that it does not become a NotFoundError.
 767         client = self.new_client()
 768         with tutil.mock_keep_responses(self.DEFAULT_EXPECT, 404, 500):
 769             with self.assertRaises(arvados.errors.KeepReadError) as exc_check:
 770                 client.get(self.HINTED_LOCATOR)
 771             self.assertNotIsInstance(
 772                 exc_check.exception, arvados.errors.NotFoundError,
 773                 "mixed errors raised NotFoundError")
 774
 775     def test_hint_server_can_succeed_without_retries(self):
 776         with tutil.mock_keep_responses(self.DEFAULT_EXPECT, 404, 200, 500):
 777             self.check_success(locator=self.HINTED_LOCATOR)
 778
 779     def test_try_next_server_after_timeout(self):
 780         with tutil.mock_keep_responses(
 781                 (socket.timeout("timed out"), 200),
 782                 (self.DEFAULT_EXPECT, 200)):
 783             self.check_success(locator=self.HINTED_LOCATOR)
 784
 785     def test_retry_data_with_wrong_checksum(self):
 786         with tutil.mock_keep_responses(
 787                 ('baddata', 200),
 788                 (self.DEFAULT_EXPECT, 200)):
 789             self.check_success(locator=self.HINTED_LOCATOR)
 790
 791
 792 @tutil.skip_sleep
 793 class KeepClientRetryPutTestCase(KeepClientRetryTestMixin, unittest.TestCase):
 794     DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_LOCATOR
 795     DEFAULT_EXCEPTION = arvados.errors.KeepWriteError
 796     TEST_PATCHER = staticmethod(tutil.mock_keep_responses)
 797
 798     def run_method(self, data=KeepClientRetryTestMixin.TEST_DATA,
 799                    copies=1, *args, **kwargs):
 800         return self.new_client().put(data, copies, *args, **kwargs)
 801
 802     def test_do_not_send_multiple_copies_to_same_server(self):
 803         with tutil.mock_keep_responses(self.DEFAULT_EXPECT, 200):
 804             self.check_exception(copies=2, num_retries=3)