Merge lp:~adam-collard/landscape-client/xenial-transport-fixes into lp:~landscape/landscape-client/trunk

[Adam Collard]

The version of Twisted in Xenial (currently 16.0.0~pre1-2ubuntu1) doesn't have the previous backwards compatible way of accessing request headers (request.received_headers as a dict).

This branch switches the tests to use the new API, but retain backwards compatibility for previous Ubuntu releases.

Note that #1549962 is addressing separate test failures.

The version of Twisted in Xenial (currently 16.0.0~pre1-2ubuntu1) doesn't have the previous backwards compatible way of accessing request headers (request.received_headers as a dict).

This branch switches the tests to use the new API, but retain backwards compatibility for previous Ubuntu releases.

Note that #1549962 is addressing separate test failures.

Testing instructions:

trial landscape.broker.tests.test_transport

[Free Ekanayaka (free.ekanayaka)]

Looks good with a nit, +1

review: Approve

[Bogdana Vereha (bogdana)]

+1

review: Approve

[lp:~adam-collard/landscape-client/xenial-transport-fixes]

830. By Adam Collard on 2016-03-04

Add comments, fix line length (free's review)

=== modified file 'landscape/broker/tests/test_transport.py'
--- landscape/broker/tests/test_transport.py	2013-11-29 16:48:55 +0000
+++ landscape/broker/tests/test_transport.py	2016-03-04 08:59:24 +0000
@@ -66,8 +66,9 @@
         message API version as HTTP headers, and the payload as a
         bpickled request body.
         """
-        r = DataCollectingResource()
-        port = reactor.listenTCP(0, server.Site(r), interface="127.0.0.1")
+        resource = DataCollectingResource()
+        port = reactor.listenTCP(
+            0, server.Site(resource), interface="127.0.0.1")
         self.ports.append(port)
         transport = HTTPTransport(
             None, "http://localhost:%d/" % (port.getHost().port,))
@@ -75,15 +76,20 @@
                                exchange_token="abcd-efgh", message_api="X.Y")
 
         def got_result(ignored):
-            self.assertEqual(r.request.received_headers["x-computer-id"],
-                             "34")
-            self.assertEqual(r.request.received_headers["x-exchange-token"],
-                             "abcd-efgh")
-            self.assertEqual(r.request.received_headers["user-agent"],
-                             "landscape-client/%s" % (VERSION,))
-            self.assertEqual(r.request.received_headers["x-message-api"],
-                             "X.Y")
-            self.assertEqual(bpickle.loads(r.content), "HI")
+            try:
+                get_header = resource.request.requestHeaders.getRawHeaders
+            except AttributeError:
+                # For backwards compatibility with Twisted versions
+                # without requestHeaders
+                def get_header(header):
+                    return [resource.request.received_headers[header]]
+
+            self.assertEqual(get_header(u"x-computer-id"), ["34"])
+            self.assertEqual(get_header("x-exchange-token"), ["abcd-efgh"])
+            self.assertEqual(
+                get_header("user-agent"), ["landscape-client/%s" % (VERSION,)])
+            self.assertEqual(get_header("x-message-api"), ["X.Y"])
+            self.assertEqual(bpickle.loads(resource.content), "HI")
         result.addCallback(got_result)
         return result
 
@@ -93,9 +99,9 @@
         a host which provides SSL data which can be verified by the
         public key specified.
         """
-        r = DataCollectingResource()
+        resource = DataCollectingResource()
         context_factory = DefaultOpenSSLContextFactory(PRIVKEY, PUBKEY)
-        port = reactor.listenSSL(0, server.Site(r), context_factory,
+        port = reactor.listenSSL(0, server.Site(resource), context_factory,
                                  interface="127.0.0.1")
         self.ports.append(port)
         transport = HTTPTransport(
@@ -104,13 +110,18 @@
                                message_api="X.Y")
 
         def got_result(ignored):
-            self.assertEqual(r.request.received_headers["x-computer-id"],
-                             "34")
-            self.assertEqual(r.request.received_headers["user-agent"],
-                             "landscape-client/%s" % (VERSION,))
-            self.assertEqual(r.request.received_headers["x-message-api"],
-                             "X.Y")
-            self.assertEqual(bpickle.loads(r.content), "HI")
+            try:
+                get_header = resource.request.requestHeaders.getRawHeaders
+            except AttributeError:
+                # For backwards compatibility with Twisted versions
+                # without requestHeaders
+                def get_header(header):
+                    return [resource.request.received_headers[header]]
+            self.assertEqual(get_header("x-computer-id"), ["34"])
+            self.assertEqual(
+                get_header("user-agent"), ["landscape-client/%s" % (VERSION,)])
+            self.assertEqual(get_header("x-message-api"), ["X.Y"])
+            self.assertEqual(bpickle.loads(resource.content), "HI")
         result.addCallback(got_result)
         return result