1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BOOST_<level>_EXCEPTION</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="../testing_tool_ref.html" title="Reference API for writing tests"> 9<link rel="prev" href="assertion_boost_level_throw.html" title="BOOST_<level>_THROW"> 10<link rel="next" href="assertion_boost_level_small.html" title="BOOST_<level>_SMALL"> 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="assertion_boost_level_throw.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="assertion_boost_level_small.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.testing_tool_ref.assertion_boost_level_exception"></a><a class="link" href="assertion_boost_level_exception.html" title="BOOST_<level>_EXCEPTION"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special"><</span><span class="identifier">level</span><span class="special">></span><span class="identifier">_EXCEPTION</span></code></a> 28</h4></div></div></div> 29<pre class="programlisting"><span class="identifier">BOOST_WARN_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span> 30<span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span> 31<span class="identifier">BOOST_REQUIRE_EXCEPTION</span><span class="special">(</span><span class="identifier">expression</span><span class="special">,</span> <span class="identifier">exception_type</span><span class="special">,</span> <span class="identifier">predicate</span><span class="special">);</span> 32</pre> 33<p> 34 As for <a class="link" href="assertion_boost_level_throw.html" title="BOOST_<level>_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special"><</span><span class="identifier">level</span><span class="special">></span><span class="identifier">_THROW</span></code></a>, these assertions validate 35 that <code class="computeroutput"><span class="identifier">expression</span></code> raises 36 an exception of the type specified by <code class="computeroutput"><span class="identifier">exception_type</span></code> 37 or any of its child type, with additional checks on the exception instance. 38 </p> 39<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 40<li class="listitem"> 41 If an expected exception is raised by <code class="computeroutput"><span class="identifier">expression</span></code>, 42 the instance of the exception is passed to <code class="computeroutput"><span class="identifier">predicate</span></code> 43 for further validation. 44 </li> 45<li class="listitem"> 46 It behaves like <a class="link" href="assertion_boost_level_throw.html" title="BOOST_<level>_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special"><</span><span class="identifier">level</span><span class="special">></span><span class="identifier">_THROW</span></code></a> if <code class="computeroutput"><span class="identifier">expression</span></code> 47 does not raise any exception, or an unrelated exception is raised. 48 </li> 49</ul></div> 50<p> 51 <code class="computeroutput"><span class="identifier">predicate</span></code> should be a unary 52 function accepting an instance of <code class="computeroutput"><span class="identifier">exception_type</span></code> 53 or any of its child, and that should return a boolean indicating a success 54 (<code class="computeroutput"><span class="keyword">true</span></code>) or a failure (<code class="computeroutput"><span class="keyword">false</span></code>). 55 </p> 56<div class="warning"><table border="0" summary="Warning"> 57<tr> 58<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../../doc/src/images/warning.png"></td> 59<th align="left">Warning</th> 60</tr> 61<tr><td align="left" valign="top"><p> 62 the assertion catches only the expected exceptions. 63 </p></td></tr> 64</table></div> 65<div class="tip"><table border="0" summary="Tip"> 66<tr> 67<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../../doc/src/images/tip.png"></td> 68<th align="left">Tip</th> 69</tr> 70<tr><td align="left" valign="top"><p> 71 It is possible to test for complex expressions with the use of constructs 72 such as <code class="computeroutput"><span class="keyword">do</span> <span class="special">{</span> 73 <span class="comment">/* ... */</span><span class="special">}</span> 74 <span class="keyword">while</span><span class="special">(</span><span class="number">0</span><span class="special">)</span></code> block. 75 </p></td></tr> 76</table></div> 77<p> 78 The example below checks that the exception carries the proper error code. 79 </p> 80<h6> 81<a name="boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.h0"></a> 82 <span class="phrase"><a name="boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.example_descr"></a></span><a class="link" href="assertion_boost_level_exception.html#boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception.example_descr">Example: 83 BOOST_<level>_EXCEPTION usage</a> 84 </h6> 85<div class="informaltable"><table class="table"> 86<colgroup><col></colgroup> 87<thead><tr><th> 88 <p> 89 Code 90 </p> 91 </th></tr></thead> 92<tbody><tr><td> 93<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">example</span> 94<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> 95 96<span class="keyword">struct</span> <span class="identifier">my_exception</span> 97<span class="special">{</span> 98 <span class="keyword">explicit</span> <span class="identifier">my_exception</span><span class="special">(</span> <span class="keyword">int</span> <span class="identifier">ec</span> <span class="special">=</span> <span class="number">0</span> <span class="special">)</span> <span class="special">:</span> <span class="identifier">m_error_code</span><span class="special">(</span> <span class="identifier">ec</span> <span class="special">)</span> 99 <span class="special">{}</span> 100 101 <span class="keyword">int</span> <span class="identifier">m_error_code</span><span class="special">;</span> 102<span class="special">};</span> 103 104<span class="keyword">bool</span> <span class="identifier">is_critical</span><span class="special">(</span> <span class="identifier">my_exception</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">ex</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">ex</span><span class="special">.</span><span class="identifier">m_error_code</span> <span class="special"><</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span> 105 106<span class="keyword">void</span> <span class="identifier">some_func</span><span class="special">(</span> <span class="keyword">int</span> <span class="identifier">i</span> <span class="special">)</span> <span class="special">{</span> <span class="keyword">if</span><span class="special">(</span> <span class="identifier">i</span><span class="special">>=</span><span class="number">0</span> <span class="special">)</span> <span class="keyword">throw</span> <span class="identifier">my_exception</span><span class="special">(</span> <span class="identifier">i</span> <span class="special">);</span> <span class="special">}</span> 107 108<span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span> <span class="identifier">test_exception_predicate</span> <span class="special">)</span> 109<span class="special">{</span> 110 <span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span> <span class="identifier">some_func</span><span class="special">(</span><span class="number">0</span><span class="special">),</span> <span class="identifier">my_exception</span><span class="special">,</span> <span class="special">!</span><span class="identifier">is_critical</span> <span class="special">);</span> 111 <span class="identifier">BOOST_CHECK_EXCEPTION</span><span class="special">(</span> <span class="identifier">some_func</span><span class="special">(</span><span class="number">1</span><span class="special">),</span> <span class="identifier">my_exception</span><span class="special">,</span> <span class="identifier">is_critical</span> <span class="special">);</span> 112<span class="special">}</span> 113</pre> 114 </td></tr></tbody> 115</table></div> 116<div class="informaltable"><table class="table"> 117<colgroup><col></colgroup> 118<thead><tr><th> 119 <p> 120 Output 121 </p> 122 </th></tr></thead> 123<tbody><tr><td> 124<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">></span> <span class="identifier">example</span> <span class="special">--</span><span class="identifier">log_level</span><span class="special">=</span><span class="identifier">success</span> 125<span class="identifier">Running</span> <span class="number">1</span> <span class="identifier">test</span> <span class="keyword">case</span><span class="special">...</span> 126<span class="identifier">Entering</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span> 127<span class="identifier">test</span><span class="special">:</span><span class="number">24</span><span class="special">:</span> <span class="identifier">Entering</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test_exception_predicate"</span> 128<span class="identifier">test</span><span class="special">:</span><span class="number">26</span><span class="special">:</span> <span class="identifier">info</span><span class="special">:</span> <span class="identifier">check</span> <span class="char">'exception "my_exception" raised as expected: validation on the raised exception through predicate "!is_critical"'</span> <span class="identifier">has</span> <span class="identifier">passed</span> 129<span class="identifier">test</span><span class="special">:</span><span class="number">27</span><span class="special">:</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test_exception_predicate"</span><span class="special">:</span> <span class="identifier">exception</span> <span class="string">"my_exception"</span> <span class="identifier">raised</span> <span class="identifier">as</span> <span class="identifier">expected</span><span class="special">:</span> <span class="identifier">validation</span> <span class="identifier">on</span> <span class="identifier">the</span> <span class="identifier">raised</span> <span class="identifier">exception</span> <span class="identifier">through</span> <span class="identifier">predicate</span> <span class="string">"is_critical"</span> 130<span class="identifier">test</span><span class="special">:</span><span class="number">24</span><span class="special">:</span> <span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="keyword">case</span> <span class="string">"test_exception_predicate"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">203u</span><span class="identifier">s</span> 131<span class="identifier">Leaving</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span><span class="special">;</span> <span class="identifier">testing</span> <span class="identifier">time</span><span class="special">:</span> <span class="number">271u</span><span class="identifier">s</span> 132 133<span class="special">***</span> <span class="number">1</span> <span class="identifier">failure</span> <span class="identifier">is</span> <span class="identifier">detected</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"example"</span> 134</pre> 135 </td></tr></tbody> 136</table></div> 137<p> 138 See also: 139 </p> 140<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 141<li class="listitem"> 142 <a class="link" href="assertion_boost_level_throw.html" title="BOOST_<level>_THROW"><code class="computeroutput"><span class="identifier">BOOST_</span><span class="special"><</span><span class="identifier">level</span><span class="special">></span><span class="identifier">_THROW</span></code></a> 143 </li> 144<li class="listitem"> 145 <a class="link" href="../../testing_tools/exception_correctness.html" title="Exception correctness">Exception 146 correctness</a> section 147 </li> 148</ul></div> 149</div> 150<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 151<td align="left"></td> 152<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 153 Distributed under the Boost Software License, Version 1.0. (See accompanying 154 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>) 155 </p> 156</div></td> 157</tr></table> 158<hr> 159<div class="spirit-nav"> 160<a accesskey="p" href="assertion_boost_level_throw.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="assertion_boost_level_small.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 161</div> 162</body> 163</html> 164
