1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.omf.node — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../',
18 COLLAPSE_INDEX: false,
23 <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24 <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25 <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26 <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
27 <link rel="up" title="Module code" href="../../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
47 <form class="search" action="../../../../search.html" method="get">
48 <input type="text" name="q" />
49 <input type="submit" value="Go" />
50 <input type="hidden" name="check_keywords" value="yes" />
51 <input type="hidden" name="area" value="default" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.omf.node</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c"># NEPI, a framework to manage network experiments</span>
69 <span class="c"># Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c"># This program is free software: you can redistribute it and/or modify</span>
72 <span class="c"># it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c"># published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c"># This program is distributed in the hope that it will be useful,</span>
76 <span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
78 <span class="c"># GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c"># You should have received a copy of the GNU General Public License</span>
81 <span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
84 <span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
86 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
87 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
88 <span class="n">ResourceState</span>
89 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span>
90 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf_resource</span> <span class="kn">import</span> <span class="n">ResourceGateway</span><span class="p">,</span> <span class="n">OMFResource</span>
91 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf_api_factory</span> <span class="kn">import</span> <span class="n">OMFAPIFactory</span>
93 <span class="kn">import</span> <span class="nn">time</span>
95 <span class="n">reschedule_check</span> <span class="o">=</span> <span class="s">"1s"</span>
96 <span class="n">confirmation_counter</span> <span class="o">=</span> <span class="mi">3600</span>
98 <span class="nd">@clsinit_copy</span>
99 <div class="viewcode-block" id="OMFNode"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.node.OMFNode">[docs]</a><span class="k">class</span> <span class="nc">OMFNode</span><span class="p">(</span><span class="n">OMFResource</span><span class="p">):</span>
100 <span class="sd">"""</span>
101 <span class="sd"> .. class:: Class Args :</span>
102 <span class="sd"> </span>
103 <span class="sd"> :param ec: The Experiment controller</span>
104 <span class="sd"> :type ec: ExperimentController</span>
105 <span class="sd"> :param guid: guid of the RM</span>
106 <span class="sd"> :type guid: int</span>
107 <span class="sd"> :param creds: Credentials to communicate with the rm (XmppClient for OMF)</span>
108 <span class="sd"> :type creds: dict</span>
110 <span class="sd"> """</span>
111 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"omf::Node"</span>
112 <span class="n">_authorized_connections</span> <span class="o">=</span> <span class="p">[</span><span class="s">"omf::Application"</span> <span class="p">,</span> <span class="s">"omf::WifiInterface"</span><span class="p">]</span>
114 <span class="nd">@classmethod</span>
115 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
116 <span class="sd">"""Register the attributes of an OMF Node</span>
118 <span class="sd"> """</span>
119 <span class="n">hostname</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">,</span> <span class="s">"Hostname of the machine"</span><span class="p">)</span>
121 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
123 <span class="c"># XXX: We don't necessary need to have the credentials at the </span>
124 <span class="c"># moment we create the RM</span>
125 <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
126 <span class="sd">"""</span>
127 <span class="sd"> :param ec: The Experiment controller</span>
128 <span class="sd"> :type ec: ExperimentController</span>
129 <span class="sd"> :param guid: guid of the RM</span>
130 <span class="sd"> :type guid: int</span>
132 <span class="sd"> """</span>
133 <span class="nb">super</span><span class="p">(</span><span class="n">OMFNode</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
135 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span> <span class="o">=</span> <span class="bp">None</span>
137 <span class="c"># For performance tests</span>
138 <span class="bp">self</span><span class="o">.</span><span class="n">perf</span> <span class="o">=</span> <span class="bp">True</span>
139 <span class="bp">self</span><span class="o">.</span><span class="n">begin_deploy_time</span> <span class="o">=</span> <span class="bp">None</span>
142 <span class="nd">@property</span>
143 <div class="viewcode-block" id="OMFNode.exp_id"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.node.OMFNode.exp_id">[docs]</a> <span class="k">def</span> <span class="nf">exp_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
144 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">exp_id</span>
146 <div class="viewcode-block" id="OMFNode.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.node.OMFNode.valid_connection">[docs]</a> <span class="k">def</span> <span class="nf">valid_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
147 <span class="sd">""" Check if the connection with the guid in parameter is possible. </span>
148 <span class="sd"> Only meaningful connections are allowed.</span>
150 <span class="sd"> :param guid: Guid of the current RM</span>
151 <span class="sd"> :type guid: int</span>
152 <span class="sd"> :rtype: Boolean</span>
154 <span class="sd"> """</span>
155 <span class="n">rm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">get_resource</span><span class="p">(</span><span class="n">guid</span><span class="p">)</span>
156 <span class="k">if</span> <span class="n">rm</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorized_connections</span><span class="p">:</span>
157 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Connection between </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> and </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> accepted"</span> <span class="o">%</span> <span class="p">(</span>
158 <span class="bp">self</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_guid</span><span class="p">,</span> <span class="n">rm</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">(),</span> <span class="n">guid</span><span class="p">)</span>
159 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
160 <span class="k">return</span> <span class="bp">True</span>
162 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Connection between </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> and </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> refused"</span> <span class="o">%</span> <span class="p">(</span>
163 <span class="bp">self</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_guid</span><span class="p">,</span> <span class="n">rm</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">(),</span> <span class="n">guid</span><span class="p">)</span>
164 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
166 <span class="k">return</span> <span class="bp">False</span>
168 <div class="viewcode-block" id="OMFNode.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.node.OMFNode.do_deploy">[docs]</a> <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
169 <span class="sd">""" Deploy the RM. It means : Send Xmpp Message Using OMF protocol </span>
170 <span class="sd"> to enroll the node into the experiment.</span>
172 <span class="sd"> """</span>
173 <span class="c">## For performance test</span>
174 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">perf</span><span class="p">:</span>
175 <span class="bp">self</span><span class="o">.</span><span class="n">begin_deploy_time</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
176 <span class="bp">self</span><span class="o">.</span><span class="n">perf</span> <span class="o">=</span> <span class="bp">False</span>
178 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppServer'</span><span class="p">):</span>
179 <span class="n">msg</span> <span class="o">=</span> <span class="s">"XmppServer is not initialzed. XMPP Connections impossible"</span>
180 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
181 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
183 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'version'</span><span class="p">):</span>
184 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Version of OMF is not indicated"</span>
185 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
186 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
188 <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppUser'</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPort'</span><span class="p">)</span>
189 <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPassword'</span><span class="p">)):</span>
190 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Credentials are not all initialzed. Default values will be used"</span>
191 <span class="bp">self</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
193 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span> <span class="p">:</span>
194 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span> <span class="o">=</span> <span class="n">OMFAPIFactory</span><span class="o">.</span><span class="n">get_api</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'version'</span><span class="p">),</span>
195 <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppServer'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppUser'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPort'</span><span class="p">),</span>
196 <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPassword'</span><span class="p">),</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">exp_id</span><span class="p">)</span>
198 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'hostname'</span><span class="p">)</span> <span class="p">:</span>
199 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Hostname's value is not initialized"</span>
200 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
201 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
203 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'version'</span><span class="p">)</span> <span class="o">==</span> <span class="s">"5"</span><span class="p">:</span>
204 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="o">.</span><span class="n">enroll_host</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'hostname'</span><span class="p">))</span>
205 <span class="k">else</span><span class="p">:</span>
206 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="o">.</span><span class="n">enroll_topic</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'hostname'</span><span class="p">))</span>
208 <span class="nb">super</span><span class="p">(</span><span class="n">OMFNode</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_deploy</span><span class="p">()</span>
210 <div class="viewcode-block" id="OMFNode.do_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.node.OMFNode.do_release">[docs]</a> <span class="k">def</span> <span class="nf">do_release</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
211 <span class="sd">""" Clean the RM at the end of the experiment by unenrolling</span>
212 <span class="sd"> the node from the topic</span>
214 <span class="sd"> """</span>
215 <span class="kn">from</span> <span class="nn">nepi.resources.omf.application</span> <span class="kn">import</span> <span class="n">OMFApplication</span>
216 <span class="n">rm_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">OMFApplication</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
217 <span class="k">if</span> <span class="n">rm_list</span><span class="p">:</span>
218 <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rm_list</span><span class="p">:</span>
219 <span class="k">if</span> <span class="n">rm</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">RELEASED</span><span class="p">:</span>
220 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">release</span><span class="p">)</span>
221 <span class="k">return</span>
223 <span class="kn">from</span> <span class="nn">nepi.resources.omf.interface</span> <span class="kn">import</span> <span class="n">OMFWifiInterface</span>
224 <span class="n">rm_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">OMFWifiInterface</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
225 <span class="k">if</span> <span class="n">rm_list</span><span class="p">:</span>
226 <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rm_list</span><span class="p">:</span>
227 <span class="k">if</span> <span class="n">rm</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">RELEASED</span><span class="p">:</span>
228 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">release</span><span class="p">)</span>
229 <span class="k">return</span>
231 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="p">:</span>
232 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'version'</span><span class="p">)</span> <span class="o">==</span> <span class="s">"5"</span><span class="p">:</span>
233 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="o">.</span><span class="n">release</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'hostname'</span><span class="p">))</span>
234 <span class="k">else</span><span class="p">:</span>
235 <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="o">.</span><span class="n">unenroll_topic</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'hostname'</span><span class="p">))</span>
237 <span class="n">OMFAPIFactory</span><span class="o">.</span><span class="n">release_api</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'version'</span><span class="p">),</span>
238 <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppServer'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppUser'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPort'</span><span class="p">),</span>
239 <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'xmppPassword'</span><span class="p">),</span> <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">exp_id</span><span class="p">)</span>
241 <span class="nb">super</span><span class="p">(</span><span class="n">OMFNode</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_release</span><span class="p">()</span>
242 </pre></div></div></div>
247 <div class="clearer"></div>
249 <div class="related">
252 <li class="right" style="margin-right: 10px">
253 <a href="../../../../genindex.html" title="General Index"
256 <a href="../../../../py-modindex.html" title="Python Module Index"
258 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
259 <li><a href="../../../index.html" >Module code</a> »</li>
263 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
264 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.