import apiclient
import apiclient.discovery
+import apiclient.errors
import config
import errors
import util
return _cast_orig(value, schema_type)
apiclient.discovery._cast = _cast_objects_too
+# Convert apiclient's HttpErrors into our own API error subclass for better
+# error reporting.
+# Reassigning apiclient.errors.HttpError is not sufficient because most of the
+# apiclient submodules import the class into their own namespace.
+def _new_http_error(cls, *args, **kwargs):
+ return super(apiclient.errors.HttpError, cls).__new__(
+ errors.ApiError, *args, **kwargs)
+apiclient.errors.HttpError.__new__ = staticmethod(_new_http_error)
+
def http_cache(data_type):
path = os.environ['HOME'] + '/.cache/arvados/' + data_type
try:
# errors.py - Arvados-specific exceptions.
+import apiclient.errors
+import json
+
+class ApiError(apiclient.errors.HttpError):
+ def _get_reason(self):
+ try:
+ return '; '.join(json.loads(self.content)['errors'])
+ except (KeyError, TypeError, ValueError):
+ return super(ApiError, self)._get_reason()
+
+
class ArgumentError(Exception):
pass
class SyntaxError(Exception):
#!/usr/bin/env python
+import apiclient.errors
import arvados
import httplib2
import json
mimetypes.init()
class ArvadosApiClientTest(unittest.TestCase):
+ @classmethod
+ def response_from_code(cls, code):
+ return httplib2.Response(
+ {'status': code,
+ 'reason': HTTP_RESPONSES.get(code, "Unknown Response"),
+ 'Content-Type': mimetypes.types_map['.json']})
+
+ @classmethod
+ def api_error_response(cls, code, *errors):
+ return (cls.response_from_code(code),
+ json.dumps({'errors': errors,
+ 'error_token': '1234567890+12345678'}))
+
@classmethod
def setUpClass(cls):
# The apiclient library has support for mocking requests for
cls.orig_api_host = arvados.config.get('ARVADOS_API_HOST')
arvados.config.settings()['ARVADOS_API_HOST'] = 'qr1hi.arvadosapi.com'
mock_responses = {
+ 'arvados.humans.delete': (cls.response_from_code(500), ""),
+ 'arvados.humans.get': cls.api_error_response(
+ 422, "Bad UUID format", "Bad output format"),
'arvados.humans.list': (None, json.dumps(
{'items_available': 0, 'items': []})),
}
filters=[['uuid', 'is', None]]).execute()
self.assertEqual(answer['items_available'], len(answer['items']))
+ def test_exceptions_include_errors(self):
+ with self.assertRaises(apiclient.errors.HttpError) as err_ctx:
+ self.api.humans().get(uuid='xyz-xyz-abcdef').execute()
+ err_s = str(err_ctx.exception)
+ for msg in ["Bad UUID format", "Bad output format"]:
+ self.assertIn(msg, err_s)
+
+ def test_exceptions_without_errors_have_basic_info(self):
+ with self.assertRaises(apiclient.errors.HttpError) as err_ctx:
+ self.api.humans().delete(uuid='xyz-xyz-abcdef').execute()
+ self.assertIn("500", str(err_ctx.exception))
+
if __name__ == '__main__':
unittest.main()