Making runId as sub folder optional for the Collector RM
[nepi.git] / src / nepi / resources / omf / interface.py
index d064c66..c78daa0 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.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
 
-
-@clsinit
-class OMFWifiInterface(ResourceManager):
+@clsinit_copy
+class OMFWifiInterface(OMFResource):
     """
     .. class:: Class Args :
       
@@ -35,12 +36,6 @@ class OMFWifiInterface(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
-
-    .. note::
-
-       This class is used only by the Experiment Controller through the Resource Factory
 
     """
     _rtype = "OMFWifiInterface"
@@ -58,15 +53,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)
@@ -84,17 +71,14 @@ class OMFWifiInterface(ResourceManager):
         """
         super(OMFWifiInterface, self).__init__(ec, guid)
 
+        self._conf = False
+
         self._omf_api = None
         self._alias = self.get('alias')
 
-    @property
-    def exp_id(self):
-        if self.ec.exp_id.startswith('exp-'):
-            return None
-        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.
+        """ 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
@@ -102,92 +86,125 @@ class OMFWifiInterface(ResourceManager):
 
         """
         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.get_rtype(), self._guid, rm.get_rtype(), guid)
         self.debug(msg)
+
         return False
 
+    @property
+    def exp_id(self):
+        return self.ec.exp_id
+
     @property
     def node(self):
-        rm_list = self.get_connected(OMFNode.rtype())
+        rm_list = self.get_connected(OMFNode.get_rtype())
+        if rm_list: return rm_list[0]
+        return None
+
+    @property
+    def channel(self):
+        rm_list = self.get_connected(OMFChannel.get_rtype())
         if rm_list: return rm_list[0]
         return None
 
-    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
+    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'), exp_id = self.exp_id)
+        if self.node.state < ResourceState.READY:
+            self.ec.schedule(reschedule_delay, self.deploy)
+            return False
 
-        if not self._omf_api :
-            self._state = ResourceState.FAILED
+        for attrname in ["mode", "type", "essid"]:
+            attrval = self.get(attrname)
+            attrname = "net/%s/%s" % (self._alias, attrname)
+            self._omf_api.configure(self.node.get('hostname'), attrname, 
+                        attrval)
+        
+        super(OMFWifiInterface, self).do_provision()
+        return True
+
+    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
+
+        attrval = self.get("ip")
+        attrname = "net/%s/%s" % (self._alias, "ip")
+        self._omf_api.configure(self.node.get('hostname'), attrname, 
+                    attrval)
+
+        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
+        """
+        self.set('xmppSlice',self.node.get('xmppSlice'))
+        self.set('xmppHost',self.node.get('xmppHost'))
+        self.set('xmppPort',self.node.get('xmppPort'))
+        self.set('xmppPassword',self.node.get('xmppPassword'))
+
+        if not (self.get('xmppSlice') and self.get('xmppHost')
+              and self.get('xmppPort') and self.get('xmppPassword')):
             msg = "Credentials are not initialzed. XMPP Connections impossible"
             self.error(msg)
-            return
+            raise RuntimeError, msg
+
+        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.get('mode') and self.get('type') and self.get('essid') and self.get('ip')):
-            self._state = ResourceState.FAILED
+        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)
-            return False
+            raise RuntimeError, msg
 
         if not self.node.get('hostname') :
             msg = "The channel is connected with an undefined node"
             self.error(msg)
-            return False
+            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'))
+        self.info(" " + self.get_rtype() + " ( Guid : " + str(self._guid) +") : " + \
+                self.get('mode') + " : " + self.get('type') + " : " + \
+                self.get('essid') + " : " + self.get('ip') + " : " + str(self.state))
     
         # Check if the node is already deployed
-        if self.node.state < ResourceState.READY:
-            self.ec.schedule(reschedule_delay, self.deploy)
+        if self.state < ResourceState.PROVISIONED:
+            if self._conf == False:
+                self._conf = self.configure_iface()
+        res = False
+        if self._conf == True:
+            res = self.configure_ip()
+            
+        if not (res and self._conf):
             return
 
-        try :
-            for attrname in ["mode", "type", "essid", "ip"]:
-                attrval = self.get(attrname)
-                attrname = "net/%s/%s" % (self._alias, attrname)
-                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).deploy()
-
-    def start(self):
-        """Start the RM. It means nothing special for an interface for now
-           It becomes STARTED as soon as this method starts.
-
-        """
-
-        super(OMFWifiInterface, 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(OMFWifiInterface, self).stop()
+        super(OMFWifiInterface, self).do_deploy()
 
-    def release(self):
-        """Clean the RM at the end of the experiment and release the API
+    def do_release(self):
+        """ Clean the RM at the end of the experiment and release the API
 
         """
-        if self._omf_api :
+        if self._omf_api:
             OMFAPIFactory.release_api(self.get('xmppSlice'), 
-                self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'), exp_id = self.exp_id)
+                self.get('xmppHost'), self.get('xmppPort'), 
+                self.get('xmppPassword'), exp_id = self.exp_id)
 
-        super(OMFWifiInterface, self).release()
+        super(OMFWifiInterface, self).do_release()