decorator_fixture.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>fixture (decorator)</title>
  5. <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../../index.html" title="Boost.Test">
  8. <link rel="up" href="../test_org_reference.html" title="Tests declaration and organization">
  9. <link rel="prev" href="decorator_enable_if.html" title="enable_if (decorator)">
  10. <link rel="next" href="decorator_label.html" title="label (decorator)">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="decorator_enable_if.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_org_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="decorator_label.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  27. <a name="boost_test.utf_reference.test_org_reference.decorator_fixture"></a><a class="link" href="decorator_fixture.html" title="fixture (decorator)">fixture
  28. (decorator)</a>
  29. </h4></div></div></div>
  30. <pre class="programlisting"><span class="identifier">fixture</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">()&gt;&amp;</span> <span class="identifier">setup</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">()&gt;&amp;</span> <span class="identifier">teardown</span> <span class="special">=</span> <span class="special">{});</span>
  31. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Fx</span><span class="special">&gt;</span>
  32. <span class="identifier">fixture</span><span class="special">&lt;</span><span class="identifier">Fx</span><span class="special">&gt;();</span>
  33. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Fx</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Arg</span><span class="special">&gt;</span>
  34. <span class="identifier">fixture</span><span class="special">&lt;</span><span class="identifier">Fx</span><span class="special">&gt;(</span><span class="keyword">const</span> <span class="identifier">Arg</span><span class="special">&amp;</span> <span class="identifier">arg</span><span class="special">);</span>
  35. </pre>
  36. <p>
  37. Decorator <code class="computeroutput"><span class="identifier">fixture</span></code> specifies
  38. a pair of functions (like <code class="computeroutput"><span class="identifier">set_up</span></code>
  39. and <code class="computeroutput"><span class="identifier">tear_down</span></code>) to be called
  40. before and after the corresponding test unit. At the suite level the <code class="computeroutput"><span class="identifier">set_up</span></code> function is called once -- before
  41. the suite execution starts -- and <code class="computeroutput"><span class="identifier">tear_down</span></code>
  42. function is called once -- after the suite execution ends. It comes in
  43. three forms.
  44. </p>
  45. <p>
  46. First expects two functions for set-up and tear-down (the second one can
  47. be skipped).
  48. </p>
  49. <p>
  50. The second expects a <code class="computeroutput"><span class="identifier">DefaultConstructible</span></code>
  51. class. Its default constructor will be used as set-up function and its
  52. destructor as a tear-down function.
  53. </p>
  54. <p>
  55. The third form requires a class with one-argument public constructor. Argument
  56. <code class="computeroutput"><span class="identifier">arg</span></code> is forwarded to the
  57. constructor.
  58. </p>
  59. <p>
  60. For the second and third form, the framework detects if there is a <code class="computeroutput"><span class="identifier">setup</span></code> and/or <code class="computeroutput"><span class="identifier">teardown</span></code>
  61. function implemented in the class, with the same declaration as described
  62. in the <a class="link" href="../../tests_organization/fixtures/models.html" title="Fixture models">fixture
  63. model</a>. If those member function are declared, they will be called
  64. right after construction and just before destruction respectively.
  65. </p>
  66. <div class="note"><table border="0" summary="Note">
  67. <tr>
  68. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  69. <th align="left">Note</th>
  70. </tr>
  71. <tr><td align="left" valign="top"><p>
  72. There is no way to get access to the members of these fixtures from within
  73. the test case or test suite.
  74. </p></td></tr>
  75. </table></div>
  76. <h6>
  77. <a name="boost_test.utf_reference.test_org_reference.decorator_fixture.h0"></a>
  78. <span class="phrase"><a name="boost_test.utf_reference.test_org_reference.decorator_fixture.example_descr"></a></span><a class="link" href="decorator_fixture.html#boost_test.utf_reference.test_org_reference.decorator_fixture.example_descr">Example:
  79. decorator fixture</a>
  80. </h6>
  81. <div class="informaltable"><table class="table">
  82. <colgroup><col></colgroup>
  83. <thead><tr><th>
  84. <p>
  85. Code
  86. </p>
  87. </th></tr></thead>
  88. <tbody><tr><td>
  89. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_MODULE</span> <span class="identifier">decorator_12</span>
  90. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">included</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  91. <span class="keyword">namespace</span> <span class="identifier">utf</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">;</span>
  92. <span class="keyword">struct</span> <span class="identifier">Fx</span>
  93. <span class="special">{</span>
  94. <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">s</span><span class="special">;</span>
  95. <span class="identifier">Fx</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">s</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span> <span class="special">:</span> <span class="identifier">s</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span>
  96. <span class="special">{</span> <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"set up "</span> <span class="special">&lt;&lt;</span> <span class="identifier">s</span><span class="special">);</span> <span class="special">}</span>
  97. <span class="special">~</span><span class="identifier">Fx</span><span class="special">()</span> <span class="special">{</span> <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"tear down "</span> <span class="special">&lt;&lt;</span> <span class="identifier">s</span><span class="special">);</span> <span class="special">}</span>
  98. <span class="special">};</span>
  99. <span class="keyword">void</span> <span class="identifier">setup</span><span class="special">()</span> <span class="special">{</span> <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"set up fun"</span><span class="special">);</span> <span class="special">}</span>
  100. <span class="keyword">void</span> <span class="identifier">teardown</span><span class="special">()</span> <span class="special">{</span> <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"tear down fun"</span><span class="special">);</span> <span class="special">}</span>
  101. <span class="identifier">BOOST_AUTO_TEST_SUITE</span><span class="special">(</span><span class="identifier">suite1</span><span class="special">,</span>
  102. <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">fixture</span><span class="special">&lt;</span><span class="identifier">Fx</span><span class="special">&gt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="string">"FX"</span><span class="special">))</span>
  103. <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">fixture</span><span class="special">&lt;</span><span class="identifier">Fx</span><span class="special">&gt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">(</span><span class="string">"FX2"</span><span class="special">)))</span>
  104. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test1</span><span class="special">,</span> <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">fixture</span><span class="special">(&amp;</span><span class="identifier">setup</span><span class="special">,</span> <span class="special">&amp;</span><span class="identifier">teardown</span><span class="special">))</span>
  105. <span class="special">{</span>
  106. <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"running test1"</span><span class="special">);</span>
  107. <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span>
  108. <span class="special">}</span>
  109. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test2</span><span class="special">)</span>
  110. <span class="special">{</span>
  111. <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"running test2"</span><span class="special">);</span>
  112. <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span>
  113. <span class="special">}</span>
  114. <span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span>
  115. </pre>
  116. </td></tr></tbody>
  117. </table></div>
  118. <div class="informaltable"><table class="table">
  119. <colgroup><col></colgroup>
  120. <thead><tr><th>
  121. <p>
  122. Output
  123. </p>
  124. </th></tr></thead>
  125. <tbody><tr><td>
  126. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">&gt;</span> <span class="identifier">decorator_12</span> <span class="special">--</span><span class="identifier">log_level</span><span class="special">=</span><span class="identifier">message</span>
  127. <span class="identifier">Running</span> <span class="number">2</span> <span class="identifier">test</span> <span class="identifier">cases</span><span class="special">...</span>
  128. <span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">FX</span>
  129. <span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">FX2</span>
  130. <span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">fun</span>
  131. <span class="identifier">running</span> <span class="identifier">test1</span>
  132. <span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">fun</span>
  133. <span class="identifier">running</span> <span class="identifier">test2</span>
  134. <span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">FX2</span>
  135. <span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">FX</span>
  136. <span class="special">***</span> <span class="identifier">No</span> <span class="identifier">errors</span> <span class="identifier">detected</span>
  137. </pre>
  138. </td></tr></tbody>
  139. </table></div>
  140. <p>
  141. For other ways of using fixtures, see <a class="link" href="../../tests_organization/fixtures.html" title="Fixtures">here</a>.
  142. </p>
  143. </div>
  144. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  145. <td align="left"></td>
  146. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  147. contributors<p>
  148. Distributed under the Boost Software License, Version 1.0. (See accompanying
  149. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  150. </p>
  151. </div></td>
  152. </tr></table>
  153. <hr>
  154. <div class="spirit-nav">
  155. <a accesskey="p" href="decorator_enable_if.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_org_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="decorator_label.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  156. </div>
  157. </body>
  158. </html>