add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / sfaapi.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/util/sfaapi.html b/doc/sphinx/_build/html/_modules/nepi/util/sfaapi.html
new file mode 100644 (file)
index 0000000..1939a77
--- /dev/null
@@ -0,0 +1,562 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>nepi.util.sfaapi &mdash; NEPI 3.0 documentation</title>
+    
+    <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../',
+        VERSION:     '3.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
+    <link rel="up" title="Module code" href="../../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for nepi.util.sfaapi</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c">#    NEPI, a framework to manage network experiments</span>
+<span class="c">#    Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c">#    This program is free software: you can redistribute it and/or modify</span>
+<span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
+<span class="c">#    published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c">#    This program is distributed in the hope that it will be useful,</span>
+<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c">#    GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c">#    You should have received a copy of the GNU General Public License</span>
+<span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<span class="c">#</span>
+<span class="c"># Author: Lucia Guevgeozian Odizzio &lt;lucia.guevgeozian_odizzio@inria.fr&gt;</span>
+
+<span class="kn">import</span> <span class="nn">threading</span>
+<span class="kn">import</span> <span class="nn">hashlib</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">time</span>
+
+<span class="kn">from</span> <span class="nn">nepi.util.logger</span> <span class="kn">import</span> <span class="n">Logger</span>
+
+<span class="k">try</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">sfa.client.sfi</span> <span class="kn">import</span> <span class="n">Sfi</span>
+    <span class="kn">from</span> <span class="nn">sfa.util.xrn</span> <span class="kn">import</span> <span class="n">hrn_to_urn</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
+    <span class="n">log</span> <span class="o">=</span> <span class="n">Logger</span><span class="p">(</span><span class="s">&quot;SFA API&quot;</span><span class="p">)</span>
+    <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Packages sfa-common or sfa-client not installed.</span><span class="se">\</span>
+<span class="s">         Could not import sfa.client.sfi or sfa.util.xrn&quot;</span><span class="p">)</span>
+
+<span class="kn">from</span> <span class="nn">nepi.util.sfarspec_proc</span> <span class="kn">import</span> <span class="n">SfaRSpecProcessing</span>
+
+<div class="viewcode-block" id="SFAAPI"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI">[docs]</a><span class="k">class</span> <span class="nc">SFAAPI</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    API for quering the SFA service. It uses Sfi class from the tool sfi client.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sfi_user</span><span class="p">,</span> <span class="n">sfi_auth</span><span class="p">,</span> <span class="n">sfi_registry</span><span class="p">,</span> <span class="n">sfi_sm</span><span class="p">,</span> <span class="n">private_key</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span>
+        <span class="n">batch</span><span class="p">,</span> <span class="n">rtype</span><span class="p">,</span> <span class="n">timeout</span><span class="p">):</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_resources_cache</span> <span class="o">=</span> <span class="bp">None</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_already_cached</span> <span class="o">=</span> <span class="bp">False</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_ec</span> <span class="o">=</span> <span class="n">ec</span> 
+        <span class="bp">self</span><span class="o">.</span><span class="n">apis</span> <span class="o">=</span> <span class="mi">1</span>
+
+        <span class="k">if</span> <span class="n">batch</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_testbed_res</span> <span class="o">=</span> <span class="n">rtype</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_count</span> <span class="o">=</span> <span class="mi">0</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_total</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_total_res</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_slice_resources_batch</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">_log</span> <span class="o">=</span> <span class="n">Logger</span><span class="p">(</span><span class="s">&quot;SFA API&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span> <span class="o">=</span> <span class="n">Sfi</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span> <span class="o">=</span> <span class="n">SfaRSpecProcessing</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">lock_blist</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">lock_resv</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">raw</span> <span class="o">=</span> <span class="bp">None</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">sfi_user</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">auth</span> <span class="o">=</span> <span class="n">sfi_auth</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">registry</span> <span class="o">=</span> <span class="n">sfi_registry</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">sm</span> <span class="o">=</span> <span class="n">sfi_sm</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">user_private_key</span> <span class="o">=</span> <span class="n">private_key</span>
+
+        <span class="c"># Load blacklist from file</span>
+        <span class="k">if</span> <span class="n">ec</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s">&#39;PlanetlabNode&#39;</span><span class="p">,</span> <span class="s">&#39;persist_blacklist&#39;</span><span class="p">):</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_set_blacklist</span><span class="p">()</span>
+
+    <span class="k">def</span> <span class="nf">_set_blacklist</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Initialize the blacklist with previous nodes blacklisted, in </span>
+<span class="sd">        previous runs.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">nepi_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="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s">&quot;~&quot;</span><span class="p">),</span> <span class="s">&quot;.nepi&quot;</span><span class="p">)</span>
+        <span class="n">plblacklist_file</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">nepi_home</span><span class="p">,</span> <span class="s">&quot;plblacklist.txt&quot;</span><span class="p">)</span>
+        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">plblacklist_file</span><span class="p">,</span> <span class="s">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
+            <span class="n">hosts_tobl</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span>
+            <span class="k">if</span> <span class="n">hosts_tobl</span><span class="p">:</span>
+                <span class="k">for</span> <span class="n">host</span> <span class="ow">in</span> <span class="n">hosts_tobl</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">_get_total_res</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the total amount of resources instanciated using this API,</span>
+<span class="sd">        to be able to add them using the same Allocate and Provision</span>
+<span class="sd">        call at once. Specially for Wilabt testbed that doesn&#39;t allow </span>
+<span class="sd">        to add slivers after the slice already has some.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">rms</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+        <span class="n">res_gids</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ec</span><span class="o">.</span><span class="n">resources</span>
+        <span class="k">for</span> <span class="n">gid</span> <span class="ow">in</span> <span class="n">res_gids</span><span class="p">:</span>
+            <span class="n">rm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ec</span><span class="o">.</span><span class="n">get_resource</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_testbed_res</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">rm</span><span class="o">.</span><span class="n">_rtype</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
+                <span class="n">rms</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rm</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">rms</span>
+
+    <span class="k">def</span> <span class="nf">_sfi_exec_method</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">slicename</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">rspec</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">urn</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Execute sfi method, which correspond to SFA call. It can be the following</span>
+<span class="sd">        calls: Describe, Delete, Allocate, Provision, ListResources.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">command</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;describe&#39;</span><span class="p">,</span> <span class="s">&#39;delete&#39;</span><span class="p">,</span> <span class="s">&#39;allocate&#39;</span><span class="p">,</span> <span class="s">&#39;provision&#39;</span><span class="p">,</span> <span class="s">&#39;action&#39;</span><span class="p">]:</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">slicename</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s">&quot;The slice hrn is expected for this method </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">command</span> <span class="o">==</span> <span class="s">&#39;allocate&#39;</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">rspec</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s">&quot;RSpec is expected for this method </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
+            
+            <span class="k">if</span> <span class="n">command</span> <span class="o">==</span> <span class="s">&#39;allocate&#39;</span><span class="p">:</span>
+                <span class="n">args_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">slicename</span><span class="p">,</span> <span class="n">rspec</span><span class="p">]</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">args_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">slicename</span><span class="p">]</span>
+            <span class="k">if</span> <span class="n">command</span> <span class="o">!=</span> <span class="s">&#39;delete&#39;</span><span class="p">:</span>
+                <span class="n">args_list</span> <span class="o">=</span> <span class="n">args_list</span> <span class="o">+</span> <span class="p">[</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;/tmp/rspec_output&#39;</span><span class="p">]</span>
+            <span class="k">if</span> <span class="n">command</span> <span class="o">==</span> <span class="s">&#39;action&#39;</span><span class="p">:</span>
+                <span class="n">args_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">slicename</span><span class="p">,</span> <span class="n">action</span><span class="p">]</span>
+
+        <span class="k">elif</span> <span class="n">command</span> <span class="o">==</span> <span class="s">&#39;resources&#39;</span><span class="p">:</span>
+            <span class="n">args_list</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;/tmp/rspec_output&#39;</span><span class="p">]</span>
+
+        <span class="k">else</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s">&quot;Sfi method not supported&quot;</span><span class="p">)</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">command</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">command_parser</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">create_parser_command</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">command</span><span class="p">)</span>
+        <span class="p">(</span><span class="n">command_options</span><span class="p">,</span> <span class="n">command_args</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">command_parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args_list</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">command_options</span> <span class="o">=</span> <span class="n">command_options</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">read_config</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">bootstrap</span><span class="p">()</span>
+
+        <span class="k">try</span><span class="p">:</span>
+            <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_output.rspec&quot;</span><span class="p">)</span>
+        <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Couldn&#39;t remove temporary output file for RSpec or it doesn&#39;t exist&quot;</span><span class="p">)</span>
+
+        <span class="k">try</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">api</span><span class="o">.</span><span class="n">dispatch</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">command_options</span><span class="p">,</span> <span class="n">command_args</span><span class="p">)</span>
+            <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_output.rspec&quot;</span><span class="p">,</span> <span class="s">&quot;r&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">result_file</span><span class="p">:</span>
+                <span class="n">result</span> <span class="o">=</span> <span class="n">result_file</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+                <span class="k">return</span> <span class="n">result</span>
+        <span class="k">except</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot; Couldn&#39;t retrive rspec output information from method </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
+            <span class="k">return</span> <span class="bp">None</span>
+
+<div class="viewcode-block" id="SFAAPI.get_resources_info"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.get_resources_info">[docs]</a>    <span class="k">def</span> <span class="nf">get_resources_info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get all resources and its attributes from aggregate.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="n">rspec_slice</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;resources&#39;</span><span class="p">)</span>
+        <span class="k">except</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to list resources&quot;</span><span class="p">)</span>
+   
+        <span class="bp">self</span><span class="o">.</span><span class="n">_resources_cache</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span><span class="o">.</span><span class="n">parse_sfa_rspec</span><span class="p">(</span><span class="n">rspec_slice</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_already_cached</span> <span class="o">=</span> <span class="bp">True</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_resources_cache</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.get_resources_hrn"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.get_resources_hrn">[docs]</a>    <span class="k">def</span> <span class="nf">get_resources_hrn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resources</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get list of resources hrn, without the resource info.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">resources</span><span class="p">:</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_already_cached</span><span class="p">:</span>
+                <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resources_info</span><span class="p">()[</span><span class="s">&#39;resource&#39;</span><span class="p">]</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_resources_cache</span><span class="p">[</span><span class="s">&#39;resource&#39;</span><span class="p">]</span>
+
+        <span class="n">component_tohrn</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+        <span class="k">for</span> <span class="n">resource</span> <span class="ow">in</span> <span class="n">resources</span><span class="p">:</span>
+            <span class="n">hrn</span> <span class="o">=</span> <span class="n">resource</span><span class="p">[</span><span class="s">&#39;hrn&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&#39;</span><span class="se">\\</span><span class="s">&#39;</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">)</span>
+            <span class="n">component_tohrn</span><span class="p">[</span><span class="n">resource</span><span class="p">[</span><span class="s">&#39;component_name&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="n">hrn</span>
+
+        <span class="k">return</span> <span class="n">component_tohrn</span>
+            </div>
+<div class="viewcode-block" id="SFAAPI.get_slice_resources"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.get_slice_resources">[docs]</a>    <span class="k">def</span> <span class="nf">get_slice_resources</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get resources and info from slice.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span><span class="p">:</span>
+                <span class="n">rspec_slice</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;describe&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+        <span class="k">except</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Fail to describe resources for slice </span><span class="si">%s</span><span class="s">, slice may be empty&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="n">rspec_slice</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+            <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span><span class="o">.</span><span class="n">parse_sfa_rspec</span><span class="p">(</span><span class="n">rspec_slice</span><span class="p">)</span>
+            <span class="k">return</span> <span class="n">result</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="k">return</span> <span class="p">{</span><span class="s">&#39;resource&#39;</span><span class="p">:[],</span><span class="s">&#39;lease&#39;</span><span class="p">:[]}</span>
+
+</div>
+<div class="viewcode-block" id="SFAAPI.add_resource_to_slice"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.add_resource_to_slice">[docs]</a>    <span class="k">def</span> <span class="nf">add_resource_to_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">,</span> <span class="n">leases</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the list of resources&#39; urn, build the rspec string and call the allocate </span>
+<span class="sd">        and provision method.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">resources_hrn_new</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+        <span class="n">resource_parts</span> <span class="o">=</span> <span class="n">resource_hrn</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
+        <span class="n">resource_hrn</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">resource_parts</span><span class="p">[:</span><span class="mi">2</span><span class="p">])</span> <span class="o">+</span> <span class="s">&#39;.&#39;</span> <span class="o">+</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">resource_parts</span><span class="p">[</span><span class="mi">2</span><span class="p">:])</span>
+        <span class="n">resources_hrn_new</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span><span class="p">:</span>
+            <span class="n">rspec_slice</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;describe&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">rspec_slice</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+                <span class="n">slice_resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span><span class="o">.</span><span class="n">parse_sfa_rspec</span><span class="p">(</span><span class="n">rspec_slice</span><span class="p">)[</span><span class="s">&#39;resource&#39;</span><span class="p">]</span>
+            <span class="k">else</span><span class="p">:</span> <span class="n">slice_resources</span> <span class="o">=</span> <span class="p">[]</span>
+            <span class="k">if</span> <span class="n">slice_resources</span><span class="p">:</span>
+                <span class="n">slice_resources_hrn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resources_hrn</span><span class="p">(</span><span class="n">slice_resources</span><span class="p">)</span>
+                <span class="k">for</span> <span class="n">s_hrn_key</span><span class="p">,</span> <span class="n">s_hrn_value</span> <span class="ow">in</span> <span class="n">slice_resources_hrn</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
+                    <span class="n">s_parts</span> <span class="o">=</span> <span class="n">s_hrn_value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
+                    <span class="n">s_hrn</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s_parts</span><span class="p">[:</span><span class="mi">2</span><span class="p">])</span> <span class="o">+</span> <span class="s">&#39;.&#39;</span> <span class="o">+</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s_parts</span><span class="p">[</span><span class="mi">2</span><span class="p">:])</span>
+                    <span class="n">resources_hrn_new</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s_hrn</span><span class="p">)</span>
+
+
+            <span class="n">resources_urn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_resources_urn</span><span class="p">(</span><span class="n">resources_hrn_new</span><span class="p">)</span>
+            <span class="n">rspec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span><span class="o">.</span><span class="n">build_sfa_rspec</span><span class="p">(</span><span class="n">slicename</span><span class="p">,</span> <span class="n">resources_urn</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">leases</span><span class="p">)</span>
+            <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
+            <span class="n">f</span><span class="o">.</span><span class="n">truncate</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+            <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">rspec</span><span class="p">)</span>
+            <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+            
+            <span class="k">if</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">getsize</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to create rspec file to allocate resource in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+
+            <span class="c"># ALLOCATE</span>
+            <span class="k">try</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Allocating resources in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;allocate&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">)</span>
+            <span class="k">except</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to allocate resource for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="n">out</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+                <span class="c"># PROVISION</span>
+                <span class="k">try</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Provisioning resources in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;provision&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span> 
+                <span class="k">except</span><span class="p">:</span>
+                    <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to provision resource for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                <span class="k">return</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.add_resource_to_slice_batch"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.add_resource_to_slice_batch">[docs]</a>    <span class="k">def</span> <span class="nf">add_resource_to_slice_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">,</span> <span class="n">properties</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">leases</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Method to add all resources together to the slice. Previous deletion of slivers.</span>
+<span class="sd">        Specially used for wilabt that doesn&#39;t allow to add more resources to the slice</span>
+<span class="sd">        after some resources are added. Every sliver have to be deleted and the batch </span>
+<span class="sd">        has to be added at once.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_count</span> <span class="o">+=</span> <span class="mi">1</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_slice_resources_batch</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+        <span class="n">resources_hrn_new</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_count</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_total</span><span class="p">):</span>
+            <span class="n">check_all_inslice</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_all_inslice</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_resources_batch</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">check_all_inslice</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
+                <span class="k">return</span> <span class="bp">True</span>
+            <span class="k">for</span> <span class="n">resource_hrn</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice_resources_batch</span><span class="p">:</span>
+                <span class="n">resource_parts</span> <span class="o">=</span> <span class="n">resource_hrn</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
+                <span class="n">resource_hrn</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">resource_parts</span><span class="p">[:</span><span class="mi">2</span><span class="p">])</span> <span class="o">+</span> <span class="s">&#39;.&#39;</span> <span class="o">+</span> <span class="s">&#39;</span><span class="se">\\</span><span class="s">.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">resource_parts</span><span class="p">[</span><span class="mi">2</span><span class="p">:])</span>
+                <span class="n">resources_hrn_new</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+            <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span><span class="p">:</span>
+                <span class="k">if</span> <span class="n">check_all_inslice</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;delete&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+                    <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">480</span><span class="p">)</span>
+                
+                <span class="c"># Re implementing urn from hrn because the library sfa-common doesn&#39;t work for wilabt</span>
+                <span class="n">resources_urn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_urn</span><span class="p">(</span><span class="n">resources_hrn_new</span><span class="p">)</span>
+                <span class="n">rspec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rspec_proc</span><span class="o">.</span><span class="n">build_sfa_rspec</span><span class="p">(</span><span class="n">slicename</span><span class="p">,</span> <span class="n">resources_urn</span><span class="p">,</span> <span class="n">properties</span><span class="p">,</span> <span class="n">leases</span><span class="p">)</span>
+                <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
+                <span class="n">f</span><span class="o">.</span><span class="n">truncate</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+                <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">rspec</span><span class="p">)</span>
+                <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+                <span class="k">if</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">getsize</span><span class="p">(</span><span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
+                    <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to create rspec file to allocate resources in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+
+                <span class="c"># ALLOCATE    </span>
+                <span class="k">try</span><span class="p">:</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Allocating resources in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                    <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;allocate&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="s">&quot;/tmp/rspec_input.rspec&quot;</span><span class="p">)</span>
+                <span class="k">except</span><span class="p">:</span>
+                    <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to allocate resource for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+
+                <span class="k">if</span> <span class="n">out</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+                    <span class="c"># PROVISION</span>
+                    <span class="k">try</span><span class="p">:</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;Provisioning resources in slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;provision&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;action&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="o">=</span><span class="n">slicename</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s">&#39;geni_start&#39;</span><span class="p">)</span>
+                    <span class="k">except</span><span class="p">:</span>
+                        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to provision resource for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+                    <span class="k">return</span> <span class="bp">True</span>
+                <span class="k">else</span><span class="p">:</span>
+                    <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to allocate resources for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+    
+        <span class="k">else</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot; Waiting for more nodes to add the batch to the slice &quot;</span><span class="p">)</span>
+</div>
+    <span class="k">def</span> <span class="nf">_check_all_inslice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resources_hrn</span><span class="p">,</span> <span class="n">slicename</span><span class="p">):</span>
+        <span class="n">slice_res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slice_resources</span><span class="p">(</span><span class="n">slicename</span><span class="p">)[</span><span class="s">&#39;resource&#39;</span><span class="p">]</span>
+        <span class="k">if</span> <span class="n">slice_res</span><span class="p">:</span>
+            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">slice_res</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s">&#39;services&#39;</span><span class="p">])</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
+                <span class="n">slice_res_hrn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resources_hrn</span><span class="p">(</span><span class="n">slice_res</span><span class="p">)</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
+                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_compare_lists</span><span class="p">(</span><span class="n">slice_res_hrn</span><span class="p">,</span> <span class="n">resources_hrn</span><span class="p">):</span>
+                    <span class="k">return</span> <span class="bp">True</span>
+                <span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">slice_res_hrn</span><span class="p">)</span>
+        <span class="k">return</span> <span class="mi">0</span>
+
+    <span class="k">def</span> <span class="nf">_compare_lists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">list1</span><span class="p">,</span> <span class="n">list2</span><span class="p">):</span>
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">list1</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">list2</span><span class="p">):</span>
+            <span class="k">return</span> <span class="bp">False</span>
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">list1</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">item</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">list2</span><span class="p">:</span>
+                <span class="k">return</span> <span class="bp">False</span>
+        <span class="k">return</span> <span class="bp">True</span>
+
+    <span class="k">def</span> <span class="nf">_get_urn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resources_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get urn from hrn.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">resources_urn</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+        <span class="k">for</span> <span class="n">hrn</span> <span class="ow">in</span> <span class="n">resources_hrn</span><span class="p">:</span>
+            <span class="n">hrn</span> <span class="o">=</span> <span class="n">hrn</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\\</span><span class="s">&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
+            <span class="n">node</span> <span class="o">=</span> <span class="n">hrn</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+            <span class="n">auth</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hrn</span><span class="p">)</span>
+            <span class="n">urn</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;urn:publicid:IDN+&#39;</span><span class="p">,</span> <span class="n">auth</span><span class="p">,</span> <span class="s">&#39;+node+&#39;</span><span class="p">,</span> <span class="n">node</span><span class="p">]</span>
+            <span class="n">urn</span> <span class="o">=</span> <span class="s">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">urn</span><span class="p">)</span>
+            <span class="n">resources_urn</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">urn</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">resources_urn</span>
+
+<div class="viewcode-block" id="SFAAPI.remove_resource_from_slice"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.remove_resource_from_slice">[docs]</a>    <span class="k">def</span> <span class="nf">remove_resource_from_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">,</span> <span class="n">leases</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Remove slivers from slice. Currently sfi doesn&#39;t support removing particular</span>
+<span class="sd">        slivers.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">resource_urn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_resources_urn</span><span class="p">([</span><span class="n">resource_hrn</span><span class="p">])</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span><span class="p">:</span>
+            <span class="k">try</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;delete&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">,</span> <span class="n">urn</span><span class="o">=</span><span class="n">resource_urn</span><span class="p">)</span>
+            <span class="k">except</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to delete resource for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+            <span class="k">return</span> <span class="bp">True</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.remove_all_from_slice"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.remove_all_from_slice">[docs]</a>    <span class="k">def</span> <span class="nf">remove_all_from_slice</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">slicename</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        De-allocate and de-provision all slivers of the named slice.</span>
+<span class="sd">        Currently sfi doesn&#39;t support removing particular</span>
+<span class="sd">        slivers, so this method works only for removing every sliver. Setting the</span>
+<span class="sd">        resource_hrn parameter is not necessary.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_slice</span><span class="p">:</span>
+            <span class="k">try</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_sfi_exec_method</span><span class="p">(</span><span class="s">&#39;delete&#39;</span><span class="p">,</span> <span class="n">slicename</span><span class="p">)</span>
+            <span class="k">except</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Fail to delete slivers for slice </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">slicename</span><span class="p">)</span>
+            <span class="k">return</span> <span class="bp">True</span>
+</div>
+    <span class="k">def</span> <span class="nf">_get_resources_urn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resources_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Builds list of resources&#39; urn based on hrn.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">resources_urn</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
+
+        <span class="k">for</span> <span class="n">resource</span> <span class="ow">in</span> <span class="n">resources_hrn</span><span class="p">:</span>
+            <span class="n">resources_urn</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hrn_to_urn</span><span class="p">(</span><span class="n">resource</span><span class="p">,</span> <span class="s">&#39;node&#39;</span><span class="p">))</span>
+            
+        <span class="k">return</span> <span class="n">resources_urn</span>
+
+<div class="viewcode-block" id="SFAAPI.blacklist_resource"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.blacklist_resource">[docs]</a>    <span class="k">def</span> <span class="nf">blacklist_resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Adding resource_hrn to blacklist, and taking </span>
+<span class="sd">        the resource from the reserved list.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_blist</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_resv</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">resource_hrn</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.blacklisted"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.blacklisted">[docs]</a>    <span class="k">def</span> <span class="nf">blacklisted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Check if the resource is in the blacklist. </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_blist</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">resource_hrn</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span><span class="p">:</span>
+                <span class="k">return</span> <span class="bp">True</span>
+        <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.reserve_resource"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.reserve_resource">[docs]</a>    <span class="k">def</span> <span class="nf">reserve_resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Add resource to the reserved list.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.reserved"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.reserved">[docs]</a>    <span class="k">def</span> <span class="nf">reserved</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_hrn</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Check that the resource in not reserved.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock_resv</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">resource_hrn</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span><span class="p">:</span>
+                <span class="k">return</span> <span class="bp">True</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">reserve_resource</span><span class="p">(</span><span class="n">resource_hrn</span><span class="p">)</span>
+                <span class="k">return</span> <span class="bp">False</span>
+</div>
+<div class="viewcode-block" id="SFAAPI.release"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPI.release">[docs]</a>    <span class="k">def</span> <span class="nf">release</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Remove hosts from the reserved and blacklist lists, and in case</span>
+<span class="sd">        the persist attribute is set, it saves the blacklisted hosts</span>
+<span class="sd">        in the blacklist file.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">apis</span> <span class="o">-=</span> <span class="mi">1</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">apis</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="n">blacklist</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_blacklist</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_reserved</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+<span class="c">#            if self._ecobj.get_global(&#39;PlanetlabSfaNode&#39;, &#39;persist_blacklist&#39;):</span>
+<span class="c">#                if blacklist:</span>
+<span class="c">#                    to_blacklist = list()</span>
+<span class="c">#                    hostnames = self.get_nodes(list(blacklist), [&#39;hostname&#39;])</span>
+<span class="c">#                    for hostname in hostnames:</span>
+<span class="c">#                        to_blacklist.append(hostname[&#39;hostname&#39;])</span>
+<span class="c">#</span>
+<span class="c">#                    nepi_home = os.path.join(os.path.expanduser(&quot;~&quot;), &quot;.nepi&quot;)</span>
+<span class="c">#                    plblacklist_file = os.path.join(nepi_home, &quot;plblacklist.txt&quot;)</span>
+<span class="c">#</span>
+<span class="c">#                    with open(plblacklist_file, &#39;w&#39;) as f:</span>
+<span class="c">#                        for host in to_blacklist:</span>
+<span class="c">#                            f.write(&quot;%s\n&quot; % host)</span>
+<span class="c">#</span>
+
+</div></div>
+<div class="viewcode-block" id="SFAAPIFactory"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPIFactory">[docs]</a><span class="k">class</span> <span class="nc">SFAAPIFactory</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    API Factory to manage a map of SFAAPI instances as key-value pairs, it</span>
+<span class="sd">    instanciate a single instance per key. The key represents the same SFA, </span>
+<span class="sd">    credentials.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+    <span class="n">_apis</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+
+   
+    <span class="nd">@classmethod</span>
+<div class="viewcode-block" id="SFAAPIFactory.get_api"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPIFactory.get_api">[docs]</a>    <span class="k">def</span> <span class="nf">get_api</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">sfi_user</span><span class="p">,</span> <span class="n">sfi_auth</span><span class="p">,</span> <span class="n">sfi_registry</span><span class="p">,</span> <span class="n">sfi_sm</span><span class="p">,</span> <span class="n">private_key</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span>
+            <span class="n">batch</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">rtype</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+
+        <span class="k">if</span> <span class="n">sfi_user</span> <span class="ow">and</span> <span class="n">sfi_sm</span><span class="p">:</span>
+            <span class="n">key</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">make_key</span><span class="p">(</span><span class="n">sfi_user</span><span class="p">,</span> <span class="n">sfi_sm</span><span class="p">)</span>
+            <span class="k">with</span> <span class="n">cls</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
+                <span class="n">api</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+
+                <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span><span class="p">:</span>
+                    <span class="n">api</span> <span class="o">=</span> <span class="n">SFAAPI</span><span class="p">(</span><span class="n">sfi_user</span><span class="p">,</span> <span class="n">sfi_auth</span><span class="p">,</span> <span class="n">sfi_registry</span><span class="p">,</span> <span class="n">sfi_sm</span><span class="p">,</span> <span class="n">private_key</span><span class="p">,</span>
+                        <span class="n">ec</span><span class="p">,</span> <span class="n">batch</span><span class="p">,</span> <span class="n">rtype</span><span class="p">,</span> <span class="n">timeout</span><span class="p">)</span>
+                    <span class="n">cls</span><span class="o">.</span><span class="n">_apis</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">api</span>
+                <span class="k">else</span><span class="p">:</span>
+                    <span class="n">api</span><span class="o">.</span><span class="n">apis</span> <span class="o">+=</span> <span class="mi">1</span>
+
+                <span class="k">return</span> <span class="n">api</span>
+
+        <span class="k">return</span> <span class="bp">None</span>
+</div>
+    <span class="nd">@classmethod</span>
+<div class="viewcode-block" id="SFAAPIFactory.make_key"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sfaapi.SFAAPIFactory.make_key">[docs]</a>    <span class="k">def</span> <span class="nf">make_key</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
+        <span class="n">skey</span> <span class="o">=</span> <span class="s">&quot;&quot;</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="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">))</span>
+        <span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span><span class="n">skey</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
+</pre></div></div></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
\ No newline at end of file