[Cppunit-devel] cookbook docs

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Hi,

CppUnit looks like a useful framework for testing, so I thought
I'd see if I can use it for my projects.  I installed the debian
package and started with the "cookbook" page.  

When I started compiling the running example, I ran into several
difficulties.  I tried to update the file to reflect the
current state of the library; patch is attached.

Summary of changes:
* note the namespace
* type Complex needs a proper constructor
* SetUp() and friends need to be public
* note that calling run() member of a TestCaller is not useful
  (this baffled me for a while --- I did "assert(false)", and 
  couldn't figure out why I got no diagnostics!)

I ran out of steam when I got to the "TestRunner" section.  None of
that worked for me, since CppUnit has no TestRunner!  Now I see that
1.5.5 has it, but only in MSWindows.  I suppose the thing to do is
replace or supplement this section with a description of using
TextTestResults?

Regards,
-Steve

--- old/cppunit-1.5.4.orig/doc/cookbook.html	Thu Oct  5 14:37:28 2000
+++ cppunit-1.5.4/doc/cookbook.html	Mon May 14 17:34:12 2001
@@ -8,7 +8,12 @@
     <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   </P>
   <H1>CppUnit Cookbook</H1>
-  <P>Here is a short cookbook to help you get started. </P>
+  <P>
+    Here is a short cookbook to help you get started.
+    Note that all CppUnit types are defined in the CppUnit
+    namespace.  For brevity, the prefix <b>CppUnit::</b>
+    is omitted in the following examples.
+  </P>
   <H2>Simple Test Case</H2>
   <P>
     You want to know whether your code is working. 
@@ -90,9 +95,7 @@
         friend bool operator== (const Complex&amp; a, const Complex&amp; b);
         double      real, imaginary;
         public:
-                    Complex ()  {
-                    real = imaginary = 0.0;
-                    }
+                    Complex ( double r, double i = 0 ) : real(r),imaginary(i) {}
         };
 
         bool operator== (const Complex&amp; a, const Complex&amp; b)
@@ -153,7 +156,7 @@
 <TT><PRE>&#9;class ComplexNumberTest : public TestCase  {
 &#9;private:
         Complex &#9;*m_10_1, *m_1_1; *m_11_2;
-&#9;protected:
+&#9;public:
 &#9;void&#9;&#9;setUp ()  {
 &#9;&#9;&#9;    m_10_1 = new Complex (10, 1);
 &#9;&#9;&#9;    m_1_1  = new Complex (1, 1);
@@ -170,21 +173,22 @@
 &#9;&#9;&#9;    assert (*m_10_1 + *m_1_1 == *m_11_2);
                  &#9;}
 &#9;};</PRE>
-</TT><P>Create and run instances for each test case like this:</P>
-<TT><PRE>&#9;test = new TestCaller&lt;ComplexNumberTest&gt;("testEquality", ComplexNumberTest::testEquality);
-        test->run (); </PRE>
-</TT><P>The second argument to the test caller constructor is the address of a method on ComplexNumberTest. When the test caller is run, that specific method will be run.</P>
-<P>Once you have several tests, organize them into a suite.</P>
+</TT><P>One may create and run instances for each test case like this:</P>
+<TT><PRE>&#9;TestCaller&lt;ComplexNumberTest&gt; test("testEquality", &amp;ComplexNumberTest::testEquality);
+        test.run (); </PRE>
+</TT><P>The second argument to the test caller constructor is the address of a method on ComplexNumberTest. When the test caller is run, that specific method will be run.  This is not a useful thing to do, however, as no diagnostics will be
+    displayed.  One will normally use a TestRunner (see below) to display
+    the results.
+    </P>
+
+    <P>Once you have several tests, organize them into a suite.</P>
 <P>&nbsp;</P>
 <H2>Suite</H2>
 <P>How do you set up your tests so that you can run them all at once?<BR>
 <BR>
-CppUnit provides a TestSuite class that runs any number of TestCases together. For example, to run a single test case, you execute:</P>
-<TT><PRE>&#9;TestResult result;
-&#9;TestCaller&lt;ComplexNumberTest&gt; test ("testAddition", ComplexNumberTest::testAddition);
-&#9;Test.run (&amp;result);</PRE>
-</TT><P>&nbsp;</P>
-<P>To create a suite of two or more tests, you do the following:</P>
+CppUnit provides a TestSuite class that runs any number of TestCases together.
+    We saw, above, how to run a single test case.
+To create a suite of two or more tests, you do the following:</P>
 <TT><PRE>&#9;TestSuite suite;
 &#9;TestResult result;
 &#9;suite.addTest (new TestCaller&lt;ComplexNumberTest&gt;("testEquality", ComplexNumberTest::testEquality));
@@ -193,6 +197,7 @@
            </PRE>
 </TT><P>TestSuites don't only have to contain callers for TestCases. They can contain any object that implements the Test interface. For example, you can create a TestSuite in your code and I can create one in mine, and we can run them together by creating a TestSuite that contains both: </P>
 <TT><PRE>&#9;TestSuite suite;
+&#9;TestResult result;
 &#9;suite.addTest (ComplexNumberTest.suite ());
 &#9;suite.addTest (SurrealNumberTest.suite ());
 &#9;suite.run (&amp;result);</PRE>



-- 
by Rocket to the Moon,
by Airplane to the Rocket,
by Taxi to the Airport,
by Frontdoor to the Taxi,
by throwing back the blanket and laying down the legs ...
- They Might Be Giants



