applied the except and raise fixers to the master branch to close the gap with py3
[nepi.git] / src / nepi / resources / omf / channel.py
index b51cd89..bac1119 100644 (file)
@@ -3,9 +3,8 @@
 #    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.
+#    it under the terms of the GNU General Public License version 2 as
+#    published by the Free Software Foundation;
 #
 #    This program is distributed in the hope that it will be useful,
 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
 # 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.util.timefuncs import tnow
+from nepi.execution.resource import ResourceManager, clsinit_copy, \
+        ResourceState
 from nepi.execution.attribute import Attribute, Flags 
 
-from nepi.resources.omf.omf_api import OMFAPIFactory
+from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
+from nepi.resources.omf.omf_api_factory import OMFAPIFactory
 
 
-@clsinit
-class OMFChannel(ResourceManager):
+@clsinit_copy
+class OMFChannel(OMFResource):
     """
     .. class:: Class Args :
       
@@ -37,13 +38,25 @@ class OMFChannel(ResourceManager):
         :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 = "OMFChannel"
-    _authorized_connections = ["OMFWifiInterface", "OMFNode"]
+    _rtype = "omf::Channel"
+    _authorized_connections = ["omf::WifiInterface", "omf::Node"]
+
+    ChannelToFreq = dict({
+             "1" : "2412",
+             "2" : "2417",
+             "3" : "2422",
+             "4" : "2427",
+             "5" : "2432",
+             "6" : "2437",
+             "7" : "2442",
+             "8" : "2447",
+             "9" : "2452",
+             "10" : "2457",
+             "11" : "2462",
+             "12" : "2467",
+             "13" : "2472",
+    })
 
     @classmethod
     def _register_attributes(cls):
@@ -51,15 +64,7 @@ class OMFChannel(ResourceManager):
         
         """
         channel = Attribute("channel", "Name of the application")
-        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(channel)
-        cls._register_attribute(xmppSlice)
-        cls._register_attribute(xmppHost)
-        cls._register_attribute(xmppPort)
-        cls._register_attribute(xmppPassword)
 
     def __init__(self, ec, guid):
         """
@@ -67,20 +72,22 @@ class OMFChannel(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(OMFChannel, self).__init__(ec, guid)
 
         self._nodes_guid = list()
+        self.frequency = None
 
         self._omf_api = None
 
+        # For performance tests
+        self.perf = True
+        self.begin_deploy_time = None
+
+
     @property
     def exp_id(self):
-        if self.ec.exp_id.startswith('exp-'):
-            return None
         return self.ec.exp_id
 
     def valid_connection(self, guid):
@@ -93,17 +100,14 @@ class OMFChannel(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
 
     def _get_target(self, conn_set):
@@ -121,92 +125,76 @@ class OMFChannel(ResourceManager):
             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" and rm_node.get('hostname'):
+                if rm_node.get_rtype() == "omf::Node" 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
+                    couple = [rm_node.get('hostname'), rm_iface.alias]
                     res.append(couple)
         return res
 
-    def discover(self):
-        """ Discover the availables channels
-
-        """
-        pass
-     
-    def provision(self):
-        """ Provision some availables channels
+    def get_frequency(self, channel):
+        """ Returns the frequency of a specific channel number
 
-        """
-        pass
+        """           
+        return OMFChannel.ChannelToFreq[channel]
 
-    def deploy(self):
+    def do_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
+        using OMF 5.4 or 6 protocol 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
+      ## For performance test
+        if self.perf:
+            self.begin_deploy_time = tnow()
+            self.perf = False
 
         if not self.get('channel'):
             msg = "Channel's value is not initialized"
             self.error(msg)
-            self.fail()
-            raise
+            raise RuntimeError(msg)
 
-        self._nodes_guid = self._get_target(self._connections) 
-        if self._nodes_guid == "reschedule" :
-            self.ec.schedule("2s", self.deploy)
-            return False
+        if self.get('version') == "6":
+            self.frequency = self.get_frequency(self.get('channel'))
+            super(OMFChannel, self).do_deploy()
+            return
 
-        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"
+        if not self.get('xmppServer'):
+            msg = "XmppServer is not initialzed. XMPP Connections impossible"
             self.error(msg)
-            self.fail()
-            raise
-
-        super(OMFChannel, self).deploy()
+            raise RuntimeError(msg)
 
-    def start(self):
-        """ Start the RM. It means nothing special for a channel for now
-        It becomes STARTED as soon as this method starts.
+        if not (self.get('xmppUser') or self.get('xmppPort') 
+                   or self.get('xmppPassword')):
+            msg = "Credentials are not all initialzed. Default values will be used"
+            self.warn(msg)
 
-        """
+        if not self._omf_api :
+            self._omf_api = OMFAPIFactory.get_api(self.get('version'), 
+              self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+               self.get('xmppPassword'), exp_id = self.exp_id)
 
-        super(OMFChannel, self).start()
+        self._nodes_guid = self._get_target(self._connections)
 
-    def stop(self):
-        """ Stop the RM. It means nothing special for a channel for now
-        It becomes STOPPED as soon as this method is called
+        if self._nodes_guid == "reschedule" :
+            self.ec.schedule("1s", self.deploy)
+        else:
+            for couple in self._nodes_guid:
+                attrval = self.get('channel')
+                attrname = "net/%s/%s" % (couple[1], 'channel')
+                self._omf_api.configure(couple[0], attrname, attrval)
 
-        """
-        super(OMFChannel, self).stop()
+        super(OMFChannel, self).do_deploy()
 
-    def release(self):
+    def do_release(self):
         """ Clean the RM at the end of the experiment and release the 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)
+            OMFAPIFactory.release_api(self.get('version'), 
+              self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+               self.get('xmppPassword'), exp_id = self.exp_id)
 
-        super(OMFChannel, self).release()
+        super(OMFChannel, self).do_release()