Tree: add channel versioning

Add ClusterShell version into channel tag for debugging and future use.

Change-Id: I0872bf0e563c18a67b4a558911942a4c2221ffdc

Author: thiell

lib/ClusterShell/Communication.py

@@ -65,6 +65,7 @@
 from collections import deque
 from cStringIO import StringIO
 
+from ClusterShell import __version__
 from ClusterShell.Event import EventHandler
 
 
@@ -83,13 +84,15 @@ def __init__(self):
         """XMLReader initializer"""
         ContentHandler.__init__(self)
         self.msg_queue = deque()
+        self.version = None
         # current packet under construction
         self._draft = None
         self._sections_map = None
 
     def startElement(self, name, attrs):
         """read a starting xml tag"""
         if name == 'channel':
+            self.version = attrs.get('version')
             self.msg_queue.appendleft(StartMessage())
         elif name == 'message':
             self._draft_new(attrs)
@@ -192,7 +195,8 @@ def _init(self):
 
     def _open(self):
         """open a new communication channel from src to dst"""
-        XMLGenerator(self.worker, encoding=ENCODING).startElement('channel', {})
+        xmlgen = XMLGenerator(self.worker, encoding=ENCODING)
+        xmlgen.startElement('channel', {'version': __version__})
 
     def _close(self):
         """close an already opened channel"""

lib/ClusterShell/Gateway.py

@@ -179,8 +179,8 @@ def recv(self, msg):
                 self.logger.debug('got start message %s', msg)
                 self.opened = True
                 self._open()
-                self.logger.debug('channel started')
-                # TODO: channel versioning
+                self.logger.debug('channel started (version %s on remote end)',
+                                  self._xml_reader.version)
             else:
                 self.logger.error('unexpected message: %s', str(msg))
                 raise MessageProcessingError('unexpected message: %s' % msg)

lib/ClusterShell/Propagation.py

@@ -275,8 +275,8 @@ def recv(self, msg):
             self.recv_cfg(msg)
         elif msg.type == StartMessage.ident:
             self.opened = True
-            self.logger.debug('channel started')
-            # TODO: channel versioning
+            self.logger.debug('channel started (version %s on remote gateway)',
+                              self._xml_reader.version)
         else:
             self.logger.error('unexpected message: %s', str(msg))
 

tests/TreeGatewayTest.py

@@ -4,12 +4,10 @@
 import logging
 import os
 import re
-import sys
 import unittest
 import xml.sax
 
-sys.path.insert(0, '../lib')
-
+from ClusterShell import __version__
 from ClusterShell.Communication import ConfigurationMessage, ControlMessage, \
     StdOutMessage, StdErrMessage, RetcodeMessage, ACKMessage, ErrorMessage, \
     TimeoutMessage, StartMessage, EndMessage, XMLReader
@@ -103,7 +101,7 @@ def tearDown(self):
     #
     def channel_send_start(self):
         """send starting channel tag"""
-        self.gateway.send('<channel>')
+        self.gateway.send('<channel version="%s">' % __version__)
 
     def channel_send_stop(self):
         """send channel ending tag"""