X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/66dd4459251971acceae41622e2e1221892a8872..b13876638cf57b400bd59513a0a1811b3d2993a1:/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 a73ca84211..c2c4728253 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,16 @@ 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 +from . import arvados_testutil as tutil +from . import keepstub +from . import run_test_server class KeepTestCase(run_test_server.TestCaseWithServers): MAIN_SERVER = {} @@ -29,19 +40,26 @@ class KeepTestCase(run_test_server.TestCaseWithServers): proxy='', local_store='') 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) + + # 6 bytes because uploaded 2 copies + self.assertEqual(6, self.keep_client.upload_counter.get()) + + 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)) @@ -50,32 +68,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)) @@ -83,19 +102,31 @@ 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.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), + b'test_head', + 'wrong content from Keep.get for "test_head"') + class KeepPermissionTestCase(run_test_server.TestCaseWithServers): MAIN_SERVER = {} KEEP_SERVER = {'blob_signing_key': 'abcdefghijk0123456789', @@ -105,18 +136,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) @@ -168,7 +199,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) @@ -177,13 +208,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): @@ -192,7 +223,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): @@ -201,7 +232,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"))') @@ -221,17 +252,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) @@ -242,21 +273,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]: @@ -287,8 +334,11 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), int(arvados.KeepClient.DEFAULT_TIMEOUT[0]*1000)) self.assertEqual( - mock.responses[0].getopt(pycurl.TIMEOUT_MS), - int(arvados.KeepClient.DEFAULT_TIMEOUT[1]*1000)) + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_TIMEOUT[2])) def test_put_timeout(self): api_client = self.mock_keep_services(count=1) @@ -296,13 +346,33 @@ 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)) self.assertEqual( - mock.responses[0].getopt(pycurl.TIMEOUT_MS), - int(arvados.KeepClient.DEFAULT_TIMEOUT[1]*1000)) + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_TIMEOUT[2])) + + def test_head_timeout(self): + api_client = self.mock_keep_services(count=1) + force_timeout = socket.timeout("timed out") + with tutil.mock_keep_responses(force_timeout, 0) as mock: + keep_client = arvados.KeepClient(api_client=api_client) + with self.assertRaises(arvados.errors.KeepReadError): + keep_client.head('ffffffffffffffffffffffffffffffff') + self.assertEqual( + mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), + int(arvados.KeepClient.DEFAULT_TIMEOUT[0]*1000)) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_TIMEOUT[2])) def test_proxy_get_timeout(self): api_client = self.mock_keep_services(service_type='proxy', count=1) @@ -315,8 +385,28 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[0]*1000)) self.assertEqual( - mock.responses[0].getopt(pycurl.TIMEOUT_MS), - int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1]*1000)) + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[2])) + + def test_proxy_head_timeout(self): + api_client = self.mock_keep_services(service_type='proxy', count=1) + force_timeout = socket.timeout("timed out") + with tutil.mock_keep_responses(force_timeout, 0) as mock: + keep_client = arvados.KeepClient(api_client=api_client) + with self.assertRaises(arvados.errors.KeepReadError): + keep_client.head('ffffffffffffffffffffffffffffffff') + self.assertEqual( + mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[0]*1000)) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[2])) def test_proxy_put_timeout(self): api_client = self.mock_keep_services(service_type='proxy', count=1) @@ -329,8 +419,11 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): mock.responses[0].getopt(pycurl.CONNECTTIMEOUT_MS), int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[0]*1000)) self.assertEqual( - mock.responses[0].getopt(pycurl.TIMEOUT_MS), - int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1]*1000)) + mock.responses[0].getopt(pycurl.LOW_SPEED_TIME), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[1])) + self.assertEqual( + mock.responses[0].getopt(pycurl.LOW_SPEED_LIMIT), + int(arvados.KeepClient.DEFAULT_PROXY_TIMEOUT[2])) def check_no_services_error(self, verb, exc_class): api_client = mock.MagicMock(name='api_client') @@ -344,6 +437,9 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): def test_get_error_with_no_services(self): self.check_no_services_error('get', arvados.errors.KeepReadError) + def test_head_error_with_no_services(self): + self.check_no_services_error('head', arvados.errors.KeepReadError) + def test_put_error_with_no_services(self): self.check_no_services_error('put', arvados.errors.KeepWriteError) @@ -358,17 +454,20 @@ 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) + def test_head_error_reflects_last_retry(self): + self.check_errors_from_last_retry('head', arvados.errors.KeepReadError) + def test_put_error_reflects_last_retry(self): self.check_errors_from_last_retry('put', arvados.errors.KeepWriteError) def test_put_error_does_not_include_successful_puts(self): data = 'partial failure test' - data_loc = '{}+{}'.format(hashlib.md5(data).hexdigest(), len(data)) + data_loc = tutil.str_keep_locator(data) api_client = self.mock_keep_services(count=3) with tutil.mock_keep_responses(data_loc, 200, 500, 500) as req_mock, \ self.assertRaises(arvados.errors.KeepWriteError) as exc_check: @@ -378,7 +477,7 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): def test_proxy_put_with_no_writable_services(self): data = 'test with no writable services' - data_loc = '{}+{}'.format(hashlib.md5(data).hexdigest(), len(data)) + data_loc = tutil.str_keep_locator(data) api_client = self.mock_keep_services(service_type='proxy', read_only=True, count=1) with tutil.mock_keep_responses(data_loc, 200, 500, 500) as req_mock, \ self.assertRaises(arvados.errors.KeepWriteError) as exc_check: @@ -387,6 +486,36 @@ class KeepClientServiceTestCase(unittest.TestCase, tutil.ApiClientMock): self.assertEqual(True, ("no Keep services available" in str(exc_check.exception))) self.assertEqual(0, len(exc_check.exception.request_errors())) + def test_oddball_service_get(self): + 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) + actual = keep_client.get(tutil.str_keep_locator(body)) + self.assertEqual(body, actual) + + def test_oddball_service_put(self): + 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): + keep_client = arvados.KeepClient(api_client=api_client) + actual = keep_client.put(body, copies=1) + self.assertEqual(pdh, actual) + + def test_oddball_service_writer_count(self): + body = b'oddball service writer count' + pdh = tutil.str_keep_locator(body) + api_client = self.mock_keep_services(service_type='fancynewblobstore', + count=4) + headers = {'x-keep-replicas-stored': 3} + with tutil.mock_keep_responses(pdh, 200, 418, 418, 418, + **headers) as req_mock: + keep_client = arvados.KeepClient(api_client=api_client) + actual = keep_client.put(body, copies=2) + self.assertEqual(pdh, actual) + self.assertEqual(1, req_mock.call_count) + @tutil.skip_sleep class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): @@ -406,7 +535,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() @@ -427,6 +556,10 @@ class KeepClientRendezvousTestCase(unittest.TestCase, tutil.ApiClientMock): self._test_probe_order_against_reference_set( lambda i: self.keep_client.get(self.hashes[i], num_retries=1)) + def test_head_probe_order_against_reference_set(self): + self._test_probe_order_against_reference_set( + lambda i: self.keep_client.head(self.hashes[i], num_retries=1)) + def test_put_probe_order_against_reference_set(self): # copies=1 prevents the test from being sensitive to races # between writer threads. @@ -439,7 +572,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) @@ -450,27 +583,35 @@ 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 + # (got_order) cannot be more than T-1 positions + # earlier than that server's position in the reference + # probe sequence (expected_order). + # + # Loop invariant: we have accounted for +pos+ expected + # probes, either by seeing them in +got_order+ or by + # putting them in +pending+ in the hope of seeing them + # later. As long as +len(pending)