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

[Javier Collado]

Literal strings don't serialize as such in yaml if they have some trailing
whitespace before the newline character.

This change removes the whitespace on every line to serialize literal strings properly.

[Joe Talbott (joetalbott)]

Nice debugging.

Should we file a bug upstream for this. This seems non-intuitive to me but perhaps yaml doesn't allow trailing whitespace on lines.

review: Approve

[Javier Collado (javier.collado)]

The specification for literal blocks:
http://www.yaml.org/spec/1.2/spec.html#id2795688

seems to allow whitespace characters (nb-chars+).

In fact, I've seen that trying to `load` a yaml stream that contains
a literal with whitespace before a newline character works fine
(and doesn't remove the whitespace).

Anyway, looking at pyyaml.org, I've seen that the bug is already reported:
http://pyyaml.org/ticket/240

=== modified file 'utah/client/result.py'
--- utah/client/result.py	2012-10-11 15:29:50 +0000
+++ utah/client/result.py	2012-10-25 11:15:28 +0000
@@ -205,7 +205,10 @@
         Transform long strings into literal blocks
         """
         if isinstance(data, str) and '\n' in data:
-            return LiteralString(data)
+            # Remove trailing whitespace to serialize in yaml
+            # as a literal string
+            lines = [line.rstrip() for line in data.splitlines()]
+            return LiteralString('\n'.join(lines))
 
         if isinstance(data, dict):
             for key, value in data.iteritems():