Better handles unicode in slcli for raw output (softlayer#740)

sudorandom · web-flow · commit ba1410e7a9ea · 2016-07-14T15:36:16.000-05:00
* Better handles unicode in slcli for raw output Closes softlayer#739. * Added a test case that will return 'invalid' instead of failing outright Also fixes a couple new style issues * Make the unicode test just for python 2
diff --git a/SoftLayer/CLI/environment.py b/SoftLayer/CLI/environment.py
@@ -69,7 +69,7 @@ def list_commands(self, *path):
         path_str = ':'.join(path)
 
         commands = []
-        for command in self.commands.keys():
+        for command in self.commands:
 
             # Filter based on prefix and the segment length
             if all([command.startswith(path_str),
diff --git a/SoftLayer/CLI/formatting.py b/SoftLayer/CLI/formatting.py
@@ -323,9 +323,14 @@ def __str__(self):
         # If the original value is None, represent this as 'NULL'
         if self.original is None:
             return 'NULL'
-        return str(self.original)
 
-    __repr__ = __str__
+        try:
+            return str(self.original)
+        except UnicodeError:
+            return 'invalid'
+
+    def __repr__(self):
+        return 'FormattedItem(%r, %r)' % (self.original, self.formatted)
 
     # Implement sorting methods.
     # NOTE(kmcdonald): functools.total_ordering could be used once support for
diff --git a/SoftLayer/CLI/virt/create_options.py b/SoftLayer/CLI/virt/create_options.py
@@ -90,7 +90,7 @@ def add_block_rows(disks, name):
 
             simple[bid].append(str(block['diskImage']['capacity']))
 
-        for label in sorted(simple.keys()):
+        for label in sorted(simple):
             table.add_row(['%s disk(%s)' % (name, label),
                            formatting.listing(simple[label],
                                               separator=',')])
diff --git a/SoftLayer/fixtures/SoftLayer_Account.py b/SoftLayer/fixtures/SoftLayer_Account.py
@@ -1,19 +1,24 @@
+# -*- coding: UTF-8 -*-
+
 getPrivateBlockDeviceTemplateGroups = [{
     'accountId': 1234,
     'blockDevices': [],
     'createDate': '2013-12-05T21:53:03-06:00',
     'globalIdentifier': 'E6DBD73B-1651-4B28-BCBA-A11DF7C9D79E',
     'id': 200,
     'name': 'test_image',
-    'parentId': ''
+    'parentId': '',
+    'publicFlag': False,
 }, {
     'accountId': 1234,
     'blockDevices': [],
     'createDate': '2013-12-05T21:53:03-06:00',
     'globalIdentifier': 'F9329795-4220-4B0A-B970-C86B950667FA',
     'id': 201,
-    'name': 'private_image2',
-    'parentId': ''
+    # 'name': 'private_image2',
+    'name': u'a¬ሴ€耀',
+    'parentId': '',
+    'publicFlag': False,
 }]
 
 getVirtualGuests = [{
diff --git a/SoftLayer/fixtures/SoftLayer_Virtual_Guest_Block_Device_Template_Group.py b/SoftLayer/fixtures/SoftLayer_Virtual_Guest_Block_Device_Template_Group.py
@@ -5,15 +5,17 @@
     'globalIdentifier': '0B5DEAF4-643D-46CA-A695-CECBE8832C9D',
     'id': 100,
     'name': 'test_image',
-    'parentId': ''
+    'parentId': '',
+    'publicFlag': True,
 }, {
     'accountId': 1234,
     'blockDevices': [],
     'createDate': '2013-12-05T21:53:03-06:00',
     'globalIdentifier': 'EB38414C-2AB3-47F3-BBBD-56A5F689620B',
     'id': 101,
     'name': 'test_image2',
-    'parentId': ''
+    'parentId': '',
+    'publicFlag': True,
 }]
 
 getObject = IMAGES[0]
diff --git a/SoftLayer/testing/xmlrpc.py b/SoftLayer/testing/xmlrpc.py
@@ -59,9 +59,12 @@ def do_POST(self):
                                                       methodresponse=True)
 
             self.send_response(200)
-            self.send_header("Content-type", "application/xml")
+            self.send_header("Content-type", "application/xml; charset=UTF-8")
             self.end_headers()
-            self.wfile.write(response_body.encode('utf-8'))
+            try:
+                self.wfile.write(response_body.encode('utf-8'))
+            except UnicodeDecodeError:
+                self.wfile.write(response_body)
 
         except SoftLayer.SoftLayerAPIError as ex:
             self.send_response(200)
diff --git a/tests/CLI/helper_tests.py b/tests/CLI/helper_tests.py
@@ -11,6 +11,7 @@
 
 import click
 import mock
+import six
 
 from SoftLayer.CLI import core
 from SoftLayer.CLI import exceptions
@@ -95,6 +96,13 @@ def test_init(self):
         self.assertEqual('test', item.formatted)
         self.assertEqual('test', str(item))
 
+    def test_unicode(self):
+        if six.PY2:
+            item = formatting.FormattedItem(u'\u32423', u'\u32423')
+            self.assertEqual(u'\u32423', item.original)
+            self.assertEqual(u'\u32423', item.formatted)
+            self.assertEqual('invalid', str(item))
+
     def test_mb_to_gb(self):
         item = formatting.mb_to_gb(1024)
         self.assertEqual(1024, item.original)
