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.netns.netnswrapper_debug — 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.netns.netnswrapper_debug</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>
86 <span class="c">############ METHODS DEBUG NETNSWRAPPER EXECUTION</span>
87 <span class="c">##</span>
88 <span class="c">## The netnswrapper works in ditributed mode, receiving instructions from</span>
89 <span class="c">## a remote client. This makes it very hard to debug scripting errors </span>
90 <span class="c">## in the client side. To simplify error debugging, when set to debug mode,</span>
91 <span class="c">## the ns3wrapper dumps every executed line to a script that can be then</span>
92 <span class="c">## executed locally to reproduce and debug the experiment.</span>
93 <span class="c">##</span>
94 <span class="c">###########################################################################</span>
96 <span class="kn">import</span> <span class="nn">logging</span>
98 <div class="viewcode-block" id="NetNSWrapperDebuger"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger">[docs]</a><span class="k">class</span> <span class="nc">NetNSWrapperDebuger</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
99 <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">enabled</span><span class="p">):</span>
100 <span class="nb">super</span><span class="p">(</span><span class="n">NetNSWrapperDebuger</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>
101 <span class="bp">self</span><span class="o">.</span><span class="n">_enabled</span> <span class="o">=</span> <span class="n">enabled</span>
102 <span class="bp">self</span><span class="o">.</span><span class="n">_script_path</span> <span class="o">=</span> <span class="s">"debug.py"</span>
104 <span class="bp">self</span><span class="o">.</span><span class="n">dump_header</span><span class="p">()</span>
106 <span class="nd">@property</span>
107 <div class="viewcode-block" id="NetNSWrapperDebuger.enabled"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.enabled">[docs]</a> <span class="k">def</span> <span class="nf">enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
108 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_enabled</span>
110 <span class="nd">@property</span>
111 <div class="viewcode-block" id="NetNSWrapperDebuger.script_path"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.script_path">[docs]</a> <span class="k">def</span> <span class="nf">script_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
112 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_script_path</span>
114 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_to_script"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_to_script">[docs]</a> <span class="k">def</span> <span class="nf">dump_to_script</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
115 <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">script_path</span><span class="p">,</span> <span class="s">"a"</span><span class="p">)</span>
116 <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
117 <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
119 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_header"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_header">[docs]</a> <span class="k">def</span> <span class="nf">dump_header</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
120 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
121 <span class="k">return</span>
123 <span class="n">header</span> <span class="o">=</span> <span class="s">"""</span>
124 <span class="s">from netnswrapper import NetNSWrapper</span>
126 <span class="s">wrapper = NS3Wrapper()</span>
128 <span class="s">"""</span>
129 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
131 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_factory"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_factory">[docs]</a> <span class="k">def</span> <span class="nf">dump_factory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">type_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
132 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
133 <span class="k">return</span>
135 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"kwargs = </span><span class="si">%(kwargs)s</span><span class="se">\n</span><span class="s">"</span>
136 <span class="s">"</span><span class="si">%(uuid)s</span><span class="s"> = wrapper.factory(</span><span class="si">%(type_name)s</span><span class="s">, **kwargs)</span><span class="se">\n\n</span><span class="s">"</span>
137 <span class="p">)</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">({</span>
138 <span class="s">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
139 <span class="s">"type_name"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">type_name</span><span class="p">),</span>
140 <span class="s">"kwargs"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_kwargs</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
141 <span class="p">})</span>
143 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
145 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_create"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_create">[docs]</a> <span class="k">def</span> <span class="nf">dump_create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
146 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
147 <span class="k">return</span>
149 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"args = </span><span class="si">%(args)s</span><span class="se">\n</span><span class="s">"</span>
150 <span class="s">"</span><span class="si">%(uuid)s</span><span class="s"> = wrapper.create(</span><span class="si">%(clazzname)s</span><span class="s">, *args)</span><span class="se">\n\n</span><span class="s">"</span>
151 <span class="p">)</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">({</span>
152 <span class="s">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
153 <span class="s">"clazzname"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">clazzname</span><span class="p">),</span>
154 <span class="s">"args"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_args</span><span class="p">(</span><span class="n">args</span><span class="p">),</span>
155 <span class="p">})</span>
157 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
159 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_invoke"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_invoke">[docs]</a> <span class="k">def</span> <span class="nf">dump_invoke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">newuuid</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
160 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
161 <span class="k">return</span>
163 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"args = </span><span class="si">%(args)s</span><span class="se">\n</span><span class="s">"</span>
164 <span class="s">"kwargs = </span><span class="si">%(kwargs)s</span><span class="se">\n</span><span class="s">"</span>
165 <span class="s">"</span><span class="si">%(newuuid)s</span><span class="s"> = wrapper.invoke(</span><span class="si">%(uuid)s</span><span class="s">, </span><span class="si">%(operation)s</span><span class="s">, *args, **kwargs)</span><span class="se">\n\n</span><span class="s">"</span>
166 <span class="p">)</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">({</span>
167 <span class="s">"newuuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">newuuid</span><span class="p">)</span> <span class="k">if</span> <span class="n">newuuid</span> <span class="k">else</span> <span class="s">"nothing"</span><span class="p">,</span>
168 <span class="s">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
169 <span class="s">"operation"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">operation</span><span class="p">),</span>
170 <span class="s">"args"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_args</span><span class="p">(</span><span class="n">args</span><span class="p">),</span>
171 <span class="s">"kwargs"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_kwargs</span><span class="p">(</span><span class="n">kwargs</span><span class="p">),</span>
172 <span class="p">})</span>
174 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
176 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_set"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_set">[docs]</a> <span class="k">def</span> <span class="nf">dump_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
177 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
178 <span class="k">return</span>
180 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"wrapper.set(</span><span class="si">%(uuid)s</span><span class="s">, </span><span class="si">%(name)s</span><span class="s">, </span><span class="si">%(value)s</span><span class="s">)</span><span class="se">\n\n</span><span class="s">"</span>
181 <span class="p">)</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">({</span>
182 <span class="s">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
183 <span class="s">"name"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">name</span><span class="p">),</span>
184 <span class="s">"value"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">value</span><span class="p">),</span>
185 <span class="p">})</span>
187 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
189 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_get"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_get">[docs]</a> <span class="k">def</span> <span class="nf">dump_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
190 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
191 <span class="k">return</span>
193 <span class="n">command</span> <span class="o">=</span> <span class="p">(</span><span class="s">"wrapper.get(</span><span class="si">%(uuid)s</span><span class="s">, </span><span class="si">%(name)s</span><span class="s">)</span><span class="se">\n\n</span><span class="s">"</span>
194 <span class="p">)</span> <span class="o">%</span> <span class="nb">dict</span><span class="p">({</span>
195 <span class="s">"uuid"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
196 <span class="s">"name"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">name</span><span class="p">),</span>
197 <span class="p">})</span>
199 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
201 <div class="viewcode-block" id="NetNSWrapperDebuger.dump_shutdown"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.dump_shutdown">[docs]</a> <span class="k">def</span> <span class="nf">dump_shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
202 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span><span class="p">:</span>
203 <span class="k">return</span>
205 <span class="n">command</span> <span class="o">=</span> <span class="s">"wrapper.shutdown()</span><span class="se">\n\n</span><span class="s">"</span>
206 <span class="bp">self</span><span class="o">.</span><span class="n">dump_to_script</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
208 <div class="viewcode-block" id="NetNSWrapperDebuger.format_value"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.format_value">[docs]</a> <span class="k">def</span> <span class="nf">format_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
209 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"uuid"</span><span class="p">):</span>
210 <span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">"-"</span><span class="p">,</span> <span class="s">""</span><span class="p">)</span>
212 <span class="kn">import</span> <span class="nn">pprint</span>
213 <span class="k">return</span> <span class="n">pprint</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
215 <div class="viewcode-block" id="NetNSWrapperDebuger.format_args"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.format_args">[docs]</a> <span class="k">def</span> <span class="nf">format_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
216 <span class="n">fargs</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
217 <span class="k">return</span> <span class="s">"[</span><span class="si">%s</span><span class="s">]"</span> <span class="o">%</span> <span class="s">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fargs</span><span class="p">)</span>
219 <div class="viewcode-block" id="NetNSWrapperDebuger.format_kwargs"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnswrapper_debug.NetNSWrapperDebuger.format_kwargs">[docs]</a> <span class="k">def</span> <span class="nf">format_kwargs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
220 <span class="n">fkwargs</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">w</span><span class="p">):</span>
221 <span class="s">"</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_value</span><span class="p">(</span><span class="n">w</span><span class="p">)),</span>
222 <span class="n">kwargs</span><span class="o">.</span><span class="n">iteritems</span><span class="p">())</span>
224 <span class="k">return</span> <span class="s">"dict({</span><span class="si">%s</span><span class="s">})"</span> <span class="o">%</span> <span class="s">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fkwargs</span><span class="p">)</span>
231 <div class="clearer"></div>
233 <div class="related">
236 <li class="right" style="margin-right: 10px">
237 <a href="../../../../genindex.html" title="General Index"
240 <a href="../../../../py-modindex.html" title="Python Module Index"
242 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
243 <li><a href="../../../index.html" >Module code</a> »</li>
247 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
248 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.