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
24 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
25 from nepi.resources.omf.omf_api import OMFAPIFactory
30 class OMFNode(OMFResource):
32 .. class:: Class Args :
34 :param ec: The Experiment controller
35 :type ec: ExperimentController
36 :param guid: guid of the RM
38 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
43 This class is used only by the Experiment Controller through the Resource Factory
47 _authorized_connections = ["OMFApplication" , "OMFWifiInterface"]
50 def _register_attributes(cls):
51 """Register the attributes of an OMF Node
54 hostname = Attribute("hostname", "Hostname of the machine")
56 cls._register_attribute(hostname)
58 # XXX: We don't necessary need to have the credentials at the
59 # moment we create the RM
60 def __init__(self, ec, guid):
62 :param ec: The Experiment controller
63 :type ec: ExperimentController
64 :param guid: guid of the RM
68 super(OMFNode, self).__init__(ec, guid)
76 def valid_connection(self, guid):
77 """ Check if the connection with the guid in parameter is possible.
78 Only meaningful connections are allowed.
80 :param guid: Guid of the current RM
85 rm = self.ec.get_resource(guid)
86 if rm.rtype() in self._authorized_connections:
87 msg = "Connection between %s %s and %s %s accepted" % (
88 self.rtype(), self._guid, rm.rtype(), guid)
93 msg = "Connection between %s %s and %s %s refused" % (
94 self.rtype(), self._guid, rm.rtype(), guid)
100 """ Deploy the RM. It means : Send Xmpp Message Using OMF protocol
101 to enroll the node into the experiment.
102 It becomes DEPLOYED after sending messages to enroll the node
105 if not (self.get('xmppSlice') and self.get('xmppHost')
106 and self.get('xmppPort') and self.get('xmppPassword')):
107 msg = "Credentials are not initialzed. XMPP Connections impossible"
109 raise RuntimeError, msg
111 if not self._omf_api :
112 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
113 self.get('xmppHost'), self.get('xmppPort'),
114 self.get('xmppPassword'), exp_id = self.exp_id)
116 if not self.get('hostname') :
117 msg = "Hostname's value is not initialized"
119 raise RuntimeError, msg
121 self._omf_api.enroll_host(self.get('hostname'))
123 super(OMFNode, self).do_deploy()
125 def do_release(self):
126 """ Clean the RM at the end of the experiment
130 self._omf_api.release(self.get('hostname'))
132 OMFAPIFactory.release_api(self.get('xmppSlice'),
133 self.get('xmppHost'), self.get('xmppPort'),
134 self.get('xmppPassword'), exp_id = self.exp_id)
136 super(OMFNode, self).do_release()