/usr/share/doc/libwreport-doc/apidocs/structwreport_1_1tests_1_1TestCase.html is in libwreport-doc 3.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | <!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.11"/>
<title>libwreport: wreport::tests::TestCase Struct 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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libwreport
 <span id="projectnumber">3.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacewreport.html">wreport</a></li><li class="navelem"><b>tests</b></li><li class="navelem"><a class="el" href="structwreport_1_1tests_1_1TestCase.html">TestCase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">wreport::tests::TestCase Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Test case collecting several test methods, and self-registering with the singleton instance of <a class="el" href="structwreport_1_1tests_1_1TestRegistry.html" title="Test registry. ">TestRegistry</a>.
<a href="structwreport_1_1tests_1_1TestCase.html#details">More...</a></p>
<p><code>#include <<a class="el" href="utils_2tests_8h_source.html">tests.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for wreport::tests::TestCase:</div>
<div class="dyncontent">
<div class="center">
<img src="structwreport_1_1tests_1_1TestCase.png" usemap="#wreport::tests::TestCase_map" alt=""/>
<map id="wreport::tests::TestCase_map" name="wreport::tests::TestCase_map">
<area href="classwreport_1_1tests_1_1FixtureTestCase.html" title="Test case that includes a fixture. " alt="wreport::tests::FixtureTestCase< FIXTURE >" shape="rect" coords="0,56,258,80"/>
</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:a6e50f8b18b7ec1eae51a0c1d76580487"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e50f8b18b7ec1eae51a0c1d76580487"></a>
 </td><td class="memItemRight" valign="bottom"><b>TestCase</b> (const std::string &<a class="el" href="structwreport_1_1tests_1_1TestCase.html#a605e252a6c52e7133a310dd69de8e69f">name</a>)</td></tr>
<tr class="separator:a6e50f8b18b7ec1eae51a0c1d76580487"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bd3eccab71a591ebbfaf47f91437948"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a2bd3eccab71a591ebbfaf47f91437948">register_tests</a> ()=0</td></tr>
<tr class="memdesc:a2bd3eccab71a591ebbfaf47f91437948"><td class="mdescLeft"> </td><td class="mdescRight">This will be called before running the test case, to populate it with its test methods. <a href="#a2bd3eccab71a591ebbfaf47f91437948">More...</a><br /></td></tr>
<tr class="separator:a2bd3eccab71a591ebbfaf47f91437948"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a427be729c15b85dd860ac01b9a4e565c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a427be729c15b85dd860ac01b9a4e565c"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a427be729c15b85dd860ac01b9a4e565c">setup</a> ()</td></tr>
<tr class="memdesc:a427be729c15b85dd860ac01b9a4e565c"><td class="mdescLeft"> </td><td class="mdescRight">Set up the test case before it is run. <br /></td></tr>
<tr class="separator:a427be729c15b85dd860ac01b9a4e565c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71d1eac71c5edcb2d9eb241add32aec9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71d1eac71c5edcb2d9eb241add32aec9"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a71d1eac71c5edcb2d9eb241add32aec9">teardown</a> ()</td></tr>
<tr class="memdesc:a71d1eac71c5edcb2d9eb241add32aec9"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after the test case is run. <br /></td></tr>
<tr class="separator:a71d1eac71c5edcb2d9eb241add32aec9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58db11369d146c9c5b7bfdfc5690acf3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58db11369d146c9c5b7bfdfc5690acf3"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a58db11369d146c9c5b7bfdfc5690acf3">method_setup</a> (<a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html">TestMethodResult</a> &)</td></tr>
<tr class="memdesc:a58db11369d146c9c5b7bfdfc5690acf3"><td class="mdescLeft"> </td><td class="mdescRight">Set up before the test method is run. <br /></td></tr>
<tr class="separator:a58db11369d146c9c5b7bfdfc5690acf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a9cf970f42e9cbe5d71824953bf7db9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a9cf970f42e9cbe5d71824953bf7db9"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a4a9cf970f42e9cbe5d71824953bf7db9">method_teardown</a> (<a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html">TestMethodResult</a> &)</td></tr>
<tr class="memdesc:a4a9cf970f42e9cbe5d71824953bf7db9"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after the test method is run. <br /></td></tr>
<tr class="separator:a4a9cf970f42e9cbe5d71824953bf7db9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24b6a1c453545a6b7244d9a9755d0375"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structwreport_1_1tests_1_1TestCaseResult.html">TestCaseResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a24b6a1c453545a6b7244d9a9755d0375">run_tests</a> (<a class="el" href="structwreport_1_1tests_1_1TestController.html">TestController</a> &controller)</td></tr>
<tr class="memdesc:a24b6a1c453545a6b7244d9a9755d0375"><td class="mdescLeft"> </td><td class="mdescRight">Call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a427be729c15b85dd860ac01b9a4e565c" title="Set up the test case before it is run. ">setup()</a>, run all the tests that have been registered, then call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a71d1eac71c5edcb2d9eb241add32aec9" title="Clean up after the test case is run. ">teardown()</a>. <a href="#a24b6a1c453545a6b7244d9a9755d0375">More...</a><br /></td></tr>
<tr class="separator:a24b6a1c453545a6b7244d9a9755d0375"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac74605e8a3f62c775042e4c0ff43794f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html">TestMethodResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#ac74605e8a3f62c775042e4c0ff43794f">run_test</a> (<a class="el" href="structwreport_1_1tests_1_1TestController.html">TestController</a> &controller, <a class="el" href="structwreport_1_1tests_1_1TestMethod.html">TestMethod</a> &method)</td></tr>
<tr class="memdesc:ac74605e8a3f62c775042e4c0ff43794f"><td class="mdescLeft"> </td><td class="mdescRight">Run a test method. <a href="#ac74605e8a3f62c775042e4c0ff43794f">More...</a><br /></td></tr>
<tr class="separator:ac74605e8a3f62c775042e4c0ff43794f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac50abce09d6c6c3dc843b9c8aae820f8"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac50abce09d6c6c3dc843b9c8aae820f8"></a>
template<typename... Args> </td></tr>
<tr class="memitem:ac50abce09d6c6c3dc843b9c8aae820f8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#ac50abce09d6c6c3dc843b9c8aae820f8">add_method</a> (const std::string &<a class="el" href="structwreport_1_1tests_1_1TestCase.html#a605e252a6c52e7133a310dd69de8e69f">name</a>, std::function< void()> test_function)</td></tr>
<tr class="memdesc:ac50abce09d6c6c3dc843b9c8aae820f8"><td class="mdescLeft"> </td><td class="mdescRight">Register a new test method. <br /></td></tr>
<tr class="separator:ac50abce09d6c6c3dc843b9c8aae820f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad78cd3b963ce9021347de43e80f95025"><td class="memTemplParams" colspan="2"><a class="anchor" id="ad78cd3b963ce9021347de43e80f95025"></a>
template<typename... Args> </td></tr>
<tr class="memitem:ad78cd3b963ce9021347de43e80f95025"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#ad78cd3b963ce9021347de43e80f95025">add_method</a> (const std::string &<a class="el" href="structwreport_1_1tests_1_1TestCase.html#a605e252a6c52e7133a310dd69de8e69f">name</a>, std::function< void()> test_function, Args &&...args)</td></tr>
<tr class="memdesc:ad78cd3b963ce9021347de43e80f95025"><td class="mdescLeft"> </td><td class="mdescRight">Register a new test method. <br /></td></tr>
<tr class="separator:ad78cd3b963ce9021347de43e80f95025"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc888f612e6390cabcb25a512dde609e"><td class="memTemplParams" colspan="2">template<typename FUNC , typename... Args> </td></tr>
<tr class="memitem:afc888f612e6390cabcb25a512dde609e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#afc888f612e6390cabcb25a512dde609e">add_method</a> (const std::string &<a class="el" href="structwreport_1_1tests_1_1TestCase.html#a605e252a6c52e7133a310dd69de8e69f">name</a>, FUNC test_function, Args &&...args)</td></tr>
<tr class="memdesc:afc888f612e6390cabcb25a512dde609e"><td class="mdescLeft"> </td><td class="mdescRight">Register a new test metheod, with arguments. <a href="#afc888f612e6390cabcb25a512dde609e">More...</a><br /></td></tr>
<tr class="separator:afc888f612e6390cabcb25a512dde609e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a605e252a6c52e7133a310dd69de8e69f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a605e252a6c52e7133a310dd69de8e69f"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a605e252a6c52e7133a310dd69de8e69f">name</a></td></tr>
<tr class="memdesc:a605e252a6c52e7133a310dd69de8e69f"><td class="mdescLeft"> </td><td class="mdescRight">Name of the test case. <br /></td></tr>
<tr class="separator:a605e252a6c52e7133a310dd69de8e69f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c2d6ec96cd366b92375af676b18a6dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c2d6ec96cd366b92375af676b18a6dc"></a>
std::vector< <a class="el" href="structwreport_1_1tests_1_1TestMethod.html">TestMethod</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1tests_1_1TestCase.html#a2c2d6ec96cd366b92375af676b18a6dc">methods</a></td></tr>
<tr class="memdesc:a2c2d6ec96cd366b92375af676b18a6dc"><td class="mdescLeft"> </td><td class="mdescRight">All registered test methods. <br /></td></tr>
<tr class="separator:a2c2d6ec96cd366b92375af676b18a6dc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Test case collecting several test methods, and self-registering with the singleton instance of <a class="el" href="structwreport_1_1tests_1_1TestRegistry.html" title="Test registry. ">TestRegistry</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afc888f612e6390cabcb25a512dde609e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename FUNC , typename... Args> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void wreport::tests::TestCase::add_method </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FUNC </td>
<td class="paramname"><em>test_function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args &&... </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a new test metheod, with arguments. </p>
<p>Any extra arguments to the function will be passed to the test method. </p>
</div>
</div>
<a class="anchor" id="a2bd3eccab71a591ebbfaf47f91437948"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wreport::tests::TestCase::register_tests </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This will be called before running the test case, to populate it with its test methods. </p>
<p>This needs to be reimplemented with a function that will mostly be a sequence of calls to <a class="el" href="structwreport_1_1tests_1_1TestCase.html#ac50abce09d6c6c3dc843b9c8aae820f8" title="Register a new test method. ">add_method()</a>. </p>
</div>
</div>
<a class="anchor" id="ac74605e8a3f62c775042e4c0ff43794f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html">TestMethodResult</a> wreport::tests::TestCase::run_test </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structwreport_1_1tests_1_1TestController.html">TestController</a> & </td>
<td class="paramname"><em>controller</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structwreport_1_1tests_1_1TestMethod.html">TestMethod</a> & </td>
<td class="paramname"><em>method</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Run a test method. </p>
<p>Call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a58db11369d146c9c5b7bfdfc5690acf3" title="Set up before the test method is run. ">method_setup()</a>, run all the tests that have been registered, then call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a4a9cf970f42e9cbe5d71824953bf7db9" title="Clean up after the test method is run. ">method_teardown()</a>.</p>
<p>Exceptions thrown by the test method are caught and reported in <a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html" title="Result of running a test method. ">TestMethodResult</a>.</p>
<p>Exceptions in <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a58db11369d146c9c5b7bfdfc5690acf3" title="Set up before the test method is run. ">method_setup()</a> and <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a4a9cf970f42e9cbe5d71824953bf7db9" title="Clean up after the test method is run. ">method_teardown()</a> are caught and reported in <a class="el" href="structwreport_1_1tests_1_1TestMethodResult.html" title="Result of running a test method. ">TestMethodResult</a>. </p>
</div>
</div>
<a class="anchor" id="a24b6a1c453545a6b7244d9a9755d0375"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structwreport_1_1tests_1_1TestCaseResult.html">TestCaseResult</a> wreport::tests::TestCase::run_tests </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structwreport_1_1tests_1_1TestController.html">TestController</a> & </td>
<td class="paramname"><em>controller</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a427be729c15b85dd860ac01b9a4e565c" title="Set up the test case before it is run. ">setup()</a>, run all the tests that have been registered, then call <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a71d1eac71c5edcb2d9eb241add32aec9" title="Clean up after the test case is run. ">teardown()</a>. </p>
<p>Exceptions in <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a427be729c15b85dd860ac01b9a4e565c" title="Set up the test case before it is run. ">setup()</a> and <a class="el" href="structwreport_1_1tests_1_1TestCase.html#a71d1eac71c5edcb2d9eb241add32aec9" title="Clean up after the test case is run. ">teardown()</a> are caught and reported in <a class="el" href="structwreport_1_1tests_1_1TestCaseResult.html" title="Result of running a whole test case. ">TestCaseResult</a>. Test are run using <a class="el" href="structwreport_1_1tests_1_1TestCase.html#ac74605e8a3f62c775042e4c0ff43794f" title="Run a test method. ">run_test()</a>. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="utils_2tests_8h_source.html">utils/tests.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|