src/nepi/resources/omf/channel.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19 #         Julien Tribino <julien.tribino@inria.fr>
  20
  21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  22         ResourceState, reschedule_delay
  23 from nepi.execution.attribute import Attribute, Flags
  24
  25 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
  26 from nepi.resources.omf.omf_api import OMFAPIFactory
  27
  28
  29 @clsinit_copy
  30 class OMFChannel(OMFResource):
  31     """
  32     .. class:: Class Args :
  33
  34         :param ec: The Experiment controller
  35         :type ec: ExperimentController
  36         :param guid: guid of the RM
  37         :type guid: int
  38         :param creds: Credentials to communicate with the rm (XmppClient for OMF)
  39         :type creds: dict
  40
  41     """
  42     _rtype = "OMFChannel"
  43     _authorized_connections = ["OMFWifiInterface", "OMFNode"]
  44
  45     @classmethod
  46     def _register_attributes(cls):
  47         """Register the attributes of an OMF channel
  48
  49         """
  50         channel = Attribute("channel", "Name of the application")
  51         cls._register_attribute(channel)
  52
  53     def __init__(self, ec, guid):
  54         """
  55         :param ec: The Experiment controller
  56         :type ec: ExperimentController
  57         :param guid: guid of the RM
  58         :type guid: int
  59
  60         """
  61         super(OMFChannel, self).__init__(ec, guid)
  62
  63         self._nodes_guid = list()
  64
  65         self._omf_api = None
  66
  67     @property
  68     def exp_id(self):
  69         return self.ec.exp_id
  70
  71     def valid_connection(self, guid):
  72         """ Check if the connection with the guid in parameter is possible.
  73         Only meaningful connections are allowed.
  74
  75         :param guid: Guid of the current RM
  76         :type guid: int
  77         :rtype:  Boolean
  78
  79         """
  80         rm = self.ec.get_resource(guid)
  81
  82         if rm.get_rtype() in self._authorized_connections:
  83             msg = "Connection between %s %s and %s %s accepted" % (
  84                     self.get_rtype(), self._guid, rm.get_rtype(), guid)
  85             self.debug(msg)
  86             return True
  87
  88         msg = "Connection between %s %s and %s %s refused" % (
  89                 self.get_rtype(), self._guid, rm.get_rtype(), guid)
  90         self.debug(msg)
  91
  92         return False
  93
  94     def _get_target(self, conn_set):
  95         """
  96         Get the couples (host, interface) that uses this channel
  97
  98         :param conn_set: Connections of the current Guid
  99         :type conn_set: set
 100         :rtype: list
 101         :return: self._nodes_guid
 102
 103         """
 104         res = []
 105         for elt in conn_set:
 106             rm_iface = self.ec.get_resource(elt)
 107             for conn in rm_iface.connections:
 108                 rm_node = self.ec.get_resource(conn)
 109                 if rm_node.get_rtype() == "OMFNode" and rm_node.get('hostname'):
 110                     if rm_iface.state < ResourceState.PROVISIONED or \
 111                             rm_node.state < ResourceState.READY:
 112                         return "reschedule"
 113                     couple = [rm_node.get('hostname'), rm_iface.get('alias')]
 114                     #print couple
 115                     res.append(couple)
 116         return res
 117
 118     def do_deploy(self):
 119         """ Deploy the RM. It means : Get the xmpp client and send messages
 120         using OMF 5.4 protocol to configure the channel.
 121         It becomes DEPLOYED after sending messages to configure the channel
 122
 123         """
 124         if not (self.get('xmppSlice') and self.get('xmppHost')
 125               and self.get('xmppPort') and self.get('xmppPassword')):
 126             msg = "Credentials are not initialzed. XMPP Connections impossible"
 127             self.error(msg)
 128             raise RuntimeError, msg
 129
 130         if not self._omf_api :
 131             self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
 132                 self.get('xmppHost'), self.get('xmppPort'),
 133                 self.get('xmppPassword'), exp_id = self.exp_id)
 134
 135         if not self.get('channel'):
 136             msg = "Channel's value is not initialized"
 137             self.error(msg)
 138             raise RuntimeError, msg
 139
 140         self._nodes_guid = self._get_target(self._connections)
 141
 142         if self._nodes_guid == "reschedule" :
 143             self.ec.schedule("2s", self.deploy)
 144         else:
 145             for couple in self._nodes_guid:
 146                 attrval = self.get('channel')
 147                 attrname = "net/%s/%s" % (couple[1], 'channel')
 148                 self._omf_api.configure(couple[0], attrname, attrval)
 149
 150             super(OMFChannel, self).do_deploy()
 151
 152     def do_release(self):
 153         """ Clean the RM at the end of the experiment and release the API
 154
 155         """
 156         if self._omf_api :
 157             OMFAPIFactory.release_api(self.get('xmppSlice'),
 158                 self.get('xmppHost'), self.get('xmppPort'),
 159                 self.get('xmppPassword'), exp_id = self.exp_id)
 160
 161         super(OMFChannel, self).do_release()
 162