X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6f1c0e1dd16f53ce4fb7e8785a130e5f588500e5..b17f04b7797eda5a5d888264f7d480d762a9966f:/sdk/python/tests/test_keep_client.py diff --git a/sdk/python/tests/test_keep_client.py b/sdk/python/tests/test_keep_client.py index 977f05ed8e..872c93bae2 100644 --- a/sdk/python/tests/test_keep_client.py +++ b/sdk/python/tests/test_keep_client.py @@ -1,3 +1,14 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: Apache-2.0 + +from __future__ import absolute_import +from __future__ import division +from future import standard_library +standard_library.install_aliases() +from builtins import str +from builtins import range +from builtins import object import hashlib import mock import os @@ -5,16 +16,17 @@ import pycurl import random import re import socket -import threading +import sys import time import unittest -import urlparse +import urllib.parse import arvados import arvados.retry -import arvados_testutil as tutil -import keepstub -import run_test_server +import arvados.util +from . import arvados_testutil as tutil +from . import keepstub +from . import run_test_server class KeepTestCase(run_test_server.TestCaseWithServers): MAIN_SERVER = {} @@ -31,7 +43,7 @@ class KeepTestCase(run_test_server.TestCaseWithServers): def test_KeepBasicRWTest(self): self.assertEqual(0, self.keep_client.upload_counter.get()) foo_locator = self.keep_client.put('foo') - self.assertRegexpMatches( + self.assertRegex( foo_locator, '^acbd18db4cc2f85cedef654fccc4a4d8\+3', 'wrong md5 hash from Keep.put("foo"): ' + foo_locator) @@ -41,14 +53,14 @@ class KeepTestCase(run_test_server.TestCaseWithServers): self.assertEqual(0, self.keep_client.download_counter.get()) self.assertEqual(self.keep_client.get(foo_locator), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') self.assertEqual(3, self.keep_client.download_counter.get()) def test_KeepBinaryRWTest(self): - blob_str = '\xff\xfe\xf7\x00\x01\x02' + blob_str = b'\xff\xfe\xf7\x00\x01\x02' blob_locator = self.keep_client.put(blob_str) - self.assertRegexpMatches( + self.assertRegex( blob_locator, '^7fc7c53b45e53926ba52821140fef396\+6', ('wrong locator from Keep.put():' + blob_locator)) @@ -57,33 +69,33 @@ class KeepTestCase(run_test_server.TestCaseWithServers): 'wrong content from Keep.get(md5())') def test_KeepLongBinaryRWTest(self): - blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03' + blob_data = b'\xff\xfe\xfd\xfc\x00\x01\x02\x03' for i in range(0,23): - blob_str = blob_str + blob_str - blob_locator = self.keep_client.put(blob_str) - self.assertRegexpMatches( + blob_data = blob_data + blob_data + blob_locator = self.keep_client.put(blob_data) + self.assertRegex( blob_locator, '^84d90fc0d8175dd5dcfab04b999bc956\+67108864', ('wrong locator from Keep.put(): ' + blob_locator)) self.assertEqual(self.keep_client.get(blob_locator), - blob_str, + blob_data, 'wrong content from Keep.get(md5())') @unittest.skip("unreliable test - please fix and close #8752") def test_KeepSingleCopyRWTest(self): - blob_str = '\xff\xfe\xfd\xfc\x00\x01\x02\x03' - blob_locator = self.keep_client.put(blob_str, copies=1) - self.assertRegexpMatches( + blob_data = b'\xff\xfe\xfd\xfc\x00\x01\x02\x03' + blob_locator = self.keep_client.put(blob_data, copies=1) + self.assertRegex( blob_locator, '^c902006bc98a3eb4a3663b65ab4a6fab\+8', ('wrong locator from Keep.put(): ' + blob_locator)) self.assertEqual(self.keep_client.get(blob_locator), - blob_str, + blob_data, 'wrong content from Keep.get(md5())') def test_KeepEmptyCollectionTest(self): blob_locator = self.keep_client.put('', copies=1) - self.assertRegexpMatches( + self.assertRegex( blob_locator, '^d41d8cd98f00b204e9800998ecf8427e\+0', ('wrong locator from Keep.put(""): ' + blob_locator)) @@ -91,28 +103,29 @@ class KeepTestCase(run_test_server.TestCaseWithServers): def test_unicode_must_be_ascii(self): # If unicode type, must only consist of valid ASCII foo_locator = self.keep_client.put(u'foo') - self.assertRegexpMatches( + self.assertRegex( foo_locator, '^acbd18db4cc2f85cedef654fccc4a4d8\+3', 'wrong md5 hash from Keep.put("foo"): ' + foo_locator) - with self.assertRaises(UnicodeEncodeError): - # Error if it is not ASCII - self.keep_client.put(u'\xe2') + if sys.version_info < (3, 0): + with self.assertRaises(UnicodeEncodeError): + # Error if it is not ASCII + self.keep_client.put(u'\xe2') - with self.assertRaises(arvados.errors.ArgumentError): - # Must be a string type + with self.assertRaises(AttributeError): + # Must be bytes or have an encode() method self.keep_client.put({}) def test_KeepHeadTest(self): locator = self.keep_client.put('test_head') - self.assertRegexpMatches( + self.assertRegex( locator, '^b9a772c7049325feb7130fff1f8333e9\+9', 'wrong md5 hash from Keep.put for "test_head": ' + locator) self.assertEqual(True, self.keep_client.head(locator)) self.assertEqual(self.keep_client.get(locator), - 'test_head', + b'test_head', 'wrong content from Keep.get for "test_head"') class KeepPermissionTestCase(run_test_server.TestCaseWithServers): @@ -124,18 +137,18 @@ class KeepPermissionTestCase(run_test_server.TestCaseWithServers): run_test_server.authorize_with('active') keep_client = arvados.KeepClient() foo_locator = keep_client.put('foo') - self.assertRegexpMatches( + self.assertRegex( foo_locator, r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$', 'invalid locator from Keep.put("foo"): ' + foo_locator) self.assertEqual(keep_client.get(foo_locator), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') # GET with an unsigned locator => NotFound bar_locator = keep_client.put('bar') unsigned_bar_locator = "37b51d194a7513e45b56f6524f2d51f2+3" - self.assertRegexpMatches( + self.assertRegex( bar_locator, r'^37b51d194a7513e45b56f6524f2d51f2\+3\+A[a-f0-9]+@[a-f0-9]+$', 'invalid locator from Keep.put("bar"): ' + bar_locator) @@ -187,7 +200,7 @@ class KeepOptionalPermission(run_test_server.TestCaseWithServers): def _put_foo_and_check(self): signed_locator = self.keep_client.put('foo') - self.assertRegexpMatches( + self.assertRegex( signed_locator, r'^acbd18db4cc2f85cedef654fccc4a4d8\+3\+A[a-f0-9]+@[a-f0-9]+$', 'invalid locator from Keep.put("foo"): ' + signed_locator) @@ -196,13 +209,13 @@ class KeepOptionalPermission(run_test_server.TestCaseWithServers): def test_KeepAuthenticatedSignedTest(self): signed_locator = self._put_foo_and_check() self.assertEqual(self.keep_client.get(signed_locator), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') def test_KeepAuthenticatedUnsignedTest(self): signed_locator = self._put_foo_and_check() self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') def test_KeepUnauthenticatedSignedTest(self): @@ -211,7 +224,7 @@ class KeepOptionalPermission(run_test_server.TestCaseWithServers): signed_locator = self._put_foo_and_check() self.keep_client.api_token = '' self.assertEqual(self.keep_client.get(signed_locator), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') def test_KeepUnauthenticatedUnsignedTest(self): @@ -220,7 +233,7 @@ class KeepOptionalPermission(run_test_server.TestCaseWithServers): signed_locator = self._put_foo_and_check() self.keep_client.api_token = '' self.assertEqual(self.keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8"), - 'foo', + b'foo', 'wrong content from Keep.get(md5("foo"))') @@ -240,17 +253,17 @@ class KeepProxyTestCase(run_test_server.TestCaseWithServers): super(KeepProxyTestCase, self).tearDown() def test_KeepProxyTest1(self): - # Will use ARVADOS_KEEP_PROXY environment variable that is set by - # setUpClass(). + # Will use ARVADOS_KEEP_SERVICES environment variable that + # is set by setUpClass(). keep_client = arvados.KeepClient(api_client=self.api_client, local_store='') baz_locator = keep_client.put('baz') - self.assertRegexpMatches( + self.assertRegex( baz_locator, '^73feffa4b7f6bb68e44cf984c85f6e88\+3', 'wrong md5 hash from Keep.put("baz"): ' + baz_locator) self.assertEqual(keep_client.get(baz_locator), - 'baz', + b'baz', 'wrong content from Keep.get(md5("baz"))') self.assertTrue(keep_client.using_proxy) @@ -261,21 +274,37 @@ class KeepProxyTestCase(run_test_server.TestCaseWithServers): keep_client = arvados.KeepClient(api_client=self.api_client, proxy='', local_store='') baz_locator = keep_client.put('baz2') - self.assertRegexpMatches( + self.assertRegex( baz_locator, '^91f372a266fe2bf2823cb8ec7fda31ce\+4', 'wrong md5 hash from Keep.put("baz2"): ' + baz_locator) self.assertEqual(keep_client.get(baz_locator), - 'baz2', + b'baz2', 'wrong content from Keep.get(md5("baz2"))') self.assertTrue(keep_client.using_proxy) + def test_KeepProxyTestMultipleURIs(self): + # Test using ARVADOS_KEEP_SERVICES env var overriding any + # existing proxy setting and setting multiple proxies + arvados.config.settings()['ARVADOS_KEEP_SERVICES'] = 'http://10.0.0.1 https://foo.example.org:1234/' + keep_client = arvados.KeepClient(api_client=self.api_client, + local_store='') + uris = [x['_service_root'] for x in keep_client._keep_services] + self.assertEqual(uris, ['http://10.0.0.1/', + 'https://foo.example.org:1234/']) + + def test_KeepProxyTestInvalidURI(self): + arvados.config.settings()['ARVADOS_KEEP_SERVICES'] = 'bad.uri.org' + with self.assertRaises(arvados.errors.ArgumentError): + keep_client = arvados.KeepClient(api_client=self.api_client, + local_store='') + class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): def get_service_roots(self, api_client): keep_client = arvados.KeepClient(api_client=api_client) services = keep_client.weighted_service_roots(arvados.KeepLocator('0'*32)) - return [urlparse.urlparse(url) for url in sorted(services)] + return [urllib.parse.urlparse(url) for url in sorted(services)] def test_ssl_flag_respected_in_roots(self): for ssl_flag in [False, True]: @@ -318,7 +347,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): with tutil.mock_keep_responses(force_timeout, 0) as mock: keep_client = arvados.KeepClient(api_client=api_client) with self.assertRaises(arvados.errors.KeepWriteError): - keep_client.put('foo') + keep_client.put(b'foo') self.assertEqual( mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), int(arvados.KeepClient.DEFAULT_TIMEOUT[0]*1000)) @@ -426,7 +455,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): num_retries=3) self.assertEqual([403, 403], [ getattr(error, 'status_code', None) - for error in err_check.exception.request_errors().itervalues()]) + for error in err_check.exception.request_errors().values()]) def test_get_error_reflects_last_retry(self): self.check_errors_from_last_retry('get', arvados.errors.KeepReadError) @@ -459,7 +488,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertEqual(0, len(exc_check.exception.request_errors())) def test_oddball_service_get(self): - body = 'oddball service get' + body = b'oddball service get' api_client = self.mock_keep_services(service_type='fancynewblobstore') with tutil.mock_keep_responses(body, 200): keep_client = arvados.KeepClient(api_client=api_client) @@ -467,7 +496,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertEqual(body, actual) def test_oddball_service_put(self): - body = 'oddball service put' + body = b'oddball service put' pdh = tutil.str_keep_locator(body) api_client = self.mock_keep_services(service_type='fancynewblobstore') with tutil.mock_keep_responses(pdh, 200): @@ -476,7 +505,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertEqual(pdh, actual) def test_oddball_service_writer_count(self): - body = 'oddball service writer count' + body = b'oddball service writer count' pdh = tutil.str_keep_locator(body) api_client = self.mock_keep_services(service_type='fancynewblobstore', count=4) @@ -489,6 +518,77 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertEqual(1, req_mock.call_count) +@tutil.skip_sleep +class KeepXRequestIdTestCase(unittest.TestCase, tutil.ApiClientMock): + def setUp(self): + self.api_client = self.mock_keep_services(count=2) + self.keep_client = arvados.KeepClient(api_client=self.api_client) + self.data = b'xyzzy' + self.locator = '1271ed5ef305aadabc605b1609e24c52' + self.test_id = arvados.util.new_request_id() + self.assertRegex(self.test_id, r'^req-[a-z0-9]{20}$') + # If we don't set request_id to None explicitly here, it will + # return : + self.api_client.request_id = None + + def test_default_to_api_client_request_id(self): + self.api_client.request_id = self.test_id + with tutil.mock_keep_responses(self.locator, 200, 200) as mock: + self.keep_client.put(self.data) + self.assertEqual(2, len(mock.responses)) + for resp in mock.responses: + self.assertProvidedRequestId(resp) + + with tutil.mock_keep_responses(self.data, 200) as mock: + self.keep_client.get(self.locator) + self.assertProvidedRequestId(mock.responses[0]) + + with tutil.mock_keep_responses(b'', 200) as mock: + self.keep_client.head(self.locator) + self.assertProvidedRequestId(mock.responses[0]) + + def test_explicit_request_id(self): + with tutil.mock_keep_responses(self.locator, 200, 200) as mock: + self.keep_client.put(self.data, request_id=self.test_id) + self.assertEqual(2, len(mock.responses)) + for resp in mock.responses: + self.assertProvidedRequestId(resp) + + with tutil.mock_keep_responses(self.data, 200) as mock: + self.keep_client.get(self.locator, request_id=self.test_id) + self.assertProvidedRequestId(mock.responses[0]) + + with tutil.mock_keep_responses(b'', 200) as mock: + self.keep_client.head(self.locator, request_id=self.test_id) + self.assertProvidedRequestId(mock.responses[0]) + + def test_automatic_request_id(self): + with tutil.mock_keep_responses(self.locator, 200, 200) as mock: + self.keep_client.put(self.data) + self.assertEqual(2, len(mock.responses)) + for resp in mock.responses: + self.assertAutomaticRequestId(resp) + + with tutil.mock_keep_responses(self.data, 200) as mock: + self.keep_client.get(self.locator) + self.assertAutomaticRequestId(mock.responses[0]) + + with tutil.mock_keep_responses(b'', 200) as mock: + self.keep_client.head(self.locator) + self.assertAutomaticRequestId(mock.responses[0]) + + def assertAutomaticRequestId(self, resp): + hdr = [x for x in resp.getopt(pycurl.HTTPHEADER) + if x.startswith('X-Request-Id: ')][0] + self.assertNotEqual(hdr, 'X-Request-Id: '+self.test_id) + self.assertRegex(hdr, r'^X-Request-Id: req-[a-z0-9]{20}$') + + def assertProvidedRequestId(self, resp): + self.assertIn('X-Request-Id: '+self.test_id, + resp.getopt(pycurl.HTTPHEADER)) + + @tutil.skip_sleep class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): @@ -507,7 +607,7 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): list('9d81c02e76a3bf54'), ] self.blocks = [ - "{:064x}".format(x) + "{:064x}".format(x).encode() for x in range(len(self.expected_order))] self.hashes = [ hashlib.md5(self.blocks[x]).hexdigest() @@ -544,7 +644,7 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertRaises(arvados.errors.KeepRequestError): op(i) got_order = [ - re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL)).group(1) + re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL).decode()).group(1) for resp in mock.responses] self.assertEqual(self.expected_order[i]*2, got_order) @@ -555,7 +655,7 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertRaises(arvados.errors.KeepWriteError): self.keep_client.put(self.blocks[i], num_retries=2, copies=copies) got_order = [ - re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL)).group(1) + re.search(r'//\[?keep0x([0-9a-f]+)', resp.getopt(pycurl.URL).decode()).group(1) for resp in mock.responses] # With T threads racing to make requests, the position # of a given server in the sequence of HTTP requests @@ -583,7 +683,7 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): def test_probe_waste_adding_one_server(self): hashes = [ - hashlib.md5("{:064x}".format(x)).hexdigest() for x in range(100)] + hashlib.md5("{:064x}".format(x).encode()).hexdigest() for x in range(100)] initial_services = 12 self.api_client = self.mock_keep_services(count=initial_services) self.keep_client = arvados.KeepClient(api_client=self.api_client) @@ -621,7 +721,7 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): max_penalty)) def check_64_zeros_error_order(self, verb, exc_class): - data = '0' * 64 + data = b'0' * 64 if verb == 'get': data = tutil.str_keep_locator(data) # Arbitrary port number: @@ -630,9 +730,9 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): keep_client = arvados.KeepClient(api_client=api_client) with mock.patch('pycurl.Curl') as curl_mock, \ self.assertRaises(exc_class) as err_check: - curl_mock.return_value.side_effect = socket.timeout + curl_mock.return_value = tutil.FakeCurl.make(code=500, body=b'') getattr(keep_client, verb)(data) - urls = [urlparse.urlparse(url) + urls = [urllib.parse.urlparse(url) for url in err_check.exception.request_errors()] self.assertEqual([('keep0x' + c, aport) for c in '3eab2d5fc9681074'], [(url.hostname, url.port) for url in urls]) @@ -644,11 +744,11 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): self.check_64_zeros_error_order('put', arvados.errors.KeepWriteError) -class KeepClientTimeout(unittest.TestCase, tutil.ApiClientMock): +class KeepClientTimeout(keepstub.StubKeepServers, unittest.TestCase): # BANDWIDTH_LOW_LIM must be less than len(DATA) so we can transfer # 1s worth of data and then trigger bandwidth errors before running # out of data. - DATA = 'x'*2**11 + DATA = b'x'*2**11 BANDWIDTH_LOW_LIM = 1024 TIMEOUT_TIME = 1.0 @@ -678,24 +778,6 @@ class KeepClientTimeout(unittest.TestCase, tutil.ApiClientMock): delta = round(time.time() - self.t0, 3) self.assertGreaterEqual(delta, self.tmin) - def setUp(self): - sock = socket.socket() - sock.bind(('0.0.0.0', 0)) - self.port = sock.getsockname()[1] - sock.close() - self.server = keepstub.Server(('0.0.0.0', self.port), keepstub.Handler) - self.thread = threading.Thread(target=self.server.serve_forever) - self.thread.daemon = True # Exit thread if main proc exits - self.thread.start() - self.api_client = self.mock_keep_services( - count=1, - service_host='localhost', - service_port=self.port, - ) - - def tearDown(self): - self.server.shutdown() - def keepClient(self, timeouts=(0.1, TIMEOUT_TIME, BANDWIDTH_LOW_LIM)): return arvados.KeepClient( api_client=self.api_client, @@ -793,10 +875,10 @@ class KeepClientTimeout(unittest.TestCase, tutil.ApiClientMock): # Allow 10s to connect, then 1s for response. Nothing should # work, and everything should take at least 1s to return. kc = self.keepClient(timeouts=(10, 1)) - with self.assertTakesBetween(1, 1.9): + with self.assertTakesBetween(1, 9): with self.assertRaises(arvados.errors.KeepReadError): kc.get(loc, num_retries=0) - with self.assertTakesBetween(1, 1.9): + with self.assertTakesBetween(1, 9): with self.assertRaises(arvados.errors.KeepWriteError): kc.put(self.DATA, copies=1, num_retries=0) @@ -824,9 +906,9 @@ class KeepClientGatewayTestCase(unittest.TestCase, tutil.ApiClientMock): code=200, body='foo', headers={'Content-Length': 3}) self.mock_disks_and_gateways() locator = 'acbd18db4cc2f85cedef654fccc4a4d8+3+K@' + self.gateways[0]['uuid'] - self.assertEqual('foo', self.keepClient.get(locator)) + self.assertEqual(b'foo', self.keepClient.get(locator)) self.assertEqual(self.gateway_roots[0]+locator, - MockCurl.return_value.getopt(pycurl.URL)) + MockCurl.return_value.getopt(pycurl.URL).decode()) self.assertEqual(True, self.keepClient.head(locator)) @mock.patch('pycurl.Curl') @@ -846,11 +928,11 @@ class KeepClientGatewayTestCase(unittest.TestCase, tutil.ApiClientMock): # Gateways are tried first, in the order given. for i, root in enumerate(self.gateway_roots): self.assertEqual(root+locator, - mocks[i].getopt(pycurl.URL)) + mocks[i].getopt(pycurl.URL).decode()) # Disk services are tried next. for i in range(gateways, gateways+disks): - self.assertRegexpMatches( - mocks[i].getopt(pycurl.URL), + self.assertRegex( + mocks[i].getopt(pycurl.URL).decode(), r'keep0x') @mock.patch('pycurl.Curl') @@ -858,7 +940,7 @@ class KeepClientGatewayTestCase(unittest.TestCase, tutil.ApiClientMock): gateways = 4 disks = 3 mocks = [ - tutil.FakeCurl.make(code=404, body='') + tutil.FakeCurl.make(code=404, body=b'') for _ in range(gateways+disks) ] MockCurl.side_effect = tutil.queue_with(mocks) @@ -870,32 +952,32 @@ class KeepClientGatewayTestCase(unittest.TestCase, tutil.ApiClientMock): # Gateways are tried first, in the order given. for i, root in enumerate(self.gateway_roots): self.assertEqual(root+locator, - mocks[i].getopt(pycurl.URL)) + mocks[i].getopt(pycurl.URL).decode()) # Disk services are tried next. for i in range(gateways, gateways+disks): - self.assertRegexpMatches( - mocks[i].getopt(pycurl.URL), + self.assertRegex( + mocks[i].getopt(pycurl.URL).decode(), r'keep0x') @mock.patch('pycurl.Curl') def test_get_with_remote_proxy_hint(self, MockCurl): MockCurl.return_value = tutil.FakeCurl.make( - code=200, body='foo', headers={'Content-Length': 3}) + code=200, body=b'foo', headers={'Content-Length': 3}) self.mock_disks_and_gateways() locator = 'acbd18db4cc2f85cedef654fccc4a4d8+3+K@xyzzy' - self.assertEqual('foo', self.keepClient.get(locator)) + self.assertEqual(b'foo', self.keepClient.get(locator)) self.assertEqual('https://keep.xyzzy.arvadosapi.com/'+locator, - MockCurl.return_value.getopt(pycurl.URL)) + MockCurl.return_value.getopt(pycurl.URL).decode()) @mock.patch('pycurl.Curl') def test_head_with_remote_proxy_hint(self, MockCurl): MockCurl.return_value = tutil.FakeCurl.make( - code=200, body='foo', headers={'Content-Length': 3}) + code=200, body=b'foo', headers={'Content-Length': 3}) self.mock_disks_and_gateways() locator = 'acbd18db4cc2f85cedef654fccc4a4d8+3+K@xyzzy' self.assertEqual(True, self.keepClient.head(locator)) self.assertEqual('https://keep.xyzzy.arvadosapi.com/'+locator, - MockCurl.return_value.getopt(pycurl.URL)) + MockCurl.return_value.getopt(pycurl.URL).decode()) class KeepClientRetryTestMixin(object): @@ -914,7 +996,7 @@ class KeepClientRetryTestMixin(object): # out appropriate methods in the client. PROXY_ADDR = 'http://[%s]:65535/' % (tutil.TEST_HOST,) - TEST_DATA = 'testdata' + TEST_DATA = b'testdata' TEST_LOCATOR = 'ef654c40ab4f1747fc699915d4f70902+8' def setUp(self): @@ -1065,65 +1147,74 @@ class KeepClientRetryPutTestCase(KeepClientRetryTestMixin, unittest.TestCase): self.check_exception(copies=2, num_retries=3) -class KeepClientAvoidClientOverreplicationTestCase(unittest.TestCase, tutil.ApiClientMock): +class AvoidOverreplication(unittest.TestCase, tutil.ApiClientMock): + class FakeKeepService(object): + def __init__(self, delay, will_succeed=False, will_raise=None, replicas=1): + self.delay = delay + self.will_succeed = will_succeed + self.will_raise = will_raise + self._result = {} + self._result['headers'] = {} + self._result['headers']['x-keep-replicas-stored'] = str(replicas) + self._result['body'] = 'foobar' - class KeepFakeWriterThread(threading.Thread): - """ - Just Simulating the real KeepClient.KeepWriterThread, to test the ThreadLimiter. - """ - def __init__(self, delay, will_succeed, thread_limiter): - super(KeepClientAvoidClientOverreplicationTestCase.KeepFakeWriterThread, self).__init__() - self.delay = delay # in seconds - self.success = will_succeed - self.limiter = thread_limiter + def put(self, data_hash, data, timeout): + time.sleep(self.delay) + if self.will_raise is not None: + raise self.will_raise + return self.will_succeed - def run(self): - with self.limiter: - if not self.limiter.shall_i_proceed(): - return - time.sleep(self.delay) - if self.success: - self.limiter.save_response('foo', 1) - else: - self.limiter.save_response(None, 0) + def last_result(self): + if self.will_succeed: + return self._result + + def finished(self): + return False + + def setUp(self): + self.copies = 3 + self.pool = arvados.KeepClient.KeepWriterThreadPool( + data = 'foo', + data_hash = 'acbd18db4cc2f85cedef654fccc4a4d8+3', + max_service_replicas = self.copies, + copies = self.copies + ) def test_only_write_enough_on_success(self): - copies = 3 - threads = [] - limiter = arvados.KeepClient.ThreadLimiter(want_copies=copies, max_service_replicas=1) - # Setting up fake writer threads with different delays so that the bug is revealed - for i in range(copies*2): - t = self.KeepFakeWriterThread( - delay=i/10.0, - will_succeed=True, - thread_limiter=limiter) - t.start() - threads.append(t) - for t in threads: - t.join() - self.assertEqual(limiter.done(), copies) - - def test_only_write_enough_on_partial_failure(self): - copies = 3 - threads = [] - limiter = arvados.KeepClient.ThreadLimiter(want_copies=copies, max_service_replicas=1) - for i in range(copies): - t = self.KeepFakeWriterThread( - delay=i/10.0, - will_succeed=False, - thread_limiter=limiter) - t.start() - threads.append(t) - t = self.KeepFakeWriterThread( - delay=i/10.0, - will_succeed=True, - thread_limiter=limiter) - t.start() - threads.append(t) - for t in threads: - t.join() - self.assertEqual(limiter.done(), copies) + for i in range(10): + ks = self.FakeKeepService(delay=i/10.0, will_succeed=True) + self.pool.add_task(ks, None) + self.pool.join() + self.assertEqual(self.pool.done(), self.copies) + + def test_only_write_enough_on_partial_success(self): + for i in range(5): + ks = self.FakeKeepService(delay=i/10.0, will_succeed=False) + self.pool.add_task(ks, None) + ks = self.FakeKeepService(delay=i/10.0, will_succeed=True) + self.pool.add_task(ks, None) + self.pool.join() + self.assertEqual(self.pool.done(), self.copies) + + def test_only_write_enough_when_some_crash(self): + for i in range(5): + ks = self.FakeKeepService(delay=i/10.0, will_raise=Exception()) + self.pool.add_task(ks, None) + ks = self.FakeKeepService(delay=i/10.0, will_succeed=True) + self.pool.add_task(ks, None) + self.pool.join() + self.assertEqual(self.pool.done(), self.copies) + + def test_fail_when_too_many_crash(self): + for i in range(self.copies+1): + ks = self.FakeKeepService(delay=i/10.0, will_raise=Exception()) + self.pool.add_task(ks, None) + for i in range(self.copies-1): + ks = self.FakeKeepService(delay=i/10.0, will_succeed=True) + self.pool.add_task(ks, None) + self.pool.join() + self.assertEqual(self.pool.done(), self.copies-1) @tutil.skip_sleep @@ -1159,3 +1250,27 @@ class RetryNeedsMultipleServices(unittest.TestCase, tutil.ApiClientMock): with self.assertRaises(arvados.errors.KeepWriteError): self.keep_client.put('foo', num_retries=1, copies=2) self.assertEqual(2, req_mock.call_count) + +class KeepClientAPIErrorTest(unittest.TestCase): + def test_api_fail(self): + class ApiMock(object): + def __getattr__(self, r): + if r == "api_token": + return "abc" + else: + raise arvados.errors.KeepReadError() + keep_client = arvados.KeepClient(api_client=ApiMock(), + proxy='', local_store='') + + # The bug this is testing for is that if an API (not + # keepstore) exception is thrown as part of a get(), the next + # attempt to get that same block will result in a deadlock. + # This is why there are two get()s in a row. Unfortunately, + # the failure mode for this test is that the test suite + # deadlocks, there isn't a good way to avoid that without + # adding a special case that has no use except for this test. + + with self.assertRaises(arvados.errors.KeepReadError): + keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8+3") + with self.assertRaises(arvados.errors.KeepReadError): + keep_client.get("acbd18db4cc2f85cedef654fccc4a4d8+3")