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, ResourceState, \
23 from nepi.execution.attribute import Attribute, Flags
25 from nepi.resources.omf.node import OMFNode
26 from nepi.resources.omf.channel import OMFChannel
27 from nepi.resources.omf.omf_api import OMFAPIFactory
31 class OMFWifiInterface(ResourceManager):
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 Factory
47 _rtype = "OMFWifiInterface"
48 _authorized_connections = ["OMFNode" , "OMFChannel"]
50 #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
53 def _register_attributes(cls):
54 """Register the attributes of an OMF interface
57 alias = Attribute("alias","Alias of the interface", default = "w0")
58 mode = Attribute("mode","Mode of the interface")
59 type = Attribute("type","Type of the interface")
60 essid = Attribute("essid","Essid of the interface")
61 ip = Attribute("ip","IP of the interface")
62 xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
63 xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
64 xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
65 xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
66 cls._register_attribute(alias)
67 cls._register_attribute(xmppSlice)
68 cls._register_attribute(xmppHost)
69 cls._register_attribute(xmppPort)
70 cls._register_attribute(xmppPassword)
71 cls._register_attribute(mode)
72 cls._register_attribute(type)
73 cls._register_attribute(essid)
74 cls._register_attribute(ip)
76 def __init__(self, ec, guid):
78 :param ec: The Experiment controller
79 :type ec: ExperimentController
80 :param guid: guid of the RM
82 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
86 super(OMFWifiInterface, self).__init__(ec, guid)
89 self._alias = self.get('alias')
93 if self.ec.exp_id.startswith('exp-'):
97 def valid_connection(self, guid):
98 """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
100 :param guid: Guid of the current RM
105 rm = self.ec.get_resource(guid)
106 if rm.rtype() in self._authorized_connections:
107 msg = "Connection between %s %s and %s %s accepted" % \
108 (self.rtype(), self._guid, rm.rtype(), guid)
111 msg = "Connection between %s %s and %s %s refused" % \
112 (self.rtype(), self._guid, rm.rtype(), guid)
118 rm_list = self.get_connected(OMFNode.rtype())
119 if rm_list: return rm_list[0]
124 rm_list = self.get_connected(OMFChannel.rtype())
125 if rm_list: return rm_list[0]
129 def configure_iface(self):
130 """ Configure the interface without the ip
133 if self.node.state < ResourceState.READY:
134 self.ec.schedule(reschedule_delay, self.deploy)
138 for attrname in ["mode", "type", "essid"]:
139 attrval = self.get(attrname)
140 attrname = "net/%s/%s" % (self._alias, attrname)
141 self._omf_api.configure(self.node.get('hostname'), attrname, attrval)
142 except AttributeError:
143 self._state = ResourceState.FAILED
144 msg = "Credentials are not initialzed. XMPP Connections impossible"
148 super(OMFWifiInterface, self).provision()
151 def configure_ip(self):
152 """ Configure the ip of the interface
156 if self.channel.state < ResourceState.READY:
157 self.ec.schedule(reschedule_delay, self.deploy)
161 attrval = self.get("ip")
162 attrname = "net/%s/%s" % (self._alias, "ip")
163 self._omf_api.configure(self.node.get('hostname'), attrname, attrval)
164 except AttributeError:
165 self._state = ResourceState.FAILED
166 msg = "Credentials are not initialzed. XMPP Connections impossible"
174 """Deploy the RM. It means : Get the xmpp client and send messages using OMF 5.4 protocol to configure the interface
175 It becomes DEPLOYED after sending messages to configure the interface
177 if not self._omf_api :
178 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
179 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'), exp_id = self.exp_id)
181 if not self._omf_api :
182 self._state = ResourceState.FAILED
183 msg = "Credentials are not initialzed. XMPP Connections impossible"
187 if not (self.get('mode') and self.get('type') and self.get('essid') and self.get('ip')):
188 self._state = ResourceState.FAILED
189 msg = "Interface's variable are not initialized"
193 if not self.node.get('hostname') :
194 msg = "The channel is connected with an undefined node"
198 # Just for information
199 self.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " + \
200 self.get('mode') + " : " + self.get('type') + " : " + \
201 self.get('essid') + " : " + self.get('ip'))
203 # Check if the node is already deployed
205 if self.state < ResourceState.PROVISIONED:
206 chk1 = self.configure_iface()
208 chk2 = self.configure_ip()
210 if not (chk1 and chk2) :
213 super(OMFWifiInterface, self).deploy()
217 """Start the RM. It means nothing special for an interface for now
218 It becomes STARTED as soon as this method starts.
222 super(OMFWifiInterface, self).start()
225 """Stop the RM. It means nothing special for an interface for now
226 It becomes STOPPED as soon as this method stops
229 super(OMFWifiInterface, self).stop()
232 """Clean the RM at the end of the experiment and release the API
236 OMFAPIFactory.release_api(self.get('xmppSlice'),
237 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'), exp_id = self.exp_id)
239 super(OMFWifiInterface, self).release()