Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59
Tree: 37313e0645
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
test
/
doc
/
html
/
boost_test
/
tests_organization
/
decorators
/
explicit_decorator_declaration.html

explicit_decorator_declaration.html 19 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Explicit decorator declaration</title>
    5. 

  5. <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="../../../index.html" title="Boost.Test">
    8. 

  8. <link rel="up" href="../decorators.html" title="Decorators">
    9. 

  9. <link rel="prev" href="suite_level_decorators.html" title="Suite-level decorators">
    10. 

  10. <link rel="next" href="../fixtures.html" title="Fixtures">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="suite_level_decorators.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../decorators.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="../fixtures.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h4 class="title">
    27. 

  27. <a name="boost_test.tests_organization.decorators.explicit_decorator_declaration"></a><a class="link" href="explicit_decorator_declaration.html" title="Explicit decorator declaration">Explicit
    28. 

  28.         decorator declaration</a>
    29. 

  29. </h4></div></div></div>
    30. 

  30. <p>
    31. 

  31.           There is another way of associating a decorator set with test units. Macro
    32. 

  32.           <a class="link" href="../../utf_reference/test_org_reference/test_org_boost_test_decorator.html" title="BOOST_TEST_DECORATOR"><code class="computeroutput"><span class="identifier">BOOST_TEST_DECORATOR</span></code></a> indicates
    33. 

  33.           that its set of decorators is to be applied to the test unit or <span class="emphasis"><em>test
    34. 

  34.           case sequence</em></span> that immediately follows the declaration.
    35. 

  35.         </p>
    36. 

  36. <h6>
    37. 

  37. <a name="boost_test.tests_organization.decorators.explicit_decorator_declaration.h0"></a>
    38. 

  38.           <span class="phrase"><a name="boost_test.tests_organization.decorators.explicit_decorator_declaration.example_descr"></a></span><a class="link" href="explicit_decorator_declaration.html#boost_test.tests_organization.decorators.explicit_decorator_declaration.example_descr">Example:
    39. 

  39.           explicit decorator declaration</a>
    40. 

  40.         </h6>
    41. 

  41. <div class="informaltable"><table class="table">
    42. 

  42. <colgroup><col></colgroup>
    43. 

  43. <thead><tr><th>
    44. 

  44.                   <p>
    45. 

  45.                     Code
    46. 

  46.                   </p>
    47. 

  47.                 </th></tr></thead>
    48. 

  48. <tbody><tr><td>
    49. 

  49. <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_00</span>
    50. 

  50. <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>
    51. 

  51. <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">data</span><span class="special">/</span><span class="identifier">test_case</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
    52. 

  52. 

  53. <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>
    54. 

  54. <span class="keyword">namespace</span> <span class="identifier">data</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">data</span><span class="special">;</span>
    55. 

  55. 

  56. <span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">description</span><span class="special">(</span><span class="string">"with description"</span><span class="special">))</span>
    57. 

  57. <span class="identifier">BOOST_DATA_TEST_CASE</span><span class="special">(</span><span class="identifier">test_1</span><span class="special">,</span> <span class="identifier">data</span><span class="special">::</span><span class="identifier">xrange</span><span class="special">(</span><span class="number">4</span><span class="special">))</span>
    58. 

  58. <span class="special">{</span>
    59. 

  59.     <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="identifier">sample</span> <span class="special">&gt;=</span> <span class="number">0</span><span class="special">);</span>
    60. 

  60. <span class="special">}</span>
    61. 

  61. </pre>
    62. 

  62.                 </td></tr></tbody>
    63. 

  63. </table></div>
    64. 

  64. <div class="informaltable"><table class="table">
    65. 

  65. <colgroup><col></colgroup>
    66. 

  66. <thead><tr><th>
    67. 

  67.                   <p>
    68. 

  68.                     Output
    69. 

  69.                   </p>
    70. 

  70.                 </th></tr></thead>
    71. 

  71. <tbody><tr><td>
    72. 

  72. <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_00</span> <span class="special">--</span><span class="identifier">list_content</span>
    73. 

  73. <span class="identifier">test_1</span><span class="special">*:</span> <span class="identifier">with</span> <span class="identifier">description</span>
    74. 

  74. <span class="identifier">test_1</span><span class="special">*:</span> <span class="identifier">with</span> <span class="identifier">description</span>
    75. 

  75. <span class="identifier">test_1</span><span class="special">*:</span> <span class="identifier">with</span> <span class="identifier">description</span>
    76. 

  76. <span class="identifier">test_1</span><span class="special">*:</span> <span class="identifier">with</span> <span class="identifier">description</span>
    77. 

  77. </pre>
    78. 

  78.                 </td></tr></tbody>
    79. 

  79. </table></div>
    80. 

  80. <p>
    81. 

  81.           In the above example a decorator is applied to a <a class="link" href="../test_cases/test_case_generation.html" title="Data-driven test cases">data-driven
    82. 

  82.           test case</a>. Macro <a class="link" href="../../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE</span></code></a> cannot take
    83. 

  83.           the decorator set as one of its arguments, therefore the explicit decorator
    84. 

  84.           declaration is used. Macro <a class="link" href="../../utf_reference/test_org_reference/test_org_boost_test_dataset.html" title="BOOST_DATA_TEST_CASE"><code class="computeroutput"><span class="identifier">BOOST_DATA_TEST_CASE</span></code></a> generates
    85. 

  85.           a sequence of 4 test cases. The decorator set is applied to each of them.
    86. 

  86.         </p>
    87. 

  87. <p>
    88. 

  88.           Another use case for the explicit decorator declaration is when you intend
    89. 

  89.           for your test program to compile also on compilers without variadic macros.
    90. 

  90.           In this case it is recommended that you use the more verbose syntax. It
    91. 

  91.           is summarized in the following table:
    92. 

  92.         </p>
    93. 

  93. <div class="informaltable"><table class="table">
    94. 

  94. <colgroup>
    95. 

  95. <col>
    96. 

  96. <col>
    97. 

  97. <col>
    98. 

  98. </colgroup>
    99. 

  99. <thead><tr>
    100. 

  100. <th>
    101. 

  101.                   <p>
    102. 

  102.                     Test unit to register
    103. 

  103.                   </p>
    104. 

  104.                 </th>
    105. 

  105. <th>
    106. 

  106.                   <p>
    107. 

  107.                     Concise syntax
    108. 

  108.                   </p>
    109. 

  109.                 </th>
    110. 

  110. <th>
    111. 

  111.                   <p>
    112. 

  112.                     Universal syntax
    113. 

  113.                   </p>
    114. 

  114.                 </th>
    115. 

  115. </tr></thead>
    116. 

  116. <tbody>
    117. 

  117. <tr>
    118. 

  118. <td>
    119. 

  119.                   <p>
    120. 

  120.                     test case
    121. 

  121.                   </p>
    122. 

  122.                 </td>
    123. 

  123. <td>
    124. 

  124. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="special">*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    125. 

  125. <span class="special">{</span>
    126. 

  126.   <span class="comment">// assertions</span>
    127. 

  127. <span class="special">}</span>
    128. 

  128. </pre>
    129. 

  129.                 </td>
    130. 

  130. <td>
    131. 

  131. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    132. 

  132. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">)</span>
    133. 

  133. <span class="special">{</span>
    134. 

  134.   <span class="comment">// assertions</span>
    135. 

  135. <span class="special">}</span>
    136. 

  136. </pre>
    137. 

  137.                 </td>
    138. 

  138. </tr>
    139. 

  139. <tr>
    140. 

  140. <td>
    141. 

  141.                   <p>
    142. 

  142.                     test case with fixture
    143. 

  143.                   </p>
    144. 

  144.                 </td>
    145. 

  145. <td>
    146. 

  146. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_FIXTURE_TEST_CASE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="identifier">Fx</span><span class="special">,</span> <span class="special">*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    147. 

  147. <span class="special">{</span>
    148. 

  148.   <span class="comment">// assertions</span>
    149. 

  149. <span class="special">}</span>
    150. 

  150. </pre>
    151. 

  151.                 </td>
    152. 

  152. <td>
    153. 

  153. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    154. 

  154. <span class="identifier">BOOST_FIXTURE_TEST_CASE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="identifier">Fx</span><span class="special">)</span>
    155. 

  155. <span class="special">{</span>
    156. 

  156.   <span class="comment">// assertions</span>
    157. 

  157. <span class="special">}</span>
    158. 

  158. </pre>
    159. 

  159.                 </td>
    160. 

  160. </tr>
    161. 

  161. <tr>
    162. 

  162. <td>
    163. 

  163.                   <p>
    164. 

  164.                     test suite
    165. 

  165.                   </p>
    166. 

  166.                 </td>
    167. 

  167. <td>
    168. 

  168. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_AUTO_TEST_SUITE</span><span class="special">(</span><span class="identifier">test_suite</span><span class="special">,</span> <span class="special">*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    169. 

  169. 

  170.   <span class="comment">// test units</span>
    171. 

  171. 

  172. <span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span>
    173. 

  173. </pre>
    174. 

  174.                 </td>
    175. 

  175. <td>
    176. 

  176. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    177. 

  177. <span class="identifier">BOOST_AUTO_TEST_SUITE</span><span class="special">(</span><span class="identifier">test_suite</span><span class="special">)</span>
    178. 

  178. 

  179.   <span class="comment">// test units</span>
    180. 

  180. 

  181. <span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span>
    182. 

  182. </pre>
    183. 

  183.                 </td>
    184. 

  184. </tr>
    185. 

  185. <tr>
    186. 

  186. <td>
    187. 

  187.                   <p>
    188. 

  188.                     test suite with fixture
    189. 

  189.                   </p>
    190. 

  190.                 </td>
    191. 

  191. <td>
    192. 

  192. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_FIXTURE_TEST_SUITE</span><span class="special">(</span><span class="identifier">test_suite</span><span class="special">,</span> <span class="identifier">Fx</span><span class="special">,</span> <span class="special">*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    193. 

  193. 

  194.   <span class="comment">// test units</span>
    195. 

  195. 

  196. <span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span>
    197. 

  197. </pre>
    198. 

  198.                 </td>
    199. 

  199. <td>
    200. 

  200. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    201. 

  201. <span class="identifier">BOOST_FIXTURE_TEST_SUITE</span><span class="special">(</span><span class="identifier">test_suite</span><span class="special">,</span> <span class="identifier">Fx</span><span class="special">)</span>
    202. 

  202. 

  203.   <span class="comment">// test units</span>
    204. 

  204. 

  205. <span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span>
    206. 

  206. </pre>
    207. 

  207.                 </td>
    208. 

  208. </tr>
    209. 

  209. <tr>
    210. 

  210. <td>
    211. 

  211.                   <p>
    212. 

  212.                     data-driven test case
    213. 

  213.                   </p>
    214. 

  214.                 </td>
    215. 

  215. <td>
    216. 

  216. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="comment">// not doable</span>
    217. 

  217. </pre>
    218. 

  218.                 </td>
    219. 

  219. <td>
    220. 

  220. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    221. 

  221. <span class="identifier">BOOST_DATA_TEST_CASE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="identifier">data</span><span class="special">,</span> <span class="identifier">var</span><span class="special">)</span>
    222. 

  222. <span class="special">{</span>
    223. 

  223.   <span class="comment">// assertions</span>
    224. 

  224. <span class="special">}</span>
    225. 

  225. </pre>
    226. 

  226.                 </td>
    227. 

  227. </tr>
    228. 

  228. <tr>
    229. 

  229. <td>
    230. 

  230.                   <p>
    231. 

  231.                     test case template
    232. 

  232.                   </p>
    233. 

  233.                 </td>
    234. 

  234. <td>
    235. 

  235. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="comment">// not doable</span>
    236. 

  236. </pre>
    237. 

  237.                 </td>
    238. 

  238. <td>
    239. 

  239. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    240. 

  240. <span class="identifier">BOOST_AUTO_TEST_CASE_TEMPLATE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">type_list</span><span class="special">)</span>
    241. 

  241. <span class="special">{</span>
    242. 

  242.   <span class="comment">// assertions</span>
    243. 

  243. <span class="special">}</span>
    244. 

  244. </pre>
    245. 

  245.                 </td>
    246. 

  246. </tr>
    247. 

  247. <tr>
    248. 

  248. <td>
    249. 

  249.                   <p>
    250. 

  250.                     test case template with fixture
    251. 

  251.                   </p>
    252. 

  252.                 </td>
    253. 

  253. <td>
    254. 

  254. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="comment">// not doable</span>
    255. 

  255. </pre>
    256. 

  256.                 </td>
    257. 

  257. <td>
    258. 

  258. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_TEST_DECORATOR</span><span class="special">(*</span><span class="identifier">decor1</span><span class="special">()</span> <span class="special">*</span><span class="identifier">decor2</span><span class="special">())</span>
    259. 

  259. <span class="identifier">BOOST_FIXTURE_TEST_CASE_TEMPLATE</span><span class="special">(</span><span class="identifier">test_case</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">type_list</span><span class="special">,</span> <span class="identifier">Fx</span><span class="special">)</span>
    260. 

  260. <span class="special">{</span>
    261. 

  261.   <span class="comment">// assertions</span>
    262. 

  262. <span class="special">}</span>
    263. 

  263. </pre>
    264. 

  264.                 </td>
    265. 

  265. </tr>
    266. 

  266. </tbody>
    267. 

  267. </table></div>
    268. 

  268. <p>
    269. 

  269.           Throughout the reminder of this documentation we use only the concise syntax.
    270. 

  270.         </p>
    271. 

  271. </div>
    272. 

  272. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    273. 

  273. <td align="left"></td>
    274. 

  274. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
    275. 

  275.       contributors<p>
    276. 

  276.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    277. 

  277.         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>)
    278. 

  278.       </p>
    279. 

  279. </div></td>
    280. 

  280. </tr></table>
    281. 

  281. <hr>
    282. 

  282. <div class="spirit-nav">
    283. 

  283. <a accesskey="p" href="suite_level_decorators.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../decorators.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="../fixtures.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
    284. 

  284. </div>
    285. 

  285. </body>
    286. 

  286. </html>
    287.