Merge lp:~cjwatson/lazr.restful/py3-response-wrapper into lp:lazr.restful

[Colin Watson]

Fix WebServiceResponseWrapper for Python 3.

The reimplementation of http.client.HTTPMessage using email.message.Message in 3.0 removed the headers attribute, so we need to go to some effort to deal with that.

Sorting list responses in the jsonBody method doesn't make sense, so stop doing that.

[Ioana Lasc (ilasc)]

makes sense to me, looks good.

review: Approve

=== modified file 'src/lazr/restful/testing/webservice.py'
--- src/lazr/restful/testing/webservice.py	2020-09-02 21:58:55 +0000
+++ src/lazr/restful/testing/webservice.py	2020-09-07 16:54:40 +0000
@@ -410,6 +410,7 @@
         return (config.path_override + '/' + default_version)
 
 
[e-mail]_2_unicode_compatible
 class WebServiceResponseWrapper(ProxyBase):
     """A response from the web service with easy access to the JSON body."""
 
@@ -421,21 +422,32 @@
         return self.getheader(key, default)
 
     def __str__(self):
+        if sys.version_info[0] >= 3:
+            # Reconstructing the original list of headers seems to involve a
+            # bit more effort on Python 3.
+            def normalize(key):
+                """Normalize an HTTP header name to title case."""
+                return '-'.join(s.title() for s in key.split('-'))
+
+            headers = [
+                '%s: %s\n' % (normalize(key), value)
+                for key, value in self.msg.items()]
+        else:
+            headers = self.msg.headers
+        body = self.body.decode('UTF-8')
         return 'HTTP/1.1 %s %s\n%s\n%s' % (
-            self.status, self.reason, ''.join(self.msg.headers), self.body)
+            self.status, self.reason, ''.join(headers), body)
 
     def jsonBody(self):
         """Return the body of the web service request as a JSON document."""
+        body = six.ensure_text(self.body)
         try:
-            json = simplejson.loads(six.ensure_text(self.body))
-            if isinstance(json, list):
-                json = sorted(json)
-            return json
+            return simplejson.loads(body)
         except ValueError:
             # Return a useful ValueError that displays the problematic
             # string, instead of one that just says the string wasn't
             # JSON.
-            raise ValueError(self.body)
+            raise ValueError(body)
 
 
 @implementer(IWebServiceConfiguration)