CppUnit快速使用指南作者：李群 文章來(lái)源：developerWorks 中國網(wǎng)站 點(diǎn)擊數： 更新時(shí)間：2006-2-7
0. 背景
CppUnit 是個(gè)基于 LGPL 的開(kāi)源項目，最初版本移植自 JUnit，是一個(gè)非常優(yōu)秀的開(kāi)源測試框架。CppUnit 和 JUnit一樣主要思想來(lái)源于極限編程（XProgramming）。主要功能就是對單元測試進(jìn)行管理，并可進(jìn)行自動(dòng)化測試。這樣描述可能沒(méi)有讓您體會(huì )到測試框架的強大威力，那您在開(kāi)發(fā)過(guò)程中遇到下列問(wèn)題嗎？如果答案是肯定的，就應該學(xué)習使用這種技術(shù)：
- 測試代碼沒(méi)有很好地維護而廢棄，再次需要測試時(shí)還需要重寫(xiě)；
- 投入太多的精力，找 bug，而新的代碼仍然會(huì )出現類(lèi)似 bug；
- 寫(xiě)完代碼，心里沒(méi)底，是否有大量 bug 等待自己；
- 新修改的代碼不知道是否影響其他部分代碼；
- 由于牽扯太多，導致不敢進(jìn)行修改代碼；
...
這些問(wèn)題下文都會(huì )涉及。這個(gè)功能強大的測試框架在國內的 C++語(yǔ)言開(kāi)發(fā)人員中使用的不是很多。本文從開(kāi)發(fā)人員的角度，介紹這個(gè)框架，希望能夠使開(kāi)發(fā)人員用最少的代價(jià)盡快掌握這種技術(shù)。下面從基本原理，CppUnit原理，手動(dòng)使用步驟，通常使用步驟，其他實(shí)際問(wèn)題等方面進(jìn)行討論。以下討論基于 CppUnit1.8.0。
1. 基本原理
對于上面的問(wèn)題僅僅說(shuō)明 CppUnit 的使用是沒(méi)有效果的，下面先從測試的目的，測試原則等方面簡(jiǎn)要說(shuō)明，然后介紹 CppUnit 的具體使用。
首先要明確我們寫(xiě)測試代碼的目的，就是驗證代碼的正確性或者調試 bug。這樣寫(xiě)測試代碼時(shí)就有了針對性，對那些容易出錯的，易變的編寫(xiě)測試代碼；而不用對每個(gè)細節，每個(gè)功能編寫(xiě)測試代碼，當然除非有過(guò)量精力或者可靠性要求。
編碼和測試的關(guān)系是密不可分的，推薦的開(kāi)發(fā)過(guò)程并不要等編寫(xiě)完所有或者很多的代碼后再進(jìn)行測試，而是在完成一部分代碼，比如一個(gè)函數，之后立刻編寫(xiě)測試代碼進(jìn)行驗證。然后再寫(xiě)一些代碼，再寫(xiě)測試。每次測試對所有以前的測試都進(jìn)行一遍。這樣做的優(yōu)點(diǎn)就是，寫(xiě)完代碼，也基本測試完一遍，心里對代碼有信心。而且在寫(xiě)新代碼時(shí)不斷地測試老代碼，對其他部分代碼的影響能夠迅速發(fā)現、定位。不斷編碼測試的過(guò)程也就是對測試代碼維護的過(guò)程，以便測試代碼一直是有效的。有了各個(gè)部分測試代碼的保證，有了自動(dòng)測試的機制，更改以前的代碼沒(méi)有什么顧慮了。在極限編程（一種軟件開(kāi)發(fā)思想）中，甚至強調先寫(xiě)測試代碼，然后編寫(xiě)符合測試代碼的代碼，進(jìn)而完成整個(gè)軟件。
根據上面說(shuō)的目的、思想，下面總結一下平時(shí)開(kāi)發(fā)過(guò)程中單元測試的原則：
- 先寫(xiě)測試代碼，然后編寫(xiě)符合測試的代碼。至少做到完成部分代碼后，完成對應的測試代碼；
- 測試代碼不需要覆蓋所有的細節，但應該對所有主要的功能和可能出錯的地方有相應的測試用例；
- 發(fā)現 bug，首先編寫(xiě)對應的測試用例，然后進(jìn)行調試；
- 不斷總結出現 bug 的原因，對其他代碼編寫(xiě)相應測試用例；
- 每次編寫(xiě)完成代碼，運行所有以前的測試用例，驗證對以前代碼影響，把這種影響盡早消除；
- 不斷維護測試代碼，保證代碼變動(dòng)后通過(guò)所有測試；
有上面的理論做指導，測試行為就可以有規可循。那么 CppUnit 如何實(shí)現這種測試框架，幫助我們管理測試代碼，完成自動(dòng)測試的？下面就看看 CppUnit 的原理。
2. CppUnit 的原理
在 CppUnit 中，一個(gè)或一組測試用例的測試對象被稱(chēng)為 Fixture（設施，下文為方便理解盡量使用英文名稱(chēng)）。Fixture 就是被測試的目標，可能是一個(gè)對象或者一組相關(guān)的對象，甚至一個(gè)函數。
有了被測試的 fixture，就可以對這個(gè) fixture 的某個(gè)功能、某個(gè)可能出錯的流程編寫(xiě)測試代碼，這樣對某個(gè)方面完整的測試被稱(chēng)為T(mén)estCase（測試用例）。通常寫(xiě)一個(gè) TestCase 的步驟包括：
- 對 fixture 進(jìn)行初始化，及其他初始化操作，比如：生成一組被測試的對象，初始化值；
- 按照要測試的某個(gè)功能或者某個(gè)流程對 fixture 進(jìn)行操作；
- 驗證結果是否正確；
- 對 fixture 的及其他的資源釋放等清理工作。
對 fixture 的多個(gè)測試用例，通常（1）（4）部分代碼都是相似的，CppUnit 在很多地方引入了 setUp 和tearDown 虛函數?？梢栽?setUp 函數里完成（1）初始化代碼，而在 tearDown函數中完成（4）代碼。具體測試用例函數中只需要完成（2）（3）部分代碼即可，運行時(shí) CppUnit 會(huì )自動(dòng)為每個(gè)測試用例函數運行setUp，之后運行 tearDown，這樣測試用例之間就沒(méi)有交叉影響。
對 fixture 的所有測試用例可以被封裝在一個(gè) CppUnit::TestFixture的子類(lèi)（命名慣例是[ClassName]Test）中。然后定義這個(gè)fixture 的 setUp 和 tearDown函數，為每個(gè)測試用例定義一個(gè)測試函數（命名慣例是 testXXX）。下面是個(gè)簡(jiǎn)單的例子：
class MathTest : public CppUnit::TestFixture { protected: int m_value1, m_value2; public: MathTest() {} // 初始化函數 void setUp () { m_value1 = 2; m_value2 = 3; } // 測試加法的測試函數 void testAdd () { // 步驟(2),對 fixture 進(jìn)行操作 int result = m_value1 + m_value2; // 步驟(3),驗證結果是否爭取 CPPUNIT_ASSERT( result == 5 ); } // 沒(méi)有什么清理工作沒(méi)有定義 tearDown. }
|
在測試函數中對執行結果的驗證成功或者失敗直接反應這個(gè)測試用例的成功和失敗。CppUnit 提供了多種驗證成功失敗的方式：
CPPUNIT_ASSERT(condition) // 確信condition為真 CPPUNIT_ASSERT_MESSAGE(message, condition) // 當condition為假時(shí)失敗, 并打印message CPPUNIT_FAIL(message) // 當前測試失敗, 并打印message CPPUNIT_ASSERT_EQUAL(expected, actual) // 確信兩者相等 CPPUNIT_ASSERT_EQUAL_MESSAGE(message, expected, actual) // 失敗的同時(shí)打印message CPPUNIT_ASSERT_DOUBLES_EQUAL(expected, actual, delta) // 當expected和actual之間差大于delta時(shí)失敗
|
要把對 fixture 的一個(gè)測試函數轉變成一個(gè)測試用例，需要生成一個(gè) CppUnit::TestCaller對象。而最終運行整個(gè)應用程序的測試代碼的時(shí)候，可能需要同時(shí)運行對一個(gè) fixture 的多個(gè)測試函數，甚至多個(gè) fixture的測試用例。CppUnit 中把這種同時(shí)運行的測試案例的集合稱(chēng)為 TestSuite。而 TestRunner 則運行測試用例或者TestSuite，具體管理所有測試用例的生命周期。目前提供了 3 類(lèi)TestRunner，包括：
CppUnit::TextUi::TestRunner // 文本方式的TestRunner CppUnit::QtUi::TestRunner // QT方式的TestRunner CppUnit::MfcUi::TestRunner // MFC方式的TestRunner
|
下面是個(gè)文本方式 TestRunner 的例子：
CppUnit::TextUi::TestRunner runner; CppUnit::TestSuite *suite= new CppUnit::TestSuite(); // 添加一個(gè)測試用例 suite->addTest(new CppUnit::TestCaller<MathTest> ( "testAdd", testAdd)); // 指定運行TestSuite runner.addTest( suite ); // 開(kāi)始運行, 自動(dòng)顯示測試進(jìn)度和測試結果 runner.run( "", true ); // Run all tests and wait
|
對測試結果的管理、顯示等功能涉及到另一類(lèi)對象，主要用于內部對測試結果、進(jìn)度的管理，以及進(jìn)度和結果的顯示。這里不做介紹。
下面我們整理一下思路，結合一個(gè)簡(jiǎn)單的例子，把上面說(shuō)的思路串在一起。
3. 手動(dòng)使用步驟
首先要明確測試的對象fixture，然后根據其功能、流程，以及以前的經(jīng)驗，確定測試用例。這個(gè)步驟非常重要，直接關(guān)系到測試的最終效果。當然增加測試用例的過(guò)程是個(gè)階段性的工作，開(kāi)始完成代碼后，先完成對功能的測試用例，保證其完成功能；然后對可能出錯的部分，結合以前的經(jīng)驗（比如邊界值測試、路徑覆蓋測試等）編寫(xiě)測試用例；最后在發(fā)現相關(guān) bug 時(shí)，根據 bug 完成測試用例。
比如對整數加法進(jìn)行測試，首先定義一個(gè)新的 TestFixture子類(lèi)，MathTest，編寫(xiě)測試用例的測試代碼。后期需要添加新的測試用例時(shí)只需要添加新的測試函數，根據需要修改 setUp 和tearDown 即可。如果需要對新的 fixture 進(jìn)行測試，定義新的 TestFixture子類(lèi)即可。注：下面代碼僅用來(lái)表示原理，不能編譯。
/// MathTest.h // A TestFixture subclass. // Announce: use as your owner risk. // Author : liqun (liqun@nsfocus.com) // Data : 2003-7-5 #include "cppunit/TestFixture.h" class MathTest : public CppUnit::TestFixture { protected: int m_value1, m_value2; public: MathTest() {} // 初始化函數 void setUp (); // 清理函數 void tearDown(); // 測試加法的測試函數 void testAdd (); // 可以添加新的測試函數 }; /// MathTest.cpp // A TestFixture subclass. // Announce: use as your owner risk. // Author : liqun (liqun@nsfocus.com) // Data : 2003-7-5 #include "MathTest.h" #include "cppunit/TestAssert.h" void MathTest::setUp() { m_value1 = 2; m_value2 = 3; } void MathTest::tearDown() { } void MathTest::testAdd() { int result = m_value1 + m_value2; CPPUNIT_ASSERT( result == 5 ); }
|
然后編寫(xiě) main 函數，把需要測試的測試用例組織到 TestSuite 中，然后通過(guò) TestRuner 運行。這部分代碼后期添加新的測試用例時(shí)需要改動(dòng)的不多。只需要把新的測試用例添加到 TestSuite 中即可。
/// main.cpp // Main file for cppunit test. // Announce: use as your owner risk. // Author : liqun (liqun@nsfocus.com) // Data : 2003-7-5 // Note : Cannot compile, only for study. #include "MathTest.h" #include "cppunit/ui/text/TestRunner.h" #include "cppunit/TestCaller.h" #include "cppunit/TestSuite.h" int main() { CppUnit::TextUi::TestRunner runner; CppUnit::TestSuite *suite= new CppUnit::TestSuite(); // 添加一個(gè)測試用例 suite->addTest(new CppUnit::TestCaller<MathTest> ( "testAdd", testAdd)); // 指定運行TestSuite runner.addTest( suite ); // 開(kāi)始運行, 自動(dòng)顯示測試進(jìn)度和測試結果 runner.run( "", true ); // Run all tests and wait }
|
4. 常用使用方式
按照上面的方式，如果要添加新的測試用例，需要把每個(gè)測試用例添加到 TestSuite 中，而且添加新的 TestFixture需要把所有頭文件添加到 main.cpp 中，比較麻煩。為此 CppUnit 提供了CppUnit::TestSuiteBuilder，CppUnit::TestFactoryRegistry 和一堆宏，用來(lái)方便地把TestFixture 和測試用例注冊到 TestSuite 中。下面就是通常的使用方式：
/// MathTest.h // A TestFixture subclass. // Announce: use as your owner risk. // Author : liqun (liqun@nsfocus.com) // Data : 2003-7-5 #include "cppunit/extensions/HelperMacros.h" class MathTest : public CppUnit::TestFixture { // 聲明一個(gè)TestSuite CPPUNIT_TEST_SUITE( MathTest ); // 添加測試用例到TestSuite, 定義新的測試用例需要在這兒聲明一下 CPPUNIT_TEST( testAdd ); // TestSuite聲明完成 CPPUNIT_TEST_SUITE_END(); // 其余不變 protected: int m_value1, m_value2; public: MathTest() {} // 初始化函數 void setUp (); // 清理函數 void tearDown(); // 測試加法的測試函數 void testAdd (); // 可以添加新的測試函數 }; /// MathTest.cpp // A TestFixture subclass. // Announce: use as your owner risk. // Author : liqun (liqun@nsfocus.com) // Data : 2003-7-5 #include "MathTest.h" // 把這個(gè)TestSuite注冊到名字為"alltest"的TestSuite中, 如果沒(méi)有定義會(huì )自動(dòng)定義 // 也可以CPPUNIT_TEST_SUITE_REGISTRATION( MathTest );注冊到全局的一個(gè)未命名的TestSuite中. CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( MathTest, "alltest" ); // 下面不變 void MathTest::setUp() { m_value1 = 2; m_value2 = 3; } void MathTest::tearDown() { } void MathTest::testAdd() { int result = m_value1 + m_value2; CPPUNIT_ASSERT( result == 5 ); } /// main.cpp // Main file for cppunit test. // Announce: use as your owner risk. // Compile : g++ -lcppunit MathTest.cpp main.cpp // Run : ./a.out // Test : RedHat 8.0 CppUnit1.8.0 // Author : liqun ( a litthle modification. liqun@nsfocus.com) // Data : 2003-7-5 // 不用再包含所有TestFixture子類(lèi)的頭文件 #include <cppunit/extensions/TestFactoryRegistry.h> #include <cppunit/ui/text/TestRunner.h> // 如果不更改TestSuite, 本文件后期不需要更改. int main() { CppUnit::TextUi::TestRunner runner; // 從注冊的TestSuite中獲取特定的TestSuite, 沒(méi)有參數獲取未命名的TestSuite. CppUnit::TestFactoryRegistry ®istry = CppUnit::TestFactoryRegistry::getRegistry("alltest"); // 添加這個(gè)TestSuite到TestRunner中 runner.addTest( registry.makeTest() ); // 運行測試 runner.run(); }
|
這樣添加新的測試用例只需要在類(lèi)定義的開(kāi)始聲明一下即可。
5. 其他實(shí)際問(wèn)題
通常包含測試用例代碼和被測試對象是在不同的項目中。應該在另一個(gè)項目（最好在不同的目錄）中編寫(xiě) TestFixture，然后把被測試的對象包含在測試項目中。
對某個(gè)類(lèi)或者某個(gè)函數進(jìn)行測試的時(shí)候，這個(gè) TestFixture 可能引用了別的類(lèi)或者別的函數，為了隔離其他部分代碼的影響，應該在源文件中臨時(shí)定義一些樁程序，模擬這些類(lèi)或者函數。這些代碼可以通過(guò)宏定義在測試項目中有效，而在被測試的項目中無(wú)效。
6. 參考資料
CppUnit 主頁(yè)JUnitTest Infected: Programmers Love Writing TestsCppUnit Cookbookxprogramming 主頁(yè)測試框架本文代碼下載7. 關(guān)于作者
李群，當前關(guān)注于網(wǎng)絡(luò )安全產(chǎn)品的開(kāi)發(fā)、研究；軟件開(kāi)發(fā)過(guò)程等方面。您可以通過(guò) liqun@nsfocus.com 和他聯(lián)系。
