ec_shutdown
[nepi.git] / src / nepi / resources / omf / node.py
index bd88c39..570afd0 100644 (file)
@@ -1,30 +1,32 @@
-"""
-    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, ResourceState
+#
+#    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 time
 
-reschedule_delay = "0.5s"
 
 @clsinit
 class OMFNode(ResourceManager):
@@ -93,18 +95,15 @@ class OMFNode(ResourceManager):
         :type ec: ExperimentController
         :param guid: guid of the RM
         :type guid: int
-        :param creds: Credentials to communicate with the rm (XmppClient for OMF)
-        :type creds: dict
 
         """
         super(OMFNode, self).__init__(ec, guid)
 
         self._omf_api = None 
 
-        # XXX: TO DISCUSS
-
-    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
@@ -113,21 +112,48 @@ class OMFNode(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 deploy(self):
-        """Deploy the RM
+        """ 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 :
+        if not self._omf_api:
             self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'), 
-                self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
-        self._omf_api.enroll_host(self.get('hostname'))
+                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('hostname'):
+            msg = "Hostname's value is not initialized"
+            self.error(msg)
+            self.fail()
+            return
+
+        try:
+            self._omf_api.enroll_host(self.get('hostname'))
+        except AttributeError:
+            msg = "Credentials are not initialzed. XMPP Connections impossible"
+            self.error(msg)
+            self.fail()
+            return
 
         super(OMFNode, self).deploy()
 
@@ -144,14 +170,15 @@ class OMFNode(ResourceManager):
         pass
 
     def start(self):
-        """Send Xmpp Message Using OMF protocol to enroll the node into the experiment
+        """Start the RM. It means nothing special for an interface for now
+           It becomes STARTED as soon as this method starts.
 
         """
         super(OMFNode, self).start()
 
-
     def stop(self):
-        """Send Xmpp Message Using OMF protocol to disconnect the node
+        """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()
@@ -160,27 +187,12 @@ class OMFNode(ResourceManager):
         """Clean the RM at the end of the experiment
 
         """
-        self._omf_api.release(self.get('hostname'))
-        OMFAPIFactory.release_api(self.get('xmppSlice'), 
-            self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
-
-
-    def configure(self):
-        #routes = self.tc._add_route.get(self.guid, [])
-        #iface_guids = self.tc.get_connected(self.guid, "devs", "node")
-       
-        for route in routes:
-            (destination, netprefix, nexthop, metric, device) = route
-            netmask = ipaddr2.ipv4_mask2dot(netprefix)
-
-            # Validate that the interface is associated to the node
-            for iface_guid in iface_guids:
-                iface = self.tc.elements.get(iface_guid)
-                if iface.devname == device:
-                    self._omf_api.execute(self.get('hostname'), 
-                        "Id#%s" % str(random.getrandbits(128)), 
-                        "add -net %s netmask %s dev %s" % (destination, netmask, iface.devname), 
-                        "/sbin/route", # path
-                        None, # env
-                     )
-                    break
+        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()
+