Merge lp:~free.ekanayaka/landscape-client/client-api-bump into lp:~landscape/landscape-client/trunk

[Free Ekanayaka]

[lp:~free.ekanayaka/landscape-client/client-api-bump]

196. By Free Ekanayaka on 2010-01-22

Add some comments to SERVER_API and CLIENT_API

[Sidnei da Silva (sidnei)]

Looks good to me. +1!

review: Approve

[Thomas Herve (therve)]

Same here!

review: Approve

[Free Ekanayaka (free.ekanayaka)]

Thanks!

=== modified file 'landscape/__init__.py'
--- landscape/__init__.py	2010-01-22 08:24:19 +0000
+++ landscape/__init__.py	2010-01-22 13:14:13 +0000
@@ -1,7 +1,17 @@
 DEBIAN_REVISION = ""
 UPSTREAM_VERSION = "1.4.4"
 VERSION = "%s%s" % (UPSTREAM_VERSION, DEBIAN_REVISION)
-API = "3.2"
+
+# The "server-api" field of outgoing messages will be set to this value, and
+# used by the server message system to lookup the correct MessageAPI adapter
+# for handling the messages sent by the client. Bump it when the schema of any
+# of the messages sent by the client changes in a backward-incompatible way.
+SERVER_API = "3.2"
+
+# The "client-api" field of outgoing messages will be set to this value, and
+# used by the server to know which schema do the message types accepted by the
+# client support. Bump it when the schema of an accepted message type changes.
+CLIENT_API = "3.3"
 
 from twisted.python import util
 

=== modified file 'landscape/broker/exchange.py'
--- landscape/broker/exchange.py	2009-08-23 07:05:22 +0000
+++ landscape/broker/exchange.py	2010-01-22 13:14:13 +0000
@@ -7,7 +7,7 @@
 
 from landscape.lib.message import got_next_expected, ANCIENT
 from landscape.log import format_delta
-from landscape import API
+from landscape import SERVER_API, CLIENT_API
 
 
 class MessageExchange(object):
@@ -266,9 +266,9 @@
                 # missing API must be 2.0.
                 server_api = "2.0"
         else:
-            server_api = API
+            server_api = SERVER_API
         payload = {"server-api": server_api,
-                   "client-api": API,
+                   "client-api": CLIENT_API,
                    "sequence": store.get_sequence(),
                    "messages": messages,
                    "total-messages": total_messages,

=== modified file 'landscape/broker/store.py'
--- landscape/broker/store.py	2009-04-02 10:25:04 +0000
+++ landscape/broker/store.py	2010-01-22 13:14:13 +0000
@@ -8,7 +8,7 @@
 from landscape.lib import bpickle
 from landscape.lib.persist import Persist
 from landscape.lib.monitor import Monitor
-from landscape import API
+from landscape import SERVER_API
 
 
 HELD = "h"
@@ -38,7 +38,7 @@
     and is entirely unrelated to the stored messages.
     """
 
-    api = API
+    api = SERVER_API
 
     def __init__(self, persist, directory, directory_size=1000,
                  monitor_interval=60*60, get_time=time.time):

=== modified file 'landscape/broker/tests/test_exchange.py'
--- landscape/broker/tests/test_exchange.py	2009-08-23 07:05:22 +0000
+++ landscape/broker/tests/test_exchange.py	2010-01-22 13:14:13 +0000
@@ -1,5 +1,5 @@
 
-from landscape import API
+from landscape import SERVER_API, CLIENT_API
 from landscape.lib.persist import Persist
 from landscape.lib.hashlib import md5
 from landscape.schema import Message, Int
@@ -47,7 +47,7 @@
         messages = self.transport.payloads[0]["messages"]
         self.assertEquals(messages, [{"type": "empty",
                                       "timestamp": 0,
-                                      "api": API}])
+                                      "api": SERVER_API}])
 
     def test_send_urgent(self):
         """
@@ -423,9 +423,9 @@
         # the client API.
         payload = self.transport.payloads[-1]
         self.assertMessages(payload["messages"], [])
-        self.assertEquals(payload.get("client-api"), API)
-        self.assertEquals(payload.get("server-api"), API)
-        self.assertEquals(self.transport.message_api, API)
+        self.assertEquals(payload.get("client-api"), CLIENT_API)
+        self.assertEquals(payload.get("server-api"), SERVER_API)
+        self.assertEquals(self.transport.message_api, SERVER_API)
 
         self.mstore.add({"type": "a", "api": "1.0"})
         self.mstore.add({"type": "b", "api": "1.0"})
@@ -442,7 +442,7 @@
         self.assertMessages(payload["messages"],
                             [{"type": "a", "api": "1.0"},
                              {"type": "b", "api": "1.0"}])
-        self.assertEquals(payload.get("client-api"), API)
+        self.assertEquals(payload.get("client-api"), CLIENT_API)
         self.assertEquals(payload.get("server-api"), "1.0")
         self.assertEquals(self.transport.message_api, "1.0")
 
@@ -452,7 +452,7 @@
         self.assertMessages(payload["messages"],
                             [{"type": "c", "api": "1.1"},
                              {"type": "d", "api": "1.1"}])
-        self.assertEquals(payload.get("client-api"), API)
+        self.assertEquals(payload.get("client-api"), CLIENT_API)
         self.assertEquals(payload.get("server-api"), "1.1")
         self.assertEquals(self.transport.message_api, "1.1")
 
@@ -462,7 +462,7 @@
         self.assertMessages(payload["messages"],
                             [{"type": "e", "api": None},
                              {"type": "f", "api": None}])
-        self.assertEquals(payload.get("client-api"), API)
+        self.assertEquals(payload.get("client-api"), CLIENT_API)
         self.assertEquals(payload.get("server-api"), "2.0")
         self.assertEquals(self.transport.message_api, "2.0")
 

=== modified file 'landscape/broker/tests/test_store.py'
--- landscape/broker/tests/test_store.py	2009-08-07 22:36:33 +0000
+++ landscape/broker/tests/test_store.py	2010-01-22 13:14:13 +0000
@@ -8,7 +8,7 @@
 
 from landscape.tests.helpers import LandscapeTest
 from landscape.tests.mocker import ANY
-from landscape import API
+from landscape import SERVER_API
 
 
 class MessageStoreTest(LandscapeTest):
@@ -123,7 +123,7 @@
         self.assertMessages(messages,
                             [{"type": "data",
                               "data": "A thing",
-                              "api": API}])
+                              "api": SERVER_API}])
 
     def test_max_pending(self):
         for i in range(10):
@@ -260,7 +260,7 @@
         messages = self.store.get_pending_messages()
 
         self.assertEquals(messages, [{"type": "data", "data": "2",
-                                      "api": API}])
+                                      "api": SERVER_API}])
 
         self.store.set_pending_offset(len(messages))
 
@@ -291,10 +291,10 @@
         self.mocker.verify()
         self.mocker.reset()
         self.assertEquals(self.store.get_pending_messages(),
-                         [{"type": "data", "data": 1, "api": API}])
+                         [{"type": "data", "data": 1, "api": SERVER_API}])
 
     def test_api_attribute(self):
-        self.assertEquals(self.store.api, API)
+        self.assertEquals(self.store.api, SERVER_API)
         new_api = "New API version!"
         self.store.api = new_api
         self.assertEquals(self.store.api, new_api)
@@ -302,7 +302,7 @@
     def test_default_api_on_messages(self):
         self.store.add({"type": "empty"})
         self.assertEquals(self.store.get_pending_messages(),
-                          [{"type": "empty", "api": API}])
+                          [{"type": "empty", "api": SERVER_API}])
 
     def test_custom_api_on_store(self):
         self.store.api = "X.Y"

=== modified file 'landscape/broker/transport.py'
--- landscape/broker/transport.py	2009-04-02 10:25:04 +0000
+++ landscape/broker/transport.py	2010-01-22 13:14:13 +0000
@@ -8,7 +8,7 @@
 from landscape.lib.fetch import fetch
 from landscape.lib import bpickle
 from landscape.log import format_delta
-from landscape import API, VERSION
+from landscape import SERVER_API, VERSION
 
 
 class HTTPTransport(object):
@@ -40,7 +40,7 @@
         return (curl, fetch(self._url, post=True, data=payload,
                             headers=headers, cainfo=self._pubkey, curl=curl))
 
-    def exchange(self, payload, computer_id=None, message_api=API):
+    def exchange(self, payload, computer_id=None, message_api=SERVER_API):
         """Exchange message data with the server.
 
         @param payload: The object to send, it must be L{bpickle}-compatible.
@@ -105,7 +105,7 @@
     def set_url(self, url):
         self._url = url
 
-    def exchange(self, payload, computer_id=None, message_api=API):
+    def exchange(self, payload, computer_id=None, message_api=SERVER_API):
         self.payloads.append(payload)
         self.computer_id = computer_id
         self.message_api = message_api

=== modified file 'landscape/manager/tests/test_customgraph.py'
--- landscape/manager/tests/test_customgraph.py	2009-08-18 16:49:00 +0000
+++ landscape/manager/tests/test_customgraph.py	2010-01-22 13:14:13 +0000
@@ -5,7 +5,7 @@
 from twisted.internet.error import ProcessDone
 from twisted.python.failure import Failure
 
-from landscape import API
+from landscape import SERVER_API
 
 from landscape.manager.customgraph import CustomGraphPlugin
 from landscape.manager.store import ManagerStore
@@ -456,7 +456,7 @@
         self.graph_manager.exchange()
         self.assertMessages(
             self.broker_service.message_store.get_pending_messages(),
-            [{"api": API,
+            [{"api": SERVER_API,
               "data": {123: {"error": u"",
                              "script-hash": "e00a2f44dbc7b6710ce32af2348aec9b",
                              "values": []}},
@@ -479,7 +479,7 @@
         self.graph_manager.exchange()
         self.assertMessages(
             self.broker_service.message_store.get_pending_messages(),
-            [{"api": API,
+            [{"api": SERVER_API,
               "data": {},
               "timestamp": 0,
               "type": "custom-graph"}])
@@ -504,13 +504,13 @@
         self.graph_manager.exchange()
         self.assertMessages(
             self.broker_service.message_store.get_pending_messages(),
-            [{"api": API,
+            [{"api": SERVER_API,
               "data": {123: {"error": u"",
                              "script-hash": "e00a2f44dbc7b6710ce32af2348aec9b",
                              "values": []}},
               "timestamp": 0,
               "type": "custom-graph"},
-             {"api": API,
+             {"api": SERVER_API,
               "data": {123: {"error": u"",
                              "script-hash": "e00a2f44dbc7b6710ce32af2348aec9b",
                              "values": []}},
@@ -538,13 +538,13 @@
         self.graph_manager.exchange()
         self.assertMessages(
             self.broker_service.message_store.get_pending_messages(),
-            [{"api": API,
+            [{"api": SERVER_API,
               "data": {123: {"error": u"",
                              "script-hash": "e00a2f44dbc7b6710ce32af2348aec9b",
                              "values": []}},
               "timestamp": 0,
               "type": "custom-graph"},
-             {"api": API,
+             {"api": SERVER_API,
               "data": {123: {"error": u"",
                              "script-hash": "d483816dc0fbb51ede42502a709b0e2a",
                              "values": []}},
@@ -587,7 +587,7 @@
             self.graph_manager.exchange()
             self.assertMessages(
                 self.broker_service.message_store.get_pending_messages(),
-                [{"api": API,
+                [{"api": SERVER_API,
                   "data": {123: {"error": u"",
                                  "script-hash":
                                     "991e15a81929c79fe1d243b2afd99c62",
@@ -629,7 +629,7 @@
             self.graph_manager.exchange()
             self.assertMessages(
                 self.broker_service.message_store.get_pending_messages(),
-                [{"api": API, "data": {}, "timestamp": 0, "type":
+                [{"api": SERVER_API, "data": {}, "timestamp": 0, "type":
                   "custom-graph"}])
         return result.addCallback(check)
 

=== modified file 'landscape/manager/tests/test_shutdownmanager.py'
--- landscape/manager/tests/test_shutdownmanager.py	2008-07-18 17:42:25 +0000
+++ landscape/manager/tests/test_shutdownmanager.py	2010-01-22 13:14:13 +0000
@@ -1,7 +1,7 @@
 from twisted.python.failure import Failure
 from twisted.internet.error import ProcessTerminated
 
-from landscape import API
+from landscape import SERVER_API
 from landscape.manager.manager import SUCCEEDED, FAILED
 from landscape.manager.shutdownmanager import (
     ShutdownManager, ShutdownProcessProtocol)
@@ -43,7 +43,7 @@
             self.assertTrue(self.broker_service.exchanger.is_urgent())
             self.assertEquals(
                 self.broker_service.message_store.get_pending_messages(),
-                [{"type": "operation-result", "api": API,
+                [{"type": "operation-result", "api": SERVER_API,
                   "operation-id": 100, "timestamp": 10, "status": SUCCEEDED,
                   "result-text": u"Data may arrive in batches."}])
 
@@ -80,7 +80,7 @@
             self.assertTrue(self.broker_service.exchanger.is_urgent())
             self.assertEquals(
                 self.broker_service.message_store.get_pending_messages(),
-                [{"type": "operation-result", "api": API,
+                [{"type": "operation-result", "api": SERVER_API,
                   "operation-id": 100, "timestamp": 0, "status": FAILED,
                   "result-text": u"Failure text is reported."}])
 

=== modified file 'landscape/monitor/tests/test_activeprocessinfo.py'
--- landscape/monitor/tests/test_activeprocessinfo.py	2009-10-06 14:16:02 +0000
+++ landscape/monitor/tests/test_activeprocessinfo.py	2010-01-22 13:14:13 +0000
@@ -10,7 +10,7 @@
 from landscape.tests.helpers import (LandscapeTest, MonitorHelper,
                                      ProcessDataBuilder)
 from landscape.tests.mocker import ANY
-from landscape import API
+from landscape import SERVER_API
 
 
 class ActiveProcessInfoTest(LandscapeTest):
@@ -470,7 +470,7 @@
         messages = self.mstore.get_pending_messages()
         self.assertEquals(len(messages), 2)
         self.assertMessages(messages, [{"timestamp": 0,
-                                        "api": API,
+                                        "api": SERVER_API,
                                         "type": "active-process-info",
                                         "kill-all-processes": True,
                                         "add-processes": [{"start-time": 110,
@@ -482,7 +482,7 @@
                                                             "vm-size": 11676,
                                                             "uid": 0}]},
                                        {"timestamp": 0,
-                                        "api": API,
+                                        "api": SERVER_API,
                                         "type": "active-process-info",
                                         "update-processes": [{"start-time": 110,
                                                               "name": u"init",