Enhance the formatting error robustness patch
This patch fixes the issues raised in the previous robustness patch I5c711b4654b5b2e591bcf365401ff35f7224fe82 Closes-bug: #1339337 Change-Id: I627c550e7bc05e56bbdffccf9bc88b88adf87aaf
This commit is contained in:
Balazs Gibizer
parent
4417d33a9f
commit
634c52f602
|
|
@ -21,6 +21,7 @@ import gettext
|
|||
import locale
|
||||
import logging
|
||||
import os
|
||||
import warnings
|
||||
|
||||
import six
|
||||
|
||||
|
|
@ -141,6 +142,18 @@ class Message(six.text_type):
|
|||
return translated_message
|
||||
|
||||
def _safe_translate(self, translated_message, translated_params):
|
||||
"""Trap translation errors and fall back to default translation.
|
||||
|
||||
:param translated_message: the requested translation
|
||||
|
||||
:param translated_params: the params to be inserted
|
||||
|
||||
:return: if parameter insertion is successful then it is the
|
||||
translated_message with the translated_params inserted, if the
|
||||
requested translation fails then it is the default translation
|
||||
with the params
|
||||
"""
|
||||
|
||||
try:
|
||||
translated_message = translated_message % translated_params
|
||||
except (KeyError, TypeError) as err:
|
||||
|
|
@ -152,17 +165,21 @@ class Message(six.text_type):
|
|||
# Log the error translating the message and use the
|
||||
# original message string so the translator's bad message
|
||||
# catalog doesn't break the caller.
|
||||
LOG.debug(
|
||||
(u'Failed to insert replacement values into translated '
|
||||
u'message %s (Original: %r): %s'),
|
||||
translated_message, self.msgid, err)
|
||||
# Do not translate this log message even if it is used as a
|
||||
# warning message as a wrong translation of this message could
|
||||
# cause infinite recursion
|
||||
msg = (u'Failed to insert replacement values into translated '
|
||||
u'message %s (Original: %r): %s')
|
||||
warnings.warn(msg % (translated_message, self.msgid, err))
|
||||
LOG.debug(msg, translated_message, self.msgid, err)
|
||||
|
||||
translated_message = self.msgid % translated_params
|
||||
|
||||
return translated_message
|
||||
|
||||
def __mod__(self, other):
|
||||
# When we mod a Message we want the actual operation to be performed
|
||||
# by the parent class (i.e. unicode()), the only thing we do here is
|
||||
# by the base class (i.e. unicode()), the only thing we do here is
|
||||
# save the original msgid and the parameters in case of a translation
|
||||
params = self._sanitize_mod_params(other)
|
||||
unicode_mod = self._safe_translate(six.text_type(self), params)
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@
|
|||
from __future__ import unicode_literals
|
||||
|
||||
import logging
|
||||
import warnings
|
||||
|
||||
import mock
|
||||
from oslotest import base as test_base
|
||||
|
|
@ -181,16 +182,15 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
msgid = "Test that we handle unused args %(arg1)d"
|
||||
params = {'arg1': 'test1'}
|
||||
|
||||
self.assertRaises(TypeError, lambda: _message.Message(msgid) % params)
|
||||
with testtools.ExpectedException(TypeError):
|
||||
_message.Message(msgid) % params
|
||||
|
||||
def test_mod_with_missing_arg(self):
|
||||
msgid = "Test that we handle missing args %(arg1)s %(arg2)s"
|
||||
params = {'arg1': 'test1'}
|
||||
|
||||
e = self.assertRaises(KeyError,
|
||||
lambda: _message.Message(msgid) % params)
|
||||
self.assertIn('arg2', six.text_type(e),
|
||||
'Missing key \'arg2\' was not flagged')
|
||||
with testtools.ExpectedException(KeyError, '.*arg2.*'):
|
||||
_message.Message(msgid) % params
|
||||
|
||||
def test_mod_with_integer_parameters(self):
|
||||
msgid = "Some string with params: %d"
|
||||
|
|
@ -379,7 +379,8 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
|
||||
@mock.patch('gettext.translation')
|
||||
@mock.patch('oslo_i18n._message.LOG')
|
||||
def test_translate_message_bad_translation(self, mock_log,
|
||||
def test_translate_message_bad_translation(self,
|
||||
mock_log,
|
||||
mock_translation):
|
||||
message_with_params = 'A message: %s'
|
||||
es_translation = 'A message in Spanish: %s %s'
|
||||
|
|
@ -389,15 +390,27 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
translator = fakes.FakeTranslations.translator({'es': translations})
|
||||
mock_translation.side_effect = translator
|
||||
|
||||
msg = _message.Message(message_with_params)
|
||||
msg = msg % param
|
||||
self.assertFalse(mock_log.debug.called)
|
||||
with warnings.catch_warnings(record=True) as w:
|
||||
warnings.simplefilter("always")
|
||||
msg = _message.Message(message_with_params)
|
||||
msg = msg % param
|
||||
default_translation = message_with_params % param
|
||||
|
||||
self.assertEqual(default_translation, msg.translate('es'))
|
||||
|
||||
self.assertEqual(1, len(w))
|
||||
# Note(gibi): in python 3.4 str.__repr__ does not put the unicode
|
||||
# marker 'u' in front of the string representations so the test
|
||||
# removes that to have the same result in python 2.7 and 3.4
|
||||
self.assertEqual("Failed to insert replacement values into "
|
||||
"translated message A message in Spanish: %s %s "
|
||||
"(Original: 'A message: %s'): "
|
||||
"not enough arguments for format string",
|
||||
str(w[0].message).replace("u'", "'"))
|
||||
|
||||
default_translation = message_with_params % param
|
||||
self.assertEqual(default_translation, msg.translate('es'))
|
||||
mock_log.debug.assert_called_with(('Failed to insert replacement '
|
||||
'values into translated message %s '
|
||||
'(Original: %r): %s'),
|
||||
'values into translated message '
|
||||
'%s (Original: %r): %s'),
|
||||
es_translation,
|
||||
message_with_params,
|
||||
mock.ANY)
|
||||
|
|
@ -405,7 +418,8 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
@mock.patch('gettext.translation')
|
||||
@mock.patch('locale.getdefaultlocale', return_value=('es', ''))
|
||||
@mock.patch('oslo_i18n._message.LOG')
|
||||
def test_translate_message_bad_default_translation(self, mock_log,
|
||||
def test_translate_message_bad_default_translation(self,
|
||||
mock_log,
|
||||
mock_local,
|
||||
mock_translation):
|
||||
message_with_params = 'A message: %s'
|
||||
|
|
@ -417,10 +431,23 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
mock_translation.side_effect = translator
|
||||
|
||||
msg = _message.Message(message_with_params)
|
||||
msg = msg % param
|
||||
|
||||
with warnings.catch_warnings(record=True) as w:
|
||||
warnings.simplefilter("always")
|
||||
msg = msg % param
|
||||
self.assertEqual(1, len(w))
|
||||
# Note(gibi): in python 3.4 str.__repr__ does not put the unicode
|
||||
# marker 'u' in front of the string representations so the test
|
||||
# removes that to have the same result in python 2.7 and 3.4
|
||||
self.assertEqual("Failed to insert replacement values into "
|
||||
"translated message A message in Spanish: %s %s "
|
||||
"(Original: 'A message: %s'): "
|
||||
"not enough arguments for format string",
|
||||
str(w[0].message).replace("u'", "'"))
|
||||
|
||||
mock_log.debug.assert_called_with(('Failed to insert replacement '
|
||||
'values into translated message %s '
|
||||
'(Original: %r): %s'),
|
||||
'values into translated message '
|
||||
'%s (Original: %r): %s'),
|
||||
es_translation,
|
||||
message_with_params,
|
||||
mock.ANY)
|
||||
|
|
@ -428,7 +455,7 @@ class MessageTestCase(test_base.BaseTestCase):
|
|||
|
||||
default_translation = message_with_params % param
|
||||
self.assertEqual(default_translation, msg)
|
||||
self.assertFalse(mock_log.debug.called)
|
||||
self.assertFalse(mock_log.warning.called)
|
||||
|
||||
@mock.patch('gettext.translation')
|
||||
def test_translate_message_with_object_param(self, mock_translation):
|
||||
|
|
|
|||
Loading…
Reference in New Issue