Merge lp:~ltrager/maas/fix_websocket_tests into lp:~maas-committers/maas/trunk

[Lee Trager]

Stop using deprecated features on the DummyRequest object for twisted 16.

MAAS was using deprecated features from the DummyRequest object during testing. These deprecated features have been removed from Twisted 16 which was just pushed into main on Xenial. I've updated our tests to use the new way which allows our unit tests to pass. I looked around the codebase and it appears that we did convert Requests to the new method awhile back so only the unit tests had to be fixed.

Upstream bugs on removing deprecated features
http://twistedmatrix.com/trac/ticket/8140
http://twistedmatrix.com/trac/ticket/8136

[Mike Pontillo (mpontillo)]

Looks good; I can verify that this work with the latest Twisted.

Please note that after this branch lands, python3-twisted versions less than 16.0 will no longer work. (I tested it.) If you have Twisted 15.5, you'll get the following errors when running the tests in maasserver.websockets.tests:

https://paste.ubuntu.com/15175321/

review: Approve

=== modified file 'src/maasserver/tests/test_webapp.py'
--- src/maasserver/tests/test_webapp.py	2016-02-10 20:24:35 +0000
+++ src/maasserver/tests/test_webapp.py	2016-02-23 00:07:20 +0000
@@ -26,7 +26,6 @@
 from maastesting.twisted import TwistedLoggerFixture
 from mock import sentinel
 from testtools.matchers import (
-    ContainsDict,
     Equals,
     Is,
     IsInstance,
@@ -130,9 +129,9 @@
         self.expectThat(
             page.find(".//p").text_content(),
             Equals("Please try again in a few seconds."))
-        self.expectThat(
-            request.outgoingHeaders,
-            ContainsDict({b"retry-after": Equals(b"5")}))
+        self.assertEqual(
+            ['5'],
+            request.responseHeaders.getRawHeaders("retry-after"))
 
     def test__startService_starts_application(self):
         service = self.make_webapp()

=== modified file 'src/maasserver/websockets/tests/test_websockets.py'
--- src/maasserver/websockets/tests/test_websockets.py	2015-11-29 23:59:47 +0000
+++ src/maasserver/websockets/tests/test_websockets.py	2016-02-23 00:07:20 +0000
@@ -551,10 +551,16 @@
         """
         result = self.resource.render(request)
         self.assertEqual(b"", result)
-        self.assertEqual({}, request.outgoingHeaders)
+        self.assertEqual(
+            {}, {name: value for name, value in
+                 request.responseHeaders.getAllRawHeaders()})
         self.assertEqual([], request.written)
         self.assertEqual(400, request.responseCode)
 
+    def update_headers(self, request, headers):
+        for name, value in headers.items():
+            request.requestHeaders.addRawHeader(name=name, value=value)
+
     def test_getChildWithDefault(self):
         """
         L{WebSocketsResource.getChildWithDefault} raises a C{RuntimeError} when
@@ -589,7 +595,7 @@
         transport = StringTransportWithDisconnection()
         transport.protocol = Protocol()
         request.transport = transport
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
@@ -597,10 +603,11 @@
         result = self.resource.render(request)
         self.assertEqual(NOT_DONE_YET, result)
         self.assertEqual(
-            {b"connection": b"Upgrade",
-             b"upgrade": b"WebSocket",
-             b"sec-websocket-accept": b"oYBv54i42V5dw6KnZqOFroecUTc="},
-            request.outgoingHeaders)
+            {b"Connection": [b"Upgrade"],
+             b"Upgrade": [b"WebSocket"],
+             b"Sec-Websocket-Accept": [b"oYBv54i42V5dw6KnZqOFroecUTc="]},
+            {name: value
+             for name, value in request.responseHeaders.getAllRawHeaders()})
         self.assertEqual([b""], request.written)
         self.assertEqual(101, request.responseCode)
         self.assertIdentical(None, request.transport)
@@ -629,19 +636,20 @@
         transport = StringTransportWithDisconnection()
         transport.protocol = Protocol()
         request.transport = transport
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"13"})
         result = self.resource.render(request)
         self.assertEqual(NOT_DONE_YET, result)
-        self.assertEqual(
-            {b"connection": b"Upgrade",
-             b"upgrade": b"WebSocket",
-             b"sec-websocket-protocol": b"bar",
-             b"sec-websocket-accept": b"oYBv54i42V5dw6KnZqOFroecUTc="},
-            request.outgoingHeaders)
+        self.assertEqual({
+            b"Connection": [b"Upgrade"],
+            b"Upgrade": [b"WebSocket"],
+            b"Sec-Websocket-Protocol": [b"bar"],
+            b"Sec-Websocket-Accept": [b"oYBv54i42V5dw6KnZqOFroecUTc="]},
+            {name: value for name, value in
+                request.responseHeaders.getAllRawHeaders()})
         self.assertEqual([b""], request.written)
         self.assertEqual(101, request.responseCode)
 
@@ -651,7 +659,7 @@
         L{WebSocketsResource} returns a failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"wrong",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
@@ -664,7 +672,7 @@
         failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+        self.update_headers(request, headers={
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"13"})
@@ -677,7 +685,7 @@
         """
         request = DummyRequest(b"/")
         request.method = b"POST"
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
@@ -690,7 +698,7 @@
         L{WebSocketsResource} returns a failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Wrong",
             b"sec-websocket-key": b"secure",
@@ -703,7 +711,7 @@
         failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"13"})
@@ -715,7 +723,7 @@
         returns a failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-version": b"13"})
@@ -727,15 +735,17 @@
         L{WebSocketsResource} returns a failed request.
         """
         request = DummyRequest(b"/")
-        request.headers.update({
+
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"11"})
         result = self.resource.render(request)
         self.assertEqual(b"", result)
-        self.assertEqual({b"sec-websocket-version": b"13"},
-                         request.outgoingHeaders)
+        self.assertEqual(
+            ['13'],
+            request.responseHeaders.getRawHeaders("sec-websocket-version"))
         self.assertEqual([], request.written)
         self.assertEqual(400, request.responseCode)
 
@@ -748,14 +758,16 @@
         request.requestHeaders = Headers()
         request.transport = StringTransportWithDisconnection()
         self.echoProtocol = None
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"13"})
         result = self.resource.render(request)
         self.assertEqual(b"", result)
-        self.assertEqual({}, request.outgoingHeaders)
+        self.assertEqual(
+            {}, {name: value for name, value in
+                 request.responseHeaders.getAllRawHeaders()})
         self.assertEqual([], request.written)
         self.assertEqual(502, request.responseCode)
 
@@ -770,18 +782,19 @@
         secureProtocol = TLSMemoryBIOProtocol(Factory(), Protocol())
         transport.protocol = secureProtocol
         request.transport = transport
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",
             b"sec-websocket-version": b"13"})
         result = self.resource.render(request)
         self.assertEqual(NOT_DONE_YET, result)
-        self.assertEqual(
-            {b"connection": b"Upgrade",
-             b"upgrade": b"WebSocket",
-             b"sec-websocket-accept": b"oYBv54i42V5dw6KnZqOFroecUTc="},
-            request.outgoingHeaders)
+        self.assertEqual({
+            b"Connection": [b"Upgrade"],
+            b"Upgrade": [b"WebSocket"],
+            b"Sec-Websocket-Accept": [b"oYBv54i42V5dw6KnZqOFroecUTc="]},
+            {name: value for name, value in
+             request.responseHeaders.getAllRawHeaders()})
         self.assertEqual([b""], request.written)
         self.assertEqual(101, request.responseCode)
         self.assertIdentical(None, request.transport)
@@ -840,7 +853,7 @@
         transport = StringTransportWithDisconnection()
         transport.protocol = Protocol()
         request.transport = transport
-        request.headers.update({
+        self.update_headers(request, headers={
             b"upgrade": b"Websocket",
             b"connection": b"Upgrade",
             b"sec-websocket-key": b"secure",