Merge lp:~free.ekanayaka/landscape-client/fix-upgrades-to-14.01 into lp:~landscape/landscape-client/trunk

[Free Ekanayaka]

Fix upgrades from < 14.01 to >= 14.01 by working around the change in
the BrokerServer.send_message signature.

Fix upgrades from < 14.01 to >= 14.01 by working around the change in
the BrokerServer.send_message signature.

[Alberto Donato (ack)]

Nice catch, +1

review: Approve

[Benji York (benji)]

Very nice. I had one less-than-trivial thought inline.

review: Approve

[lp:~free.ekanayaka/landscape-client/fix-upgrades-to-14.01]

794. By Free Ekanayaka on 2014-11-06

Address review comments

=== modified file 'landscape/broker/server.py'
--- landscape/broker/server.py	2013-07-19 09:57:57 +0000
+++ landscape/broker/server.py	2014-11-06 07:42:30 +0000
@@ -191,6 +191,22 @@
             during the next regularly scheduled exchange.
         @return: The message identifier created when queuing C{message}.
         """
+        if isinstance(session_id, bool) and message["type"] in (
+                "operation-result", "change-packages-result"):
+            # XXX This means we're performing a Landscape-driven upgrade and
+            # we're being invoked by a package-changer or release-upgrader
+            # process that is running code which doesn't know about the
+            # session_id parameter, i.e. it was written against the old
+            # signature:
+            #
+            #     def send_message(self, message, urgent=False):
+            #
+            # In this case we'll just let the message in. This transitional
+            # code can be dropped once we stop supporting clients without
+            # session IDs (i.e. with versions < 14.01).
+            urgent = True
+            session_id = self.get_session_id()
+
         if session_id is None:
             raise RuntimeError(
                 "Session ID must be set before attempting to send a message")
 
=== modified file 'landscape/broker/tests/test_server.py'
--- landscape/broker/tests/test_server.py	2013-09-09 14:12:05 +0000
+++ landscape/broker/tests/test_server.py	2014-11-06 07:42:30 +0000
@@ -104,6 +104,29 @@
         self.assertRaises(
             RuntimeError, self.broker.send_message, message, None)
 
+    def test_send_message_with_old_release_upgrader(self):
+        """
+        If we receive a message from an old release-upgrader process that
+        doesn't know about session IDs, we just let the message in.
+        """
+        message = {"type": "operation-result", "operation-id": 99, "status": 5}
+        self.mstore.set_accepted_types(["operation-result"])
+        self.broker.send_message(message, True)
+        self.assertMessages(self.mstore.get_pending_messages(), [message])
+        self.assertTrue(self.exchanger.is_urgent())
+
+    def test_send_message_with_old_package_changer(self):
+        """
+        If we receive a message from an old package-changer process that
+        doesn't know about session IDs, we just let the message in.
+        """
+        message = {"type": "change-packages-result", "operation-id": 99,
+                   "result-code": 123}
+        self.mstore.set_accepted_types(["change-packages-result"])
+        self.broker.send_message(message, True)
+        self.assertMessages(self.mstore.get_pending_messages(), [message])
+        self.assertTrue(self.exchanger.is_urgent())
+
     def test_is_pending(self):
         """
         The L{BrokerServer.is_pending} method indicates if a message with