对于如何在VS2013中进行Boost单元测试,这方面资料太少。自己也因此走了不少弯路。下文将会阐述一下如何在VS2013中进行Boost单元测试。
在开始Boost单元测试之前,我们需要先安装VS2013插件Boost Unit Test Adapter (Update 3) 以及编译Boost库。Boost Unit Test Adapte可以在VS2013中的“工具->扩展与更新”中找到并安装。对于Boost Unit Test Adapter所支持的Boost库版本请参考网页。我选择的是版本号为1.55.0的Boost库(可以在其官网下载得到)。在编译Boost库的时候,可以参考教程及博文。我选择的是完全编译(bjam --toolset=msvc-12.0 --build-type=complete)。
下文以几个步骤来阐述:
1. 新建解决方案及工程
接下来,我们新建一个BoostUnitTest解决方案,然后在该方案下添加(鼠标右击解决方案新建项目)两个项目。第一个项目是空的“WIN32”项目“Tested”,另一个是“Boost Unit Test Project”项目(新建项目->模板->Visual C++->Test下)“BoostUnitTest”。如下图:
2. 在被测试工程中添加文件
在Tested工程中添加一个头文件tested.h及源文件tested.cpp. 具体代码如下
1 #include <iostream> 2 3 using namespace std; 4 5 class Tested 6 { 7 public: 8 9 Tested(); 10 virtual ~Tested(); 11 int add(const int a, const int b); 12 13 private: 14 15 };
1 #include "tested.h" 2 3 Tested::Tested() 4 { 5 6 } 7 8 Tested::~Tested() 9 { 10 11 } 12 13 int Tested::add(const int a, const int b) 14 { 15 return a + b; 16 }
在这里,我们并不需要新建一个main函数对这个类tested进行测试(因为我们已经有单元测试了),但一个程序默认是需要main函数的,所以在需要在Tested项目属性中进行这样的设置(“配置类型”改为“动态库(.dll)”见下图):
接着,“生成”该工程,产生tested.obj文件。
3. 配置Boost单元测试工程
新建的Boost单元测试工程中有两个源文件“BoostUnitTestSample.cpp”及“BoostUnitTest.cpp”(还有stdafx.h、stdafx.cpp、targetver.h),前一个文件是样例,可以不要,后一个文件可以当作我们的单元测试源文件。
先对该工程进行配置:
1)添加“平台工具集”为"Visual Studio 2013 (v120)",见下图:
2)添加包含Boost库的根目录(在我电脑上是D:oots_1_55_0),见下图:
3)添加Boost库目录及待测试工程的.obj文件所在目录,见下图:
4)添加“附加依赖项”“tested.obj”,见下图:
4. 进行Boost单元测试
注:我们在这时只进行简单的单元测试,更加复杂的测试请参考文章最后给出的链接。
在BoostUnitTest工程中的文件“BoostUnitTest.cpp”(也可新建)添加如下代码:
1 #define BOOST_TEST_MODULE Tested_Module // 主测试套件,一个测试项目中只能有一个主测试套件 2 3 #include "stdafx.h" 4 #include "D:VSProjectBoostUnitTestBoostUnitTestTested ested.h" // 待测工程头文件 5 6 struct Tested_Fixture // 测试夹具 7 { 8 Tested_Fixture() 9 { 10 BOOST_TEST_MESSAGE("setup fixture"); 11 tmpTested = new Tested(); 12 } 13 ~Tested_Fixture() 14 { 15 BOOST_TEST_MESSAGE("teardown fixture"); 16 delete tmpTested; 17 } 18 Tested * tmpTested; 19 }; 20 21 BOOST_FIXTURE_TEST_SUITE(Tested_test, Tested_Fixture) // 测试套件 22 23 BOOST_AUTO_TEST_CASE( Tested_Method_add_Test) // 测试用例 24 { 25 // TODO: Your test code here 26 BOOST_WARN(tmpTested->add(2, 2) == 4); // WARN型预言检测 27 BOOST_CHECK(tmpTested->add(2, 2) == 4); // CHECK型预言检测 28 BOOST_REQUIRE(tmpTested->add(2, 2) == 4); // REQUIRE型预言检测 29 } 30 31 BOOST_AUTO_TEST_SUITE_END()
点击“生成->生成解决方案”(预先打开“测试->窗口->测试资源管理器”)可以看到在“测试资源管理器”中出现了“BoostUnitTest”这个单元测试用例,如下图:
注:如果电脑安装有杀毒软件(如360),“生成解决方案”的时候可能会提示:error LNK1104: 无法打开文件“...BoostUnitTestDebugTested.dll"。这是因为杀毒软件拦截了单元测试工程对被测试工程.dll文件的访问。比较简单的方法是将杀毒软件关闭就OK了。
点击“全部运行”,可以看到该测试用例变绿,说明测试通过,如下图:
如果我们将“BoostUnitTest.cpp”中的第13行改成:
BOOST_CHECK(tmpTested->add(2, 2) == 3);
单元测试运行结果是不通过,如下图:
至此,如何进行一个简单的Boost单元测试的过程就完成了。
// 添加于2014.10.18 ---------------------------------------------------------------------------
现在,我在之前程序的基础上又添加了一点异常测试,相关的源代码如下:
1 #include <iostream> 2 3 using namespace std; 4 5 class Tested 6 { 7 public: 8 9 Tested(); 10 virtual ~Tested(); 11 int add(const int a, const int b); 12 void testException(); 13 14 private: 15 16 };
1 #include "tested.h" 2 3 Tested::Tested() 4 { 5 6 } 7 8 Tested::~Tested() 9 { 10 11 } 12 13 int Tested::add(const int a, const int b) 14 { 15 return a + b; 16 } 17 18 void Tested::testException() 19 { 20 throw logic_error("my throw"); // 抛出一个逻辑错误异常 21 }
1 #define BOOST_TEST_MODULE Tested_Module // 主测试套件,一个测试项目中只能有一个主测试套件 2 3 #include "stdafx.h" 4 #include "D:VSProjectBoostUnitTestBoostUnitTestTested ested.h" // 待测工程头文件 5 6 struct Tested_Fixture // 测试夹具 7 { 8 Tested_Fixture() 9 { 10 BOOST_TEST_MESSAGE("setup fixture"); 11 tmpTested = new Tested(); 12 } 13 ~Tested_Fixture() 14 { 15 BOOST_TEST_MESSAGE("teardown fixture"); 16 delete tmpTested; 17 } 18 Tested * tmpTested; 19 }; 20 21 BOOST_FIXTURE_TEST_SUITE(Tested_test, Tested_Fixture) // 测试套件 22 23 BOOST_AUTO_TEST_CASE(Tested_Method_add_Test) // 测试用例 24 { 25 // TODO: Your test code here 26 BOOST_WARN(tmpTested->add(2, 2) == 4); // WARN型预言检测 27 BOOST_CHECK(tmpTested->add(2, 2) == 4); // CHECK型预言检测 28 BOOST_REQUIRE(tmpTested->add(2, 2) == 4); // REQUIRE型预言检测 29 30 } 31 32 BOOST_AUTO_TEST_CASE(Tested_Method_testException_Test) // 测试用例 33 { 34 // TODO: Your test code here 35 BOOST_REQUIRE_NO_THROW(tmpTested->testException()); // 验证是否无异常抛出,是则为真 36 BOOST_REQUIRE_THROW(tmpTested->testException(), logic_error); // 验证抛出的是否是logic_error异常 37 BOOST_REQUIRE_THROW(tmpTested->testException(), runtime_error); // 验证抛出的是否是runtime_error异常 38 39 } 40 41 BOOST_AUTO_TEST_SUITE_END()
很显示,程序的运行结果如下:
35 BOOST_REQUIRE_NO_THROW(tmpTested->testException()); // 测试不通过 36 BOOST_REQUIRE_THROW(tmpTested->testException(), logic_error); // 测试通过 37 BOOST_REQUIRE_THROW(tmpTested->testException(), runtime_error); // 测试不通过
如果要进行更复杂的测试,可以参考官方文档。
还有一些个人觉得比较好的参考资料:
Boost Test Library 中文手册;
DeveloperWorks的“了解Boost单元测试框架”;
博文“单元测试分享”;
博文“Boost学习总结(C++)”;
博文“面向C++的测试驱动开发”。
连载“单元测试实践的主要问题与解决”。