Something went wrong on our end
-
Gerardo Tauriello authoredGerardo Tauriello authored
test_actions.html 18.40 KiB
<!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>test_actions — ProMod3 0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '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="ProMod3 0 documentation" href="../index.html" />
<link rel="up" title="Module code" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for test_actions</h1><div class="highlight"><pre>
<span class="sd">"""</span>
<span class="sd">unittest.TestCase class providing common functionality for testing actions.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">unittest</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">ost</span>
<span class="c"># set verbosity level here, is propagated to all others</span>
<span class="n">ost</span><span class="o">.</span><span class="n">PushVerbosityLevel</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<div class="viewcode-block" id="ActionTestCase"><a class="viewcode-back" href="../actions/index_dev.html#test_actions.ActionTestCase">[docs]</a><span class="k">class</span> <span class="nc">ActionTestCase</span><span class="p">(</span><span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Class to help developing actions. Comes with a lot of convenience wrappers</span>
<span class="sd"> around what should be tested and serves as a recorder for test calls...</span>
<span class="sd"> just for in two years when you come back to rewrite the whole action...</span>
<span class="sd"> While inheriting this class, :attr:`pm_action` needs to be defined.</span>
<span class="sd"> Otherwise the whole idea does not work.</span>
<span class="sd"> .. attribute:: pm_bin</span>
<span class="sd"> This is the path of the ``pm`` binary. Automatically set by calling</span>
<span class="sd"> :meth:`~ActionTestCase.__init__` inside the initialisation of your class.</span>
<span class="sd"> :type: :class:`str`</span>
<span class="sd"> .. attribute:: pm_action</span>
<span class="sd"> The action to be tested. Needs to be set by your initialisation routine,</span><span class="sd"> **after** calling :meth:`~ActionTestCase.__init__` from here. Skip the</span>
<span class="sd"> "pm-" in front of the action name.</span>
<span class="sd"> :type: :class:`str`</span>
<span class="sd"> """</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Convenience stuff for action testing.</span>
<span class="sd"> """</span>
<span class="c"># Determining the pm binary to be called. Going hard-coded is a bad</span>
<span class="c"># thing. But this is a unit test and we now where we are. Also be</span>
<span class="c"># putting it into the 'setUp' function, we only need to change it once,</span>
<span class="c"># if so. The other idea would be to use a config file which</span>
<span class="n">bld_dir</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">abspath</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">dirname</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">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pm_bin</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">bld_dir</span><span class="p">,</span> <span class="s">'stage'</span><span class="p">,</span> <span class="s">'bin'</span><span class="p">,</span> <span class="s">'pm'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pm_action</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="ActionTestCase.RunAction"><a class="viewcode-back" href="../actions/index_dev.html#test_actions.ActionTestCase.RunAction">[docs]</a> <span class="k">def</span> <span class="nf">RunAction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arguments</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Call an action, return the exit status (``$?`` shell variable). May be</span>
<span class="sd"> set to ``verbose`` to print the actions terminal output. The action to</span>
<span class="sd"> be executed needs to be stored in :attr:`pm_action` first.</span>
<span class="sd"> If in verbose mode, output to :file:`stdout` of the action will be</span>
<span class="sd"> printed first followed by :file:`stderr`.</span>
<span class="sd"> :param arguments: A list of arguments for the call.</span>
<span class="sd"> :type arguments: :class:`list`</span>
<span class="sd"> :param verbose: If ``True``, report output of the action.</span>
<span class="sd"> :type verbose: :class:`bool`</span>
<span class="sd"> :returns: The exit code of the action (:class:`int`).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">pm_action</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">"A 'pm_action' attribute has to be defined by "</span><span class="o">+</span>
<span class="s">"each subclass of 'test_actions.ActionTestCase'"</span><span class="p">)</span>
<span class="c"># run the action with arguments, wait for the job to finish and capture</span>
<span class="c"># output</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">pm_bin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pm_action</span><span class="p">]</span> <span class="o">+</span> <span class="n">arguments</span>
<span class="n">job</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
<span class="n">sout</span><span class="p">,</span> <span class="n">serr</span> <span class="o">=</span> <span class="n">job</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
<span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogScript</span><span class="p">(</span><span class="s">"stdout of '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">))</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogScript</span><span class="p">(</span><span class="s">"------"</span><span class="p">)</span>
<span class="n">lines</span> <span class="o">=</span> <span class="n">sout</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span>
<span class="k">for</span> <span class="n">out_l</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">:</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogScript</span><span class="p">(</span><span class="n">out_l</span><span class="p">)</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogScript</span><span class="p">(</span><span class="s">"------"</span><span class="p">)</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogError</span><span class="p">(</span><span class="s">"stderr of '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">))</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogError</span><span class="p">(</span><span class="s">"------"</span><span class="p">)</span>
<span class="n">lines</span> <span class="o">=</span> <span class="n">serr</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span>
<span class="k">for</span> <span class="n">err_l</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">:</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogError</span><span class="p">(</span><span class="n">err_l</span><span class="p">)</span>
<span class="n">ost</span><span class="o">.</span><span class="n">LogError</span><span class="p">(</span><span class="s">"------"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">job</span><span class="o">.</span><span class="n">returncode</span>
</div>
<div class="viewcode-block" id="ActionTestCase.RunExitStatusTest"><a class="viewcode-back" href="../actions/index_dev.html#test_actions.ActionTestCase.RunExitStatusTest">[docs]</a> <span class="k">def</span> <span class="nf">RunExitStatusTest</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exit_code</span><span class="p">,</span> <span class="n">arguments</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Run the action with given arguments and check the exit code.</span>
<span class="sd"> :param exit_code: The expected return code, ``$?`` in a shell.</span>
<span class="sd"> :type exit_code: :class:`int`</span>
<span class="sd"> :param arguments: A list of arguments for the call.</span>
<span class="sd"> :type arguments: :class:`list`</span>
<span class="sd"> :param verbose: If ``True``, report output of the action.</span>
<span class="sd"> :type verbose: :class:`bool`</span>
<span class="sd"> """</span>
<span class="n">exit_code_run</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">RunAction</span><span class="p">(</span><span class="n">arguments</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="n">verbose</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">exit_code</span><span class="p">,</span> <span class="n">exit_code_run</span><span class="p">,</span>
<span class="n">msg</span><span class="o">=</span><span class="s">"Exit code of '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="s">' '</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">pm_bin</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pm_action</span><span class="p">]</span><span class="o">+</span>
<span class="n">arguments</span><span class="p">)</span><span class="o">+</span>
<span class="s">"is supposed to be '</span><span class="si">%d</span><span class="s">' "</span> <span class="o">%</span> <span class="n">exit_code</span><span class="o">+</span>
<span class="s">"but returned as '</span><span class="si">%d</span><span class="s">'."</span> <span class="o">%</span> <span class="n">exit_code_run</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="ActionTestCase.testPMExists"><a class="viewcode-back" href="../actions/index_dev.html#test_actions.ActionTestCase.testPMExists">[docs]</a> <span class="k">def</span> <span class="nf">testPMExists</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is an internal test, executed when the source code of the test</span>
<span class="sd"> class is run as unit test. Verifies that :attr:`pm_bin` is an existing</span>
<span class="sd"> file (also complains if a directory is found instead).</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</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">isfile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pm_bin</span><span class="p">),</span> <span class="bp">True</span><span class="p">,</span>
<span class="n">msg</span><span class="o">=</span><span class="s">"Could not find 'pm' bin at '</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">pm_bin</span><span class="o">+</span>
<span class="s">"cannot proceed unit tests."</span><span class="p">)</span>
</div></div>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">ost</span> <span class="kn">import</span> <span class="n">testutils</span>
<span class="n">sys</span><span class="o">.</span><span class="n">dont_write_bytecode</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">testutils</span><span class="o">.</span><span class="n">RunTests</span><span class="p">()</span>
<span class="c"># LocalWords: attr meth ActionTestCase init str stdout stderr param bool</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<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="clearer"></div>
</div>
<div class="footer">
©2015, Bienchen.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
</div>
</body>
</html>