80c6283361
In testcase, setUp will be called automatically. This patch used to remove setUp functions that do nothing. Besides, it will keep code clean. Change-Id: I2bf79884704974dc00196816f7de43580b474d3e
298 lines
11 KiB
Python
298 lines
11 KiB
Python
|
|
# Copyright 2013 Red Hat, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import sys
|
|
|
|
from oslo_serialization import jsonutils
|
|
import six
|
|
import testscenarios
|
|
|
|
import oslo_messaging
|
|
from oslo_messaging._drivers import common as exceptions
|
|
from oslo_messaging.tests import utils as test_utils
|
|
|
|
load_tests = testscenarios.load_tests_apply_scenarios
|
|
|
|
EXCEPTIONS_MODULE = 'exceptions' if six.PY2 else 'builtins'
|
|
OTHER_EXCEPTIONS_MODULE = 'builtins' if six.PY2 else 'exceptions'
|
|
|
|
|
|
class NovaStyleException(Exception):
|
|
|
|
format = 'I am Nova'
|
|
|
|
def __init__(self, message=None, **kwargs):
|
|
self.kwargs = kwargs
|
|
if not message:
|
|
message = self.format % kwargs
|
|
super(NovaStyleException, self).__init__(message)
|
|
|
|
|
|
class KwargsStyleException(NovaStyleException):
|
|
|
|
format = 'I am %(who)s'
|
|
|
|
|
|
def add_remote_postfix(ex):
|
|
ex_type = type(ex)
|
|
message = str(ex)
|
|
str_override = lambda self: message
|
|
new_ex_type = type(ex_type.__name__ + "_Remote", (ex_type,),
|
|
{'__str__': str_override,
|
|
'__unicode__': str_override})
|
|
new_ex_type.__module__ = '%s_Remote' % ex.__class__.__module__
|
|
try:
|
|
ex.__class__ = new_ex_type
|
|
except TypeError:
|
|
ex.args = (message,) + ex.args[1:]
|
|
return ex
|
|
|
|
|
|
class SerializeRemoteExceptionTestCase(test_utils.BaseTestCase):
|
|
|
|
_add_remote = [
|
|
('add_remote', dict(add_remote=True)),
|
|
('do_not_add_remote', dict(add_remote=False)),
|
|
]
|
|
|
|
_exception_types = [
|
|
('bog_standard', dict(cls=Exception,
|
|
args=['test'],
|
|
kwargs={},
|
|
clsname='Exception',
|
|
modname=EXCEPTIONS_MODULE,
|
|
msg='test')),
|
|
('nova_style', dict(cls=NovaStyleException,
|
|
args=[],
|
|
kwargs={},
|
|
clsname='NovaStyleException',
|
|
modname=__name__,
|
|
msg='I am Nova')),
|
|
('nova_style_with_msg', dict(cls=NovaStyleException,
|
|
args=['testing'],
|
|
kwargs={},
|
|
clsname='NovaStyleException',
|
|
modname=__name__,
|
|
msg='testing')),
|
|
('kwargs_style', dict(cls=KwargsStyleException,
|
|
args=[],
|
|
kwargs={'who': 'Oslo'},
|
|
clsname='KwargsStyleException',
|
|
modname=__name__,
|
|
msg='I am Oslo')),
|
|
]
|
|
|
|
@classmethod
|
|
def generate_scenarios(cls):
|
|
cls.scenarios = testscenarios.multiply_scenarios(cls._add_remote,
|
|
cls._exception_types)
|
|
|
|
def test_serialize_remote_exception(self):
|
|
try:
|
|
try:
|
|
raise self.cls(*self.args, **self.kwargs)
|
|
except Exception as ex:
|
|
# Note: in Python 3 ex variable will be cleared at the end of
|
|
# the except clause, so explicitly make an extra copy of it
|
|
cls_error = ex
|
|
if self.add_remote:
|
|
ex = add_remote_postfix(ex)
|
|
raise ex
|
|
except Exception:
|
|
exc_info = sys.exc_info()
|
|
|
|
serialized = exceptions.serialize_remote_exception(exc_info)
|
|
|
|
failure = jsonutils.loads(serialized)
|
|
|
|
self.assertEqual(self.clsname, failure['class'], failure)
|
|
self.assertEqual(self.modname, failure['module'])
|
|
self.assertEqual(self.msg, failure['message'])
|
|
self.assertEqual([self.msg], failure['args'])
|
|
self.assertEqual(self.kwargs, failure['kwargs'])
|
|
|
|
# Note: _Remote prefix not stripped from tracebacks
|
|
tb = cls_error.__class__.__name__ + ': ' + self.msg
|
|
self.assertIn(tb, ''.join(failure['tb']))
|
|
|
|
|
|
SerializeRemoteExceptionTestCase.generate_scenarios()
|
|
|
|
|
|
class DeserializeRemoteExceptionTestCase(test_utils.BaseTestCase):
|
|
|
|
_standard_allowed = [__name__]
|
|
|
|
scenarios = [
|
|
('bog_standard',
|
|
dict(allowed=_standard_allowed,
|
|
clsname='Exception',
|
|
modname=EXCEPTIONS_MODULE,
|
|
cls=Exception,
|
|
args=['test'],
|
|
kwargs={},
|
|
str='test\ntraceback\ntraceback\n',
|
|
remote_name='Exception',
|
|
remote_args=('test\ntraceback\ntraceback\n', ),
|
|
remote_kwargs={})),
|
|
('different_python_versions',
|
|
dict(allowed=_standard_allowed,
|
|
clsname='Exception',
|
|
modname=OTHER_EXCEPTIONS_MODULE,
|
|
cls=Exception,
|
|
args=['test'],
|
|
kwargs={},
|
|
str='test\ntraceback\ntraceback\n',
|
|
remote_name='Exception',
|
|
remote_args=('test\ntraceback\ntraceback\n', ),
|
|
remote_kwargs={})),
|
|
('nova_style',
|
|
dict(allowed=_standard_allowed,
|
|
clsname='NovaStyleException',
|
|
modname=__name__,
|
|
cls=NovaStyleException,
|
|
args=[],
|
|
kwargs={},
|
|
str='test\ntraceback\ntraceback\n',
|
|
remote_name='NovaStyleException_Remote',
|
|
remote_args=('I am Nova', ),
|
|
remote_kwargs={})),
|
|
('nova_style_with_msg',
|
|
dict(allowed=_standard_allowed,
|
|
clsname='NovaStyleException',
|
|
modname=__name__,
|
|
cls=NovaStyleException,
|
|
args=['testing'],
|
|
kwargs={},
|
|
str='test\ntraceback\ntraceback\n',
|
|
remote_name='NovaStyleException_Remote',
|
|
remote_args=('testing', ),
|
|
remote_kwargs={})),
|
|
('kwargs_style',
|
|
dict(allowed=_standard_allowed,
|
|
clsname='KwargsStyleException',
|
|
modname=__name__,
|
|
cls=KwargsStyleException,
|
|
args=[],
|
|
kwargs={'who': 'Oslo'},
|
|
str='test\ntraceback\ntraceback\n',
|
|
remote_name='KwargsStyleException_Remote',
|
|
remote_args=('I am Oslo', ),
|
|
remote_kwargs={})),
|
|
('not_allowed',
|
|
dict(allowed=[],
|
|
clsname='NovaStyleException',
|
|
modname=__name__,
|
|
cls=oslo_messaging.RemoteError,
|
|
args=[],
|
|
kwargs={},
|
|
str=("Remote error: NovaStyleException test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
msg=("Remote error: NovaStyleException test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
remote_name='RemoteError',
|
|
remote_args=(),
|
|
remote_kwargs={'exc_type': 'NovaStyleException',
|
|
'value': 'test',
|
|
'traceback': 'traceback\ntraceback\n'})),
|
|
('unknown_module',
|
|
dict(allowed=['notexist'],
|
|
clsname='Exception',
|
|
modname='notexist',
|
|
cls=oslo_messaging.RemoteError,
|
|
args=[],
|
|
kwargs={},
|
|
str=("Remote error: Exception test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
msg=("Remote error: Exception test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
remote_name='RemoteError',
|
|
remote_args=(),
|
|
remote_kwargs={'exc_type': 'Exception',
|
|
'value': 'test',
|
|
'traceback': 'traceback\ntraceback\n'})),
|
|
('unknown_exception',
|
|
dict(allowed=[],
|
|
clsname='FarcicalError',
|
|
modname=EXCEPTIONS_MODULE,
|
|
cls=oslo_messaging.RemoteError,
|
|
args=[],
|
|
kwargs={},
|
|
str=("Remote error: FarcicalError test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
msg=("Remote error: FarcicalError test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
remote_name='RemoteError',
|
|
remote_args=(),
|
|
remote_kwargs={'exc_type': 'FarcicalError',
|
|
'value': 'test',
|
|
'traceback': 'traceback\ntraceback\n'})),
|
|
('unknown_kwarg',
|
|
dict(allowed=[],
|
|
clsname='Exception',
|
|
modname=EXCEPTIONS_MODULE,
|
|
cls=oslo_messaging.RemoteError,
|
|
args=[],
|
|
kwargs={'foobar': 'blaa'},
|
|
str=("Remote error: Exception test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
msg=("Remote error: Exception test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
remote_name='RemoteError',
|
|
remote_args=(),
|
|
remote_kwargs={'exc_type': 'Exception',
|
|
'value': 'test',
|
|
'traceback': 'traceback\ntraceback\n'})),
|
|
('system_exit',
|
|
dict(allowed=[],
|
|
clsname='SystemExit',
|
|
modname=EXCEPTIONS_MODULE,
|
|
cls=oslo_messaging.RemoteError,
|
|
args=[],
|
|
kwargs={},
|
|
str=("Remote error: SystemExit test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
msg=("Remote error: SystemExit test\n"
|
|
"[%r]." % u'traceback\ntraceback\n'),
|
|
remote_name='RemoteError',
|
|
remote_args=(),
|
|
remote_kwargs={'exc_type': 'SystemExit',
|
|
'value': 'test',
|
|
'traceback': 'traceback\ntraceback\n'})),
|
|
]
|
|
|
|
def test_deserialize_remote_exception(self):
|
|
failure = {
|
|
'class': self.clsname,
|
|
'module': self.modname,
|
|
'message': 'test',
|
|
'tb': ['traceback\ntraceback\n'],
|
|
'args': self.args,
|
|
'kwargs': self.kwargs,
|
|
}
|
|
|
|
serialized = jsonutils.dumps(failure)
|
|
|
|
ex = exceptions.deserialize_remote_exception(serialized, self.allowed)
|
|
|
|
self.assertIsInstance(ex, self.cls)
|
|
self.assertEqual(self.remote_name, ex.__class__.__name__)
|
|
self.assertEqual(self.str, six.text_type(ex))
|
|
if hasattr(self, 'msg'):
|
|
self.assertEqual(self.msg, six.text_type(ex))
|
|
self.assertEqual((self.msg,) + self.remote_args, ex.args)
|
|
else:
|
|
self.assertEqual(self.remote_args, ex.args)
|