1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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"><</span><span class="keyword">void</span><span class="special">()>&</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"><</span><span class="keyword">void</span><span class="special">()>&</span> <span class="identifier">teardown</span> <span class="special">=</span> <span class="special">{});</span> 31 32<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Fx</span><span class="special">></span> 33 <span class="identifier">fixture</span><span class="special"><</span><span class="identifier">Fx</span><span class="special">>();</span> 34 35<span class="keyword">template</span> <span class="special"><</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">></span> 36 <span class="identifier">fixture</span><span class="special"><</span><span class="identifier">Fx</span><span class="special">>(</span><span class="keyword">const</span> <span class="identifier">Arg</span><span class="special">&</span> <span class="identifier">arg</span><span class="special">);</span> 37</pre> 38<p> 39 Decorator <code class="computeroutput"><span class="identifier">fixture</span></code> specifies 40 a pair of functions (like <code class="computeroutput"><span class="identifier">set_up</span></code> 41 and <code class="computeroutput"><span class="identifier">tear_down</span></code>) to be called 42 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 43 the suite execution starts -- and <code class="computeroutput"><span class="identifier">tear_down</span></code> 44 function is called once -- after the suite execution ends. It comes in 45 three forms. 46 </p> 47<p> 48 First expects two functions for set-up and tear-down (the second one can 49 be skipped). 50 </p> 51<p> 52 The second expects a <code class="computeroutput"><span class="identifier">DefaultConstructible</span></code> 53 class. Its default constructor will be used as set-up function and its 54 destructor as a tear-down function. 55 </p> 56<p> 57 The third form requires a class with one-argument public constructor. Argument 58 <code class="computeroutput"><span class="identifier">arg</span></code> is forwarded to the 59 constructor. 60 </p> 61<p> 62 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> 63 function implemented in the class, with the same declaration as described 64 in the <a class="link" href="../../tests_organization/fixtures/models.html" title="Fixture models">fixture 65 model</a>. If those member function are declared, they will be called 66 right after construction and just before destruction respectively. 67 </p> 68<div class="note"><table border="0" summary="Note"> 69<tr> 70<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> 71<th align="left">Note</th> 72</tr> 73<tr><td align="left" valign="top"><p> 74 There is no way to get access to the members of these fixtures from within 75 the test case or test suite. 76 </p></td></tr> 77</table></div> 78<h6> 79<a name="boost_test.utf_reference.test_org_reference.decorator_fixture.h0"></a> 80 <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: 81 decorator fixture</a> 82 </h6> 83<div class="informaltable"><table class="table"> 84<colgroup><col></colgroup> 85<thead><tr><th> 86 <p> 87 Code 88 </p> 89 </th></tr></thead> 90<tbody><tr><td> 91<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> 92<span class="preprocessor">#include</span> <span class="special"><</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">></span> 93<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> 94 95<span class="keyword">struct</span> <span class="identifier">Fx</span> 96<span class="special">{</span> 97 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">s</span><span class="special">;</span> 98 <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> 99 <span class="special">{</span> <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"set up "</span> <span class="special"><<</span> <span class="identifier">s</span><span class="special">);</span> <span class="special">}</span> 100 <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"><<</span> <span class="identifier">s</span><span class="special">);</span> <span class="special">}</span> 101<span class="special">};</span> 102 103<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> 104<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> 105 106<span class="identifier">BOOST_AUTO_TEST_SUITE</span><span class="special">(</span><span class="identifier">suite1</span><span class="special">,</span> 107 <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">fixture</span><span class="special"><</span><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="special">(</span><span class="string">"FX"</span><span class="special">))</span> 108 <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">fixture</span><span class="special"><</span><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="special">(</span><span class="string">"FX2"</span><span class="special">)))</span> 109 110 <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">(&</span><span class="identifier">setup</span><span class="special">,</span> <span class="special">&</span><span class="identifier">teardown</span><span class="special">))</span> 111 <span class="special">{</span> 112 <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"running test1"</span><span class="special">);</span> 113 <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> 114 <span class="special">}</span> 115 116 <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test2</span><span class="special">)</span> 117 <span class="special">{</span> 118 <span class="identifier">BOOST_TEST_MESSAGE</span><span class="special">(</span><span class="string">"running test2"</span><span class="special">);</span> 119 <span class="identifier">BOOST_TEST</span><span class="special">(</span><span class="keyword">true</span><span class="special">);</span> 120 <span class="special">}</span> 121 122<span class="identifier">BOOST_AUTO_TEST_SUITE_END</span><span class="special">()</span> 123</pre> 124 </td></tr></tbody> 125</table></div> 126<div class="informaltable"><table class="table"> 127<colgroup><col></colgroup> 128<thead><tr><th> 129 <p> 130 Output 131 </p> 132 </th></tr></thead> 133<tbody><tr><td> 134<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">></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> 135<span class="identifier">Running</span> <span class="number">2</span> <span class="identifier">test</span> <span class="identifier">cases</span><span class="special">...</span> 136<span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">FX</span> 137<span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">FX2</span> 138<span class="identifier">set</span> <span class="identifier">up</span> <span class="identifier">fun</span> 139<span class="identifier">running</span> <span class="identifier">test1</span> 140<span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">fun</span> 141<span class="identifier">running</span> <span class="identifier">test2</span> 142<span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">FX2</span> 143<span class="identifier">tear</span> <span class="identifier">down</span> <span class="identifier">FX</span> 144 145<span class="special">***</span> <span class="identifier">No</span> <span class="identifier">errors</span> <span class="identifier">detected</span> 146</pre> 147 </td></tr></tbody> 148</table></div> 149<p> 150 For other ways of using fixtures, see <a class="link" href="../../tests_organization/fixtures.html" title="Fixtures">here</a>. 151 </p> 152</div> 153<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 154<td align="left"></td> 155<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 156 Distributed under the Boost Software License, Version 1.0. (See accompanying 157 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>) 158 </p> 159</div></td> 160</tr></table> 161<hr> 162<div class="spirit-nav"> 163<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> 164</div> 165</body> 166</html> 167
