import mock
import os
+import socket
import unittest
+import urlparse
import arvados
import arvados.retry
+import arvados_testutil as tutil
import run_test_server
-from arvados_testutil import fake_httplib2_response
class KeepTestCase(run_test_server.TestCaseWithServers):
MAIN_SERVER = {}
self.assertTrue(keep_client.using_proxy)
+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:
# 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://[100::]/'
+ PROXY_ADDR = 'http://[%s]:65535/' % (tutil.TEST_HOST,)
TEST_DATA = 'testdata'
TEST_LOCATOR = 'ef654c40ab4f1747fc699915d4f70902+8'
- @staticmethod
- def mock_responses(body, *codes):
- return mock.patch('httplib2.Http.request', side_effect=(
- (fake_httplib2_response(code), body) for code in codes))
+ def setUp(self):
+ self.client_kwargs = {'proxy': self.PROXY_ADDR, 'local_store': ''}
- def new_client(self):
- return arvados.KeepClient(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")
self.assertRaises(error_class, self.run_method, *args, **kwargs)
def test_immediate_success(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 200):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 200):
self.check_success()
def test_retry_then_success(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 500, 200):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 200):
self.check_success(num_retries=3)
def test_no_default_retry(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 500, 200):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 500, 200):
self.check_exception()
def test_no_retry_after_permanent_error(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 403, 200):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 403, 200):
self.check_exception(num_retries=3)
def test_error_after_retries_exhausted(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 500, 500, 200):
+ 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()
+
-# Don't delay from HTTPRetryLoop's exponential backoff.
-no_backoff = mock.patch('time.sleep', lambda n: None)
-@no_backoff
-class KeepClientRetryGetTestCase(unittest.TestCase, KeepClientRetryTestMixin):
+@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'
return self.new_client().get(locator, *args, **kwargs)
def test_specific_exception_when_not_found(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 404, 200):
+ 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):
# This test rigs up 50/50 disagreement between two servers, and
# checks that it does not become a NotFoundError.
client = self.new_client()
- with self.mock_responses(self.DEFAULT_EXPECT, 404, 500):
+ 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(
"mixed errors raised NotFoundError")
def test_hint_server_can_succeed_without_retries(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 404, 200, 500):
+ 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)
-@no_backoff
-class KeepClientRetryPutTestCase(unittest.TestCase, KeepClientRetryTestMixin):
+@tutil.skip_sleep
+class KeepClientRetryPutTestCase(KeepClientRetryTestMixin, unittest.TestCase):
DEFAULT_EXPECT = KeepClientRetryTestMixin.TEST_LOCATOR
DEFAULT_EXCEPTION = arvados.errors.KeepWriteError
return self.new_client().put(data, copies, *args, **kwargs)
def test_do_not_send_multiple_copies_to_same_server(self):
- with self.mock_responses(self.DEFAULT_EXPECT, 200):
+ with tutil.mock_responses(self.DEFAULT_EXPECT, 200):
self.check_exception(copies=2, num_retries=3)