dash-docs/en/doxygen/html/classrpc-tests_1_1RPCCoverage.html

287 lines
14 KiB
HTML

<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: rpc-tests.RPCCoverage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classrpc-tests_1_1RPCCoverage.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="classrpc-tests_1_1RPCCoverage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rpc-tests.RPCCoverage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for rpc-tests.RPCCoverage:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classrpc-tests_1_1RPCCoverage.png" usemap="#rpc-tests.RPCCoverage_map" alt=""/>
<map id="rpc-tests.RPCCoverage_map" name="rpc-tests.RPCCoverage_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9e388d2b87993d7419b7ce6f3949d175"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#a9e388d2b87993d7419b7ce6f3949d175">__init__</a> (self)</td></tr>
<tr class="separator:a9e388d2b87993d7419b7ce6f3949d175"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf651b4f221dd910e2ae9cc0fc37477d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#abf651b4f221dd910e2ae9cc0fc37477d">report_rpc_coverage</a> (self)</td></tr>
<tr class="separator:abf651b4f221dd910e2ae9cc0fc37477d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae30232eeb6ca50e0e05ceb8a6d5220df"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#ae30232eeb6ca50e0e05ceb8a6d5220df">cleanup</a> (self)</td></tr>
<tr class="separator:ae30232eeb6ca50e0e05ceb8a6d5220df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a249f6aac08f7f7668fecdf92a99994ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#a249f6aac08f7f7668fecdf92a99994ed">dir</a></td></tr>
<tr class="separator:a249f6aac08f7f7668fecdf92a99994ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeb110e6db72d41dd16b815daf9d395c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#abeb110e6db72d41dd16b815daf9d395c">flag</a></td></tr>
<tr class="separator:abeb110e6db72d41dd16b815daf9d395c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a1f4a43d549a344715a52e3a87266f16d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrpc-tests_1_1RPCCoverage.html#a1f4a43d549a344715a52e3a87266f16d">_get_uncovered_rpc_commands</a> (self)</td></tr>
<tr class="separator:a1f4a43d549a344715a52e3a87266f16d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Coverage reporting utilities for pull-tester.
Coverage calculation works by having each test script subprocess write
coverage files into a particular directory. These files contain the RPC
commands invoked during testing, as well as a complete listing of RPC
commands per `bitcoin-cli help` (`rpc_interface.txt`).
After all tests complete, the commands run are combined and diff'd against
the complete list to calculate uncovered RPC commands.
See also: qa/rpc-tests/test_framework/coverage.py</pre>
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00210">210</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9e388d2b87993d7419b7ce6f3949d175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e388d2b87993d7419b7ce6f3949d175">&#9670;&nbsp;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def rpc-tests.RPCCoverage.__init__ </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00225">225</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1f4a43d549a344715a52e3a87266f16d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f4a43d549a344715a52e3a87266f16d">&#9670;&nbsp;</a></span>_get_uncovered_rpc_commands()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def rpc-tests.RPCCoverage._get_uncovered_rpc_commands </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return a set of currently untested RPC commands.</pre>
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00245">245</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
<p class="reference">Referenced by <a class="el" href="rpc-tests_8py_source.html#l00229">rpc-tests.RPCCoverage.report_rpc_coverage()</a>.</p>
</div>
</div>
<a id="ae30232eeb6ca50e0e05ceb8a6d5220df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae30232eeb6ca50e0e05ceb8a6d5220df">&#9670;&nbsp;</a></span>cleanup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def rpc-tests.RPCCoverage.cleanup </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00242">242</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
</div>
</div>
<a id="abf651b4f221dd910e2ae9cc0fc37477d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf651b4f221dd910e2ae9cc0fc37477d">&#9670;&nbsp;</a></span>report_rpc_coverage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def rpc-tests.RPCCoverage.report_rpc_coverage </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Print out RPC commands that were unexercised by tests.</pre>
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00229">229</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a249f6aac08f7f7668fecdf92a99994ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a249f6aac08f7f7668fecdf92a99994ed">&#9670;&nbsp;</a></span>dir</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rpc-tests.RPCCoverage.dir</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00226">226</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
<p class="reference">Referenced by <a class="el" href="rpc-tests_8py_source.html#l00245">rpc-tests.RPCCoverage._get_uncovered_rpc_commands()</a>, and <a class="el" href="rpc-tests_8py_source.html#l00242">rpc-tests.RPCCoverage.cleanup()</a>.</p>
</div>
</div>
<a id="abeb110e6db72d41dd16b815daf9d395c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeb110e6db72d41dd16b815daf9d395c">&#9670;&nbsp;</a></span>flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rpc-tests.RPCCoverage.flag</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc-tests_8py_source.html#l00227">227</a> of file <a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>qa/pull-tester/<a class="el" href="rpc-tests_8py_source.html">rpc-tests.py</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacerpc-tests.html">rpc-tests</a></li><li class="navelem"><a class="el" href="classrpc-tests_1_1RPCCoverage.html">RPCCoverage</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:14 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>