簡介
測試是軟件開發過程中極其重要的一環,詳盡周密的測試能夠減少軟件BUG,提高軟件品質。測試包括單元測試、系統測試等。其中單元測試是指針對軟件功能單元所作的測試,這里的功能單元可以是一個類的屬性或者方法,測試的目的是看這些基本單元是否工作正常。由于單元測試的內容很基礎,因此可以看作是測試工作的第一環,該項工作一般由開發人員自行完成。如果條件允許,單元測試代碼的開發應與程序代碼的開發同步進行。
雖然不同程序的單元測試代碼不盡相同,但測試代碼的框架卻非常相似,于是便出現了一些單元測試類庫,CppUnit便是其中之一。
CppUnit是XUnit中的一員,XUnit是一個大家族,還包括JUnit和PythonUnit等。CppUnit簡單實用,學習和使用起來都很方便,網上已有一些文章對其作介紹,但本文更著重于講解其中的基本概念和使用方法,以幫助初次接觸CppUnit的人員快速入門。
安裝
目前,CppUnit的最新版本是1.10.2,你可以從下面地址獲?。?/p>http://sourceforge.net/projects/cppunit
解壓后,你可以看到CppUnit包含如下目錄:
config: 配置文件 contrib: contribution,其他人貢獻的外圍代碼 doc: 文檔,需要通過doxygen工具生成,也可以直接從sourceforge站點上下載打包好的文檔 examples:示例代碼 include: 頭文件 lib: 存放編譯好的庫 src: 源文件,以及編譯庫的工程等
然后打開src目錄下的CppUnitLibraries工程,執行build/batch build,編譯成功的話,生成的庫文件將被拷貝到lib目錄下。
你也可以根據需要選擇所需的項目進行編譯,其中項目cppunit為靜態庫,cppunit_dll為動態庫,生成的庫文件為:
cppunit.lib: 靜態庫release版 cppunitd.lib: 靜態庫debug版 cppunit_dll.lib: 動態庫release版 cppunitd_dll.lib:動態庫debug版
要使用CppUnit,還得設置好頭文件和庫文件路徑,以VC6為例,選擇Tools/Options/Directories,在Include files和Library files中分別添加%CppUnitPath%/include和%CppUnitPath%/lib,其中%CppUnitPath%表示CppUnit所在路徑。
做好準備工作后,我們就可以編寫自己的單元測試代碼了。需說明的是,CppUnit所用的動態運行期庫均為多線程動態庫,因此你的單元測試程序也得使用相應設置,否則會發生沖突。
概念
在使用之前,我們有必要認識一下CppUnit中的主要類,當然你也可以先看后面的例子,遇到問題再回過頭來看這一節。
CppUnit核心內容主要包括六個方面,
1. 測試對象(Test,TestFixture,...):用于開發測試用例,以及對測試用例進行組織管理。
2. 測試結果(TestResult):處理測試用例執行結果。TestResult與下面的TestListener采用的是觀察者模式(Observer Pattern)。
3. 測試結果監聽者(TestListener):TestListener作為TestResult的觀察者,擔任實際的結果處理角色。
4. 結果輸出(Outputter):將結果進行輸出,可以制定不同的輸出格式。
5. 對象工廠(TestFactory):用于創建測試對象,對測試用例進行自動化管理。
6. 測試執行體(TestRunner):用于運行一個測試。
以上各模塊的主要類繼承結構如下:
Test TestFixture TestResult TestListener _______|_________ | | | | | TestSuccessListener TestComposite TestLeaf | | | |____________| TestResultCollector TestSuit | TestCase | TestCaller<Fixture> Outputter TestFactory TestRunner ____________________|_________________ | | | | TestFactoryRegistry CompilerOutputter TextOutputter XmlOutputter | TestSuiteFactory<TestCaseType>
接下來再對其中一些關鍵類作以介紹。
Test:所有測試對象的基類。
CppUnit采用樹形結構來組織管理測試對象(類似于目錄樹),因此這里采用了組合設計模式(Composite Pattern),Test的兩個直接子類TestLeaf和TestComposite分別表示“測試樹”中的葉節點和非葉節點,其中TestComposite主要起組織管理的作用,就像目錄樹中的文件夾,而TestLeaf才是最終具有執行能力的測試對象,就像目錄樹中的文件。
Test最重要的一個公共接口為:
virtual void run(TestResult *result) = 0;
其作用為執行測試對象,將結果提交給result。
在實際應用中,我們一般不會直接使用Test、TestComposite以及TestLeaf,除非我們要重新定制某些機制。
TestFixture:用于維護一組測試用例的上下文環境。
在實際應用中,我們經常會開發一組測試用例來對某個類的接口加以測試,而這些測試用例很可能具有相同的初始化和清理代碼。為此,CppUnit引入TestFixture來實現這一機制。
TestFixture具有以下兩個接口,分別用于處理測試環境的初始化與清理工作:
virtual void setUp();
virtual void tearDown();
TestCase:測試用例,從名字上就可以看出來,它便是單元測試的執行對象。
TestCase從Test和TestFixture多繼承而來,通過把Test::run制定成模板函數(Template Method)而將兩個父類的操作融合在一起,run函數的偽定義如下:
// 偽代碼
void TestCase::run(TestResult* result)
{
result->startTest(this); // 通知result測試開始
if( result->protect(this, &TestCase::setUp) ) // 調用setUp,初始化環境
result->protect(this, &TestCase::runTest); // 執行runTest,即真正的測試代碼
result->protect(this, &TestCase::tearDown); // 調用tearDown,清理環境
result->endTest(this); // 通知result測試結束
}
這里要提到的是函數runTest,它是TestCase定義的一個接口,原型如下:
virtual void runTest();
用戶需從TestCase派生出子類并實現runTest以開發自己所需的測試用例。
另外還要提到的就是TestResult的protect方法,其作用是對執行函數(實際上是函數對象)的錯誤信息(包括斷言和異常等)進行捕獲,從而實現對測試結果的統計。
TestSuit:測試包,按照樹形結構管理測試用例
TestSuit是TestComposite的一個實現,它采用vector來管理子測試對象(Test),從而形成遞歸的樹形結構。
TestCaller:TestCase適配器(Adapter),它將成員函數轉換成測試用例
雖然我們可以從TestCase派生自己的測試類,但從TestCase類的定義可以看出,它只能支持一個測試用例,這對于測試代碼的組織和維護很不方便,尤其是那些有共同上下文環境的一組測試。為此,CppUnit提供了TestCaller以解決這個問題。
TestCaller是一個模板類,它以實現了TestFixture接口的類為模板參數,將目標類中某個符合runTest原型的測試方法適配成TestCase的子類。
在實際應用中,我們大多采用TestFixture和TestCaller相組合的方式,具體例子參見后文。
TestResult和TestListener:處理測試信息和結果
前面已經提到,TestResult和TestListener采用了觀察者模式,TestResult維護一個注冊表,用于管理向其登記過的TestListener,當TestResult收到測試對象(Test)的測試信息時,再一一分發給它所管轄的TestListener。這一設計有助于實現對同一測試的多種處理方式。
TestFactory:測試工廠
這是一個輔助類,通過借助一系列宏定義讓測試用例的組織管理變得自動化。參見后面的例子。
TestRunner:用于執行測試用例
TestRunner將待執行的測試對象管理起來,然后供用戶調用。其接口為:
virtual void addTest( Test *test ); virtual void run( TestResult &controller, const std::string &testPath = "" );
這也是一個輔助類,需注意的是,通過addTest添加到TestRunner中的測試對象必須是通過new動態創建的,用戶不能刪除這個對象,因為TestRunner將自行管理測試對象的生命期。
使用
先讓我們看看一個簡單的例子:
#include <cppunit/TestCase.h>
#include <cppunit/TestResult.h>
#include <cppunit/TestResultCollector.h>
#include <cppunit/TextOutputter.h>
// 定義測試用例
class SimpleTest : public CppUnit::TestCase
{
public:
void runTest() // 重載測試方法
{
int i = 1;
CPPUNIT_ASSERT_EQUAL(0, i);
}
};
int main(int argc, char* argv[])
{
CppUnit::TestResult r;
CppUnit::TestResultCollector rc;
r.addListener(&rc); // 準備好結果收集器
SimpleTest t;
t.run(&r); // 運行測試用例
CppUnit::TextOutputter o(&rc, std::cout);
o.write(); // 將結果輸出
return 0;
}
編譯后運行,輸出結果為:!!!FAILURES!!!
Test Results:
Run: 1 Failures: 1 Errors: 0
1) test: (F) line: 18 E:/CppUnitExamples/SimpleTest.cpp
equality assertion failed
- Expected: 1
- Actual : 0
上面的例子很簡單,需說明的是CPPUNIT_ASSERT_EQUAL宏。CppUnit定義了一組宏用于檢測錯誤,CPPUNIT_ASSERT_EQUAL是其中之一,當斷言失敗時,CppUnit便會將錯誤信息報告給TestResult。這些宏定義的說明如下:
CPPUNIT_ASSERT(condition):判斷condition的值是否為真,如果為假則生成錯誤信息。
CPPUNIT_ASSERT_MESSAGE(message, condition):與CPPUNIT_ASSERT類似,但結果為假時報告messsage信息。
CPPUNIT_FAIL(message):直接報告messsage錯誤信息。
CPPUNIT_ASSERT_EQUAL(expected, actual):判斷expected和actual的值是否相等,如果不等輸出錯誤信息。
CPPUNIT_ASSERT_EQUAL_MESSAGE(message, expected, actual):與CPPUNIT_ASSERT_EQUAL類似,但斷言失敗時輸出message信息。
CPPUNIT_ASSERT_DOUBLES_EQUAL(expected, actual, delta):判斷expected與actual的偏差是否小于delta,用于浮點數比較。
CPPUNIT_ASSERT_THROW(expression, ExceptionType):判斷執行表達式expression后是否拋出ExceptionType異常。
CPPUNIT_ASSERT_NO_THROW(expression):斷言執行表達式expression后無異常拋出。
接下來再看看TestFixture和TestCaller的組合使用:
#include <cppunit/TestCase.h>
#include <cppunit/TestResult.h>
#include <cppunit/TestResultCollector.h>
#include <cppunit/TextOutputter.h>
#include <cppunit/TestCaller.h>
#include <cppunit/TestRunner.h>
// 定義測試類
class StringTest : public CppUnit::TestFixture
{
public:
void setUp() // 初始化
{
m_str1 = "Hello, world";
m_str2 = "Hi, cppunit";
}
void tearDown() // 清理
{
}
void testSwap() // 測試方法1
{
std::string str1 = m_str1;
std::string str2 = m_str2;
m_str1.swap(m_str2);
CPPUNIT_ASSERT(m_str1 == str2);
CPPUNIT_ASSERT(m_str2 == str1);
}
void testFind() // 測試方法2
{
int pos1 = m_str1.find(',');
int pos2 = m_str2.rfind(',');
CPPUNIT_ASSERT_EQUAL(5, pos1);
CPPUNIT_ASSERT_EQUAL(2, pos2);
}
protected:
std::string m_str1;
std::string m_str2;
};
int main(int argc, char* argv[])
{
CppUnit::TestResult r;
CppUnit::TestResultCollector rc;
r.addListener(&rc); // 準備好結果收集器
CppUnit::TestRunner runner; // 定義執行實體
runner.addTest(new CppUnit::TestCaller<StringTest>("testSwap", &StringTest::testSwap)); // 構建測試用例1
runner.addTest(new CppUnit::TestCaller<StringTest>("testFind", &StringTest::testFind)); // 構建測試用例2
runner.run(r); // 運行測試
CppUnit::TextOutputter o(&rc, std::cout);
o.write(); // 將結果輸出
return rc.wasSuccessful() ? 0 : -1;
}
編譯后運行結果為:OK (2 tests)
上面的代碼從功能上講沒有什么問題,但編寫起來太繁瑣了,為此,我們可以借助CppUnit定義的一套輔助宏,將測試用例的定義和注冊變得自動化。上面的代碼改造后如下:
#include <cppunit/TestResult.h>
#include <cppunit/TestResultCollector.h>
#include <cppunit/TextOutputter.h>
#include <cppunit/TestRunner.h>
#include <cppunit/extensions/HelperMacros.h>
// 定義測試類
class StringTest : public CppUnit::TestFixture
{
CPPUNIT_TEST_SUITE(StringTest); // 定義測試包
CPPUNIT_TEST(testSwap); // 添加測試用例1
CPPUNIT_TEST(testFind); // 添加測試用例2
CPPUNIT_TEST_SUITE_END(); // 結束測試包定義
public:
void setUp() // 初始化
{
m_str1 = "Hello, world";
m_str2 = "Hi, cppunit";
}
void tearDown() // 清理
{
}
void testSwap() // 測試方法1
{
std::string str1 = m_str1;
std::string str2 = m_str2;
m_str1.swap(m_str2);
CPPUNIT_ASSERT(m_str1 == str2);
CPPUNIT_ASSERT(m_str2 == str1);
}
void testFind() // 測試方法2
{
int pos1 = m_str1.find(',');
int pos2 = m_str2.rfind(',');
CPPUNIT_ASSERT_EQUAL(5, pos1);
CPPUNIT_ASSERT_EQUAL(2, pos2);
}
protected:
std::string m_str1;
std::string m_str2;
};
CPPUNIT_TEST_SUITE_REGISTRATION(StringTest); // 自動注冊測試包
int main(int argc, char* argv[])
{
CppUnit::TestResult r;
CppUnit::TestResultCollector rc;
r.addListener(&rc); // 準備好結果收集器
CppUnit::TestRunner runner; // 定義執行實體
runner.addTest(CppUnit::TestFactoryRegistry::getRegistry().makeTest());
runner.run(r); // 運行測試
CppUnit::TextOutputter o(&rc, std::cout);
o.write(); // 將結果輸出
return rc.wasSuccessful() ? 0 : -1;
}
CppUnit的簡單介紹就到此,相信你已經了解了其中的基本概念,也能夠開發單元測試代碼了。
轉自:http://blog.csdn.net/freefalcon/article/details/753819