Ensure that Message objects will be sent via RPC in unicode format

Fixes bug 1229204

Change-Id: Ia915f3175bee370d747e362cd9d35d8536c1b7b2
Co-authored-by: He Jie Xu <xuhj@linux.vnet.ibm.com>

2 files changed, 18 insertions, 0 deletions

diff --git a/openstack/common/jsonutils.py b/openstack/common/jsonutils.py
index b64d69a..100a10e 100644
--- a/openstack/common/jsonutils.py
+++ b/openstack/common/jsonutils.py
@@ -46,6 +46,7 @@ except ImportError:
 
 import six
 
+from openstack.common import gettextutils
 from openstack.common import importutils
 from openstack.common import timeutils
 
@@ -135,6 +136,8 @@ def to_primitive(value, convert_instances=False, convert_datetime=True,
 
         if convert_datetime and isinstance(value, datetime.datetime):
             return timeutils.strtime(value)
+        elif isinstance(value, gettextutils.Message):
+            return value.data
         elif hasattr(value, 'iteritems'):
             return recursive(dict(value.iteritems()), level=level + 1)
         elif hasattr(value, '__iter__'):
diff --git a/tests/unit/test_jsonutils.py b/tests/unit/test_jsonutils.py
index 0bf811a..94d5076 100644
--- a/tests/unit/test_jsonutils.py
+++ b/tests/unit/test_jsonutils.py
@@ -25,6 +25,7 @@ import netaddr
 import six
 import testtools
 
+from openstack.common import gettextutils
 from openstack.common import jsonutils
 from openstack.common import test
 
@@ -181,3 +182,17 @@ class ToPrimitiveTestCase(test.BaseTestCase):
         thing = {'ip_addr': netaddr.IPAddress('1.2.3.4')}
         ret = jsonutils.to_primitive(thing)
         self.assertEqual({'ip_addr': '1.2.3.4'}, ret)
+
+    def test_message_with_param(self):
+        message_with_params = 'A message with param: %s'
+        msg = gettextutils.Message(message_with_params, 'test_domain')
+        msg = msg % 'test_domain'
+        ret = jsonutils.to_primitive(msg)
+        self.assertEqual(msg, ret)
+
+    def test_message_with_named_param(self):
+        message_with_params = 'A message with params: %(param)s'
+        msg = gettextutils.Message(message_with_params, 'test_domain')
+        msg = msg % {'param': 'hello'}
+        ret = jsonutils.to_primitive(msg)
+        self.assertEqual(msg, ret)