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.all.collector — NEPI 3.2 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.2 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.2 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.all.collector</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>
85 <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="p">,</span> <span class="n">Types</span>
86 <span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">Trace</span><span class="p">,</span> <span class="n">TraceAttr</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><span class="p">,</span> <span class="n">ResourceAction</span>
89 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
91 <span class="kn">import</span> <span class="nn">os</span>
92 <span class="kn">import</span> <span class="nn">tempfile</span>
94 <span class="nd">@clsinit_copy</span>
95 <div class="viewcode-block" id="Collector"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector">[docs]</a><span class="k">class</span> <span class="nc">Collector</span><span class="p">(</span><span class="n">ResourceManager</span><span class="p">):</span>
96 <span class="sd">""" The collector entity is reponsible of collecting traces</span>
97 <span class="sd"> of a same type associated to RMs into a local directory.</span>
99 <span class="sd"> .. class:: Class Args :</span>
101 <span class="sd"> :param ec: The Experiment controller</span>
102 <span class="sd"> :type ec: ExperimentController</span>
103 <span class="sd"> :param guid: guid of the RM</span>
104 <span class="sd"> :type guid: int</span>
106 <span class="sd"> """</span>
107 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"Collector"</span>
108 <span class="n">_help</span> <span class="o">=</span> <span class="s">"A Collector can be attached to a trace name on another "</span> \
109 <span class="s">"ResourceManager and will retrieve and store the trace content "</span> \
110 <span class="s">"in a local file at the end of the experiment"</span>
111 <span class="n">_platform</span> <span class="o">=</span> <span class="s">"all"</span>
113 <span class="nd">@classmethod</span>
114 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
115 <span class="n">trace_name</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"traceName"</span><span class="p">,</span>
116 <span class="s">"Name of the trace to be collected"</span><span class="p">,</span>
117 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
119 <span class="n">sub_dir</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"subDir"</span><span class="p">,</span>
120 <span class="s">"Sub directory to collect traces into"</span><span class="p">,</span>
121 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
123 <span class="n">rename</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"rename"</span><span class="p">,</span>
124 <span class="s">"Name to give to the collected trace file"</span><span class="p">,</span>
125 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
127 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">trace_name</span><span class="p">)</span>
128 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">sub_dir</span><span class="p">)</span>
129 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">rename</span><span class="p">)</span>
131 <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>
132 <span class="nb">super</span><span class="p">(</span><span class="n">Collector</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>
133 <span class="bp">self</span><span class="o">.</span><span class="n">_store_path</span> <span class="o">=</span> <span class="bp">None</span>
135 <span class="nd">@property</span>
136 <div class="viewcode-block" id="Collector.store_path"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector.store_path">[docs]</a> <span class="k">def</span> <span class="nf">store_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
137 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_store_path</span>
139 <div class="viewcode-block" id="Collector.do_provision"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector.do_provision">[docs]</a> <span class="k">def</span> <span class="nf">do_provision</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
140 <span class="n">trace_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"traceName"</span><span class="p">)</span>
141 <span class="k">if</span> <span class="ow">not</span> <span class="n">trace_name</span><span class="p">:</span>
142 <span class="bp">self</span><span class="o">.</span><span class="n">fail</span><span class="p">()</span>
144 <span class="n">msg</span> <span class="o">=</span> <span class="s">"No traceName was specified"</span>
145 <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>
146 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
148 <span class="bp">self</span><span class="o">.</span><span class="n">_store_path</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">run_dir</span>
150 <span class="n">subdir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"subDir"</span><span class="p">)</span>
151 <span class="k">if</span> <span class="n">subdir</span><span class="p">:</span>
152 <span class="bp">self</span><span class="o">.</span><span class="n">_store_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">store_path</span><span class="p">,</span> <span class="n">subdir</span><span class="p">)</span>
154 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Creating local directory at </span><span class="si">%s</span><span class="s"> to store </span><span class="si">%s</span><span class="s"> traces "</span> <span class="o">%</span> <span class="p">(</span>
155 <span class="bp">self</span><span class="o">.</span><span class="n">store_path</span><span class="p">,</span> <span class="n">trace_name</span><span class="p">)</span>
156 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
158 <span class="k">try</span><span class="p">:</span>
159 <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">store_path</span><span class="p">)</span>
160 <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
161 <span class="k">pass</span>
163 <span class="nb">super</span><span class="p">(</span><span class="n">Collector</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
165 <div class="viewcode-block" id="Collector.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector.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>
166 <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
167 <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
169 <span class="nb">super</span><span class="p">(</span><span class="n">Collector</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>
171 <div class="viewcode-block" id="Collector.do_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector.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>
172 <span class="n">trace_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"traceName"</span><span class="p">)</span>
173 <span class="n">rename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"rename"</span><span class="p">)</span> <span class="ow">or</span> <span class="n">trace_name</span>
175 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Collecting '</span><span class="si">%s</span><span class="s">' traces to local directory </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span>
176 <span class="n">trace_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">store_path</span><span class="p">)</span>
177 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
179 <span class="n">rms</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">()</span>
180 <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
181 <span class="n">fpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">store_path</span><span class="p">,</span> <span class="s">"</span><span class="si">%d</span><span class="s">.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">rm</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span>
182 <span class="n">rename</span><span class="p">))</span>
184 <span class="k">try</span><span class="p">:</span>
185 <span class="n">result</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">trace</span><span class="p">(</span><span class="n">rm</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span> <span class="n">trace_name</span><span class="p">)</span>
186 <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fpath</span><span class="p">,</span> <span class="s">"w"</span><span class="p">)</span>
187 <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
188 <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
189 <span class="k">except</span><span class="p">:</span>
190 <span class="kn">import</span> <span class="nn">traceback</span>
191 <span class="n">err</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
192 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Couldn't retrieve trace </span><span class="si">%s</span><span class="s"> for </span><span class="si">%d</span><span class="s"> at </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span><span class="n">trace_name</span><span class="p">,</span>
193 <span class="n">rm</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span> <span class="n">fpath</span><span class="p">)</span>
194 <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="n">out</span> <span class="o">=</span> <span class="s">""</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">err</span><span class="p">)</span>
195 <span class="k">continue</span>
197 <span class="nb">super</span><span class="p">(</span><span class="n">Collector</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>
199 <div class="viewcode-block" id="Collector.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.all.html#nepi.resources.all.collector.Collector.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>
200 <span class="c"># TODO: Validate!</span>
201 <span class="k">return</span> <span class="bp">True</span>
202 </pre></div></div></div>
207 <div class="clearer"></div>
209 <div class="related">
212 <li class="right" style="margin-right: 10px">
213 <a href="../../../../genindex.html" title="General Index"
216 <a href="../../../../py-modindex.html" title="Python Module Index"
218 <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
219 <li><a href="../../../index.html" >Module code</a> »</li>
223 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
224 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.