mirror of
https://github.com/boostorg/test.git
synced 2026-02-02 21:22:10 +00:00
520 lines
22 KiB
HTML
520 lines
22 KiB
HTML
<html>
|
||
|
||
<head>
|
||
<title>Test Tools</title>
|
||
<script language="javascript">var viso_path="js-lib"</script>
|
||
<script language="javascript" src="js-lib/core.js" > </script>
|
||
|
||
<script language="JavaScript">
|
||
JS.include( "btl.js" );
|
||
</script>
|
||
|
||
<script>put_screen_style();</script>
|
||
<link rel="stylesheet" type="text/css" href="style/btl_print.css" media="print" />
|
||
|
||
<meta http-equiv="Content-Language" content="en-us" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||
|
||
<style>
|
||
H4
|
||
{
|
||
margin: 0px;
|
||
}
|
||
</style>
|
||
</head>
|
||
|
||
<body onload="btl_menu_init()">
|
||
<div align="center">
|
||
<table class="body-table" cellspacing="3" >
|
||
<tr>
|
||
<td id="body">
|
||
|
||
<script language="Javascript">btl_header();</script>
|
||
|
||
<h1 align="center">Boost Test Library: Test Tools</h1>
|
||
<p class="page-toc">
|
||
<a href="#Introduction">Introduction</a><br>
|
||
<a href="#Benifits">Benefits</a><br>
|
||
<a href="#Specification">Specification</a><br></p>
|
||
<p class="page-toc-indented">
|
||
<a href="#BOOST_CHECKPOINT">BOOST_CHECKPOINT</a><br>
|
||
<a href="#BOOST_WARN">BOOST_WARN</a><br>
|
||
<a href="#BOOST_CHECK">BOOST_CHECK</a><br>
|
||
<a href="#BOOST_CHECK_EQUAL">BOOST_CHECK_EQUAL</a><br>
|
||
<a href="#BOOST_CHECK_CLOSE_tolerance">BOOST_CHECK_CLOSE</a><br>
|
||
<a href="#BOOST_REQUIRE">BOOST_REQUIRE</a><br>
|
||
<a href="#BOOST_MESSAGE">BOOST_MESSAGE</a><br>
|
||
<a href="#BOOST_CHECK_MESSAGE">BOOST_WARN_MESSAGE</a><br>
|
||
<a href="#BOOST_CHECK_MESSAGE">BOOST_CHECK_MESSAGE</a><br>
|
||
<a href="#BOOST_CHECK_MESSAGE">BOOST_REQUIRE_MESSAGE</a><br>
|
||
<a href="#BOOST_CHECK_PREDICATE">BOOST_CHECK_PREDICATE</a><br>
|
||
<a href="#BOOST_REQUIRE_PREDICATE">BOOST_REQUIRE_PREDICATE</a><br>
|
||
<a href="#BOOST_ERROR">BOOST_ERROR</a><br>
|
||
<a href="#BOOST_FAIL">BOOST_FAIL</a><br>
|
||
<a href="#BOOST_CHECK_THROW">BOOST_CHECK_THROW</a><br>
|
||
<a href="#BOOST_CHECK_EQUAL_COLLECTIONS">BOOST_CHECK_EQUAL_COLLECTIONS</a><br>
|
||
<a href="#BOOST_IS_DEFINED">BOOST_IS_DEFINED</a><br>
|
||
<a href="output_test_stream.htm">output_test_stream</a><br>
|
||
<a href="#Deprecated">Depricated Boost.Test v1 test tools</a>
|
||
</p>
|
||
<p class="page-toc">
|
||
<a href="#Examples">Example and Test Programs</a><br>
|
||
<a href="#Design">Design</a>
|
||
</p>
|
||
|
||
<h2><a name="Introduction">Introduction</a></h2>
|
||
|
||
<p class="1-line-indented"> Boost Test Library's Test Tools supply a toolbox to ease a creation and a maintenance of test programs.
|
||
The toolbox supplied in a form of macros and function declarations. While the functions can be called directly,
|
||
the usual way to use Test Tools is via convenience macros. All macros arguments are calculated once, so it's safe to
|
||
pass complex expressions in their place. All macros provide an error location: a
|
||
file name and a line number. Boost Test Library's Test Tools are intended for test code rather than library or
|
||
production code, where throwing exceptions, using assert(), or BOOST_STATIC_ASSERT() may be more suitable ways to
|
||
detect and report errors.
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
To use the Test Tools you need to link with either the <a href="prg_exec_monitor.htm">Program Execution Monitor</a> or the
|
||
<a href="unit_test_framework.htm">Unit Test Framework</a>.
|
||
</p>
|
||
|
||
<h2><a name="Benifits">Benefits</a></h2>
|
||
<p class="1-line-indented">Using of Test Tools simplify writing of test program and provide a uniform
|
||
error reporting mechanism.</p>
|
||
|
||
<h2><a name="Specification">Specification</a></h2>
|
||
|
||
<h3><a name="BOOST_CHECKPOINT">BOOST_CHECKPOINT</a>( message )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to mark a test flow with a check
|
||
points. The checkpoint can help to locate a source of a runtime exception.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
BOOST_CHECKPOINT( <span class="literal">"Going to throw an exception"</span> );
|
||
<span class="reserv-word">throw</span> <span class="literal">"some error"</span>;
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">
|
||
Exception in test_main : C string:some_error<br>
|
||
test.cpp(2) : last checkpoint: Going to throw an exception
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_WARN">BOOST_WARN</a>( predicate )</h3>
|
||
<p class="1-line-indented">This tool is used to perform a weak validation of
|
||
the the predicate. If predicate is true, the tool produces a conformation
|
||
message in other case it produces a warning message in a form "warning in
|
||
...: condition <predicate> is not satisfied"</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
BOOST_WARN( <span class="reserv-word">sizeof</span>(<span class="cpp-type">int</span>) == <span class="reserv-word">sizeof</span>(<span class="cpp-type">short</span>) );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
<p class="test-output">test.cpp(2) : warning in test_main: condition sizeof(int) == sizeof(short) is not satisfied
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK">BOOST_CHECK</a>( predicate )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to validate the predicate value.
|
||
If predicate is true, the tool produces a conformation message (note here and
|
||
further: to manage what massages appear in the test output stream set the proper
|
||
log level) in other case it produces an error message in a form "error
|
||
in ...: test <predicate> fail"</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i=<span class="literal">2</span>;
|
||
BOOST_CHECK( i == <span class="literal">1</span> );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
<p class="test-output">test.cpp(3) : error in test_main: test i==1 failed
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK_EQUAL">BOOST_CHECK_EQUAL</a>( left, right )</h3>
|
||
|
||
<p class="1-line-indented">The same as BOOST_CHECK( left == right ). The tools
|
||
allows to see mismatched values.
|
||
</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i = <span class="literal">2</span>;
|
||
<span class="cpp-type">int</span> j = <span class="literal">1</span>;
|
||
BOOST_CHECK_EQUAL( i, j );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output"> test.cpp(4) : error in test_main: test i == j failed [2 != 1]
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK_CLOSE_tolerance">BOOST_CHECK_CLOSE</a>( left, right, tolerance_src )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to check for the strong relationship
|
||
defined by the predicate <a href="floating_point_comparison.htm">close_at_tolerance
|
||
</a>( tolerance_src ) between <i>left</i> and <i>right</i>. To check for the
|
||
weak relationship use <a href="#BOOST_CHECK_PREDICATE">BOOST_CHECK_PREDICATE</a>.
|
||
Note that you need to include <a href="../../../boost/test/floating_point_comparison.hpp">
|
||
floating_point_comparison.hpp</a> yourself to use this tool since it depend on
|
||
this file that does not get included automatically to minimize code dependency.
|
||
</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">double</span> v1 = <span class="literal">1.23456e-10</span>;
|
||
<span class="cpp-type">double</span> v2 = <span class="literal">1.23457e-10</span>;
|
||
|
||
BOOST_CHECK_CLOSE( v1, v2, <span class="literal">1e-6</span> ); <span class="comment">// should fail at tolerance supplied</span>
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(4) : error in test_main: test v1 (==) v2 failed [1.23456e-10 != 1.23457e-10 (1e-06)]
|
||
</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">double</span> v1 = <span class="literal">4.1;</span>
|
||
|
||
v1 = v1 * v1;
|
||
BOOST_CHECK_CLOSE( v1, <span class="literal">16.81</span>, <span class="literal">1</span>+<span class="literal">2</span> );
|
||
<span class="comment">// 1(arithmetic operation) +
|
||
// 2(decimal to binary conversions) -
|
||
// number of rounding errors; should pass</span>
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</h4>
|
||
|
||
<h3><a name="BOOST_REQUIRE">BOOST_REQUIRE</a>( predicate )</h3>
|
||
<p class="1-line-indented">This tool is used to validate
|
||
the predicate value. If predicate is <i>true</i>, the tool produces a
|
||
conformation message in other case it produces an error message in a form "
|
||
fatal error in ...: test <predicate> fail" and then abort the
|
||
current test case processing.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i = <span class="literal">3</span>;
|
||
BOOST_REQUIRE( i > <span class="literal">5</span> );
|
||
BOOST_CHECK( i == <span class="literal">6</span> ); <span class="comment">// will never reach this check</span>
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(3) : fatal error in test_main: test i>5 failed
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_MESSAGE">BOOST_MESSAGE</a>( message )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to print the message in the test
|
||
output stream. The message argument can be of any type and can be a result of
|
||
concatenations using the operator <<.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="reserv-word">struct</span> A {
|
||
<span class="reserv-word">friend</span> <span class="cpp-type">std::ostream</span>& <span class=keyword>operator</span><<( <span class="cpp-type">std::ostream</span>& str, A <span class=keyword>const</span>& a ) {
|
||
str << <span class="literal">"struct A"</span>;
|
||
|
||
<span class="reserv-word">return</span> str;
|
||
}
|
||
};
|
||
|
||
<span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
BOOST_MESSAGE( <span class="literal">"Starting test"</span> );
|
||
|
||
<span class="cpp-type">int</span> i = <span class="literal">2</span>;
|
||
BOOST_MESSAGE( <span class="literal">"i="</span> << i );
|
||
|
||
BOOST_MESSAGE( <span class="literal">"still testing..."</span> );
|
||
|
||
<span class="reserv-word">struct</span> A a;
|
||
BOOST_MESSAGE( a << <span class="literal">'.'</span> );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">Starting test</font><br>
|
||
i=2<br>
|
||
still testing...<br>
|
||
struct A.
|
||
<script language="Javascript">put_ref_to_top()</script></p>
|
||
|
||
<h3><a name="BOOST_CHECK_MESSAGE">BOOST_WARN_MESSAGE</a>( predicate, message )<br>
|
||
BOOST_CHECK_MESSAGE( predicate, message )<br> <a name="BOOST_CHECK_MESSAGE">BOOST_REQUIRE_MESSAGE</a>( predicate, message )</h3>
|
||
|
||
<p class="1-line-indented">This group of tools works the same way as their non
|
||
_MESSAGE form. The only difference is test instead of generating of an error/confirm
|
||
message these macros use the supplied one.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test.cpp( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">double</span> res = sin( <span class="literal">45</span> );
|
||
|
||
BOOST_CHECK_MESSAGE( res > <span class="literal">3</span>, <span class="literal">"Why not?!?!"</span> );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}
|
||
</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(3) : error in test_main: Why not?!?!
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK_PREDICATE">BOOST_CHECK_PREDICATE</a>( prediate, number_of_arguments, arguments_list ) </h3>
|
||
|
||
<p class="1-line-indented">This tool is used to validate the supplied predicate.
|
||
If predicate produces <i>true</i> value, the tool produces a conformation
|
||
message in other case it produces an error message in a form "error in ...:
|
||
test <predicate>( arguments_list ) fail for (arguments values)".
|
||
Right now only unary and binary predicates are supported.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">bool</span> is_even( <span class="cpp-type">int</span> i ) {
|
||
<span class="reserv-word">return</span> i%<span class="literal">2</span> == <span class="literal">0</span>;
|
||
}
|
||
|
||
<span class="cpp-type">int</span> test.cpp( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i = <span class="literal">17</span>;
|
||
BOOST_CHECK_PREDICATE( &is_even, <span class="literal">1</span>, (i) );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}
|
||
</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(3) : error in test_main: test &is_even(i) failed for 17
|
||
</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test.cpp( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i = <span class="literal">17</span>;
|
||
|
||
BOOST_CHECK_PREDICATE( std::not_equal_to<<span class="cpp-type">int</span>>(), <span class="literal">2</span>, (i,<span class="literal">17</span>) );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}
|
||
</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(3) : error in test_main: test std::not_equal_to<int>()(i, 17) failed for (17, 17)
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_REQUIRE_PREDICATE">BOOST_REQUIRE_PREDICATE</a>( prediate, number_of_arguments, arguments_list ) </h3>
|
||
|
||
<p class="1-line-indented">This tool is used to validate the supplied predicate.
|
||
If predicate produces <i> true</i> value, the tool produces a conformation message
|
||
in other case it produces an error message in a form "error in ...: test
|
||
<predicate>( arguments_list ) fail for (arguments values)" and abort
|
||
current test case processing. Right now only unary and binary predicates are
|
||
supported.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test.cpp( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">double</span> fp1 = <span class="literal">1.23456e-10</span>;
|
||
<span class="cpp-type">double</span> fp2 = <span class="literal">1.23457e-10</span>;
|
||
<span class="cpp-type">double</span> epsilon = <span class="literal">8.1e-6</span>;
|
||
|
||
<span class="comment">// check weak closeness </span>
|
||
BOOST_CHECK_PREDICATE( close_at_tolerance<double>( epsilon, <span class="reserv-word">false</span> ),
|
||
<span class="literal">2</span>, ( fp1, fp2 ) ); <span class="comment">// should pass</span>
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}
|
||
</pre>
|
||
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<h3><a name="BOOST_ERROR">BOOST_ERROR</a>( message )<br>
|
||
<a name="BOOST_FAIL">BOOST_FAIL</a>( message )</h3>
|
||
|
||
<p class="1-line-indented">BOOST_ERROR is the same as BOOST_CHECK_MESSAGE( false, message ).
|
||
This tool is used for an unconditional error message logging. BOOST_FAIL
|
||
is the same as BOOST_REQUIRE_MESSAGE( false, message ). This tool is used for
|
||
an unconditional error message logging and the current test case aborting.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
BOOST_ERROR( <span class="literal">"Nothing to test"</span> );
|
||
BOOST_FAIL( <span class="literal">"Test is not ready yet"</span> );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
<p class="test-output">
|
||
test.cpp(3) : error in test_main: Nothing to test<br>
|
||
test.cpp(4) : fatal error in test_main: Test is not ready yet
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK_THROW">BOOST_CHECK_THROW</a>( statement, exception )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to perform an error detection check.
|
||
The tool executes the supplied statement and check that it throw the supplied exception.
|
||
</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="reserv-word">class</span> my_exception{};
|
||
<span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> i = <span class="literal"> 0</span>;
|
||
BOOST_CHECK_THROW( i++, my_exception );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(4) : error in test_main: exception my_exception expected
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_CHECK_EQUAL_COLLECTIONS">BOOST_CHECK_EQUAL</a>_COLLECTIONS( left_begin, left_end, right_begin )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to perform an element comparison of
|
||
two collections</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
<span class="cpp-type">int</span> col1 [] = { <span class="literal">1</span>, <span class="literal">2</span>, <span class="literal">3</span>, <span class="literal">4</span>, <span class="literal">5</span>, <span class="literal">6</span>, <span class="literal">7</span> };
|
||
<span class="cpp-type">int</span> col2 [] = { <span class="literal">1</span>, <span class="literal">2</span>, <span class="literal">4</span>, <span class="literal">4</span>, <span class="literal">5</span>, <span class="literal">7</span>, <span class="literal">7</span> };
|
||
|
||
BOOST_CHECK_EQUAL_COLLECTIONS( col1, col1+<span class="literal">7</span>, col2);
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(4) : error in test_main: test {col1, col1+7} == {col2,...} failed [3 != 4]<br>
|
||
test.cpp(4) : error in test_main: test {col1, col1+7} == {col2,...} failed [6 != 7]
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="BOOST_IS_DEFINED">BOOST_IS_DEFINED</a>( symbol )</h3>
|
||
|
||
<p class="1-line-indented">This tool is used to check whether or not the supplied
|
||
symbol is defined.</p>
|
||
|
||
<h4>Example: test.cpp</h4>
|
||
|
||
<pre class="code"><span class="cpp-type">int</span> test_main( <span class="cpp-type">int</span>, <span class="cpp-type">char</span>* [] ) {
|
||
BOOST_CHECK( BOOST_IS_DEFINED(SYMBOL1) );
|
||
BOOST_CHECK( BOOST_IS_DEFINED(SYMBOL2(arg)) );
|
||
|
||
<span class="reserv-word">return</span> <span class="literal">0</span>;
|
||
}</pre>
|
||
|
||
<h4>Output:</h4>
|
||
|
||
<p class="test-output">test.cpp(2) : error in test_main: test BOOST_IS_DEFINED(SYMBOL1) failed<br>
|
||
test.cpp(3) : error in test_main: test BOOST_IS_DEFINED(SYMBOL2(arg)) failed
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
|
||
<h3><a name="Deprecated">Depricated Boost.Test v1 test tools</a></h3>
|
||
|
||
<p class="1-line-indented">Here is the list of depricated test tools used in Boost.Test
|
||
version 1 and their new analogs:</p>
|
||
|
||
<div align="center">
|
||
<table class="2-column-table" cellspacing="0" >
|
||
<thead>
|
||
<tr>
|
||
<td align="center"><font size="4">Old tool </font> </td>
|
||
<td align="center"><font size="4">New analog tool</font></td>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><span class="new-term">BOOST_TEST</span>( predicate ) </td>
|
||
<td><span class="new-term">BOOST_CHECK</span>( predicate )</td>
|
||
</tr>
|
||
<tr>
|
||
<td><span class="new-term">BOOST_CRITICAL_TEST</span>( predicate ) </td>
|
||
<td><span class="new-term">BOOST_REQUIRE</span>( predicate )</td>
|
||
</tr>
|
||
<tr>
|
||
<td><span class="new-term">BOOST_CRITICAL_ERROR</span>( message )
|
||
</td>
|
||
<td><span class="new-term">BOOST_FAIL</span>( message )</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p>The main reasons for making these changes were conciseness and uniformity. Old
|
||
deprecated names are still accepted but may be excluded in a future releases.
|
||
Thanks for Ullrich Koethe, who originally proposed new names.
|
||
|
||
<h2><a name="Examples">Examples and Test Programs</a></h2>
|
||
<p class="indented"><a href="../example/test_exec_example.cpp">test_exec_example.cpp</a><br>
|
||
<a href="../test/test_exec_fail2.cpp">test_exec_fail2.cpp</a><br>
|
||
<a href="../test/test_exec_fail3.cpp">test_exec_fail3.cpp</a><br>
|
||
<a href="../test/test_tools_test.cpp">test_tools_test.cpp</a>
|
||
</p>
|
||
|
||
<h2><a name="Design">Design</a></h2>
|
||
<p class="1-line-indented">The <a href="test_lib_design.htm">Boost Test Library Design</a>
|
||
document describes the relationship between Boost Test Library components.
|
||
<script language="Javascript">put_ref_to_top()</script>
|
||
</p>
|
||
<hr>
|
||
<p><EFBFBD>
|
||
<script language="Javascript">contact_addess()</script>
|
||
<script language="Javascript">get_copyright_date()</script>
|
||
</p>
|
||
|
||
<p>Revised
|
||
<!--webbot bot="Timestamp" S-Type="EDITED"
|
||
S-Format="%d %b %Y" startspan -->30 Aug 2002<!--webbot bot="Timestamp" i-CheckSum="14755" endspan -->
|
||
</p>
|
||
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</body>
|
||
</html> |