--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.resources.omf.node — NEPI 3.2 documentation</title>
+
+ <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '3.2',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.2 documentation" href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.resources.omf.node</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+<span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
+
+<span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
+<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> \
+ <span class="n">ResourceState</span>
+<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>
+<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>
+<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>
+
+<span class="kn">import</span> <span class="nn">time</span>
+
+<span class="n">reschedule_check</span> <span class="o">=</span> <span class="s">"1s"</span>
+<span class="n">confirmation_counter</span> <span class="o">=</span> <span class="mi">3600</span>
+
+<span class="nd">@clsinit_copy</span>
+<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>
+ <span class="sd">"""</span>
+<span class="sd"> .. class:: Class Args :</span>
+<span class="sd"> </span>
+<span class="sd"> :param ec: The Experiment controller</span>
+<span class="sd"> :type ec: ExperimentController</span>
+<span class="sd"> :param guid: guid of the RM</span>
+<span class="sd"> :type guid: int</span>
+<span class="sd"> :param creds: Credentials to communicate with the rm (XmppClient for OMF)</span>
+<span class="sd"> :type creds: dict</span>
+
+<span class="sd"> """</span>
+ <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"omf::Node"</span>
+ <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>
+
+ <span class="nd">@classmethod</span>
+ <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+ <span class="sd">"""Register the attributes of an OMF Node</span>
+
+<span class="sd"> """</span>
+ <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>
+
+ <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>
+
+ <span class="c"># XXX: We don't necessary need to have the credentials at the </span>
+ <span class="c"># moment we create the RM</span>
+ <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>
+ <span class="sd">"""</span>
+<span class="sd"> :param ec: The Experiment controller</span>
+<span class="sd"> :type ec: ExperimentController</span>
+<span class="sd"> :param guid: guid of the RM</span>
+<span class="sd"> :type guid: int</span>
+
+<span class="sd"> """</span>
+ <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>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># For performance tests</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">perf</span> <span class="o">=</span> <span class="bp">True</span>
+ <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>
+
+
+ <span class="nd">@property</span>
+<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>
+ <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>
+</div>
+<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>
+ <span class="sd">""" Check if the connection with the guid in parameter is possible. </span>
+<span class="sd"> Only meaningful connections are allowed.</span>
+
+<span class="sd"> :param guid: Guid of the current RM</span>
+<span class="sd"> :type guid: int</span>
+<span class="sd"> :rtype: Boolean</span>
+
+<span class="sd"> """</span>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <span class="k">return</span> <span class="bp">True</span>
+
+ <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>
+ <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>
+ <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>
+
+ <span class="k">return</span> <span class="bp">False</span>
+</div>
+<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>
+ <span class="sd">""" Deploy the RM. It means : Send Xmpp Message Using OMF protocol </span>
+<span class="sd"> to enroll the node into the experiment.</span>
+
+<span class="sd"> """</span>
+ <span class="c">## For performance test</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">perf</span><span class="p">:</span>
+ <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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">perf</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <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>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"XmppServer is not initialzed. XMPP Connections impossible"</span>
+ <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>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+
+ <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>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Version of OMF is not indicated"</span>
+ <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>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+
+ <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>
+ <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>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Credentials are not all initialzed. Default values will be used"</span>
+ <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>
+
+ <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>
+ <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>
+ <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>
+ <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>
+
+ <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>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Hostname's value is not initialized"</span>
+ <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>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+
+ <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>
+ <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>
+ <span class="k">else</span><span class="p">:</span>
+ <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>
+
+ <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>
+</div>
+<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>
+ <span class="sd">""" Clean the RM at the end of the experiment by unenrolling</span>
+<span class="sd"> the node from the topic</span>
+
+<span class="sd"> """</span>
+ <span class="kn">from</span> <span class="nn">nepi.resources.omf.application</span> <span class="kn">import</span> <span class="n">OMFApplication</span>
+ <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>
+ <span class="k">if</span> <span class="n">rm_list</span><span class="p">:</span>
+ <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>
+ <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>
+ <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>
+ <span class="k">return</span>
+
+ <span class="kn">from</span> <span class="nn">nepi.resources.omf.interface</span> <span class="kn">import</span> <span class="n">OMFWifiInterface</span>
+ <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>
+ <span class="k">if</span> <span class="n">rm_list</span><span class="p">:</span>
+ <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>
+ <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>
+ <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>
+ <span class="k">return</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_omf_api</span><span class="p">:</span>
+ <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>
+ <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>
+ <span class="k">else</span><span class="p">:</span>
+ <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>
+
+ <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>
+ <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>
+ <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>
+
+ <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>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff