Code cleanup. Setting resource state through specific functions
[nepi.git] / src / nepi / resources / omf / interface.py
index 5e6fb6d..a3b9c3a 100644 (file)
@@ -1,30 +1,31 @@
-"""
-    NEPI, a framework to manage network experiments
-    Copyright (C) 2013 INRIA
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""
-
-from nepi.execution.resource import ResourceManager, clsinit
+#
+#    NEPI, a framework to manage network experiments
+#    Copyright (C) 2013 INRIA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# 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.attribute import Attribute, Flags 
 
+from nepi.resources.omf.node import OMFNode
+from nepi.resources.omf.channel import OMFChannel
 from nepi.resources.omf.omf_api import OMFAPIFactory
 
-import nepi
-import logging
-
 @clsinit
 class OMFWifiInterface(ResourceManager):
     """
@@ -39,12 +40,12 @@ 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"
     _authorized_connections = ["OMFNode" , "OMFChannel"]
-    _waiters = ["OMFNode"]
 
     #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
 
@@ -87,11 +88,9 @@ class OMFWifiInterface(ResourceManager):
         self._omf_api = None
         self._alias = self.get('alias')
 
-        self._logger = logging.getLogger("nepi.omf.omfIface  ")
-        self._logger.setLevel(nepi.LOGLEVEL)
-
-    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
@@ -100,67 +99,130 @@ class OMFWifiInterface(ResourceManager):
         """
         rm = self.ec.get_resource(guid)
         if rm.rtype() in self._authorized_connections:
-            self._logger.debug("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
-        self._logger.debug("Connection between %s %s and %s %s refused" % 
-            (self.rtype(), self._guid, rm.rtype(), guid))
-        return False
 
-    def _get_nodes(self, conn_set):
-        """ Get the RM of the node to which the application is connected
+        msg = "Connection between %s %s and %s %s refused" % \
+             (self.rtype(), self._guid, rm.rtype(), guid)
+        self.debug(msg)
 
-        :param conn_set: Connections of the current Guid
-        :type conn_set: set
-        :rtype: ResourceManager
+        return False
 
-        """
-        for elt in conn_set:
-            rm = self.ec.get_resource(elt)
-            if rm.rtype() == "OMFNode":
-                return rm
+    @property
+    def node(self):
+        rm_list = self.get_connected(OMFNode.rtype())
+        if rm_list: return rm_list[0]
         return None
 
-    def deploy_action(self):
-        """Deploy the RM
+    @property
+    def channel(self):
+        rm_list = self.get_connected(OMFChannel.rtype())
+        if rm_list: return rm_list[0]
+        return None
+
+
+    def configure_iface(self):
+        """ Configure the interface without the ip
 
         """
-        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_node = self._get_nodes(self._connections)    
-            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)
-
-        super(OMFWifiInterface, self).deploy_action()
-
-
-    def start(self):
-        """Send Xmpp Messages Using OMF protocol to configure Interface
+                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
+
+    def configure_ip(self):
+        """ Configure the ip of the interface
 
         """
-
-        super(OMFWifiInterface, self).start()
-
-    def stop(self):
-        """Send Xmpp Message Using OMF protocol to put down 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
+
+        return True
+
+    def 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
         """
-        super(OMFWifiInterface, self).stop()
+        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._omf_api :
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            self.fail()
+            return
+
+        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)
+            self.fail()
+            return False
+
+        if not self.node.get('hostname') :
+            msg = "The channel is connected with an undefined node"
+            self.error(msg)
+            self.fail()
+            return False
+
+        # 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
+        chk1 = True
+        if self.state < ResourceState.PROVISIONED:
+            chk1 = self.configure_iface()
+        if chk1:
+            chk2 = self.configure_ip()
+
+        if not (chk1 and chk2) :
+            return False
+            
+        super(OMFWifiInterface, self).deploy()
+        return True
 
     def release(self):
-        """Clean the RM at the end of the experiment
+        """ 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.ec.exp_id)
 
+        super(OMFWifiInterface, self).release()