update test and examples for OMF6 in OMF section
[nepi.git] / src / nepi / resources / omf / node.py
index b6b65ef..c0e10f9 100644 (file)
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 #         Julien Tribino <julien.tribino@inria.fr>
 
-
-from nepi.execution.resource import ResourceManager, clsinit, ResourceState, \
-        reschedule_delay
+from nepi.execution.resource import ResourceManager, clsinit_copy, \
+        ResourceState, reschedule_delay
 from nepi.execution.attribute import Attribute, Flags 
 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
-from nepi.resources.omf.omf_api import OMFAPIFactory
+from nepi.resources.omf.omf_api_factory import OMFAPIFactory
 
 import time
 
+reschedule_check = "0.3s"
+confirmation_counter = 300
 
-@clsinit
+@clsinit_copy
 class OMFNode(OMFResource):
     """
     .. class:: Class Args :
@@ -40,10 +41,6 @@ class OMFNode(OMFResource):
         :param creds: Credentials to communicate with the rm (XmppClient for OMF)
         :type creds: dict
 
-    .. note::
-
-       This class is used only by the Experiment Controller through the Resource Factory
-
     """
     _rtype = "OMFNode"
     _authorized_connections = ["OMFApplication" , "OMFWifiInterface"]
@@ -71,6 +68,10 @@ class OMFNode(OMFResource):
 
         self._omf_api = None 
 
+    @property
+    def exp_id(self):
+        return self.ec.exp_id
+
     def valid_connection(self, guid):
         """ Check if the connection with the guid in parameter is possible. 
         Only meaningful connections are allowed.
@@ -81,89 +82,85 @@ class OMFNode(OMFResource):
 
         """
         rm = self.ec.get_resource(guid)
-        if rm.rtype() in self._authorized_connections:
+        if rm.get_rtype() in self._authorized_connections:
             msg = "Connection between %s %s and %s %s accepted" % (
-                    self.rtype(), self._guid, rm.rtype(), guid)
+                    self.get_rtype(), self._guid, rm.get_rtype(), guid)
             self.debug(msg)
-
             return True
 
         msg = "Connection between %s %s and %s %s refused" % (
-                self.rtype(), self._guid, rm.rtype(), guid)
-        self.debug(msg)
+                self.get_rtype(), self._guid, rm.get_rtype(), guid)
+        self.error(msg)
 
         return False
 
-    def deploy(self):
+    def do_deploy(self):
         """ Deploy the RM. It means : Send Xmpp Message Using OMF protocol 
             to enroll the node into the experiment.
-            It becomes DEPLOYED after sending messages to enroll the node
 
         """ 
-        if not self._omf_api :
-            self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'), 
-                self.get('xmppHost'), self.get('xmppPort'), 
-                self.get('xmppPassword'), exp_id = self.ec.exp_id)
+        if not self.get('xmppServer'):
+            msg = "XmppServer is not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            raise RuntimeError, msg
 
-        if not self._omf_api :
-            msg = "Credentials are not initialzed. XMPP Connections impossible"
+        if not self.get('version'):
+            msg = "Version of OMF is not indicated"
             self.error(msg)
-            self.fail()
-            return
+            raise RuntimeError, msg
+
+        if not (self.get('xmppUser') or self.get('xmppPort') 
+                   or self.get('xmppPassword')):
+            msg = "Credentials are not all initialzed. Default values will be used"
+            self.warn(msg)
+
+        if not self._omf_api :
+            self._omf_api = OMFAPIFactory.get_api(self.get('version'), 
+              self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+               self.get('xmppPassword'), exp_id = self.exp_id)
 
         if not self.get('hostname') :
             msg = "Hostname's value is not initialized"
             self.error(msg)
-            self.fail()
-            return False
+            raise RuntimeError, msg
 
-        try:
+        if self.get('version') == "5":
             self._omf_api.enroll_host(self.get('hostname'))
-        except AttributeError:
-            msg = "Credentials are not initialzed. XMPP Connections impossible"
-            self.error(msg)
-            self.fail()
-            #raise AttributeError, msg
-
-        super(OMFNode, self).deploy()
+        else:
+            self._omf_api.enroll_topic(self.get('hostname'))
 
-    def discover(self):
-        """ Discover the availables nodes
+        super(OMFNode, self).do_deploy()
 
-        """
-        pass
-     
-    def provision(self):
-        """ Provision some availables nodes
-
-        """
-        pass
-
-    def start(self):
-        """Start the RM. It means nothing special for an interface for now
-           It becomes STARTED as soon as this method starts.
+    def do_release(self):
+        """ Clean the RM at the end of the experiment by unenrolling
+        the node from the topic
 
         """
-
-        super(OMFNode, self).start()
-
-    def stop(self):
-        """Stop the RM. It means nothing special for an interface for now
-           It becomes STOPPED as soon as this method stops
-
-        """
-        super(OMFNode, self).stop()
-
-    def release(self):
-        """Clean the RM at the end of the experiment
-
-        """
-        if self._omf_api :
-            self._omf_api.release(self.get('hostname'))
-
-            OMFAPIFactory.release_api(self.get('xmppSlice'), 
-                self.get('xmppHost'), self.get('xmppPort'), 
-                self.get('xmppPassword'), exp_id = self.ec.exp_id)
-
-        super(OMFNode, self).release()
+        from nepi.resources.omf.application import OMFApplication
+        rm_list = self.get_connected(OMFApplication.get_rtype())
+        if rm_list:
+            for rm in rm_list:
+                if rm.state < ResourceState.RELEASED:
+                    self.ec.schedule(reschedule_delay, self.release)
+                    return 
+
+        from nepi.resources.omf.interface import OMFWifiInterface
+        rm_list = self.get_connected(OMFWifiInterface.get_rtype())
+        if rm_list:
+            for rm in rm_list:
+                if rm.state < ResourceState.RELEASED:
+                    self.ec.schedule(reschedule_delay, self.release)
+                    return 
+
+        if self._omf_api:
+            if self.get('version') == "5":
+                self._omf_api.release(self.get('hostname'))
+            else:
+                self._omf_api.unenroll_topic(self.get('hostname'))
+
+            OMFAPIFactory.release_api(self.get('version'), 
+              self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+               self.get('xmppPassword'), exp_id = self.exp_id)
+
+        super(OMFNode, self).do_release()