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.linux.node — 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.linux.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>
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.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> \
87 <span class="n">ResourceState</span>
88 <span class="kn">from</span> <span class="nn">nepi.resources.linux</span> <span class="kn">import</span> <span class="n">rpmfuncs</span><span class="p">,</span> <span class="n">debfuncs</span>
89 <span class="kn">from</span> <span class="nn">nepi.util</span> <span class="kn">import</span> <span class="n">sshfuncs</span><span class="p">,</span> <span class="n">execfuncs</span>
90 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
92 <span class="kn">import</span> <span class="nn">collections</span>
93 <span class="kn">import</span> <span class="nn">os</span>
94 <span class="kn">import</span> <span class="nn">random</span>
95 <span class="kn">import</span> <span class="nn">re</span>
96 <span class="kn">import</span> <span class="nn">tempfile</span>
97 <span class="kn">import</span> <span class="nn">time</span>
98 <span class="kn">import</span> <span class="nn">threading</span>
99 <span class="kn">import</span> <span class="nn">traceback</span>
101 <span class="c"># TODO: Unify delays!!</span>
102 <span class="c"># TODO: Validate outcome of uploads!! </span>
104 <div class="viewcode-block" id="ExitCode"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.ExitCode">[docs]</a><span class="k">class</span> <span class="nc">ExitCode</span><span class="p">:</span>
105 <span class="sd">"""</span>
106 <span class="sd"> Error codes that the rexitcode function can return if unable to</span>
107 <span class="sd"> check the exit code of a spawned process</span>
108 <span class="sd"> """</span>
109 <span class="n">FILENOTFOUND</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
110 <span class="n">CORRUPTFILE</span> <span class="o">=</span> <span class="o">-</span><span class="mi">2</span>
111 <span class="n">ERROR</span> <span class="o">=</span> <span class="o">-</span><span class="mi">3</span>
112 <span class="n">OK</span> <span class="o">=</span> <span class="mi">0</span>
114 <div class="viewcode-block" id="OSType"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.OSType">[docs]</a><span class="k">class</span> <span class="nc">OSType</span><span class="p">:</span>
115 <span class="sd">"""</span>
116 <span class="sd"> Supported flavors of Linux OS</span>
117 <span class="sd"> """</span>
118 <span class="n">DEBIAN</span> <span class="o">=</span> <span class="mi">1</span>
119 <span class="n">UBUNTU</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">1</span>
120 <span class="n">FEDORA</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">2</span>
121 <span class="n">FEDORA_8</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">3</span> <span class="o">|</span> <span class="n">FEDORA</span>
122 <span class="n">FEDORA_12</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">4</span> <span class="o">|</span> <span class="n">FEDORA</span>
123 <span class="n">FEDORA_14</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">5</span> <span class="o">|</span> <span class="n">FEDORA</span>
125 <span class="nd">@clsinit_copy</span>
126 <div class="viewcode-block" id="LinuxNode"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode">[docs]</a><span class="k">class</span> <span class="nc">LinuxNode</span><span class="p">(</span><span class="n">ResourceManager</span><span class="p">):</span>
127 <span class="sd">"""</span>
128 <span class="sd"> .. class:: Class Args :</span>
129 <span class="sd"> </span>
130 <span class="sd"> :param ec: The Experiment controller</span>
131 <span class="sd"> :type ec: ExperimentController</span>
132 <span class="sd"> :param guid: guid of the RM</span>
133 <span class="sd"> :type guid: int</span>
135 <span class="sd"> .. note::</span>
137 <span class="sd"> There are different ways in which commands can be executed using the</span>
138 <span class="sd"> LinuxNode interface (i.e. 'execute' - blocking and non blocking, 'run',</span>
139 <span class="sd"> 'run_and_wait'). </span>
140 <span class="sd"> </span>
141 <span class="sd"> Brief explanation:</span>
143 <span class="sd"> * 'execute' (blocking mode) : </span>
145 <span class="sd"> HOW IT WORKS: 'execute', forks a process and run the</span>
146 <span class="sd"> command, synchronously, attached to the terminal, in</span>
147 <span class="sd"> foreground.</span>
148 <span class="sd"> The execute method will block until the command returns</span>
149 <span class="sd"> the result on 'out', 'err' (so until it finishes executing).</span>
150 <span class="sd"> </span>
151 <span class="sd"> USAGE: short-lived commands that must be executed attached</span>
152 <span class="sd"> to a terminal and in foreground, for which it IS necessary</span>
153 <span class="sd"> to block until the command has finished (e.g. if you want</span>
154 <span class="sd"> to run 'ls' or 'cat').</span>
156 <span class="sd"> * 'execute' (NON blocking mode - blocking = False) :</span>
158 <span class="sd"> HOW IT WORKS: Same as before, except that execute method</span>
159 <span class="sd"> will return immediately (even if command still running).</span>
161 <span class="sd"> USAGE: long-lived commands that must be executed attached</span>
162 <span class="sd"> to a terminal and in foreground, but for which it is not</span>
163 <span class="sd"> necessary to block until the command has finished. (e.g.</span>
164 <span class="sd"> start an application using X11 forwarding)</span>
166 <span class="sd"> * 'run' :</span>
168 <span class="sd"> HOW IT WORKS: Connects to the host ( using SSH if remote)</span>
169 <span class="sd"> and launches the command in background, detached from any</span>
170 <span class="sd"> terminal (daemonized), and returns. The command continues to</span>
171 <span class="sd"> run remotely, but since it is detached from the terminal,</span>
172 <span class="sd"> its pipes (stdin, stdout, stderr) can't be redirected to the</span>
173 <span class="sd"> console (as normal non detached processes would), and so they</span>
174 <span class="sd"> are explicitly redirected to files. The pidfile is created as</span>
175 <span class="sd"> part of the process of launching the command. The pidfile</span>
176 <span class="sd"> holds the pid and ppid of the process forked in background,</span>
177 <span class="sd"> so later on it is possible to check whether the command is still</span>
178 <span class="sd"> running.</span>
180 <span class="sd"> USAGE: long-lived commands that can run detached in background,</span>
181 <span class="sd"> for which it is NOT necessary to block (wait) until the command</span>
182 <span class="sd"> has finished. (e.g. start an application that is not using X11</span>
183 <span class="sd"> forwarding. It can run detached and remotely in background)</span>
185 <span class="sd"> * 'run_and_wait' :</span>
187 <span class="sd"> HOW IT WORKS: Similar to 'run' except that it 'blocks' until</span>
188 <span class="sd"> the command has finished execution. It also checks whether</span>
189 <span class="sd"> errors occurred during runtime by reading the exitcode file,</span>
190 <span class="sd"> which contains the exit code of the command that was run</span>
191 <span class="sd"> (checking stderr only is not always reliable since many</span>
192 <span class="sd"> commands throw debugging info to stderr and the only way to</span>
193 <span class="sd"> automatically know whether an error really happened is to</span>
194 <span class="sd"> check the process exit code).</span>
196 <span class="sd"> Another difference with respect to 'run', is that instead</span>
197 <span class="sd"> of directly executing the command as a bash command line,</span>
198 <span class="sd"> it uploads the command to a bash script and runs the script.</span>
199 <span class="sd"> This allows to use the bash script to debug errors, since</span>
200 <span class="sd"> it remains at the remote host and can be run manually to</span>
201 <span class="sd"> reproduce the error.</span>
202 <span class="sd"> </span>
203 <span class="sd"> USAGE: medium-lived commands that can run detached in</span>
204 <span class="sd"> background, for which it IS necessary to block (wait) until</span>
205 <span class="sd"> the command has finished. (e.g. Package installation,</span>
206 <span class="sd"> source compilation, file download, etc)</span>
208 <span class="sd"> """</span>
209 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::Node"</span>
210 <span class="n">_help</span> <span class="o">=</span> <span class="s">"Controls Linux host machines ( either localhost or a host "</span> \
211 <span class="s">"that can be accessed using a SSH key)"</span>
212 <span class="n">_platform</span> <span class="o">=</span> <span class="s">"linux"</span>
214 <span class="nd">@classmethod</span>
215 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
216 <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>
217 <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>
219 <span class="n">username</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"username"</span><span class="p">,</span> <span class="s">"Local account username"</span><span class="p">,</span>
220 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
222 <span class="n">port</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"port"</span><span class="p">,</span> <span class="s">"SSH port"</span><span class="p">,</span> <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>
224 <span class="n">home</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"home"</span><span class="p">,</span>
225 <span class="s">"Experiment home directory to store all experiment related files"</span><span class="p">,</span>
226 <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>
228 <span class="n">identity</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"identity"</span><span class="p">,</span> <span class="s">"SSH identity file"</span><span class="p">,</span>
229 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Credential</span><span class="p">)</span>
231 <span class="n">server_key</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"serverKey"</span><span class="p">,</span> <span class="s">"Server public key"</span><span class="p">,</span>
232 <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>
234 <span class="n">clean_home</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"cleanHome"</span><span class="p">,</span> <span class="s">"Remove all nepi files and directories "</span>
235 <span class="s">" from node home folder before starting experiment"</span><span class="p">,</span>
236 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
237 <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
238 <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>
240 <span class="n">clean_experiment</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"cleanExperiment"</span><span class="p">,</span> <span class="s">"Remove all files and directories "</span>
241 <span class="s">" from a previous same experiment, before the new experiment starts"</span><span class="p">,</span>
242 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
243 <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
244 <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>
246 <span class="n">clean_processes</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"cleanProcesses"</span><span class="p">,</span>
247 <span class="s">"Kill all running processes before starting experiment"</span><span class="p">,</span>
248 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
249 <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
250 <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>
252 <span class="n">tear_down</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"tearDown"</span><span class="p">,</span> <span class="s">"Bash script to be executed before "</span> <span class="o">+</span> \
253 <span class="s">"releasing the resource"</span><span class="p">,</span>
254 <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>
256 <span class="n">gateway_user</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"gatewayUser"</span><span class="p">,</span> <span class="s">"Gateway account username"</span><span class="p">,</span>
257 <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>
259 <span class="n">gateway</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"gateway"</span><span class="p">,</span> <span class="s">"Hostname of the gateway machine"</span><span class="p">,</span>
260 <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>
262 <span class="n">ip</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"ip"</span><span class="p">,</span> <span class="s">"Linux host public IP address. "</span>
263 <span class="s">"Must not be modified by the user unless hostname is 'localhost'"</span><span class="p">,</span>
264 <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>
266 <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>
267 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
268 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
269 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">home</span><span class="p">)</span>
270 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">identity</span><span class="p">)</span>
271 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">server_key</span><span class="p">)</span>
272 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">clean_home</span><span class="p">)</span>
273 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">clean_experiment</span><span class="p">)</span>
274 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">clean_processes</span><span class="p">)</span>
275 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">tear_down</span><span class="p">)</span>
276 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">gateway_user</span><span class="p">)</span>
277 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">gateway</span><span class="p">)</span>
278 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ip</span><span class="p">)</span>
280 <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>
281 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxNode</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>
282 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="bp">None</span>
283 <span class="c"># home directory at Linux host</span>
284 <span class="bp">self</span><span class="o">.</span><span class="n">_home_dir</span> <span class="o">=</span> <span class="s">""</span>
286 <span class="c"># lock to prevent concurrent applications on the same node,</span>
287 <span class="c"># to execute commands at the same time. There are potential</span>
288 <span class="c"># concurrency issues when using SSH to a same host from </span>
289 <span class="c"># multiple threads. There are also possible operational </span>
290 <span class="c"># issues, e.g. an application querying the existence </span>
291 <span class="c"># of a file or folder prior to its creation, and another </span>
292 <span class="c"># application creating the same file or folder in between.</span>
293 <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
295 <div class="viewcode-block" id="LinuxNode.log_message"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.log_message">[docs]</a> <span class="k">def</span> <span class="nf">log_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
296 <span class="k">return</span> <span class="s">" guid </span><span class="si">%d</span><span class="s"> - host </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">guid</span><span class="p">,</span>
297 <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">msg</span><span class="p">)</span>
299 <span class="nd">@property</span>
300 <div class="viewcode-block" id="LinuxNode.home_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.home_dir">[docs]</a> <span class="k">def</span> <span class="nf">home_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
301 <span class="n">home</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">"home"</span><span class="p">)</span> <span class="ow">or</span> <span class="s">""</span>
302 <span class="k">if</span> <span class="ow">not</span> <span class="n">home</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"/"</span><span class="p">):</span>
303 <span class="n">home</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">_home_dir</span><span class="p">,</span> <span class="n">home</span><span class="p">)</span>
304 <span class="k">return</span> <span class="n">home</span>
306 <span class="nd">@property</span>
307 <div class="viewcode-block" id="LinuxNode.nepi_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.nepi_home">[docs]</a> <span class="k">def</span> <span class="nf">nepi_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
308 <span class="k">return</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">home_dir</span><span class="p">,</span> <span class="s">".nepi"</span><span class="p">)</span>
310 <span class="nd">@property</span>
311 <div class="viewcode-block" id="LinuxNode.usr_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.usr_dir">[docs]</a> <span class="k">def</span> <span class="nf">usr_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
312 <span class="k">return</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">nepi_home</span><span class="p">,</span> <span class="s">"nepi-usr"</span><span class="p">)</span>
314 <span class="nd">@property</span>
315 <div class="viewcode-block" id="LinuxNode.lib_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.lib_dir">[docs]</a> <span class="k">def</span> <span class="nf">lib_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
316 <span class="k">return</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">usr_dir</span><span class="p">,</span> <span class="s">"lib"</span><span class="p">)</span>
318 <span class="nd">@property</span>
319 <div class="viewcode-block" id="LinuxNode.bin_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.bin_dir">[docs]</a> <span class="k">def</span> <span class="nf">bin_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
320 <span class="k">return</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">usr_dir</span><span class="p">,</span> <span class="s">"bin"</span><span class="p">)</span>
322 <span class="nd">@property</span>
323 <div class="viewcode-block" id="LinuxNode.src_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.src_dir">[docs]</a> <span class="k">def</span> <span class="nf">src_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
324 <span class="k">return</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">usr_dir</span><span class="p">,</span> <span class="s">"src"</span><span class="p">)</span>
326 <span class="nd">@property</span>
327 <div class="viewcode-block" id="LinuxNode.share_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.share_dir">[docs]</a> <span class="k">def</span> <span class="nf">share_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
328 <span class="k">return</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">usr_dir</span><span class="p">,</span> <span class="s">"share"</span><span class="p">)</span>
330 <span class="nd">@property</span>
331 <div class="viewcode-block" id="LinuxNode.exp_dir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.exp_dir">[docs]</a> <span class="k">def</span> <span class="nf">exp_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
332 <span class="k">return</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">nepi_home</span><span class="p">,</span> <span class="s">"nepi-exp"</span><span class="p">)</span>
334 <span class="nd">@property</span>
335 <div class="viewcode-block" id="LinuxNode.exp_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.exp_home">[docs]</a> <span class="k">def</span> <span class="nf">exp_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
336 <span class="k">return</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">exp_dir</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">exp_id</span><span class="p">)</span>
338 <span class="nd">@property</span>
339 <div class="viewcode-block" id="LinuxNode.node_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.node_home">[docs]</a> <span class="k">def</span> <span class="nf">node_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
340 <span class="k">return</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">exp_home</span><span class="p">,</span> <span class="s">"node-</span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
342 <span class="nd">@property</span>
343 <div class="viewcode-block" id="LinuxNode.run_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.run_home">[docs]</a> <span class="k">def</span> <span class="nf">run_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
344 <span class="k">return</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">node_home</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">run_id</span><span class="p">)</span>
346 <span class="nd">@property</span>
347 <div class="viewcode-block" id="LinuxNode.os"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.os">[docs]</a> <span class="k">def</span> <span class="nf">os</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
348 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_os</span><span class="p">:</span>
349 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_os</span>
351 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span> <span class="ow">and</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">"username"</span><span class="p">):</span>
352 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Can't resolve OS, insufficient data "</span>
353 <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>
354 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
356 <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_os</span><span class="p">()</span>
358 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Debian"</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
359 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">DEBIAN</span>
360 <span class="k">elif</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Ubuntu"</span><span class="p">)</span> <span class="o">==</span><span class="mi">0</span><span class="p">:</span>
361 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">UBUNTU</span>
362 <span class="k">elif</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Fedora release"</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
363 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">FEDORA</span>
364 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Fedora release 8"</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
365 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">FEDORA_8</span>
366 <span class="k">elif</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Fedora release 12"</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
367 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">FEDORA_12</span>
368 <span class="k">elif</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Fedora release 14"</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
369 <span class="bp">self</span><span class="o">.</span><span class="n">_os</span> <span class="o">=</span> <span class="n">OSType</span><span class="o">.</span><span class="n">FEDORA_14</span>
370 <span class="k">else</span><span class="p">:</span>
371 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unsupported OS"</span>
372 <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="p">)</span>
373 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <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="n">msg</span><span class="p">,</span> <span class="n">out</span> <span class="p">)</span>
375 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_os</span>
377 <div class="viewcode-block" id="LinuxNode.get_os"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.get_os">[docs]</a> <span class="k">def</span> <span class="nf">get_os</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
378 <span class="c"># The underlying SSH layer will sometimes return an empty</span>
379 <span class="c"># output (even if the command was executed without errors).</span>
380 <span class="c"># To work arround this, repeat the operation N times or</span>
381 <span class="c"># until the result is not empty string</span>
382 <span class="n">out</span> <span class="o">=</span> <span class="s">""</span>
383 <span class="k">try</span><span class="p">:</span>
384 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"cat /etc/issue"</span><span class="p">,</span>
385 <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
386 <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
387 <span class="k">except</span><span class="p">:</span>
388 <span class="n">trace</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
389 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error detecting OS: </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="n">trace</span>
390 <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="p">,</span> <span class="n">err</span><span class="p">)</span>
392 <span class="k">return</span> <span class="n">out</span>
394 <span class="nd">@property</span>
395 <div class="viewcode-block" id="LinuxNode.use_deb"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.use_deb">[docs]</a> <span class="k">def</span> <span class="nf">use_deb</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
396 <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span> <span class="o">&</span> <span class="p">(</span><span class="n">OSType</span><span class="o">.</span><span class="n">DEBIAN</span><span class="o">|</span><span class="n">OSType</span><span class="o">.</span><span class="n">UBUNTU</span><span class="p">))</span>
398 <span class="nd">@property</span>
399 <div class="viewcode-block" id="LinuxNode.use_rpm"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.use_rpm">[docs]</a> <span class="k">def</span> <span class="nf">use_rpm</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
400 <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span> <span class="o">&</span> <span class="n">OSType</span><span class="o">.</span><span class="n">FEDORA</span><span class="p">)</span>
402 <span class="nd">@property</span>
403 <div class="viewcode-block" id="LinuxNode.localhost"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.localhost">[docs]</a> <span class="k">def</span> <span class="nf">localhost</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
404 <span class="k">return</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="ow">in</span> <span class="p">[</span><span class="s">'localhost'</span><span class="p">,</span> <span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="s">'::1'</span><span class="p">]</span>
406 <div class="viewcode-block" id="LinuxNode.do_provision"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.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>
407 <span class="c"># check if host is alive</span>
408 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>
409 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Deploy failed. Unresponsive node </span><span class="si">%s</span><span class="s">"</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">"hostname"</span><span class="p">)</span>
410 <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>
411 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
413 <span class="bp">self</span><span class="o">.</span><span class="n">find_home</span><span class="p">()</span>
415 <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">"cleanProcesses"</span><span class="p">):</span>
416 <span class="bp">self</span><span class="o">.</span><span class="n">clean_processes</span><span class="p">()</span>
418 <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">"cleanHome"</span><span class="p">):</span>
419 <span class="bp">self</span><span class="o">.</span><span class="n">clean_home</span><span class="p">()</span>
421 <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">"cleanExperiment"</span><span class="p">):</span>
422 <span class="bp">self</span><span class="o">.</span><span class="n">clean_experiment</span><span class="p">()</span>
424 <span class="c"># Create shared directory structure and node home directory</span>
425 <span class="n">paths</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">lib_dir</span><span class="p">,</span>
426 <span class="bp">self</span><span class="o">.</span><span class="n">bin_dir</span><span class="p">,</span>
427 <span class="bp">self</span><span class="o">.</span><span class="n">src_dir</span><span class="p">,</span>
428 <span class="bp">self</span><span class="o">.</span><span class="n">share_dir</span><span class="p">,</span>
429 <span class="bp">self</span><span class="o">.</span><span class="n">node_home</span><span class="p">]</span>
431 <span class="bp">self</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">paths</span><span class="p">)</span>
433 <span class="c"># Get Public IP address if possible</span>
434 <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">"ip"</span><span class="p">):</span>
435 <span class="k">try</span><span class="p">:</span>
436 <span class="n">ip</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">gethostbyname</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>
437 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"ip"</span><span class="p">,</span> <span class="n">ip</span><span class="p">)</span>
438 <span class="k">except</span><span class="p">:</span>
439 <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">"gateway"</span><span class="p">)</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
440 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Local DNS can not resolve hostname </span><span class="si">%s</span><span class="s">"</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">"hostname"</span><span class="p">)</span>
441 <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>
443 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxNode</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>
445 <div class="viewcode-block" id="LinuxNode.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.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>
446 <span class="k">if</span> <span class="bp">self</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">NEW</span><span class="p">:</span>
447 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Deploying node"</span><span class="p">)</span>
448 <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
449 <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
451 <span class="c"># Node needs to wait until all associated interfaces are </span>
452 <span class="c"># ready before it can finalize deployment</span>
453 <span class="kn">from</span> <span class="nn">nepi.resources.linux.interface</span> <span class="kn">import</span> <span class="n">LinuxInterface</span>
454 <span class="n">ifaces</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">LinuxInterface</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
455 <span class="k">for</span> <span class="n">iface</span> <span class="ow">in</span> <span class="n">ifaces</span><span class="p">:</span>
456 <span class="k">if</span> <span class="n">iface</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">READY</span><span class="p">:</span>
457 <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">deploy</span><span class="p">)</span>
458 <span class="k">return</span>
460 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxNode</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>
462 <div class="viewcode-block" id="LinuxNode.do_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.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>
463 <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>
464 <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
465 <span class="c"># Node needs to wait until all associated RMs are released</span>
466 <span class="c"># before it can be released</span>
467 <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>
468 <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>
469 <span class="k">return</span>
471 <span class="n">tear_down</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">"tearDown"</span><span class="p">)</span>
472 <span class="k">if</span> <span class="n">tear_down</span><span class="p">:</span>
473 <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">tear_down</span><span class="p">)</span>
475 <span class="bp">self</span><span class="o">.</span><span class="n">clean_processes</span><span class="p">()</span>
477 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxNode</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>
479 <div class="viewcode-block" id="LinuxNode.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.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>
480 <span class="c"># TODO: Validate!</span>
481 <span class="k">return</span> <span class="bp">True</span>
483 <div class="viewcode-block" id="LinuxNode.clean_processes"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.clean_processes">[docs]</a> <span class="k">def</span> <span class="nf">clean_processes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
484 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Cleaning up processes"</span><span class="p">)</span>
486 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
487 <span class="k">return</span>
489 <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">"username"</span><span class="p">)</span> <span class="o">!=</span> <span class="s">'root'</span><span class="p">:</span>
490 <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"sudo -S killall tcpdump || /bin/true ; "</span> <span class="o">+</span>
491 <span class="s">"sudo -S kill -9 $(ps aux | grep '[.]nepi' | awk '{print $2}') || /bin/true ; "</span> <span class="o">+</span>
492 <span class="s">"sudo -S killall -u </span><span class="si">%s</span><span class="s"> || /bin/true ; "</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">"username"</span><span class="p">))</span>
493 <span class="k">else</span><span class="p">:</span>
494 <span class="k">if</span> <span class="bp">self</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">READY</span><span class="p">:</span>
495 <span class="kn">import</span> <span class="nn">pickle</span>
496 <span class="n">pids</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="s">"/tmp/save.proc"</span><span class="p">,</span> <span class="s">"rb"</span><span class="p">))</span>
497 <span class="n">pids_temp</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
498 <span class="n">ps_aux</span> <span class="o">=</span> <span class="s">"ps aux |awk '{print $2,$11}'"</span>
499 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">ps_aux</span><span class="p">)</span>
500 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
501 <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">):</span>
502 <span class="n">parts</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">" "</span><span class="p">)</span>
503 <span class="n">pids_temp</span><span class="p">[</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
504 <span class="n">kill_pids</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">pids_temp</span><span class="o">.</span><span class="n">items</span><span class="p">())</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">pids</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
505 <span class="n">kill_pids</span> <span class="o">=</span> <span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">kill_pids</span><span class="p">)</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
507 <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"killall tcpdump || /bin/true ; "</span> <span class="o">+</span>
508 <span class="s">"kill $(ps aux | grep '[.]nepi' | awk '{print $2}') || /bin/true ; "</span> <span class="o">+</span>
509 <span class="s">"kill </span><span class="si">%s</span><span class="s"> || /bin/true ; "</span> <span class="o">%</span> <span class="n">kill_pids</span><span class="p">)</span>
510 <span class="k">else</span><span class="p">:</span>
511 <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"killall tcpdump || /bin/true ; "</span> <span class="o">+</span>
512 <span class="s">"kill $(ps aux | grep '[.]nepi' | awk '{print $2}') || /bin/true ; "</span><span class="p">)</span>
513 <span class="k">else</span><span class="p">:</span>
514 <span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="s">"killall tcpdump || /bin/true ; "</span> <span class="o">+</span>
515 <span class="s">"kill $(ps aux | grep '[.]nepi' | awk '{print $2}') || /bin/true ; "</span><span class="p">)</span>
517 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">retry</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
519 <div class="viewcode-block" id="LinuxNode.clean_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.clean_home">[docs]</a> <span class="k">def</span> <span class="nf">clean_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
520 <span class="sd">""" Cleans all NEPI related folders in the Linux host</span>
521 <span class="sd"> """</span>
522 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Cleaning up home"</span><span class="p">)</span>
524 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"cd </span><span class="si">%s</span><span class="s"> ; find . -maxdepth 1 -name \.nepi -execdir rm -rf {} + "</span> <span class="o">%</span> <span class="p">(</span>
525 <span class="bp">self</span><span class="o">.</span><span class="n">home_dir</span> <span class="p">)</span>
527 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
529 <div class="viewcode-block" id="LinuxNode.clean_experiment"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.clean_experiment">[docs]</a> <span class="k">def</span> <span class="nf">clean_experiment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
530 <span class="sd">""" Cleans all experiment related files in the Linux host.</span>
531 <span class="sd"> It preserves NEPI files and folders that have a multi experiment</span>
532 <span class="sd"> scope.</span>
533 <span class="sd"> """</span>
534 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Cleaning up experiment files"</span><span class="p">)</span>
536 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"cd </span><span class="si">%s</span><span class="s"> ; find . -maxdepth 1 -name '</span><span class="si">%s</span><span class="s">' -execdir rm -rf {} + "</span> <span class="o">%</span> <span class="p">(</span>
537 <span class="bp">self</span><span class="o">.</span><span class="n">exp_dir</span><span class="p">,</span>
538 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">exp_id</span> <span class="p">)</span>
540 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
542 <div class="viewcode-block" id="LinuxNode.execute"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span>
543 <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
544 <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
545 <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
546 <span class="n">forward_x11</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
547 <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
548 <span class="n">connect_timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">,</span>
549 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
550 <span class="n">persistent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
551 <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
552 <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">False</span>
553 <span class="p">):</span>
554 <span class="sd">""" Notice that this invocation will block until the</span>
555 <span class="sd"> execution finishes. If this is not the desired behavior,</span>
556 <span class="sd"> use 'run' instead."""</span>
558 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
559 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lexec</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
560 <span class="n">user</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">"username"</span><span class="p">),</span> <span class="c"># still problem with localhost</span>
561 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
562 <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">)</span>
563 <span class="k">else</span><span class="p">:</span>
564 <span class="k">if</span> <span class="n">with_lock</span><span class="p">:</span>
565 <span class="c"># If the execute command is blocking, we don't want to keep</span>
566 <span class="c"># the node lock. This lock is used to avoid race conditions</span>
567 <span class="c"># when creating the ControlMaster sockets. A more elegant</span>
568 <span class="c"># solution is needed.</span>
569 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
570 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rexec</span><span class="p">(</span>
571 <span class="n">command</span><span class="p">,</span>
572 <span class="n">host</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">"hostname"</span><span class="p">),</span>
573 <span class="n">user</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">"username"</span><span class="p">),</span>
574 <span class="n">port</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">"port"</span><span class="p">),</span>
575 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
576 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
577 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
578 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
579 <span class="n">identity</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">"identity"</span><span class="p">),</span>
580 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
581 <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
582 <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">,</span>
583 <span class="n">forward_x11</span> <span class="o">=</span> <span class="n">forward_x11</span><span class="p">,</span>
584 <span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span><span class="p">,</span>
585 <span class="n">connect_timeout</span> <span class="o">=</span> <span class="n">connect_timeout</span><span class="p">,</span>
586 <span class="n">persistent</span> <span class="o">=</span> <span class="n">persistent</span><span class="p">,</span>
587 <span class="n">blocking</span> <span class="o">=</span> <span class="n">blocking</span><span class="p">,</span>
588 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
589 <span class="p">)</span>
590 <span class="k">else</span><span class="p">:</span>
591 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rexec</span><span class="p">(</span>
592 <span class="n">command</span><span class="p">,</span>
593 <span class="n">host</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">"hostname"</span><span class="p">),</span>
594 <span class="n">user</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">"username"</span><span class="p">),</span>
595 <span class="n">port</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">"port"</span><span class="p">),</span>
596 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
597 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
598 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
599 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
600 <span class="n">identity</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">"identity"</span><span class="p">),</span>
601 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
602 <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
603 <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">,</span>
604 <span class="n">forward_x11</span> <span class="o">=</span> <span class="n">forward_x11</span><span class="p">,</span>
605 <span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span><span class="p">,</span>
606 <span class="n">connect_timeout</span> <span class="o">=</span> <span class="n">connect_timeout</span><span class="p">,</span>
607 <span class="n">persistent</span> <span class="o">=</span> <span class="n">persistent</span><span class="p">,</span>
608 <span class="n">blocking</span> <span class="o">=</span> <span class="n">blocking</span><span class="p">,</span>
609 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
610 <span class="p">)</span>
612 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
614 <div class="viewcode-block" id="LinuxNode.run"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span>
615 <span class="n">create_home</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
616 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">'pidfile'</span><span class="p">,</span>
617 <span class="n">stdin</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
618 <span class="n">stdout</span> <span class="o">=</span> <span class="s">'stdout'</span><span class="p">,</span>
619 <span class="n">stderr</span> <span class="o">=</span> <span class="s">'stderr'</span><span class="p">,</span>
620 <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
621 <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
622 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
624 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Running command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
626 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
627 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lspawn</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">pidfile</span><span class="p">,</span>
628 <span class="n">home</span> <span class="o">=</span> <span class="n">home</span><span class="p">,</span>
629 <span class="n">create_home</span> <span class="o">=</span> <span class="n">create_home</span><span class="p">,</span>
630 <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
631 <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
632 <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
633 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">)</span>
634 <span class="k">else</span><span class="p">:</span>
635 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
636 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rspawn</span><span class="p">(</span>
637 <span class="n">command</span><span class="p">,</span>
638 <span class="n">pidfile</span> <span class="o">=</span> <span class="n">pidfile</span><span class="p">,</span>
639 <span class="n">home</span> <span class="o">=</span> <span class="n">home</span><span class="p">,</span>
640 <span class="n">create_home</span> <span class="o">=</span> <span class="n">create_home</span><span class="p">,</span>
641 <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
642 <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
643 <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span> <span class="ow">or</span> <span class="s">'/dev/null'</span><span class="p">,</span>
644 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
645 <span class="n">host</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">"hostname"</span><span class="p">),</span>
646 <span class="n">user</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">"username"</span><span class="p">),</span>
647 <span class="n">port</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">"port"</span><span class="p">),</span>
648 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
649 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
650 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
651 <span class="n">identity</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">"identity"</span><span class="p">),</span>
652 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
653 <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">,</span>
654 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
655 <span class="p">)</span>
657 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
659 <div class="viewcode-block" id="LinuxNode.getpid"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.getpid">[docs]</a> <span class="k">def</span> <span class="nf">getpid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">pidfile</span> <span class="o">=</span> <span class="s">"pidfile"</span><span class="p">):</span>
660 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
661 <span class="n">pidtuple</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lgetpid</span><span class="p">(</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="n">home</span><span class="p">,</span> <span class="n">pidfile</span><span class="p">))</span>
662 <span class="k">else</span><span class="p">:</span>
663 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
664 <span class="n">pidtuple</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rgetpid</span><span class="p">(</span>
665 <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="n">home</span><span class="p">,</span> <span class="n">pidfile</span><span class="p">),</span>
666 <span class="n">host</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">"hostname"</span><span class="p">),</span>
667 <span class="n">user</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">"username"</span><span class="p">),</span>
668 <span class="n">port</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">"port"</span><span class="p">),</span>
669 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
670 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
671 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
672 <span class="n">identity</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">"identity"</span><span class="p">),</span>
673 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
674 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span>
675 <span class="p">)</span>
677 <span class="k">return</span> <span class="n">pidtuple</span>
679 <div class="viewcode-block" id="LinuxNode.status"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.status">[docs]</a> <span class="k">def</span> <span class="nf">status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">):</span>
680 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
681 <span class="n">status</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lstatus</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">)</span>
682 <span class="k">else</span><span class="p">:</span>
683 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
684 <span class="n">status</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rstatus</span><span class="p">(</span>
685 <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span>
686 <span class="n">host</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">"hostname"</span><span class="p">),</span>
687 <span class="n">user</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">"username"</span><span class="p">),</span>
688 <span class="n">port</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">"port"</span><span class="p">),</span>
689 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
690 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
691 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
692 <span class="n">identity</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">"identity"</span><span class="p">),</span>
693 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
694 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span>
695 <span class="p">)</span>
697 <span class="k">return</span> <span class="n">status</span>
699 <div class="viewcode-block" id="LinuxNode.kill"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.kill">[docs]</a> <span class="k">def</span> <span class="nf">kill</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
700 <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">""</span>
701 <span class="n">proc</span> <span class="o">=</span> <span class="bp">None</span>
702 <span class="n">status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">)</span>
704 <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">ProcStatus</span><span class="o">.</span><span class="n">RUNNING</span><span class="p">:</span>
705 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
706 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lkill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span> <span class="n">sudo</span><span class="p">)</span>
707 <span class="k">else</span><span class="p">:</span>
708 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
709 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rkill</span><span class="p">(</span>
710 <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span>
711 <span class="n">host</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">"hostname"</span><span class="p">),</span>
712 <span class="n">user</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">"username"</span><span class="p">),</span>
713 <span class="n">port</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">"port"</span><span class="p">),</span>
714 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
715 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
716 <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
717 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
718 <span class="n">identity</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">"identity"</span><span class="p">),</span>
719 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
720 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span>
721 <span class="p">)</span>
723 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
725 <div class="viewcode-block" id="LinuxNode.copy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">):</span>
726 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
727 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">execfuncs</span><span class="o">.</span><span class="n">lcopy</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span>
728 <span class="n">recursive</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
729 <span class="k">else</span><span class="p">:</span>
730 <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node_lock</span><span class="p">:</span>
731 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">sshfuncs</span><span class="o">.</span><span class="n">rcopy</span><span class="p">(</span>
732 <span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span>
733 <span class="n">port</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">"port"</span><span class="p">),</span>
734 <span class="n">gwuser</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">"gatewayUser"</span><span class="p">),</span>
735 <span class="n">gw</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">"gateway"</span><span class="p">),</span>
736 <span class="n">identity</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">"identity"</span><span class="p">),</span>
737 <span class="n">server_key</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">"serverKey"</span><span class="p">),</span>
738 <span class="n">recursive</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
739 <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
741 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
743 <div class="viewcode-block" id="LinuxNode.upload"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.upload">[docs]</a> <span class="k">def</span> <span class="nf">upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span> <span class="n">text</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
744 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
745 <span class="sd">""" Copy content to destination</span>
747 <span class="sd"> src string with the content to copy. Can be:</span>
748 <span class="sd"> - plain text</span>
749 <span class="sd"> - a string with the path to a local file</span>
750 <span class="sd"> - a string with a semi-colon separeted list of local files</span>
751 <span class="sd"> - a string with a local directory</span>
753 <span class="sd"> dst string with destination path on the remote host (remote is </span>
754 <span class="sd"> always self.host)</span>
756 <span class="sd"> text src is text input, it must be stored into a temp file before </span>
757 <span class="sd"> uploading</span>
758 <span class="sd"> """</span>
759 <span class="c"># If source is a string input </span>
760 <span class="n">f</span> <span class="o">=</span> <span class="bp">None</span>
761 <span class="k">if</span> <span class="n">text</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">src</span><span class="p">):</span>
762 <span class="c"># src is text input that should be uploaded as file</span>
763 <span class="c"># create a temporal file with the content to upload</span>
764 <span class="n">f</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">delete</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
765 <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">src</span><span class="p">)</span>
766 <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
767 <span class="n">src</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">name</span>
769 <span class="c"># If dst files should not be overwritten, check that the files do not</span>
770 <span class="c"># exits already</span>
771 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
772 <span class="n">src</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">";"</span><span class="p">))</span>
774 <span class="k">if</span> <span class="n">overwrite</span> <span class="o">==</span> <span class="bp">False</span><span class="p">:</span>
775 <span class="n">src</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter_existing_files</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">)</span>
776 <span class="k">if</span> <span class="ow">not</span> <span class="n">src</span><span class="p">:</span>
777 <span class="k">return</span> <span class="p">(</span><span class="s">""</span><span class="p">,</span> <span class="s">""</span><span class="p">),</span> <span class="bp">None</span>
779 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
780 <span class="c"># Build destination as <user>@<server>:<path></span>
781 <span class="n">dst</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><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">get</span><span class="p">(</span><span class="s">"username"</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">dst</span><span class="p">)</span>
783 <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">)</span>
785 <span class="c"># clean up temp file</span>
786 <span class="k">if</span> <span class="n">f</span><span class="p">:</span>
787 <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
789 <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
790 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to upload files - src: </span><span class="si">%s</span><span class="s"> dst: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="s">";"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">src</span><span class="p">),</span> <span class="n">dst</span><span class="p">)</span>
791 <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="p">,</span> <span class="n">err</span><span class="p">)</span>
793 <span class="n">msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> out: </span><span class="si">%s</span><span class="s"> err: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
794 <span class="k">if</span> <span class="n">raise_on_error</span><span class="p">:</span>
795 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
797 <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
799 <div class="viewcode-block" id="LinuxNode.download"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.download">[docs]</a> <span class="k">def</span> <span class="nf">download</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">,</span> <span class="n">raise_on_error</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
800 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
801 <span class="c"># Build destination as <user>@<server>:<path></span>
802 <span class="n">src</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><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">get</span><span class="p">(</span><span class="s">"username"</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">src</span><span class="p">)</span>
804 <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">)</span>
806 <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
807 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to download files - src: </span><span class="si">%s</span><span class="s"> dst: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="s">";"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">src</span><span class="p">),</span> <span class="n">dst</span><span class="p">)</span>
808 <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="p">,</span> <span class="n">err</span><span class="p">)</span>
810 <span class="k">if</span> <span class="n">raise_on_error</span><span class="p">:</span>
811 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
813 <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
815 <div class="viewcode-block" id="LinuxNode.install_packages_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.install_packages_command">[docs]</a> <span class="k">def</span> <span class="nf">install_packages_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">):</span>
816 <span class="n">command</span> <span class="o">=</span> <span class="s">""</span>
817 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_rpm</span><span class="p">:</span>
818 <span class="n">command</span> <span class="o">=</span> <span class="n">rpmfuncs</span><span class="o">.</span><span class="n">install_packages_command</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span><span class="p">,</span> <span class="n">packages</span><span class="p">)</span>
819 <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_deb</span><span class="p">:</span>
820 <span class="n">command</span> <span class="o">=</span> <span class="n">debfuncs</span><span class="o">.</span><span class="n">install_packages_command</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span><span class="p">,</span> <span class="n">packages</span><span class="p">)</span>
821 <span class="k">else</span><span class="p">:</span>
822 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error installing packages ( OS not known ) "</span>
823 <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="bp">self</span><span class="o">.</span><span class="n">os</span><span class="p">)</span>
824 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
826 <span class="k">return</span> <span class="n">command</span>
828 <div class="viewcode-block" id="LinuxNode.install_packages"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.install_packages">[docs]</a> <span class="k">def</span> <span class="nf">install_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">run_home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
829 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
830 <span class="sd">""" Install packages in the Linux host.</span>
832 <span class="sd"> 'home' is the directory to upload the package installation script.</span>
833 <span class="sd"> 'run_home' is the directory from where to execute the script.</span>
834 <span class="sd"> """</span>
835 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">install_packages_command</span><span class="p">(</span><span class="n">packages</span><span class="p">)</span>
837 <span class="n">run_home</span> <span class="o">=</span> <span class="n">run_home</span> <span class="ow">or</span> <span class="n">home</span>
839 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">run_home</span><span class="p">,</span>
840 <span class="n">shfile</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="n">home</span><span class="p">,</span> <span class="s">"instpkg.sh"</span><span class="p">),</span>
841 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">"instpkg_pidfile"</span><span class="p">,</span>
842 <span class="n">ecodefile</span> <span class="o">=</span> <span class="s">"instpkg_exitcode"</span><span class="p">,</span>
843 <span class="n">stdout</span> <span class="o">=</span> <span class="s">"instpkg_stdout"</span><span class="p">,</span>
844 <span class="n">stderr</span> <span class="o">=</span> <span class="s">"instpkg_stderr"</span><span class="p">,</span>
845 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
846 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="n">raise_on_error</span><span class="p">)</span>
848 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
850 <div class="viewcode-block" id="LinuxNode.remove_packages"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.remove_packages">[docs]</a> <span class="k">def</span> <span class="nf">remove_packages</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">run_home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
851 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
852 <span class="sd">""" Uninstall packages from the Linux host.</span>
854 <span class="sd"> 'home' is the directory to upload the package un-installation script.</span>
855 <span class="sd"> 'run_home' is the directory from where to execute the script.</span>
856 <span class="sd"> """</span>
857 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_rpm</span><span class="p">:</span>
858 <span class="n">command</span> <span class="o">=</span> <span class="n">rpmfuncs</span><span class="o">.</span><span class="n">remove_packages_command</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span><span class="p">,</span> <span class="n">packages</span><span class="p">)</span>
859 <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_deb</span><span class="p">:</span>
860 <span class="n">command</span> <span class="o">=</span> <span class="n">debfuncs</span><span class="o">.</span><span class="n">remove_packages_command</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">os</span><span class="p">,</span> <span class="n">packages</span><span class="p">)</span>
861 <span class="k">else</span><span class="p">:</span>
862 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error removing packages ( OS not known ) "</span>
863 <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>
864 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
866 <span class="n">run_home</span> <span class="o">=</span> <span class="n">run_home</span> <span class="ow">or</span> <span class="n">home</span>
868 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">run_home</span><span class="p">,</span>
869 <span class="n">shfile</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="n">home</span><span class="p">,</span> <span class="s">"rmpkg.sh"</span><span class="p">),</span>
870 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">"rmpkg_pidfile"</span><span class="p">,</span>
871 <span class="n">ecodefile</span> <span class="o">=</span> <span class="s">"rmpkg_exitcode"</span><span class="p">,</span>
872 <span class="n">stdout</span> <span class="o">=</span> <span class="s">"rmpkg_stdout"</span><span class="p">,</span>
873 <span class="n">stderr</span> <span class="o">=</span> <span class="s">"rmpkg_stderr"</span><span class="p">,</span>
874 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
875 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="n">raise_on_error</span><span class="p">)</span>
877 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
879 <div class="viewcode-block" id="LinuxNode.mkdir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.mkdir">[docs]</a> <span class="k">def</span> <span class="nf">mkdir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">paths</span><span class="p">,</span> <span class="n">clean</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
880 <span class="sd">""" Paths is either a single remote directory path to create,</span>
881 <span class="sd"> or a list of directories to create.</span>
882 <span class="sd"> """</span>
883 <span class="k">if</span> <span class="n">clean</span><span class="p">:</span>
884 <span class="bp">self</span><span class="o">.</span><span class="n">rmdir</span><span class="p">(</span><span class="n">paths</span><span class="p">)</span>
886 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">paths</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
887 <span class="n">paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">paths</span><span class="p">]</span>
889 <span class="n">cmd</span> <span class="o">=</span> <span class="s">" ; "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">path</span><span class="p">:</span> <span class="s">"mkdir -p </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">path</span><span class="p">,</span> <span class="n">paths</span><span class="p">))</span>
891 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
893 <div class="viewcode-block" id="LinuxNode.rmdir"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.rmdir">[docs]</a> <span class="k">def</span> <span class="nf">rmdir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">paths</span><span class="p">):</span>
894 <span class="sd">""" Paths is either a single remote directory path to delete,</span>
895 <span class="sd"> or a list of directories to delete.</span>
896 <span class="sd"> """</span>
898 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">paths</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
899 <span class="n">paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">paths</span><span class="p">]</span>
901 <span class="n">cmd</span> <span class="o">=</span> <span class="s">" ; "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">path</span><span class="p">:</span> <span class="s">"rm -rf </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">path</span><span class="p">,</span> <span class="n">paths</span><span class="p">))</span>
903 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
905 <div class="viewcode-block" id="LinuxNode.run_and_wait"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.run_and_wait">[docs]</a> <span class="k">def</span> <span class="nf">run_and_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span>
906 <span class="n">shfile</span><span class="o">=</span><span class="s">"cmd.sh"</span><span class="p">,</span>
907 <span class="n">env</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
908 <span class="n">overwrite</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
909 <span class="n">wait_run</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
910 <span class="n">pidfile</span><span class="o">=</span><span class="s">"pidfile"</span><span class="p">,</span>
911 <span class="n">ecodefile</span><span class="o">=</span><span class="s">"exitcode"</span><span class="p">,</span>
912 <span class="n">stdin</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
913 <span class="n">stdout</span><span class="o">=</span><span class="s">"stdout"</span><span class="p">,</span>
914 <span class="n">stderr</span><span class="o">=</span><span class="s">"stderr"</span><span class="p">,</span>
915 <span class="n">sudo</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
916 <span class="n">tty</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
917 <span class="n">raise_on_error</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
918 <span class="sd">"""</span>
919 <span class="sd"> Uploads the 'command' to a bash script in the host.</span>
920 <span class="sd"> Then runs the script detached in background in the host, and</span>
921 <span class="sd"> busy-waites until the script finishes executing.</span>
922 <span class="sd"> """</span>
924 <span class="k">if</span> <span class="ow">not</span> <span class="n">shfile</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"/"</span><span class="p">):</span>
925 <span class="n">shfile</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="n">home</span><span class="p">,</span> <span class="n">shfile</span><span class="p">)</span>
927 <span class="bp">self</span><span class="o">.</span><span class="n">upload_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
928 <span class="n">shfile</span> <span class="o">=</span> <span class="n">shfile</span><span class="p">,</span>
929 <span class="n">ecodefile</span> <span class="o">=</span> <span class="n">ecodefile</span><span class="p">,</span>
930 <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
931 <span class="n">overwrite</span> <span class="o">=</span> <span class="n">overwrite</span><span class="p">)</span>
933 <span class="n">command</span> <span class="o">=</span> <span class="s">"bash </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">shfile</span>
934 <span class="c"># run command in background in remote host</span>
935 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span>
936 <span class="n">pidfile</span> <span class="o">=</span> <span class="n">pidfile</span><span class="p">,</span>
937 <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span><span class="p">,</span>
938 <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
939 <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">,</span>
940 <span class="n">sudo</span> <span class="o">=</span> <span class="n">sudo</span><span class="p">,</span>
941 <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">)</span>
943 <span class="c"># check no errors occurred</span>
944 <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
945 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to run command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">command</span>
946 <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="p">,</span> <span class="n">err</span><span class="p">)</span>
947 <span class="k">if</span> <span class="n">raise_on_error</span><span class="p">:</span>
948 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
950 <span class="c"># Wait for pid file to be generated</span>
951 <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_pid</span><span class="p">(</span>
952 <span class="n">home</span> <span class="o">=</span> <span class="n">home</span><span class="p">,</span>
953 <span class="n">pidfile</span> <span class="o">=</span> <span class="n">pidfile</span><span class="p">,</span>
954 <span class="n">raise_on_error</span> <span class="o">=</span> <span class="n">raise_on_error</span><span class="p">)</span>
956 <span class="k">if</span> <span class="n">wait_run</span><span class="p">:</span>
957 <span class="c"># wait until command finishes to execute</span>
958 <span class="bp">self</span><span class="o">.</span><span class="n">wait_run</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">)</span>
960 <span class="p">(</span><span class="n">eout</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_errors</span><span class="p">(</span><span class="n">home</span><span class="p">,</span>
961 <span class="n">ecodefile</span> <span class="o">=</span> <span class="n">ecodefile</span><span class="p">,</span>
962 <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">)</span>
964 <span class="c"># Out is what was written in the stderr file</span>
965 <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
966 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to run command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">command</span>
967 <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">eout</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
969 <span class="k">if</span> <span class="n">raise_on_error</span><span class="p">:</span>
970 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
972 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">oerr</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="n">stdout</span><span class="p">)</span>
974 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
976 <div class="viewcode-block" id="LinuxNode.exitcode"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.exitcode">[docs]</a> <span class="k">def</span> <span class="nf">exitcode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">ecodefile</span> <span class="o">=</span> <span class="s">"exitcode"</span><span class="p">):</span>
977 <span class="sd">"""</span>
978 <span class="sd"> Get the exit code of an application.</span>
979 <span class="sd"> Returns an integer value with the exit code </span>
980 <span class="sd"> """</span>
981 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="n">ecodefile</span><span class="p">)</span>
983 <span class="c"># Succeeded to open file, return exit code in the file</span>
984 <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
985 <span class="k">try</span><span class="p">:</span>
986 <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
987 <span class="k">except</span><span class="p">:</span>
988 <span class="c"># Error in the content of the file!</span>
989 <span class="k">return</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">CORRUPTFILE</span>
991 <span class="c"># No such file or directory</span>
992 <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
993 <span class="k">return</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">FILENOTFOUND</span>
995 <span class="c"># Other error from 'cat'</span>
996 <span class="k">return</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">ERROR</span>
998 <div class="viewcode-block" id="LinuxNode.upload_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.upload_command">[docs]</a> <span class="k">def</span> <span class="nf">upload_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span>
999 <span class="n">shfile</span><span class="o">=</span><span class="s">"cmd.sh"</span><span class="p">,</span>
1000 <span class="n">ecodefile</span><span class="o">=</span><span class="s">"exitcode"</span><span class="p">,</span>
1001 <span class="n">overwrite</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
1002 <span class="n">env</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
1003 <span class="sd">""" Saves the command as a bash script file in the remote host, and</span>
1004 <span class="sd"> forces to save the exit code of the command execution to the ecodefile</span>
1005 <span class="sd"> """</span>
1007 <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">command</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">";"</span><span class="p">)</span> <span class="ow">or</span> <span class="n">command</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"&"</span><span class="p">)):</span>
1008 <span class="n">command</span> <span class="o">+=</span> <span class="s">";"</span>
1010 <span class="c"># The exit code of the command will be stored in ecodefile</span>
1011 <span class="n">command</span> <span class="o">=</span> <span class="s">" { </span><span class="si">%(command)s</span><span class="s"> } ; echo $? > </span><span class="si">%(ecodefile)s</span><span class="s"> ;"</span> <span class="o">%</span> <span class="p">{</span>
1012 <span class="s">'command'</span><span class="p">:</span> <span class="n">command</span><span class="p">,</span>
1013 <span class="s">'ecodefile'</span><span class="p">:</span> <span class="n">ecodefile</span><span class="p">,</span>
1014 <span class="p">}</span>
1016 <span class="c"># Export environment</span>
1017 <span class="n">environ</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_environment</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
1019 <span class="c"># Add environ to command</span>
1020 <span class="n">command</span> <span class="o">=</span> <span class="n">environ</span> <span class="o">+</span> <span class="n">command</span>
1022 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">upload</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">shfile</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="n">overwrite</span><span class="p">)</span>
1024 <div class="viewcode-block" id="LinuxNode.format_environment"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.format_environment">[docs]</a> <span class="k">def</span> <span class="nf">format_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">inline</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
1025 <span class="sd">""" Formats the environment variables for a command to be executed</span>
1026 <span class="sd"> either as an inline command</span>
1027 <span class="sd"> (i.e. export PYTHONPATH=src/..; export LALAL= ..;python script.py) or </span>
1028 <span class="sd"> as a bash script (i.e. export PYTHONPATH=src/.. \n export LALA=.. \n)</span>
1029 <span class="sd"> """</span>
1030 <span class="k">if</span> <span class="ow">not</span> <span class="n">env</span><span class="p">:</span> <span class="k">return</span> <span class="s">""</span>
1032 <span class="c"># Remove extra white spaces</span>
1033 <span class="n">env</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'\s+'</span><span class="p">,</span> <span class="s">' '</span><span class="p">,</span> <span class="n">env</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
1035 <span class="n">sep</span> <span class="o">=</span> <span class="s">";"</span> <span class="k">if</span> <span class="n">inline</span> <span class="k">else</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span>
1036 <span class="k">return</span> <span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">e</span><span class="p">:</span> <span class="s">" export </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">e</span><span class="p">,</span> <span class="n">env</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">" "</span><span class="p">)))</span> <span class="o">+</span> <span class="n">sep</span>
1038 <div class="viewcode-block" id="LinuxNode.check_errors"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.check_errors">[docs]</a> <span class="k">def</span> <span class="nf">check_errors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span>
1039 <span class="n">ecodefile</span> <span class="o">=</span> <span class="s">"exitcode"</span><span class="p">,</span>
1040 <span class="n">stderr</span> <span class="o">=</span> <span class="s">"stderr"</span><span class="p">):</span>
1041 <span class="sd">""" Checks whether errors occurred while running a command.</span>
1042 <span class="sd"> It first checks the exit code for the command, and only if the</span>
1043 <span class="sd"> exit code is an error one it returns the error output.</span>
1045 <span class="sd"> """</span>
1046 <span class="n">proc</span> <span class="o">=</span> <span class="bp">None</span>
1047 <span class="n">err</span> <span class="o">=</span> <span class="s">""</span>
1049 <span class="c"># get exit code saved in the 'exitcode' file</span>
1050 <span class="n">ecode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">exitcode</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="n">ecodefile</span><span class="p">)</span>
1052 <span class="k">if</span> <span class="n">ecode</span> <span class="ow">in</span> <span class="p">[</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">CORRUPTFILE</span><span class="p">,</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">ERROR</span> <span class="p">]:</span>
1053 <span class="n">err</span> <span class="o">=</span> <span class="s">"Error retrieving exit code status from file </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="n">home</span><span class="p">,</span> <span class="n">ecodefile</span><span class="p">)</span>
1054 <span class="k">elif</span> <span class="n">ecode</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">ecode</span> <span class="o">==</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">FILENOTFOUND</span><span class="p">:</span>
1055 <span class="c"># The process returned an error code or didn't exist. </span>
1056 <span class="c"># Check standard error.</span>
1057 <span class="p">(</span><span class="n">err</span><span class="p">,</span> <span class="n">eerr</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span><span class="n">home</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span>
1059 <span class="c"># If the stderr file was not found, assume nothing bad happened,</span>
1060 <span class="c"># and just ignore the error.</span>
1061 <span class="c"># (cat returns 1 for error "No such file or directory")</span>
1062 <span class="k">if</span> <span class="n">ecode</span> <span class="o">==</span> <span class="n">ExitCode</span><span class="o">.</span><span class="n">FILENOTFOUND</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
1063 <span class="n">err</span> <span class="o">=</span> <span class="s">""</span>
1065 <span class="k">return</span> <span class="p">(</span><span class="s">""</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
1067 <div class="viewcode-block" id="LinuxNode.wait_pid"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.wait_pid">[docs]</a> <span class="k">def</span> <span class="nf">wait_pid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">pidfile</span> <span class="o">=</span> <span class="s">"pidfile"</span><span class="p">,</span> <span class="n">raise_on_error</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
1068 <span class="sd">""" Waits until the pid file for the command is generated, </span>
1069 <span class="sd"> and returns the pid and ppid of the process """</span>
1070 <span class="n">pid</span> <span class="o">=</span> <span class="n">ppid</span> <span class="o">=</span> <span class="bp">None</span>
1071 <span class="n">delay</span> <span class="o">=</span> <span class="mf">1.0</span>
1073 <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span>
1074 <span class="n">pidtuple</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getpid</span><span class="p">(</span><span class="n">home</span> <span class="o">=</span> <span class="n">home</span><span class="p">,</span> <span class="n">pidfile</span> <span class="o">=</span> <span class="n">pidfile</span><span class="p">)</span>
1076 <span class="k">if</span> <span class="n">pidtuple</span><span class="p">:</span>
1077 <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span> <span class="o">=</span> <span class="n">pidtuple</span>
1078 <span class="k">break</span>
1079 <span class="k">else</span><span class="p">:</span>
1080 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
1081 <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
1082 <span class="k">else</span><span class="p">:</span>
1083 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to get pid for pidfile </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>
1084 <span class="n">home</span><span class="p">,</span> <span class="n">pidfile</span> <span class="p">)</span>
1085 <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>
1087 <span class="k">if</span> <span class="n">raise_on_error</span><span class="p">:</span>
1088 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
1090 <span class="k">return</span> <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span>
1092 <div class="viewcode-block" id="LinuxNode.wait_run"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.wait_run">[docs]</a> <span class="k">def</span> <span class="nf">wait_run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span> <span class="n">trial</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
1093 <span class="sd">""" wait for a remote process to finish execution """</span>
1094 <span class="n">delay</span> <span class="o">=</span> <span class="mf">1.0</span>
1096 <span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
1097 <span class="n">status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">status</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">)</span>
1099 <span class="k">if</span> <span class="n">status</span> <span class="ow">is</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">FINISHED</span><span class="p">:</span>
1100 <span class="k">break</span>
1101 <span class="k">elif</span> <span class="n">status</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">RUNNING</span><span class="p">:</span>
1102 <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
1103 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
1104 <span class="c"># If it takes more than 20 seconds to start, then</span>
1105 <span class="c"># asume something went wrong</span>
1106 <span class="k">if</span> <span class="n">delay</span> <span class="o">></span> <span class="mi">20</span><span class="p">:</span>
1107 <span class="k">break</span>
1108 <span class="k">else</span><span class="p">:</span>
1109 <span class="c"># The app is running, just wait...</span>
1110 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
1112 <div class="viewcode-block" id="LinuxNode.check_output"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.check_output">[docs]</a> <span class="k">def</span> <span class="nf">check_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
1113 <span class="sd">""" Retrives content of file """</span>
1114 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"cat </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
1115 <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="n">home</span><span class="p">,</span> <span class="n">filename</span><span class="p">),</span> <span class="n">retry</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
1116 <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
1118 <div class="viewcode-block" id="LinuxNode.is_alive"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.is_alive">[docs]</a> <span class="k">def</span> <span class="nf">is_alive</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
1119 <span class="sd">""" Checks if host is responsive</span>
1120 <span class="sd"> """</span>
1121 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">localhost</span><span class="p">:</span>
1122 <span class="k">return</span> <span class="bp">True</span>
1124 <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">""</span>
1125 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unresponsive host. Wrong answer. "</span>
1127 <span class="c"># The underlying SSH layer will sometimes return an empty</span>
1128 <span class="c"># output (even if the command was executed without errors).</span>
1129 <span class="c"># To work arround this, repeat the operation N times or</span>
1130 <span class="c"># until the result is not empty string</span>
1131 <span class="k">try</span><span class="p">:</span>
1132 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"echo 'ALIVE'"</span><span class="p">,</span>
1133 <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
1134 <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
1136 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"ALIVE"</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
1137 <span class="k">return</span> <span class="bp">True</span>
1138 <span class="k">except</span><span class="p">:</span>
1139 <span class="n">trace</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
1140 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unresponsive host. Error reaching host: </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="n">trace</span>
1142 <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="p">,</span> <span class="n">err</span><span class="p">)</span>
1143 <span class="k">return</span> <span class="bp">False</span>
1145 <div class="viewcode-block" id="LinuxNode.find_home"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.find_home">[docs]</a> <span class="k">def</span> <span class="nf">find_home</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
1146 <span class="sd">""" Retrieves host home directory</span>
1147 <span class="sd"> """</span>
1148 <span class="c"># The underlying SSH layer will sometimes return an empty</span>
1149 <span class="c"># output (even if the command was executed without errors).</span>
1150 <span class="c"># To work arround this, repeat the operation N times or</span>
1151 <span class="c"># until the result is not empty string</span>
1152 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Impossible to retrieve HOME directory"</span>
1153 <span class="k">try</span><span class="p">:</span>
1154 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"echo ${HOME}"</span><span class="p">,</span>
1155 <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
1156 <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
1158 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">!=</span> <span class="s">""</span><span class="p">:</span>
1159 <span class="bp">self</span><span class="o">.</span><span class="n">_home_dir</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
1160 <span class="k">except</span><span class="p">:</span>
1161 <span class="n">trace</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
1162 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Impossible to retrieve HOME directory </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">trace</span>
1164 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_home_dir</span><span class="p">:</span>
1165 <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>
1166 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
1168 <div class="viewcode-block" id="LinuxNode.filter_existing_files"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.node.LinuxNode.filter_existing_files">[docs]</a> <span class="k">def</span> <span class="nf">filter_existing_files</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">dst</span><span class="p">):</span>
1169 <span class="sd">""" Removes files that already exist in the Linux host from src list</span>
1170 <span class="sd"> """</span>
1171 <span class="c"># construct a dictionary with { dst: src }</span>
1172 <span class="n">dests</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="p">(</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="n">dst</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">s</span><span class="p">)),</span> <span class="n">s</span><span class="p">),</span> <span class="n">src</span><span class="p">))</span> \
1173 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">src</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="k">else</span> <span class="nb">dict</span><span class="p">({</span><span class="n">dst</span><span class="p">:</span> <span class="n">src</span><span class="p">[</span><span class="mi">0</span><span class="p">]})</span>
1175 <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
1176 <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dests</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
1177 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">" [ -f </span><span class="si">%(dst)s</span><span class="s"> ] && echo '</span><span class="si">%(dst)s</span><span class="s">' "</span> <span class="o">%</span> <span class="p">{</span><span class="s">'dst'</span> <span class="p">:</span> <span class="n">d</span><span class="p">}</span> <span class="p">)</span>
1179 <span class="n">command</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">command</span><span class="p">)</span>
1181 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">retry</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="n">with_lock</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
1183 <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dests</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
1184 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="o">></span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
1185 <span class="k">del</span> <span class="n">dests</span><span class="p">[</span><span class="n">d</span><span class="p">]</span>
1187 <span class="k">if</span> <span class="ow">not</span> <span class="n">dests</span><span class="p">:</span>
1188 <span class="k">return</span> <span class="p">[]</span>
1190 <span class="k">return</span> <span class="n">dests</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
1191 </pre></div></div></div>
1196 <div class="clearer"></div>
1198 <div class="related">
1201 <li class="right" style="margin-right: 10px">
1202 <a href="../../../../genindex.html" title="General Index"
1205 <a href="../../../../py-modindex.html" title="Python Module Index"
1207 <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
1208 <li><a href="../../../index.html" >Module code</a> »</li>
1211 <div class="footer">
1212 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
1213 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.