ec_shutdown
[nepi.git] / src / nepi / resources / omf / channel.py
index 3d19ed1..ccd67be 100644 (file)
@@ -1,29 +1,29 @@
-"""
-    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.omf_api import OMFAPIFactory
 
-import nepi
-import logging
 
 @clsinit
 class OMFChannel(ResourceManager):
@@ -44,12 +44,11 @@ class OMFChannel(ResourceManager):
     """
     _rtype = "OMFChannel"
     _authorized_connections = ["OMFWifiInterface", "OMFNode"]
-    _waiters = ["OMFNode", "OMFWifiInterface"]
-
 
     @classmethod
     def _register_attributes(cls):
         """Register the attributes of an OMF channel
+        
         """
         channel = Attribute("channel", "Name of the application")
         xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
@@ -78,11 +77,15 @@ class OMFChannel(ResourceManager):
 
         self._omf_api = None
 
-        self._logger = logging.getLogger("nepi.omf.omfChannel")
-        self._logger.setLevel(nepi.LOGLEVEL)
+    @property
+    def exp_id(self):
+        if self.ec.exp_id.startswith('exp-'):
+            return None
+        return self.ec.exp_id
 
-    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
@@ -90,16 +93,22 @@ class OMFChannel(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))
+
+        msg = "Connection between %s %s and %s %s refused" % (
+                self.rtype(), self._guid, rm.rtype(), guid)
+        self.debug(msg)
+        
         return False
 
     def _get_target(self, conn_set):
         """
-        Get the couples (host, interface) that used this channel
+        Get the couples (host, interface) that uses this channel
 
         :param conn_set: Connections of the current Guid
         :type conn_set: set
@@ -107,34 +116,19 @@ class OMFChannel(ResourceManager):
         :return: self._nodes_guid
 
         """
+        res = []
         for elt in conn_set:
             rm_iface = self.ec.get_resource(elt)
             for conn in rm_iface.connections:
                 rm_node = self.ec.get_resource(conn)
-                if rm_node.rtype() == "OMFNode":
+                if rm_node.rtype() == "OMFNode" and rm_node.get('hostname'):
+                    if rm_iface.state < ResourceState.PROVISIONED or \
+                            rm_node.state < ResourceState.READY:
+                        return "reschedule"
                     couple = [rm_node.get('hostname'), rm_iface.get('alias')]
                     #print couple
-                    self._nodes_guid.append(couple)
-        return self._nodes_guid
-
-    def deploy_action(self):
-        """Deploy the RM
-
-        """
-        self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'), 
-            self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
-
-        if self.get('channel'):
-            set_nodes = self._get_target(self._connections) 
-            print set_nodes
-            for couple in set_nodes:
-                #print "Couple node/alias : " + couple[0] + "  ,  " + couple[1]
-                attrval = self.get('channel')
-                attrname = "net/%s/%s" % (couple[1], 'channel')
-                #print "Send the configure message"
-                self._omf_api.configure(couple[0], attrname, attrval)
-
-        super(OMFChannel, self).deploy_action()
+                    res.append(couple)
+        return res
 
     def discover(self):
         """ Discover the availables channels
@@ -148,23 +142,71 @@ class OMFChannel(ResourceManager):
         """
         pass
 
+    def deploy(self):
+        """ Deploy the RM. It means : Get the xmpp client and send messages 
+        using OMF 5.4 protocol to configure the channel.
+        It becomes DEPLOYED after sending messages to configure the channel
+
+        """
+        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)
+
+        if not self._omf_api :
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            self.fail()
+            return
+
+        if not self.get('channel'):
+            msg = "Channel's value is not initialized"
+            self.error(msg)
+            self.fail()
+            return
+
+        self._nodes_guid = self._get_target(self._connections) 
+        if self._nodes_guid == "reschedule" :
+            self.ec.schedule("2s", self.deploy)
+            return False
+
+        try:
+            for couple in self._nodes_guid:
+                #print "Couple node/alias : " + couple[0] + "  ,  " + couple[1]
+                attrval = self.get('channel')
+                attrname = "net/%s/%s" % (couple[1], 'channel')
+                self._omf_api.configure(couple[0], attrname, attrval)
+        except AttributeError:
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            self.fail()
+            return
+
+        super(OMFChannel, self).deploy()
+
     def start(self):
-        """Send Xmpp Message Using OMF protocol to configure Channel
+        """ Start the RM. It means nothing special for a channel for now
+        It becomes STARTED as soon as this method starts.
 
         """
 
         super(OMFChannel, self).start()
 
     def stop(self):
-        """Send Xmpp Message Using OMF protocol to put down the interface
+        """ Stop the RM. It means nothing special for a channel for now
+        It becomes STOPPED as soon as this method is called
 
         """
         super(OMFChannel, self).stop()
 
     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.exp_id)
+
+        super(OMFChannel, self).release()