1 | <html> |
---|
2 | |
---|
3 | <head> |
---|
4 | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
---|
5 | <meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
---|
6 | <meta name="ProgId" content="FrontPage.Editor.Document"> |
---|
7 | <title>Boost Test Policies and Protocols</title> |
---|
8 | </head> |
---|
9 | |
---|
10 | <body bgcolor="#FFFFFF" text="#000000"> |
---|
11 | |
---|
12 | <table border="1" bgcolor="#007F7F" cellpadding="2"> |
---|
13 | <tr> |
---|
14 | <td bgcolor="#FFFFFF"><img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td> |
---|
15 | <td><a href="../index.htm"><font face="Arial" color="#FFFFFF"><big>Home</big></font></a></td> |
---|
16 | <td><a href="../libs/libraries.htm"><font face="Arial" color="#FFFFFF"><big>Libraries</big></font></a></td> |
---|
17 | <td><a href="../people/people.htm"><font face="Arial" color="#FFFFFF"><big>People</big></font></a></td> |
---|
18 | <td><a href="faq.htm"><font face="Arial" color="#FFFFFF"><big>FAQ</big></font></a></td> |
---|
19 | <td><a href="index.htm"><font face="Arial" color="#FFFFFF"><big>More</big></font></a></td> |
---|
20 | </tr> |
---|
21 | </table> |
---|
22 | <h1>Boost Test Policies and Protocols</h1> |
---|
23 | <p>The Boost libraries are intended to be both reliable and portable. |
---|
24 | Every experienced programmer knows that means each library must be tested against a suitable number of test cases, on a wide range of platforms, |
---|
25 | and then tested again (regression tested) every time a change is made and before |
---|
26 | every release. </p> |
---|
27 | <p>"Quality assurance based on a wide range of targeted tests" as one |
---|
28 | of the key answers to C.A.R |
---|
29 | Hoare's question |
---|
30 | "How did software get so reliable without proof."</p> |
---|
31 | <h2>Regression test</h2> |
---|
32 | <p>Boost uses an automatic <a href="regression.html"> regression test suite</a> which generates HTML |
---|
33 | <a href="../status/compiler_status.html">compiler |
---|
34 | status tables</a>.</p> |
---|
35 | <h2>Test Policy</h2> |
---|
36 | <h3>Required</h3> |
---|
37 | <ul> |
---|
38 | <li>Every Boost library should supply one or more suitable test programs to be |
---|
39 | exercised by the Boost <a href="regression.html"> regression test suite</a>. In addition to |
---|
40 | the usual compile-link-run tests expecting successful completion, |
---|
41 | compile-only or compile-and-link-only tests may be performed, and success |
---|
42 | for the test may be defined as failure of the steps.</li> |
---|
43 | <li>Test program execution must report errors by returning a non-zero value. They |
---|
44 | may also write to stdout or stderr, but that output should be relatively |
---|
45 | brief. Regardless of other output, a non-zero return value is the only |
---|
46 | way the regression test framework will recognize an error has |
---|
47 | occurred. Note that test programs to be included in the status tables must |
---|
48 | compile, link, and run quickly since the tests are executed many, many, |
---|
49 | times.</li> |
---|
50 | <li>Libraries with time consuming tests should be divided into a |
---|
51 | fast-execution basic test program for the status tables, and a separate |
---|
52 | full-coverage test program for exhaustive test cases. The basic test |
---|
53 | should concentrate on compilation issues so that the status tables |
---|
54 | accurately reflect the library's likelihood of correct compilation on a |
---|
55 | platform.</li> |
---|
56 | <li>If for any reason the usual test policies do not apply to a particular |
---|
57 | library, an alternate test strategy must be implemented.</li> |
---|
58 | <li>A <a href="regression.html#Adding_new_test">Jamfile</a> to drive the |
---|
59 | regression tests for the library. </li> |
---|
60 | </ul> |
---|
61 | <h3>Optional (but highly recommended)</h3> |
---|
62 | <p>The <a href="../libs/test/index.html">Boost Test Library</a> provides many |
---|
63 | useful components which ease the construction of test programs.</p> |
---|
64 | <ul> |
---|
65 | <li>Use the library's |
---|
66 | <a href="../libs/test/doc/components/test_tools/index.html">Test Tools</a> for the construction of simple test |
---|
67 | programs that do not need much structure.</li> |
---|
68 | <li>Use the library's |
---|
69 | <a href="../libs/test/doc/components/utf/index.html">Unit Test |
---|
70 | Framework</a> for the construction of more complex test programs that need to |
---|
71 | be structured into individual tests |
---|
72 | and test suites.</li> |
---|
73 | </ul> |
---|
74 | <h2>Suggested Protocol for Fixing Bugs or Adding Features.</h2> |
---|
75 | <ul> |
---|
76 | <li>First, add regression test cases that detects the bug or tests the |
---|
77 | feature. Sometimes adding one case suggests similar untested cases, and they |
---|
78 | are added too.</li> |
---|
79 | <li>Second, for bugs, run the regression test and verify that the bug is now |
---|
80 | detected.</li> |
---|
81 | <li>Third, then, and only then, fix the bug or add the feature.</li> |
---|
82 | <li>Finally, rerun the full regression tests - sometimes the change breaks |
---|
83 | something else.</li> |
---|
84 | </ul> |
---|
85 | <h2>History</h2> |
---|
86 | <p><a href="regression.html#History">See Regression Test History</a>.</p> |
---|
87 | <h2>Acknowledgements</h2> |
---|
88 | <p>Written by Beman Dawes. Jens Maurer, Paul Moore, Gary Powell and Jeremy Siek contributed helpful suggestions.</p> |
---|
89 | <hr> |
---|
90 | <p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->08 January, 2004<!--webbot bot="Timestamp" endspan i-checksum="38708" --> |
---|
91 | </p> |
---|
92 | <p>© Copyright Beman Dawes 2001</p> |
---|
93 | <p> Use, modification, and distribution are subject to the Boost Software |
---|
94 | License, Version 1.0. (See accompanying file <a href="../LICENSE_1_0.txt"> |
---|
95 | LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> |
---|
96 | www.boost.org/LICENSE_1_0.txt</a>)</p> |
---|
97 | |
---|
98 | </body> |
---|
99 | |
---|
100 | </html> |
---|