Fixing RM.DEPLOY being executed after/during RM.RELEASE by adding a release_lock...
[nepi.git] / src / nepi / resources / omf / interface.py
index 13469b8..b4c1df7 100644 (file)
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 #         Julien Tribino <julien.tribino@inria.fr>
 
-from nepi.execution.resource import ResourceManager, clsinit, ResourceState
+from nepi.execution.resource import ResourceManager, clsinit_copy, \
+        ResourceState, reschedule_delay
 from nepi.execution.attribute import Attribute, Flags 
 
+from nepi.resources.omf.node import OMFNode
+from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
+from nepi.resources.omf.channel import OMFChannel
 from nepi.resources.omf.omf_api import OMFAPIFactory
 
-reschedule_delay = "0.5s"
-
-@clsinit
-class OMFWifiInterface(ResourceManager):
+@clsinit_copy
+class OMFWifiInterface(OMFResource):
     """
     .. class:: Class Args :
       
@@ -39,7 +41,8 @@ class OMFWifiInterface(ResourceManager):
 
     .. note::
 
-       This class is used only by the Experiment Controller through the Resource Factory
+       This class is used only by the Experiment Controller through the Resource 
+       Factory
 
     """
     _rtype = "OMFWifiInterface"
@@ -57,15 +60,7 @@ class OMFWifiInterface(ResourceManager):
         type = Attribute("type","Type of the interface")
         essid = Attribute("essid","Essid of the interface")
         ip = Attribute("ip","IP of the interface")
-        xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
-        xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
-        xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
-        xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
         cls._register_attribute(alias)
-        cls._register_attribute(xmppSlice)
-        cls._register_attribute(xmppHost)
-        cls._register_attribute(xmppPort)
-        cls._register_attribute(xmppPassword)
         cls._register_attribute(mode)
         cls._register_attribute(type)
         cls._register_attribute(essid)
@@ -86,8 +81,9 @@ class OMFWifiInterface(ResourceManager):
         self._omf_api = None
         self._alias = self.get('alias')
 
-    def _validate_connection(self, guid):
-        """ Check if the connection is available.
+    def valid_connection(self, guid):
+        """ Check if the connection with the guid in parameter is possible. 
+        Only meaningful connections are allowed.
 
         :param guid: Guid of the current RM
         :type guid: int
@@ -96,72 +92,124 @@ class OMFWifiInterface(ResourceManager):
         """
         rm = self.ec.get_resource(guid)
         if rm.rtype() in self._authorized_connections:
-            msg = "Connection between %s %s and %s %s accepted" % (self.rtype(), self._guid, rm.rtype(), guid)
+            msg = "Connection between %s %s and %s %s accepted" % \
+                (self.rtype(), self._guid, rm.rtype(), guid)
             self.debug(msg)
+
             return True
-        msg = "Connection between %s %s and %s %s refused" % (self.rtype(), self._guid, rm.rtype(), guid)
+
+        msg = "Connection between %s %s and %s %s refused" % \
+             (self.rtype(), self._guid, rm.rtype(), guid)
         self.debug(msg)
+
         return False
 
-    def _get_nodes(self, conn_set):
-        """ Get the RM of the node to which the application is connected
+    @property
+    def exp_id(self):
+        return self.ec.exp_id
 
-        :param conn_set: Connections of the current Guid
-        :type conn_set: set
-        :rtype: ResourceManager
+    @property
+    def node(self):
+        rm_list = self.get_connected(OMFNode.rtype())
+        if rm_list: return rm_list[0]
+        return None
 
-        """
-        for elt in conn_set:
-            rm = self.ec.get_resource(elt)
-            if rm.rtype() == "OMFNode":
-                return rm
+    @property
+    def channel(self):
+        rm_list = self.get_connected(OMFChannel.rtype())
+        if rm_list: return rm_list[0]
         return None
 
-    def deploy(self):
-        """Deploy the RM
+    def configure_iface(self):
+        """ Configure the interface without the ip
 
         """
-        if not self._omf_api :
-            self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'), 
-                self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
+        if self.node.state < ResourceState.READY:
+            self.ec.schedule(reschedule_delay, self.deploy)
+            return False
 
-        self._logger.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " +
-            self.get('mode') + " : " + self.get('type') + " : " +
-            self.get('essid') + " : " + self.get('ip'))
-        #try:
-        if self.get('mode') and self.get('type') and self.get('essid') and self.get('ip'):
-            rm_list = self.get_connected("OMFNode") 
-            for rm_node in rm_list:
-                if rm_node.state < ResourceState.READY:
-                    self.ec.schedule(reschedule_delay, self.deploy)
-                    return 
-            for attrname in ["mode", "type", "essid", "ip"]:
+        try :
+            for attrname in ["mode", "type", "essid"]:
                 attrval = self.get(attrname)
                 attrname = "net/%s/%s" % (self._alias, attrname)
-                #print "Send the configure message"
-                self._omf_api.configure(rm_node.get('hostname'), attrname, attrval)
+                self._omf_api.configure(self.node.get('hostname'), attrname, 
+                        attrval)
+        except AttributeError:
+            self._state = ResourceState.FAILED
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.debug(msg)
+            #raise
+        
+        super(OMFWifiInterface, self).provision()
+        return True
 
-        super(OMFWifiInterface, self).deploy()
+    def configure_ip(self):
+        """ Configure the ip of the interface
 
+        """
+        if self.channel.state < ResourceState.READY:
+            self.ec.schedule(reschedule_delay, self.deploy)
+            return False
+
+        try :
+            attrval = self.get("ip")
+            attrname = "net/%s/%s" % (self._alias, "ip")
+            self._omf_api.configure(self.node.get('hostname'), attrname, 
+                    attrval)
+        except AttributeError:
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.debug(msg)
+            self.fail()
+            #raise
 
-    def start(self):
-        """Send Xmpp Messages Using OMF protocol to configure Interface
+        return True
 
+    def do_deploy(self):
+        """ Deploy the RM. It means : Get the xmpp client and send messages 
+        using OMF 5.4 protocol to configure the interface.
+        It becomes DEPLOYED after sending messages to configure the interface
         """
+        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.exp_id)
 
-        super(OMFWifiInterface, self).start()
-
-    def stop(self):
-        """Send Xmpp Message Using OMF protocol to put down the interface
+        if not self._omf_api :
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            raise RuntimeError, msg
+
+        if not (self.get('mode') and self.get('type') and self.get('essid') \
+                and self.get('ip')):
+            msg = "Interface's variable are not initialized"
+            self.error(msg)
+            raise RuntimeError, msg
+
+        if not self.node.get('hostname') :
+            msg = "The channel is connected with an undefined node"
+            self.error(msg)
+            raise RuntimeError, msg
+
+        # Just for information
+        self.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " + \
+            self.get('mode') + " : " + self.get('type') + " : " + \
+            self.get('essid') + " : " + self.get('ip'))
+    
+        # Check if the node is already deployed
+        if self.state < ResourceState.PROVISIONED:
+            if self.configure_iface():
+                self.configure_ip()
 
-        """
-        super(OMFWifiInterface, self).stop()
+        super(OMFWifiInterface, self).do_deploy()
 
-    def release(self):
-        """Clean the RM at the end of the experiment
+    def do_release(self):
+        """ Clean the RM at the end of the experiment and release the API
 
         """
-        OMFAPIFactory.release_api(self.get('xmppSlice'), 
-            self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
+        if self._omf_api:
+            OMFAPIFactory.release_api(self.get('xmppSlice'), 
+                self.get('xmppHost'), self.get('xmppPort'), 
+                self.get('xmppPassword'), exp_id = self.exp_id)
 
+        super(OMFWifiInterface, self).do_release()