Merge lp:~javier.collado/utah/bug1071385 into lp:utah

[Javier Collado]

This change makes sure that unicode is used for the output from shell commands
when it contains a non-ascii character.

Also, it takes care of representing long unicode strings as literal blocks (the
current behaviour for byte strings).

Using the same example as in the bug, I get the following the expected output
for different locales:

- German
stderr: |-
  fail://example.com: Nicht unterstütztes Schema »fail«.

- Spanish:
stderr: |-
  fail://example.com: Esquema “fail” no soportado.

- Chinese
stderr: |-
  fail://example.com: 不支持的协议类型 “fail”.

- English:
stderr: |-
  fail://example.com: Unsupported scheme `fail'.

[Joe Talbott (joetalbott)]

Looks good, thanks.

review: Approve

=== modified file 'utah/client/common.py'
--- utah/client/common.py	2012-11-07 21:54:57 +0000
+++ utah/client/common.py	2012-12-03 14:21:27 +0000
@@ -97,6 +97,9 @@
 
     try:
         stdout, stderr = p.communicate()
+        stdout = normalize_encoding(stdout)
+        stderr = normalize_encoding(stderr)
+
         if timeout != 0:
             signal.alarm(0)
     except TimeoutAlarm:
@@ -135,6 +138,22 @@
                       )
 
 
+def normalize_encoding(value, encoding='utf-8'):
+    """Normalize string encoding.
+
+    Make sure that byte strings are used only for ascii data and unicode
+    strings for strings using any other encoding.
+
+    """
+    unicode_value = value.decode(encoding)
+    try:
+        output = unicode_value.encode('ascii')
+    except UnicodeEncodeError:
+        output = unicode_value
+
+    return output
+
+
 # TODO: it might make sense to have a result object that keeps track of
 # test pass, fail, error and serializes it's data.
 def make_result(command, retcode, stdout='', stderr='', start_time='',

=== modified file 'utah/client/result.py'
--- utah/client/result.py	2012-11-07 18:01:26 +0000
+++ utah/client/result.py	2012-12-03 14:21:27 +0000
@@ -197,12 +197,14 @@
 
 # Trick to get strings printed as literal blocks
 # inspired by: http://stackoverflow.com/a/7445560/183066
-class LiteralString(str):
-    pass
+class LiteralString(object):
+    def __init__(self, str_data):
+        self.str_data = str_data
 
 
 def literal_block(dumper, data):
-    return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
+    return dumper.represent_scalar('tag:yaml.org,2002:str',
+                                   data.str_data, style='|')
 yaml.add_representer(LiteralString, literal_block)
 
 
@@ -211,7 +213,7 @@
         """
         Transform long strings into literal blocks
         """
-        if isinstance(data, str) and '\n' in data:
+        if isinstance(data, basestring) and '\n' in data:
             # Remove trailing whitespace to serialize in yaml
             # as a literal string
             lines = [line.rstrip() for line in data.splitlines()]
@@ -228,8 +230,10 @@
     def result(self, verbose=False):
         if self.results:
             data = self._literalize(self.payload())
-            yaml.dump(data, sys.stdout, explicit_start='---',
-                      default_flow_style=False)
+            yaml.dump(data, sys.stdout,
+                      explicit_start='---',
+                      default_flow_style=False,
+                      allow_unicode=True)
 
         status = self.status
         self.clear_results()