2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
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.
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.
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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 # Julien Tribino <julien.tribino@inria.fr>
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
22 ResourceState, reschedule_delay
23 from nepi.execution.attribute import Attribute, Flags
25 from nepi.resources.omf.node import OMFNode
26 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
27 from nepi.resources.omf.channel import OMFChannel
28 from nepi.resources.omf.omf_api import OMFAPIFactory
31 class OMFWifiInterface(OMFResource):
33 .. class:: Class Args :
35 :param ec: The Experiment controller
36 :type ec: ExperimentController
37 :param guid: guid of the RM
39 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
44 This class is used only by the Experiment Controller through the Resource
48 _rtype = "OMFWifiInterface"
49 _authorized_connections = ["OMFNode" , "OMFChannel"]
51 #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
54 def _register_attributes(cls):
55 """Register the attributes of an OMF interface
58 alias = Attribute("alias","Alias of the interface", default = "w0")
59 mode = Attribute("mode","Mode of the interface")
60 type = Attribute("type","Type of the interface")
61 essid = Attribute("essid","Essid of the interface")
62 ip = Attribute("ip","IP of the interface")
63 cls._register_attribute(alias)
64 cls._register_attribute(mode)
65 cls._register_attribute(type)
66 cls._register_attribute(essid)
67 cls._register_attribute(ip)
69 def __init__(self, ec, guid):
71 :param ec: The Experiment controller
72 :type ec: ExperimentController
73 :param guid: guid of the RM
75 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
79 super(OMFWifiInterface, self).__init__(ec, guid)
84 self._alias = self.get('alias')
86 def valid_connection(self, guid):
87 """ Check if the connection with the guid in parameter is possible.
88 Only meaningful connections are allowed.
90 :param guid: Guid of the current RM
95 rm = self.ec.get_resource(guid)
96 if rm.get_rtype() in self._authorized_connections:
97 msg = "Connection between %s %s and %s %s accepted" % \
98 (self.get_rtype(), self._guid, rm.get_rtype(), guid)
103 msg = "Connection between %s %s and %s %s refused" % \
104 (self.get_rtype(), self._guid, rm.get_rtype(), guid)
111 return self.ec.exp_id
115 rm_list = self.get_connected(OMFNode.get_rtype())
116 if rm_list: return rm_list[0]
121 rm_list = self.get_connected(OMFChannel.get_rtype())
122 if rm_list: return rm_list[0]
125 def configure_iface(self):
126 """ Configure the interface without the ip
129 if self.node.state < ResourceState.READY:
130 self.ec.schedule(reschedule_delay, self.deploy)
133 for attrname in ["mode", "type", "essid"]:
134 attrval = self.get(attrname)
135 attrname = "net/%s/%s" % (self._alias, attrname)
136 self._omf_api.configure(self.node.get('hostname'), attrname,
139 super(OMFWifiInterface, self).do_provision()
142 def configure_ip(self):
143 """ Configure the ip of the interface
146 if self.channel.state < ResourceState.READY:
147 self.ec.schedule(reschedule_delay, self.deploy)
150 attrval = self.get("ip")
151 attrname = "net/%s/%s" % (self._alias, "ip")
152 self._omf_api.configure(self.node.get('hostname'), attrname,
158 """ Deploy the RM. It means : Get the xmpp client and send messages
159 using OMF 5.4 protocol to configure the interface.
160 It becomes DEPLOYED after sending messages to configure the interface
162 self.set('xmppSlice',self.node.get('xmppSlice'))
163 self.set('xmppHost',self.node.get('xmppHost'))
164 self.set('xmppPort',self.node.get('xmppPort'))
165 self.set('xmppPassword',self.node.get('xmppPassword'))
167 if not (self.get('xmppSlice') and self.get('xmppHost')
168 and self.get('xmppPort') and self.get('xmppPassword')):
169 msg = "Credentials are not initialzed. XMPP Connections impossible"
171 raise RuntimeError, msg
173 if not self._omf_api :
174 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
175 self.get('xmppHost'), self.get('xmppPort'),
176 self.get('xmppPassword'), exp_id = self.exp_id)
178 if not (self.get('mode') and self.get('type') and self.get('essid') \
180 msg = "Interface's variable are not initialized"
182 raise RuntimeError, msg
184 if not self.node.get('hostname') :
185 msg = "The channel is connected with an undefined node"
187 raise RuntimeError, msg
189 # Just for information
190 self.debug(" " + self.get_rtype() + " ( Guid : " + str(self._guid) +") : " + \
191 self.get('mode') + " : " + self.get('type') + " : " + \
192 self.get('essid') + " : " + self.get('ip'))
194 # Check if the node is already deployed
195 if self.state < ResourceState.PROVISIONED:
196 if self._conf == False:
197 self._conf = self.configure_iface()
198 if self._conf == True:
201 super(OMFWifiInterface, self).do_deploy()
203 def do_release(self):
204 """ Clean the RM at the end of the experiment and release the API
208 OMFAPIFactory.release_api(self.get('xmppSlice'),
209 self.get('xmppHost'), self.get('xmppPort'),
210 self.get('xmppPassword'), exp_id = self.exp_id)
212 super(OMFWifiInterface, self).do_release()