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
22 from nepi.execution.attribute import Attribute, Flags
23 from nepi.resources.omf.omf_api import OMFAPIFactory
25 reschedule_delay = "0.5s"
28 class OMFApplication(ResourceManager):
30 .. class:: Class Args :
32 :param ec: The Experiment controller
33 :type ec: ExperimentController
34 :param guid: guid of the RM
36 :param creds: Credentials to communicate with the rm (XmppClient)
41 This class is used only by the Experiment Controller through the Resource Factory
44 _rtype = "OMFApplication"
45 _authorized_connections = ["OMFNode"]
48 def _register_attributes(cls):
49 """Register the attributes of an OMF application
52 appid = Attribute("appid", "Name of the application")
53 path = Attribute("path", "Path of the application")
54 args = Attribute("args", "Argument of the application")
55 env = Attribute("env", "Environnement variable of the application")
56 xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
57 xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
58 xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
59 xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
60 cls._register_attribute(appid)
61 cls._register_attribute(path)
62 cls._register_attribute(args)
63 cls._register_attribute(env)
64 cls._register_attribute(xmppSlice)
65 cls._register_attribute(xmppHost)
66 cls._register_attribute(xmppPort)
67 cls._register_attribute(xmppPassword)
70 def __init__(self, ec, guid):
72 :param ec: The Experiment controller
73 :type ec: ExperimentController
74 :param guid: guid of the RM
76 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
81 super(OMFApplication, self).__init__(ec, guid)
92 def valid_connection(self, guid):
93 """Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
95 :param guid: Guid of RM it will be connected
100 rm = self.ec.get_resource(guid)
101 if rm.rtype() not in self._authorized_connections:
102 msg = "Connection between %s %s and %s %s refused : An Application can be connected only to a Node" %\
103 (self.rtype(), self._guid, rm.rtype(), guid)
106 elif len(self.connections) != 0 :
107 msg = "Connection between %s %s and %s %s refused : This Application is already connected" % \
108 (self.rtype(), self._guid, rm.rtype(), guid)
112 msg = "Connection between %s %s and %s %s accepted" % (self.rtype(), self._guid, rm.rtype(), guid)
117 """Deploy the RM. It means nothing special for an application for now (later it will be upload sources, ...)
118 It becomes DEPLOYED after getting the xmpp client.
120 if not self._omf_api :
121 self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
122 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))
124 super(OMFApplication, self).deploy()
127 """Start the RM. It means : Send Xmpp Message Using OMF protocol to execute the application
128 It becomes STARTED before the messages are sent (for coordination)
131 super(OMFApplication, self).start()
132 if self.get('appid') and self.get('path') and self.get('args') and self.get('env') :
133 msg = " " + self.rtype() + " ( Guid : " + str(self._guid) +") : " + \
134 self.get('appid') + " : " + self.get('path') + " : " + \
135 self.get('args') + " : " + self.get('env')
137 rm_list = self.get_connected("OMFNode")
139 for rm_node in rm_list:
140 if rm_node.get('hostname') :
141 self._omf_api.execute(rm_node.get('hostname'),self.get('appid'), \
142 self.get('args'), self.get('path'), self.get('env'))
143 except AttributeError:
144 self._state = ResourceState.FAILED
145 msg = "Credentials are not initialzed. XMPP Connections impossible"
149 self._state = ResourceState.FAILED
150 msg = "Application's information are not initialized"
154 """Stop the RM. It means : Send Xmpp Message Using OMF protocol to kill the application
155 It becomes STOPPED after the message is sent.
159 rm_list = self.get_connected("OMFNode")
160 for rm_node in rm_list :
161 self._omf_api.exit(rm_node.get('hostname'),self.get('appid'))
162 except AttributeError:
163 self._state = ResourceState.FAILED
164 msg = "Credentials were not initialzed. XMPP Connections impossible"
167 super(OMFApplication, self).stop()
168 self._state = ResourceState.FINISHED
172 """Clean the RM at the end of the experiment and release the API.
176 OMFAPIFactory.release_api(self.get('xmppSlice'),
177 self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'))