Revised the contents of the section setUp_and_tearDown

[ccunit/ccunit.git] / doc / cookbook.dox

/* -*- Indented-Text -*- */
/* Copyright (C) 2003, 2010 TSUTSUMI Kikuo.
   This file is part of the CCUnit Library.

   The CCUnit Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1 of
   the License, or (at your option) any later version.

   The CCUnit Library is distributed in the hope that it will be
   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the CCUnit Library; see the file COPYING.LESSER.
   If not, see <http://www.gnu.org/licenses/>
*/
/* $Id$ */
/**
@english
@page cookbook CCUnit Cookbook
@japanese
@page cookbook CCUnit ¥¯¥Ã¥¯¥Ö¥Ã¥¯
@endif

@~english
Here is a short cookbook to help you get started.
@~japanese
¤³¤ì¤Ï CCUnit ¤ò»È¤¤»Ï¤á¤ë¤Ë¤¢¤¿¤Ã¤Æ¡¢
Íý²ò¤Î½õ¤±¤È¤Ê¤ë¤è¤¦¤Êû¤¤¥¯¥Ã¥¯¥Ö¥Ã¥¯¤Ç¤¹¡£
@~
@english
[see also <a href="../ja/cookbook.html">Japanese</a> documents]
@japanese
[see also <a href="../../cookbook.html">English</a> documents]
@endif

@english
@section simple_test_case Simple Test Case
@japanese
@section simple_test_case ¥·¥ó¥×¥ë¤Ê¥Æ¥¹¥È¥±¡¼¥¹
@endif

@~english
Tests in <b>CCUnit</b> can be run automatically.  They are
easy to set up and once you have written them, they are
always there to help you keep confidence in the quality of
your code.
@~japanese
CCUnit¤ò»È¤Ã¤¿¥Æ¥¹¥È¤Ï¼«Æ°Åª¤Ë¼Â¹Ô¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
CCUnit ¤Î¥Æ¥¹¥È¤Ï´Êñ¤Ë¥»¥Ã¥È¥¢¥Ã¥×¤¹¤ë¤³¤È¤¬¤Ç¤­¡¢
°ìÅ٥ƥ¹¥È¤ò½ñ¤¤¤Æ¤·¤Þ¤¨¤Ð¡¢
¤¤¤Ä¤Ç¤â¥×¥í¥°¥é¥à¤ÎÉʼÁ¤ò¿®Íê¤Ç¤­¤ë¤â¤Î¤ËÊݤĤ³¤È¤¬¤Ç¤­¤ë¤Ç¤·¤ç¤¦¡£
@~

@~english
To make a simple test, here is what you do:
@~japanese
ñ½ã¤Ê¥Æ¥¹¥È¤òºî¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@~

<ol>
<li> @english Create a test function
     @japanese ¥Æ¥¹¥È´Ø¿ô¤òºî¤ê¤Þ¤¹¡£
     @endif
</li>
<li> @english When you want to check a value, call
     @link CCUNIT_ASSERT() CCUNIT_ASSERT(bool) @endlink
     and pass a bool that is true if the test succeeds

     ASSERT macro is listed in others as well in
     @link Assertions Making assertions @endlink.
     @japanese
     Ãͤò¥Á¥§¥Ã¥¯¤·¤¿¤¤¾ì¹ç¤Ï¡¢
     @link CCUNIT_ASSERT() CCUNIT_ASSERT(bool) @endlink
     ¤ò¸Æ¤Ó½Ð¤·¤Æ¡¢
     ¥Æ¥¹¥È¤¬À®¸ù¤¹¤ë¤Ê¤é¿¿¤òÊÖ¤¹¤è¤¦¤Ê¿¿µ¶ÃͤòÅϤ·¤Þ¤¹¡£

     ASSERT ´Ø·¸¤Î¥Þ¥¯¥í¤Ï¾¤Ë¤â
     @link Assertions ¥¢¥µ¡¼¥È¤ÎÀë¸À @endlink
     ¤Ë¥ê¥¹¥È¤·¤Æ¤¢¤ê¤Þ¤¹¡£
     @endif
</li>
</ol>

@~english
For example, to test that the sum of two complex number
which is the sum of the values of two complex numbers,
write (This sample program is in the @c examples/complex directory):
@~japanese
Î㤨¤Ð¡¢´Êñ¤ÊÊ£ÁÇ¿ô¤Î¥é¥¤¥Ö¥é¥ê¤ò¥Æ¥¹¥È¤¹¤ë¤³¤È¤òÎã¤Ë¤È¤Ã¤Æ¤ß¤Þ¤·¤ç¤¦¡£
¡Ê¤³¤³¤Ç»ÈÍѤ¹¤ë¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï
examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤¢¤ê¤Þ¤¹¡£¡Ë
Ê£ÁÇ¿ô¤ò½é´ü²½¤¹¤ë¤³¤È¤¬¤Ç¤­¤¿¤«¤ò¥Æ¥¹¥È¤·¤¿¤ê¡¢
Æó¤Ä¤ÎÊ£ÁÇ¿ô¤¬Åù¤·¤¤¤«¤ò¥Æ¥¹¥È¤¹¤ë¤È¤·¤Þ¤¹¡£
@~

@dontinclude complex/testComplex.c

@skip test_complex_new
@until }
@skip test_complex_equals
@until }

@english
@japanese
¤³¤ÎÆó¤Ä¤Î¥Æ¥¹¥È´Ø¿ô¤ò¤Þ¤È¤á¤Æ¤Ò¤È¤Ä¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ë¤·¤Æ¼Â¹Ô¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
@endif

@dontinclude complex/runTestCase.c

@skip main
@until ccunit_newTestCase

@english
@japanese
¤Þ¤º¥Æ¥¹¥È¥±¡¼¥¹¤Ë¥á¥â¥ê¤ò³ä¤êÅö¤Æ¤Þ¤¹¡£
@endif

@until test_complex_equals);

@english
@japanese
¤½¤·¤Æ¥Æ¥¹¥È¥±¡¼¥¹¤Ë¥Æ¥¹¥È´Ø¿ô¤òÅÐÏ¿¤·¤Þ¤¹¡£
ɽÌÀ (ASSERT) ¤¬¼ºÇÔ¤·¤¿»þ¤Ëɽ¼¨¤¹¤ë¤¿¤á¤Î´Ø¿ô̾¤È´Ø¿ô¤ÎÀâÌÀ¤ò°ì½ï¤Ë»ØÄꤷ¤Æ¤¤¤Þ¤¹¡£
@endif

@until }

@english
@japanese
¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤·¡¢
·ë²Ì¤òÊÖ¤·¤Þ¤¹¡£
@endif

@english
The sample code made in the above is in the directory <code>examples/complex</code>,
the files are @c testComplex.c and <code>runTestCase.c</code>.
@japanese
¤³¤³¤Þ¤Ç¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ï¡¢@c examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Î
<code>testComplex.c, runTestCase.c</code> ¤Ë¤¢¤ê¤Þ¤¹¡£

¥³¥ó¥Ñ¥¤¥ë¤ª¤è¤Ó¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@endif

@code
$ gcc -o runTestCase runTestCase.c testComplex.c complex.c -lccunit
$ ./runTestCase
$ echo $?
0
@endcode

@~english
That was a very simple test. Ordinarily, you'll have many
little test cases that you'll want to run on the same set of
objects. To do this, use global variables.
@~japanese
¤³¤ì¤ÏÂçÊÑñ½ã¤Ê¥Æ¥¹¥È¤Ç¤¹¡£
Ä̾
¤¿¤¯¤µ¤ó¤Î¾®¤µ¤Ê¥Æ¥¹¥È´Ø¿ô¤òºî¤Ã¤Æ¡¢
Ʊ¤¸¤è¤¦¤Ê¥Ç¡¼¥¿¤Î½¸¤Þ¤ê¤ò»È¤Ã¤Æ¥Æ¥¹¥È¤ò¹Ô¤¦¤³¤È¤Ë¤Ê¤ë¤Ç¤·¤ç¤¦¡£
¤Ä¤Þ¤ê³Æ¥Æ¥¹¥È´Ø¿ô¶¦Ä̤Υ°¥í¡¼¥Ð¥ëÊÑ¿ô¤ò»È¤¦¤ÈÊØÍø¤Ç¤¹¡£
@~

@english
@section setUp_and_tearDown setUp and tearDown
@japanese
@section setUp_and_tearDown setUp ¤È tearDown
@endif

@~english
What if you have two or more tests that operate on the same
similar set of objects?
@~japanese
¤â¤·Ê£¿ô¤Î¥Æ¥¹¥È´Ø¿ô¤¬¤¢¤ë¤Ê¤é¡¢
Ʊ¤¸¥Ç¡¼¥¿¤Î½¸¤Þ¤ê¤ò¤¤¤¯¤Ä¤«»È¤¦¤Î¤Ç¤Ï¤Ê¤¤¤Ç¤·¤ç¤¦¤«¡£
@~

@dot
digraph TestCase {
  node [ fontsize=9, fontname=Helvetica ]
  edge [ fontsize=9, dir=back, arrowtail=vee ]
  gv [ label="Global Variables", shape=box ]
  { rank=same;
    tc1 [ label="Test case 1" ];
    tcn [ label="Test case n" ];
  }
  gv -> tc1;
  gv -> tcn;
  tc1 -> tcn [ style=dotted, arrowtail=none ];
}
@enddot

@~english
Tests need to run against the background of a known set of
objects. This set of objects is called a test fixture. When
you are writing tests you will often find that you spend
more time writing the code to set up the fixture than you do
in actually testing values.
@~japanese
¥Æ¥¹¥È¤ÏÃæ¿È¤Î¤ï¤«¤Ã¤Æ¤¤¤ë¥Ç¡¼¥¿¤Î½¸¤Þ¤ê¤òÁ°Äó¤È¤·¤Æ¼Â¹Ô¤µ¤ì¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
¥Æ¥¹¥È¤ò½ñ¤¤¤Æ¤¤¤ë¤È¡¢
¼ÂºÝ¤Ë¥Æ¥¹¥È¤¹¤ëÃͤò¥»¥Ã¥È¥¢¥Ã¥×¤¹¤ë¥³¡¼¥É¤ò½ñ¤¯Êý¤Ë¡¢
¤è¤ê»þ´Ö¤ò¤«¤±¤Æ¤¤¤ë¤³¤È¤Ëµ¤¤Å¤¯¤³¤È¤¬¤è¤¯¤¢¤ê¤Þ¤¹¡£
@~

@english
@japanese
Î㤨¤ÐÁ°Àá¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ç¤Ï¡¢
¤¤¤¯¤Ä¤«¤ÎÊ£ÁÇ¿ô¤ò³ä¤êÅö¤Æ¤¿¤ê²òÊü¤·¤¿¤ê¤·¤Æ¤¤¤Þ¤¹¡£
@endif

@~english
Often, you will be able to use the same fixture for several
different tests. Each case will send slightly different
messages or parameters to the fixture and will check for
different results.
@~japanese
¿¤¯¤Î¾ì¹ç¡¢¤¤¤¯¤Ä¤«¤Î°Û¤Ê¤Ã¤¿¥Æ¥¹¥È¤Î¤¿¤á¤ËƱ¤¸¥°¥í¡¼¥Ð¥ëÊÑ¿ô¤ò»È¤¦¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
¤½¤ì¤¾¤ì¤Î¥Æ¥¹¥È´Ø¿ô¤ò¼Â¹Ô¤¹¤ëÁ°¤ËÊÑ¿ô¤ò½é´ü²½¤·¡¢
ÃͤòÄ´¤Ù¤ë¤³¤È¤Ë¤Ê¤ë¤Ç¤·¤ç¤¦¡£
¤½¤·¤Æ¥Æ¥¹¥È¤¬½ª¤ï¤Ã¤¿¤é¸å»ÏËö¤¹¤ë¤³¤È¤Ë¤Ê¤ê¤Þ¤¹¡£
@~

@dot
digraph TestFixture {
  node [ fontsize=9, fontname=Helvetica ]
  edge [ fontsize=9, dir=back, arrowtail=vee ]
  rankdir=TB;
  gv [ label="Global Variables", shape=box ]
  { rank=same;
    su [ label="setUp" ];
    tc [ label="TestCase" ];
    td [ label="tearDown" ];
  }
  gv -> su [ label="initialize" ];
  gv -> tc [ label="access" ];
  gv -> td [ label="clean-up" ];
}
@enddot

@~english
When you have a common fixture, here is what you do:
@~japanese
¤â¤·³Æ¥Æ¥¹¥È¤Ë¶¦Ä̤Υ°¥í¡¼¥Ð¥ëÊÑ¿ô¤¬¤¢¤ì¤Ð¡¢
¼¡¤Î¤è¤¦¤Ë¤¹¤ë¤³¤È¤Ç¤·¤ç¤¦¡£
@~

<ol>
<li>@english
    Create a @link CCUnitTestCase TestCase @endlink object
    @japanese
    @link CCUnitTestCase TestCase @endlink ¤òºîÀ®¤·¤Þ¤¹
    @endif
</li>
<li>@english
    Add an global variable for each part of the case
    @japanese
    TestCase ¤Î¥¹¥³¡¼¥×Æâ¤Ë¥°¥í¡¼¥Ð¥ëÊÑ¿ô¤òÄêµÁ¤·¤Þ¤¹
    @endif
</li>
<li>@english
    Write @c setUp() function to initialize the valiables
    @japanese
    ¥Õ¥£¥¯¥¹¥Á¥ã¤ò½é´ü²½¤¹¤ë @c setUp() ´Ø¿ô¤ò½ñ¤­¤Þ¤¹
    @endif
</li>
<li>@english
    Write @c tearDown() to release any permanent
    resources you allocated in @c setUp
    @japanese
    @c setUp() ¤Ç³ä¤êÅö¤Æ¤¿±Ê³Ū¥ê¥½¡¼¥¹¤ò²òÊü¤¹¤ë¤¿¤á¤Î
    @c tearDown() ´Ø¿ô¤ò½ñ¤­¤Þ¤¹
    @endif
</li>
<li>@english Write TestFunc.
    @japanese
    ¥Æ¥¹¥È´Ø¿ô (TestFunc) ¤ò½ñ¤­¤Þ¤¹¡£
    @endif
</li>
<li>@english
    Add @link CCUnitTestFunc TestFunc @endlink objects to case object
    @japanese
    @link CCUnitTestFunc TestFunc @endlink ¤ò
    @link CCUnitTestCase TestCase @endlink ¤ËÅÐÏ¿¤·¤Þ¤¹¡£
    @endif
</li>
</ol>

@english
For example, to write several test cases, first create a
fixture:
@japanese
@endif

@dontinclude complex/testComplexSetup.c

@skipline complex.h
@until end test case

@dontinclude complex/runTestCaseSetup.c

@skip int main
@until setUp_test_complex);
@until tearDown_test_complex);

@english
@japanese
@c setUp() ¤È @c tearDown() ¤òÅÐÏ¿¤·¤Þ¤¹¡£
¤³¤Î»þ¡¢´Ø¿ô¤Î̾Á°¤¬ @c setUp/tearDown ¤Ç»Ï¤Þ¤Ã¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
@endif

@until }

@english
@japanese
¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤·¡¢
·ë²Ì¤òÊÖ¤·¤Þ¤¹¡£
@endif

@english
The sample code made in the above is in the directory <code>examples/complex</code>,
the files are @c testComplexSetup.c and <code>runTestCaseSetup.c</code>.
@japanese
¤³¤³¤Þ¤Ç¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ï¡¢@c examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Î
<code>testComplexSetup.c, runTestCaseSetup.c</code> ¤Ë¤¢¤ê¤Þ¤¹¡£

¥³¥ó¥Ñ¥¤¥ë¤ª¤è¤Ó¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@endif

@code
$ gcc -o runTestCaseSetup runTestCaseSetup.c testComplexSetup.c complex.c -lccunit
$ ./runTestCase
$ echo $?
0
@endcode

@english
@section one_time_setUp_tearDown setUp/tearDown of only one time
@japanese
@section one_time_setUp_tearDown °ì²ó¤À¤±¤Î setUp/tearDown
@endif


@english
Calling sequence of test cases in a fixture is following:
@japanese
¤Ò¤È¤Ä¤Î¥Õ¥£¥¯¥¹¥Á¥ã¤ÎÃæ¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¼Â¹Ô¥·¡¼¥±¥ó¥¹¤Ï¼¡¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
@endif

@dot
digraph TestCaseCallingSequence {
  node [ fontsize=9, fontname=Helvetica ]
  edge [ fontsize=9 ]
  rankdir = LR;
  { rank=same;
    setUp;
    setUp2 [ label="setUp" ];
  }
  setup_setUp -> setUp [ weight=8 ];
  setup_setUp -> setUp2 [ style=invis ];
  setUp -> "TestFunc 1" [ weight=8 ];
  "TestFunc 1" -> tearDown [ weight=8 ];
  setUp2 -> "TestFunc n" [ weight=8 ];
  tearDown2 [ label="tearDown" ];
  "TestFunc n" -> tearDown2;
  tearDown2 -> setup_tearDown;
  tearDown -> setUp2;
}
@enddot

@english
The sample code made in the above is in the directory <code>examples/complex</code>,
the files <code>testComplex.c</code> and <code>runTestCase.c</code>.
@japanese
¤³¤³¤Þ¤Ç¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ï¡¢<code>examples/complex</code> ¥Ç¥£¥ì¥¯¥È¥ê¤Î
<code>testComplex.c, runTestCase.c</code> ¤Ë¤¢¤ê¤Þ¤¹¡£

¥³¥ó¥Ñ¥¤¥ë¤ª¤è¤Ó¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@endif

@code
$ gcc -I. -o runTestCase runTestCase.c testComplex.c complex.c -lccunit
$ ./runTestCase
@endcode

@~english
Once you have several tests, organize them into a suite.
@~japanese
°ìÅÙ¤¤¤¯¤Ä¤«¤Î¥Æ¥¹¥È¤òºî¤Ã¤¿¤é¡¢
¤½¤ì¤é¤ò¥¹¡¼¥Ä¤ËÀ°Íý¤·¤Þ¤¹¡£
@~

@english
@section suite Suite
@japanese
@section suite ¥¹¡¼¥Ä
@endif

@dot
digraph TestStructure {
  node [ fontsize=9, fontname=Helvetica ];
  edge [ dir=back, fontsize=9 ];
  TestSuite -> TestSuite [ label="1..n" ];
  TestCase;
  TestSuite -> TestCase [ label="1..n" ];
  TestCase -> setup_setUp [ label="0..1" ];
  TestCase -> setUp [ label="0..1" ];
  TestFunc;
  TestCase -> TestFunc [ label="1..n" ];
  TestCase -> tearDown [ label="0..1" ];
  TestCase -> setup_tearDown [ label="0..1" ];
}
@enddot

@~english
How do you set up your tests so that you can run them all at once?
@~japanese
°ìÅ٤˥ƥ¹¥È¤ò¼Â¹Ô¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¤è¤¦¤Ë½àÈ÷¤¹¤ë¤Ë¤Ï¡¢
¤É¤Î¤è¤¦¤Ë¤·¤¿¤é¤¤¤¤¤Ç¤·¤ç¤¦¤«¡©
@~

@~english
CCUnit provides a @link CCUnitTestSuite TestSuite @endlink
module that runs any number of TestFuncs together.
@~japanese
CCUnit ¤Ï¤¤¤¯¤Ä¤â¤Î @link CCUnitTestFunc TestFuncs @endlink
¤ò°ì½ï¤Ë¼Â¹Ô¤¹¤ë
@link CCUnitTestSuite TestSuite @endlink ¥â¥¸¥å¡¼¥ë¤òÄ󶡤·¤Þ¤¹¡£
@~

@~english
You saw, above, how to run test testCase.
@~japanese
¥Æ¥¹¥È¥Õ¥£¥¯¥¹¥Á¥ã¤ò¼Â¹Ô¤¹¤ëÊýË¡¤Ï¾å½Ò¤·¤Þ¤·¤¿¡£
@~

@~english
To create a suite of two or more tests, you do the following:
@~japanese
Æó¤Ä°Ê¾å¤Î¥Æ¥¹¥È¤ò´Þ¤à°ì¤Ä¤Î¥¹¡¼¥Ä¤òºî¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@~

@code
int main ()
{
  CCUnitTestSuite* suite;
  CCUnitTestCase* testCase;
  CCUnitTestResult* result;
  suite = ccunit_newTestSuite ("Complex test suite");
  testCase = ccunit_newTestCase ("Complex Tests",
                                   CCUNIT_NEWTESTFUNC(setUp_complex_test),
                                   CCUNIT_NEWTESTFUNC(tearDown_complex_test));
  ccunit_addNewTestFunc (testCase, "test_complex_equals", "complex equals test",
                         test_complex_equals);
  ccunit_addNewTestFunc (testCase, "test_complex_add", "complex add test",
                         test_complex_add);
  ccunit_addNewTestFunc (testCase, "test_complex_sub", "complex sub test",
                         test_complex_sub);
  ccunit_addTestCase (suite, fixtuer);
  result = ccunit_runTestSuite (suite, NULL);
  return 0;
}
@endcode

@~english
@link CCUnitTestSuite TestSuites @endlink don't only have to
contain @link CCUnitTestCase TestCases @endlink.  They
can contain any object that implements the @link CCUnitTest
Test @endlink interface.  For example, you can create a
@link CCUnitTestSuite TestSuite @endlink
(<code>complex_add_sub_suite ()</code>) in your code and I
can create one in mine
(<code>complex_mul_div_suite ()</code>), and we can run them together by
creating a @link CCUnitTestSuite TestSuite @endlink that
contains both:
@~japanese
@link CCUnitTestSuite TestSuites @endlink ¤Ï
@link CCUnitTestCase TestCases @endlink
¤ò´Þ¤à¤À¤±¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£
@link CCUnitTestSuite TestSuites @endlink ¼«¿È¤ò´Þ¤à¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
<!--
¤½¤ì¤é¤Ï @link CCUnitTest Test @endlink
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò¼ÂÁõ¤¹¤ë¤É¤ó¤Ê¥ª¥Ö¥¸¥§¥¯¥È¤Ç¤â´Þ¤á¤é¤ì¤Þ¤¹¡£
-->
Î㤨¤Ð¡¢¤¢¤Ê¤¿¤Ï¤¢¤Ê¤¿¤Î¥³¡¼¥É¤Ë @link CCUnitTestSuite TestSuite @endlink
(<code>complex_add_sub_suite ()</code>)
¤òºî¤ë¤³¤È¤¬¤Ç¤­¡¢
¤½¤·¤Æ»ä¤Ï»ä¤Î¥¹¡¼¥Ä
(<code>complex_mul_div_suite ()</code>)
¤òºî¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡¢
¤½¤·¤Æ»äã¤ÏξÊý¤È¤â¤ò´Þ¤ó¤Ç¤¤¤ë @link CCUnitTestSuite TestSuite @endlink
¤òºî¤Ã¤Æ°ì½ï¤Ë¤½¤ì¤¾¤ì¤Î¥¹¡¼¥Ä¤òÆ°¤«¤¹¤³¤È¤¬¤Ç¤­¤ë¤Î¤Ç¤¹¡£
@~

@code
  CCUnitTestSuite* suite;
  CCUnitTestResult* result;
  suite = ccunit_newTestSuite ("Complex add/sub/mul/div test suite");
  ccunit_addTestSuite (suite, complex_add_sub_suite ());
  ccunit_addTestSuite (suite, complex_mul_div_suite ());
  result = ccunit_runTestSuite(suite, NULL);
@endcode

@english
The sample code made in the above is in the directory <code>examples/complex</code>,
the files <code>testComplex.c</code>, <code>testComplexMulDiv.c</code>,
<code>complexTestSuite.c</code> and <code>runTestSuite.c</code>.
@japanese
¤³¤³¤Þ¤Ç¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ï¡¢<code>examples/complex</code> ¥Ç¥£¥ì¥¯¥È¥ê¤Î
<code>testComplex.c, testComplexMulDiv.c, complexTestSuite.c, runTestSuite.c</code>
¤Ë¤¢¤ê¤Þ¤¹¡£

¥³¥ó¥Ñ¥¤¥ë¤ª¤è¤Ó¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@endif

@code
$ gcc -I. -o runTestSuite runTestSuite.c testComplex.c testComplexMulDiv.c complexTestSuite.c complex.c -lccunit
$ ./runTestSuite
@endcode

@english
@section test_runner TestRunner
@japanese
@section test_runner ¥Æ¥¹¥È¥é¥ó¥Ê¡¼
@endif

@~english
How do you run your tests and collect their results?
The testCases store result of own tests into
the @link CCUnitTestResult TestResult @endlink.
@~japanese
¤É¤¦¤ä¤Ã¤Æ¥Æ¥¹¥È¤ò¼Â¹Ô¤·¡¢¤½¤Î·ë²Ì¤ò½¸¤á¤¿¤éÎɤ¤¤Ç¤·¤ç¤¦¤«¡£
¥Õ¥£¥¯¥¹¥Á¥ã¤Ï¥Æ¥¹¥È¥±¡¼¥¹¤Î¼Â¹Ô·ë²Ì¤ò
@link CCUnitTestResult TestResult @endlink ¤Ë³ÊǼ¤·¤Þ¤¹¡£
@~

@dot
digraph TestResult {
  node [ fontsize=9, fontname=Helvetica ]
  { rank=same;
    edge [ fontsize=9, fontname=Courier ]
    TestCase -> TestResult [ label="TestFailure", style=dotted, arrowhead=vee ];
  }
  edge [ fontsize=9, dir=back ]
  TestCase -> setUp;
  TestCase -> "TestFunc 1..n";
  TestCase -> tearDown;
  TestResult -> "TestFailure 0..m";
}
@enddot

@~english
Once you have a test suite, you'll want to run it. %CCUnit
provides @link ExecutingTest TestRunner @endlink
to define the suite to be run and to display
its results.
@~japanese
°ì¤Ä¥Æ¥¹¥È¥¹¡¼¥Ä¤ò½ñ¤¤¤¿¤é¡¢
¤½¤ì¤ò¼Â¹Ô¤·¤¿¤¤¤Ç¤·¤ç¤¦¡£
CCUnit ¤Ï¥¹¡¼¥Ä¤ò¼Â¹Ô¤¹¤ë¤¿¤á¤ËÄêµÁ¤·¡¢
·ë²Ì¤òɽ¼¨¤¹¤ë¤¿¤á¤Î @link ExecutingTest TestRunner @endlink ¤òÄ󶡤·¤Þ¤¹¡£
@~

@~english
To use the @link CCUnitTestRunner TestRunner @endlink,
include the header files for the tests in runTestRunner.c:
@~japanese
@link CCUnitTestRunner TestRunner @endlink ¤ò»ÈÍѤ¹¤ë¤Ë¤Ï¡¢
Î㤨¤Ð runTestRunner.c ¤Ç¥Æ¥¹¥È¤Î¤¿¤á¤Î¥Õ¥¡¥¤¥ë¤Î¥Ø¥Ã¥À¤ò¥¤¥ó¥¯¥ë¡¼¥É¤·¤Þ¤¹¡£
@~

@code
#include <ccunit/CCUnitTestRunner.h>
#include <ccunit/CCUnitTestSuite.h>
@endcode

@~english
And call to
@link ccunit_runTestRunner()
ccunit_runTestRunner (CCUnitTestRunner*, CCUnitTestSuite *) @endlink
in the <code>main()</code> function:
@~japanese
¤½¤·¤Æ@link ccunit_runTestRunner()
ccunit_runTestRunner (CCUnitTestRunner*, CCUnitTestSuite *) @endlink
¤ò<code>main()</code>´Ø¿ô¤Ç¼Â¹Ô¤·¤Þ¤¹¡£
@~

@code
extern CCUnitTestSuite* complex_add_sub_suite ();
extern CCUnitTestSuite* complex_mul_div_suite ();

int main( int argc, char **argv)
{
  CCUnitTestRunner* runner;
  CCUnitTestSuite* suite;
  suite = ccunit_newTestSuite ("complex test suite");
  ccunit_addTestSuite (suite, complex_add_sub_suite ());
  ccunit_addTestSuite (suite, complex_mul_div_suite ());
  runner = ccunit_newTestRunner (stdout);
  return ccunit_runTestRunner (runner, suite);
}
@endcode

@english
The sample code made in the above is in the directory <code>examples/complex</code>,
the files <code>testComplex.c, complexTestSuite.c</code> and <code>runTestRunner.c</code>.
@japanese
¤³¤³¤Þ¤Ç¤Î¥µ¥ó¥×¥ë¥³¡¼¥É¤Ï¡¢<code>examples/complex</code> ¥Ç¥£¥ì¥¯¥È¥ê¤Î
<code>testComplex.c, complexTestSuite.c, runTestRunner.c</code>
¤Ë¤¢¤ê¤Þ¤¹¡£

¥³¥ó¥Ñ¥¤¥ë¤ª¤è¤Ó¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
@endif

@code
$ gcc -I. -o runTestRunner runTestRunner.c testComplex.c testComplexMulDiv.c complexTestSuite.c complex.c -lccunit
$ ./runTestRunner
.....
Time: 0.000066 sec

OK (5 tests)
@endcode

@~english
The @link ExecutingTest TestRunner @endlink will run the tests.
If all the tests pass, you'll get an informative message.
If any fail, you'll get the following information:
@~japanese
@link ExecutingTest TestRunner @endlink ¤Ï¥Æ¥¹¥È¤ò¼Â¹Ô¤·¤Þ¤¹¡£
¤â¤·¤¹¤Ù¤Æ¤Î¥Æ¥¹¥È¤¬¥Ñ¥¹¤¹¤ì¤Ð¡¢¤½¤Î¾ðÊó¤Î¥á¥Ã¥»¡¼¥¸¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
¾å¤ÎÎã¤Ç¤Ï¡¢ºÇ½é¤Î¡Ö<code>.....</code>¡×¤Ï¼Â¹Ô¤·¤¿¥Æ¥¹¥È¥±¡¼¥¹¤Ç¤¹¡£
¼Â¹Ô¤¹¤ëľÁ°¤Ë¡Ö<code>.</code>¡×¤¬½ÐÎϤµ¤ì¤Þ¤¹¡£
Á´¤Æ¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¼Â¹Ô¤¬½ªÎ»¤¹¤ë¤È¡¢
¼Â¹Ô¤Ë¤«¤«¤Ã¤¿»þ´Ö¤È¼Â¹Ô¤·¤¿¥Æ¥¹¥È¥±¡¼¥¹¤Î¿ô¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£

¤É¤ì¤«¤¬¼ºÇÔ¤¹¤ì¤Ð¡¢¤½¤ì¤Ë¤Ä¤¤¤Æ°Ê²¼¤Î¤è¤¦¤Ê¾ðÊó¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
@~

<ul>
<li>@~english
    The name of the source file that contains the test
    @~japanese
    ¥Æ¥¹¥È¤ò´Þ¤ó¤Ç¤¤¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾
    @~
</li>
<li>@~english
    The line number where the failure occurred
    @~japanese
    ¼ºÇÔ¤¬µ¯¤³¤Ã¤¿¹ÔÈÖ¹æ
    @~
</li>
<li>@~english
    The name of the test case that failed
    @~japanese
    ¼ºÇÔ¤·¤¿¥Æ¥¹¥È¥±¡¼¥¹¤Î̾Á°
    @~
</li>
<li>@~english
    All of the text inside the call to
    <code>CCUNIT_ASSERT ()</code> which detected the failure
    @~japanese
    ¼ºÇÔ¤ò¸¡ÃΤ·¤¿<code>CCUNIT_ASSERT ()</code>¤¬¸Æ¤Ó½Ð¤µ¤ì¤¿»þ¤Î¾ò·ï¤Îʸ»úÎó¡£
    @~
</li>
</ul>

@english
@japanese
»î¤·¤Ë @c testComplex.c ¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ç¤ï¤¶¤È´Ö°ã¤¨¤Æ¤ß¤Þ¤·¤ç¤¦¡£
<code>!complex_equals</code> ¤Î <code>!</code> ¤ò¤È¤Ã¤Æ¤ß¤Þ¤¹¡£
@endif

@code
//* testComplex.c *\/
//** test equals *\/
void test_complex_equals ()
{
  CCUNIT_ASSERT_TEST_OBJ (s10_1, complex_equals, s10_1, complex_to_string);
//*CCUNIT_ASSERT_TEST_OBJ (s10_1, !complex_equals, s1_1, complex_to_string);*\/
  CCUNIT_ASSERT_TEST_OBJ (s10_1, complex_equals, s1_1, complex_to_string);
}
@endcode

@code
$ gcc -I. -o runTestRunner runTestRunner.c testComplex.c testComplexMulDiv.c complexTestSuite.c complex.c -lccunit
$ ./runTestRunner
.F....
Time: 0.000059 sec

FAILURES!!!
Test Results: 
Run 5, Failures 1
There was 1 failure:
testComplex.c:53: complex equals test:
        complex_equals (s10_1, s1_1)
        expect: 10+1i
        actual: 1+1i
@endcode

@english
@japanese
¤³¤ÎÎã¤Ç¤Ï¥Æ¥¹¥È¥±¡¼¥¹¤ò 5 ¸Ä¼Â¹Ô¤·¤Æ¡¢
¤Ò¤È¤Ä¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ç¼ºÇÔ¤·¤Æ¤¤¤ë¤³¤È¤¬¤ï¤«¤ê¤Þ¤¹¡£
ºÇ½é¤Î¡Ö<code>.F....</code>¡×¤Ç¤Ï¡¢
¤Ò¤È¤ÄÌܤΥƥ¹¥È¥±¡¼¥¹¤¬¼ºÇÔ¤·¤Æ¤¤¤ë¤³¤È¤ò¤¢¤é¤ï¤·¤Æ¤¤¤Þ¤¹¡£

¤Þ¤¿¾å½Ò¤Î¤è¤¦¤Ë¡¢
¼ºÇÔ¤·¤¿¥Õ¥¡¥¤¥ë̾¡¢¹ÔÈֹ桢¥Æ¥¹¥È¥±¡¼¥¹¤Î̾Á° (<code>complex equals test</code>)¡¢
ɽÌÀ¤·¤¿¾ò·ï¤Îʸ»úÎó (<code>complex_equals (s10_1, s1_1)</code>)¡¢
´üÂÔ¤·¤¿ÃÍ (<code>10+1i</code>)¡¢
¼ÂºÝ¤ÎÃÍ (<code>1+1i</code>)
¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
@endif

@english
@section helper_macros Helper Tool
@japanese
@section helper_macros ¥Ø¥ë¥Ñ¡¼¥Ä¡¼¥ë
@endif

@~english
As you might have noticed, implementing the <code>suite
()</code> function of testCase is a repetitive and error
prone task. A @ref CreatingTestSuite set of functions and
command have been created to automatically implements the
<code>suite()</code> function.
@~japanese
¤ªµ¤¤Å¤­¤Î¤è¤¦¤Ë¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤Î <code>suite ()</code>´Ø¿ô¤ò¼ÂÁõ¤¹¤ë¤Î¤Ï¡¢
È¿ÉüŪ¤Ç´Ö°ã¤¤¤ä¤¹¤¤ºî¶È¤Ç¤¹¡£
@ref CreatingTestSuite ¤Î´Ø¿ô¤Î½¸¤Þ¤ê¤È¥³¥Þ¥ó¥É¤Ï<code>suite ()</code>
´Ø¿ô¤Î¼ÂÁõ¤ò¼«Æ°Åª¤ËºîÀ®¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
@~

@dontinclude complex/testComplex.c

@~english
The following code is a rewrite of ComplexTest using those command:
@~japanese
°Ê²¼¤Î¥³¡¼¥É¤Ï¤½¤ì¤é¤Î¥³¥Þ¥ó¥É¤¬»È¤¦¤è¤¦¤Ë testComplex.c ¤ò½ñ´¹¤¨¤¿¤â¤Î¤Ç¤¹¡£
@~

@~english
First, you declare the testCase, passing the test testCase
name to the javaDoc style comment, which consist of a
C-style comment block starting with two <tt>*</tt>'s:
@~japanese
ºÇ½é¤Ë¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤òÀë¸À¤·¤Þ¤¹¡£
¤³¤ì¤ÏjavaDoc¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥ÈÆâ¤Ë¥Õ¥£¥¯¥¹¥Á¥ã¤Î̾Á°¤òµ­½Ò¤·¤Þ¤¹¡£
javaDoc¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥È¤È¤Ï C ¥¹¥¿¥¤¥ë¤Î¥³¥á¥ó¥È¥Ö¥í¥Ã¥¯¤Î³«»Ï¤¬
Æó¤Ä¤Î¥¢¥¹¥¿¥ê¥¹¥¯ <tt>**</tt> ¤Ë¤Ê¤Ã¤Æ¤¤¤ë¤â¤Î¤Ç¤¹¡£
@~

@code
#include <ccunit/CCUnitAssert.h>

//** test case: complex number test *\/
@endcode

@~english
The function to make @link CCUnitTestSuite TestSuite
@endlink is <code>ccunit_suite</code>.
But, it can be changed to another
name by the <code>-f</code> option of the
<code>ccunit_makeSuite</code> command, too.
Then, you define each test case of the testCase with prefix
<code>test</code>, <code>setUp</code>,
<code>tearDown</code>:
@~japanese
@link CCUnitTestSuite TestSuite @endlink
¤òºîÀ®¤¹¤ë´Ø¿ô¤Ï <code>ccunit_suite</code> ¤Ç¤¹¡¢
¤·¤«¤· <code>ccunit_makeSuite</code> ¥³¥Þ¥ó¥É¤Î
<code>-f</code> ¥ª¥×¥·¥ç¥ó¤ÇÊ̤Î̾Á°¤ËÊѤ¨¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
¤½¤·¤Æ¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Ë¤Ï¤½¤ì¤¾¤ì̾Á°¤ÎÀèƬ¤Ë¡¢
<code>test</code>, <code>setUp</code>,
<code>tearDown</code> ¤ò¤Ä¤±¤Æ¤¯¤À¤µ¤¤¡£
@~

@code
#include <complex.h>

static complex_t* s10_1;
static complex_t* s1_1;
static complex_t* s11_2;
static complex_t* sc;

void setup_setUp_complex_test ()
{
  sc = complex_new (1, 1);
}

void setup_tearDown_complex_test ()
{
  complex_delete (sc);
}

void setUp_complex_test ()
{
  s10_1 = complex_new (10, 1);
  s1_1 = complex_new (1, 1);
  s11_2 = complex_new (11, 2);
}

void tearDown_complex_test ()
{
  complex_delete (s10_1);
  complex_delete (s1_1);
  complex_delete (s11_2);
}

//** test equals *\/
void test_complex_equals ()
{
  CCUNIT_ASSERT_TEST_OBJ (s10_1, complex_equals, s10_1, complex_to_string);
  CCUNIT_ASSERT_TEST_OBJ (s10_1, !complex_equals, s1_1, complex_to_string);
}

//** test add *\/
void test_complex_add ()
{
  complex_t c10_1 = { 10.0, 1.0 };
  complex_t c1_1 = { 1.0, 1.0 };
  complex_t result;
  complex_t c11_2 = { 11.0, 2.0 };
  CCUNIT_ASSERT (complex_equals (&c11_2, complex_add (&result, &c10_1, &c1_1)));
}

//** test sub *\/
void test_complex_sub ()
{
  complex_t c9_0 = { 9, 0 };
  complex_t result;
  CCUNIT_ASSERT_TEST_OBJ (&c9_0, complex_equals,
                          complex_sub (&result, s10_1, s1_1),
                          complex_to_string);
}
@endcode

@~english
Finally, you end the testCase declaration:
@~japanese
ºÇ¸å¤Ë¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤Î½ª¤ê¤òÀë¸À¤·¤Þ¤¹¡£
@~

@code
//** end test case *\/
@endcode

@english
@japanese
¤Ò¤È¤Ä¤Î¥Õ¥¡¥¤¥ë¤ÎÃæ¤ËÊ£¿ô¤Î¥Õ¥£¥¯¥¹¥Á¥ã¤òÄêµÁ¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
¤½¤Î¾ì¹ç¤Ï¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤Î½ª¤ï¤ê¤ÎÀë¸À¤Î¸å¤Ë³¤±¤Æ¥Õ¥£¥¯¥¹¥Á¥ã¤òÄêµÁ¤·¤Æ¤¯¤À¤µ¤¤¡£
@endif

@~english
To generate creating suite function code, run
<code>ccunit_makeSuite</code> tool.
@~japanese
¥¹¡¼¥ÄºîÀ®´Ø¿ô¤Î¥³¡¼¥É¤òÀ¸À®¤¹¤ë¤Ë¤Ï¡¢
<code>ccunit_makeSuite</code>¥Ä¡¼¥ë¤ò¼Â¹Ô¤·¤Þ¤¹¡£
@~

@code
$ ccunit_makeSuite -f complex_suite -o suiteComplex.c testComplex.c
$ cat suiteComplex.c

#include <ccunit/CCUnitTestSuite.h>
#include <ccunit/CCUnitTestCase.h>
#include <ccunit/CCUnitTestFunc.h>

//* test testCase: complex number test *\/
//* setUp_complex_test *\/
extern void setUp_complex_test ();
//* tearDown_complex_test *\/
extern void tearDown_complex_test ();
//* test_complex_equals *\/
extern void test_complex_equals ();
//* test_complex_add *\/
extern void test_complex_add ();
//* test_complex_sub *\/
extern void test_complex_sub ();

static CCUnitTestFunc fx_001_cases[] = {
  {
    "test_complex_equals",
    "test equals",
    test_complex_equals
  },
  {
    "test_complex_add",
    "test add",
    test_complex_add
  },
  {
    "test_complex_sub",
    "test sub",
    test_complex_sub
  },
  {
    NULL, NULL, NULL
  },
};

static CCUnitTestCaseDfn fx_001 = {
  { ccunitTypeTestCase },
  "complex number test",
  {
    "setup_setUp_complex_test",
    "setup_setUp_complex_test",
    setup_setUp_complex_test
  },
  {
    "setup_tearDown_complex_test",
    "setup_tearDown_complex_test",
    setup_tearDown_complex_test
  },
  {
    "setUp_complex_test",
    "setUp_complex_test",
    setUp_complex_test
  },
  {
    "tearDown_complex_test",
    "tearDown_complex_test",
    tearDown_complex_test
  },
  fx_001_cases,
};

static CCUnitTestDfn* suite_001_test[] = {
    &fx_001.test,
    NULL,
};

static CCUnitTestSuiteDfn suite_001 = {
  { ccunitTypeSuite },
  "",
  suite_001_test
};


CCUnitTestSuite* complex_suite (const char* name)
{
  if (!suite_001.name[0])
    suite_001.name = name;
  return ccunit_newTestSuiteFromDfn (&suite_001);
}
$
@endcode

@english
TestCases can be packaged into test suite.
You declare the suite before testCases.
@japanese
¤Ê¤ª¡¢¤¤¤¯¤Ä¤«¤Î¥Õ¥£¥¯¥¹¥Á¥ã¤ò¥Æ¥¹¥È¥¹¡¼¥Ä¤Ë¤Þ¤È¤á¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
¤½¤Î¤¿¤á¤Ë¤Ï¡¢¥Õ¥£¥¯¥¹¥Á¥ã¤ÎÄêµÁ¤ÎÁ°¤Ë¥Æ¥¹¥È¥¹¡¼¥Ä¤òÀë¸À¤·¤Þ¤¹¡£
@endif

@code
//** test suite: complex number test suite *\/
//** test case: complex number equality test *\/
...
//** test case: complex number compute test *\/
...
@endcode

@copydetails CCUnitMakeSuite

@english
@section post_build_check Post-build check
@japanese
@section post_build_check ¥Ó¥ë¥É¸å¤Î¥Á¥§¥Ã¥¯
@endif

@~english
Now that we have our unit tests running, how about
integrating unit testing to our build process ?
@~japanese
¤µ¤¢¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¤ò¼Â¹Ô¤¹¤ë½àÈ÷¤¬¤Ç¤­¤Þ¤·¤¿¡£
¤Ç¤Ï¥Ó¥ë¥É¥×¥í¥»¥¹¤Ë¥æ¥Ë¥Ã¥È¥Æ¥¹¥È¤òÅý¹ç¤¹¤ë¤Ë¤Ï¤É¤¦¤·¤¿¤é¤¤¤¤¤Ç¤·¤ç¤¦¡£
@~

@~english
To do that, the application must returns a value different than 0 to indicate that
there was an error.
@~japanese
¤½¤¦¤¹¤ë¤Ë¤Ï¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ï¡¢¥¨¥é¡¼¤¬È¯À¸¤·¤¿¤³¤È¤ò¼¨¤¹
0 °Ê³°¤ÎÃͤòÊÖ¤µ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
@~

@~english
@link ccunit_runTestRunner() ccunit_runTestRunner() @endlink returns
a integer indicating if the run was successful.
@~japanese
@link ccunit_runTestRunner() ccunit_runTestRunner() @endlink
¤Ï¡¢¼Â¹Ô¤¬À®¸ù¤·¤¿¤«¤É¤¦¤«¤ò¼¨¤¹À°¿ô¤òÊÖ¤·¤Þ¤¹¡£
@~

@~english
Updating our main programm, we obtains:
@~japanese
¼¡¤Î¤è¤¦¤Ë¥á¥¤¥ó¥×¥í¥°¥é¥à¤ò¹¹¿·¤·¤Þ¤¹¡£
@~

@code
#include <ccunit/CCUnitTestRunner.h>

extern CCUnitTestSuite* complex_suite(const char* name);

int main (int argc, char** argv)
{
  CCUnitTestRunner* runner;
  CCUnitTestSuite* suite;
  int wasSucessful;
  runner = ccunit_newTestRunner (stdout);
  suite = complex_suite ("complex test suite");
  wasSucessful = ccunit_runTestRunner (runner, suite);
  return wasSucessful;
}
@endcode

@~english
Now, you need to run your application after compilation.
@~japanese
¤½¤ì¤Ç¤Ï¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ò¥³¥ó¥Ñ¥¤¥ë¤·¤¿¸å¤Ë¼Â¹Ô¤·¤Æ¤ß¤Þ¤·¤ç¤¦¡£
@~

@code
$ gcc -I. -o runTest runTest.c testComplex.c suiteComplex.c complex.c -lccunit
$ ./runTest
...
Time: 0.000032 sec

OK (3 tests)
@endcode

@code
$ ccunit_makeSuite -f complex_suite -o suiteComplex.c testComplex.c testComplexMulDiv.c
$ gcc -I. -o runTest runTest.c testComplex.c testComplexMulDiv.c suiteComplex.c complex.c -lccunit
$ ./runTest
.....
Time: 0.000045 sec

OK (5 tests)
@endcode

@~english
The sample program made in the above is in the @c examples/complex directory.
@~japanese
°Ê¾å¤ÇºîÀ®¤·¤¿¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ï @c examples/complex ¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤¢¤ê¤Þ¤¹¡£
@~

- complex - @~english some complex number library test cases
  @~japanese Ê£ÁÇ¿ô¤ò·×»»¤¹¤ë¥é¥¤¥Ö¥é¥ê¤È¤½¤Î¥Æ¥¹¥È¥±¡¼¥¹¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
  - libcomplex.a - complex number library
    - complex.c
    - complex.h
  - runTestCase @~japanese - ¤â¤Ã¤È¤âñ½ã¤Ê¥Æ¥¹¥È¥±¡¼¥¹¤ò¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
    - runTestCase.c - main program
    - testComplex.c - test cases
  - runTestSuite @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤Î¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
    - runTestSuite.c - main program
    - testComplex.c - test cases
    - testComplexMulDiv.c - test cases
    - complexTestSuite.c - create test suite function
  - runTestRunner @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¥Æ¥¹¥È¥é¥ó¥Ê¡¼¤Ç¼Â¹Ô¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
    - runTestRunner.c - main program
    - testComplex.c - test cases
    - testComplexMulDiv.c - test cases
    - complexTestSuite.c - create test suite function
  - runTest @~japanese - ¥Æ¥¹¥È¥¹¡¼¥Ä¤ò¼«Æ°À¸À®¤¹¤ë¥µ¥ó¥×¥ë¤Ç¤¹¡£@~
    - runTest.c - main program
    - testComplex.c - test cases
    - suiteComplex.c - auto generated test suite from testComplex.c

*/