+
+
+class KeepClientServiceTestCase(unittest.TestCase):
+ def mock_keep_services(self, *services):
+ api_client = mock.MagicMock(name='api_client')
+ api_client.keep_services().accessible().execute.return_value = {
+ 'items_available': len(services),
+ 'items': [{
+ 'uuid': 'zzzzz-bi6l4-mockservice{:04x}'.format(index),
+ 'owner_uuid': 'zzzzz-tpzed-mockownerabcdef',
+ 'service_host': host,
+ 'service_port': port,
+ 'service_ssl_flag': ssl,
+ 'service_type': servtype,
+ } for index, (host, port, ssl, servtype)
+ in enumerate(services)],
+ }
+ return api_client
+
+ def get_service_roots(self, *services):
+ api_client = self.mock_keep_services(*services)
+ keep_client = arvados.KeepClient(api_client=api_client)
+ services = keep_client.shuffled_service_roots('000000')
+ return [urlparse.urlparse(url) for url in sorted(services)]
+
+ def test_ssl_flag_respected_in_roots(self):
+ services = self.get_service_roots(('keep', 10, False, 'disk'),
+ ('keep', 20, True, 'disk'))
+ self.assertEqual(10, services[0].port)
+ self.assertEqual('http', services[0].scheme)
+ self.assertEqual(20, services[1].port)
+ self.assertEqual('https', services[1].scheme)
+
+ def test_correct_ports_with_ipv6_addresses(self):
+ service = self.get_service_roots(('100::1', 10, True, 'proxy'))[0]
+ self.assertEqual('100::1', service.hostname)
+ self.assertEqual(10, service.port)
+
+
+class KeepClientRetryTestMixin(object):
+ # Testing with a local Keep store won't exercise the retry behavior.
+ # Instead, our strategy is:
+ # * Create a client with one proxy specified (pointed at a black
+ # hole), so there's no need to instantiate an API client, and
+ # all HTTP requests come from one place.
+ # * Mock httplib's request method to provide simulated responses.
+ # This lets us test the retry logic extensively without relying on any
+ # supporting servers, and prevents side effects in case something hiccups.
+ # To use this mixin, define DEFAULT_EXPECT, DEFAULT_EXCEPTION, and
+ # run_method().
+ PROXY_ADDR = 'http://[%s]:65535/' % (tutil.TEST_HOST,)
+ TEST_DATA = 'testdata'
+ TEST_LOCATOR = 'ef654c40ab4f1747fc699915d4f70902+8'
+
+ def setUp(self):
+ self.client_kwargs = {'proxy': self.PROXY_ADDR, 'local_store': ''}
+
+ def new_client(self, **caller_kwargs):
+ kwargs = self.client_kwargs.copy()
+ kwargs.update(caller_kwargs)
+ return arvados.KeepClient(**kwargs)
+
+ def run_method(self, *args, **kwargs):
+ raise NotImplementedError("test subclasses must define run_method")
+
+ def check_success(self, expected=None, *args, **kwargs):
+ if expected is None:
+ expected = self.DEFAULT_EXPECT
+ self.assertEqual(expected, self.run_method(*args, **kwargs))
+
+ def check_exception(self, error_class=None, *args, **kwargs):
+ if error_class is None:
+ error_class = self.DEFAULT_EXCEPTION
+ self.assertRaises(error_class, self.run_method, *args, **kwargs)
+
+ def test_immediate_success(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 200):
+ self.check_success()
+
+ def test_retry_then_success(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 200):
+ self.check_success(num_retries=3)
+
+ def test_no_default_retry(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 200):
+ self.check_exception()
+
+ def test_no_retry_after_permanent_error(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 403, 200):
+ self.check_exception(num_retries=3)
+
+ def test_error_after_retries_exhausted(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 500, 200):
+ self.check_exception(num_retries=1)
+
+ def test_num_retries_instance_fallback(self):
+ self.client_kwargs['num_retries'] = 3
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 200):
+ self.check_success()
+
+
+@tutil.skip_sleep
+class KeepClientRetryGetTestCase(KeepClientRetryTestMixin, unittest.TestCase):
+ DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_DATA
+ DEFAULT_EXCEPTION = arvados.errors.KeepReadError
+ HINTED_LOCATOR = KeepClientRetryTestMixin.TEST_LOCATOR + '+K@xyzzy'
+
+ def run_method(self, locator=KeepClientRetryTestMixin.TEST_LOCATOR,
+ *args, **kwargs):
+ return self.new_client().get(locator, *args, **kwargs)
+
+ def test_specific_exception_when_not_found(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 404, 200):
+ self.check_exception(arvados.errors.NotFoundError, num_retries=3)
+
+ def test_general_exception_with_mixed_errors(self):
+ # get should raise a NotFoundError if no server returns the block,
+ # and a high threshold of servers report that it's not found.
+ # This test rigs up 50/50 disagreement between two servers, and
+ # checks that it does not become a NotFoundError.
+ client = self.new_client()
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 404, 500):
+ with self.assertRaises(arvados.errors.KeepReadError) as exc_check:
+ client.get(self.HINTED_LOCATOR)
+ self.assertNotIsInstance(
+ exc_check.exception, arvados.errors.NotFoundError,
+ "mixed errors raised NotFoundError")
+
+ def test_hint_server_can_succeed_without_retries(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 404, 200, 500):
+ self.check_success(locator=self.HINTED_LOCATOR)
+
+ def test_try_next_server_after_timeout(self):
+ side_effects = [
+ socket.timeout("timed out"),
+ (tutil.fake_httplib2_response(200), self.DEFAULT_EXPECT)]
+ with mock.patch('httplib2.Http.request',
+ side_effect=iter(side_effects)):
+ self.check_success(locator=self.HINTED_LOCATOR)
+
+ def test_retry_data_with_wrong_checksum(self):
+ side_effects = ((tutil.fake_httplib2_response(200), s)
+ for s in ['baddata', self.TEST_DATA])
+ with mock.patch('httplib2.Http.request', side_effect=side_effects):
+ self.check_success(locator=self.HINTED_LOCATOR)
+
+
+@tutil.skip_sleep
+class KeepClientRetryPutTestCase(KeepClientRetryTestMixin, unittest.TestCase):
+ DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_LOCATOR
+ DEFAULT_EXCEPTION = arvados.errors.KeepWriteError
+
+ def run_method(self, data=KeepClientRetryTestMixin.TEST_DATA,
+ copies=1, *args, **kwargs):
+ return self.new_client().put(data, copies, *args, **kwargs)
+
+ def test_do_not_send_multiple_copies_to_same_server(self):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 200):
+ self.check_exception(copies=2, num_retries=3)