¡@

Home 

OpenStack Study: test_exception.py

OpenStack Index

**** CubicPower OpenStack Study ****

# Copyright 2012 OpenStack Foundation

#

# 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 uuid

import six

from keystone.common import wsgi

from keystone import config

from keystone import exception

from keystone.openstack.common import jsonutils

from keystone import tests

CONF = config.CONF

**** CubicPower OpenStack Study ****

class ExceptionTestCase(tests.TestCase):

**** CubicPower OpenStack Study ****

    def assertValidJsonRendering(self, e):

        resp = wsgi.render_exception(e)

        self.assertEqual(resp.status_int, e.code)

        self.assertEqual(resp.status, '%s %s' % (e.code, e.title))

        j = jsonutils.loads(resp.body)

        self.assertIsNotNone(j.get('error'))

        self.assertIsNotNone(j['error'].get('code'))

        self.assertIsNotNone(j['error'].get('title'))

        self.assertIsNotNone(j['error'].get('message'))

        self.assertNotIn('\n', j['error']['message'])

        self.assertNotIn('  ', j['error']['message'])

        self.assertTrue(type(j['error']['code']) is int)

**** CubicPower OpenStack Study ****

    def test_all_json_renderings(self):

        """Everything callable in the exception module should be renderable.

        ... except for the base error class (exception.Error), which is not

        user-facing.

        This test provides a custom message to bypass docstring parsing, which

        should be tested separately.

        """

        for cls in [x for x in exception.__dict__.values() if callable(x)]:

            if cls is not exception.Error and isinstance(cls, exception.Error):

                self.assertValidJsonRendering(cls(message='Overriden.'))

**** CubicPower OpenStack Study ****

    def test_validation_error(self):

        target = uuid.uuid4().hex

        attribute = uuid.uuid4().hex

        e = exception.ValidationError(target=target, attribute=attribute)

        self.assertValidJsonRendering(e)

        self.assertIn(target, six.text_type(e))

        self.assertIn(attribute, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_not_found(self):

        target = uuid.uuid4().hex

        e = exception.NotFound(target=target)

        self.assertValidJsonRendering(e)

        self.assertIn(target, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_403_title(self):

        e = exception.Forbidden()

        resp = wsgi.render_exception(e)

        j = jsonutils.loads(resp.body)

        self.assertEqual('Forbidden', e.title)

        self.assertEqual('Forbidden', j['error'].get('title'))

**** CubicPower OpenStack Study ****

    def test_unicode_message(self):

        message = u'Comment \xe7a va'

        e = exception.Error(message)

        try:

            self.assertEqual(six.text_type(e), message)

        except UnicodeEncodeError:

            self.fail("unicode error message not supported")

**** CubicPower OpenStack Study ****

    def test_unicode_string(self):

        e = exception.ValidationError(attribute='xx',

                                      target='Long \xe2\x80\x93 Dash')

        self.assertIn(u'\u2013', e.message)

**** CubicPower OpenStack Study ****

    def test_invalid_unicode_string(self):

        # NOTE(jamielennox): This is a complete failure case so what is

        # returned in the e.message is not that important so long as there is

        # an error with a message

        e = exception.ValidationError(attribute='xx',

                                      target='\xe7a va')

        self.assertIn('%(attribute)', e.message)

**** CubicPower OpenStack Study ****

class UnexpectedExceptionTestCase(ExceptionTestCase):

"""Tests if internal info is exposed to the API user on UnexpectedError."""

class SubClassExc(exception.UnexpectedError):

debug_message_format = 'Debug Message: %(debug_info)s'

**** CubicPower OpenStack Study ****

    def setUp(self):

        super(UnexpectedExceptionTestCase, self).setUp()

        self.exc_str = uuid.uuid4().hex

**** CubicPower OpenStack Study ****

    def test_unexpected_error_no_debug(self):

        self.config_fixture.config(debug=False)

        e = exception.UnexpectedError(exception=self.exc_str)

        self.assertNotIn(self.exc_str, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unexpected_error_debug(self):

        self.config_fixture.config(debug=True)

        e = exception.UnexpectedError(exception=self.exc_str)

        self.assertIn(self.exc_str, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unexpected_error_subclass_no_debug(self):

        self.config_fixture.config(debug=False)

        e = UnexpectedExceptionTestCase.SubClassExc(

            debug_info=self.exc_str)

        self.assertEqual(exception.UnexpectedError._message_format,

                         six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unexpected_error_subclass_debug(self):

        self.config_fixture.config(debug=True)

        subclass = self.SubClassExc

        e = subclass(debug_info=self.exc_str)

        expected = subclass.debug_message_format % {'debug_info': self.exc_str}

        self.assertEqual(expected, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unexpected_error_custom_message_no_debug(self):

        self.config_fixture.config(debug=False)

        e = exception.UnexpectedError(self.exc_str)

        self.assertEqual(exception.UnexpectedError._message_format,

                         six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unexpected_error_custom_message_debug(self):

        self.config_fixture.config(debug=True)

        e = exception.UnexpectedError(self.exc_str)

        self.assertEqual(self.exc_str,

                         six.text_type(e))

**** CubicPower OpenStack Study ****

class SecurityErrorTestCase(ExceptionTestCase):

"""Tests whether security-related info is exposed to the API user."""

**** CubicPower OpenStack Study ****

    def test_unauthorized_exposure(self):

        self.config_fixture.config(debug=False)

        risky_info = uuid.uuid4().hex

        e = exception.Unauthorized(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertNotIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unauthorized_exposure_in_debug(self):

        self.config_fixture.config(debug=True)

        risky_info = uuid.uuid4().hex

        e = exception.Unauthorized(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_forbidden_exposure(self):

        self.config_fixture.config(debug=False)

        risky_info = uuid.uuid4().hex

        e = exception.Forbidden(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertNotIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_forbidden_exposure_in_debug(self):

        self.config_fixture.config(debug=True)

        risky_info = uuid.uuid4().hex

        e = exception.Forbidden(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_forbidden_action_exposure(self):

        self.config_fixture.config(debug=False)

        risky_info = uuid.uuid4().hex

        action = uuid.uuid4().hex

        e = exception.ForbiddenAction(message=risky_info, action=action)

        self.assertValidJsonRendering(e)

        self.assertNotIn(risky_info, six.text_type(e))

        self.assertIn(action, six.text_type(e))

        e = exception.ForbiddenAction(action=risky_info)

        self.assertValidJsonRendering(e)

        self.assertIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_forbidden_action_exposure_in_debug(self):

        self.config_fixture.config(debug=True)

        risky_info = uuid.uuid4().hex

        e = exception.ForbiddenAction(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertIn(risky_info, six.text_type(e))

        e = exception.ForbiddenAction(action=risky_info)

        self.assertValidJsonRendering(e)

        self.assertIn(risky_info, six.text_type(e))

**** CubicPower OpenStack Study ****

    def test_unicode_argument_message(self):

        self.config_fixture.config(debug=False)

        risky_info = u'\u7ee7\u7eed\u884c\u7f29\u8fdb\u6216'

        e = exception.Forbidden(message=risky_info)

        self.assertValidJsonRendering(e)

        self.assertNotIn(risky_info, six.text_type(e))