单元测试之CppTest测试框架

1 背景

前面文章CppTest实战演示中报告如何使用CppTest库。其主函数如下：

1. int main(int argc, char *argv[])
2. {
3.     Test::Suite mainSuite;
4.     Test::TextOutput output(Test::TextOutput::Verbose);
6.     mainSuite.add(std::unique_ptr<Test::Suite>(new SeesionSuite));
7.     mainSuite.run(output, true);
9.     return 0;
10. }

复制代码

以上代码有一点不好，就是每增加一个测试Suite就必要在main函数中调用mainSuite.add增加用例。有没有办法测试Suite自动添加，不必要修改main函数。下面报告的测试框架可以办理这个问题。
2 设计

起首设计类TestApp，该类是单例模式，可以添加测试Suite,其次AutoAddSuite是一模板类在其构造函数中自动添加测试Suite.
其类图如下：

类界说如下：

1. class TestApp
2. {
3.     Test::Suite mainSuite_;
4.     TestApp();
5. public:
6.     static TestApp& Instance();
8.     void  addSuite(Test::Suite * suite);
9.     int run(int argc, char *argv[]);
10. };
11. #define theTestApp TestApp::Instance()
13. template<typename Suite>
14. class AutoAddSuite
15. {
16.     Suite* suite;
17. public:
18.     AutoAddSuite()
19.     : suite(new Suite())
20.     {
21.         theTestApp.addSuite(suite);
22.     }
23. };
24. #define ADD_SUITE(Type) AutoAddSuite<Type>  add##Type

复制代码

说明:

• TestApp类型是单例类，提高增加Suite接口和run接口
  
• AutoAddSuite是一个自动添加Suite的模板类型
  
• 宏ADD_SUITE界说了AutoAddSuite对象，用于自动添加。
  

3 实现

1. #include "testapp.h"
3. #include <iostream>
4. #include <cstring>
5. #include <cstdio>
7. namespace
8. {
9. void usage()
10. {
11.     std::cout << "usage: test [MODE]\n"
12.          << "where MODE may be one of:\n"
13.          << "  --compiler\n"
14.          << "  --html\n"
15.          << "  --text-terse (default)\n"
16.          << "  --text-verbose\n";
17.     exit(0);
18. }
20. std::unique_ptr<Test::Output> cmdline(int argc, char* argv[])
21. {
22.     if (argc > 2)
23.         usage(); // will not return
25.     Test::Output* output = 0;
27.     if (argc == 1)
28.         output = new Test::TextOutput(Test::TextOutput::Verbose);
29.     else
30.     {
31.         const char* arg = argv[1];
32.         if (strcmp(arg, "--compiler") == 0)
33.             output = new Test::CompilerOutput;
34.         else if (strcmp(arg, "--html") == 0)
35.             output =  new Test::HtmlOutput;
36.         else if (strcmp(arg, "--text-terse") == 0)
37.             output = new Test::TextOutput(Test::TextOutput::Terse);
38.         else if (strcmp(arg, "--text-verbose") == 0)
39.             output = new Test::TextOutput(Test::TextOutput::Verbose);
40.         else
41.         {
42.             std::cout << "invalid commandline argument: " << arg << std::endl;
43.             usage(); // will not return
44.         }
45.     }
47.     return std::unique_ptr<Test::Output>(output);
48. }
49. }
51. TestApp & TestApp::Instance()
52. {
53.     static TestApp theApp;
54.     return theApp;
55. }
57. TestApp::TestApp()
58. {}
60. void TestApp::addSuite(Test::Suite * suite)
61. {
62.     mainSuite_.add(std::unique_ptr<Test::Suite>(suite));
63. }
65. int TestApp::run(int argc, char *argv[])
66. {
67.     try
68.     {
69.         std::unique_ptr<Test::Output> output(cmdline(argc, argv));
70.         mainSuite_.run(*output, true);
72.         Test::HtmlOutput* const html = dynamic_cast<Test::HtmlOutput*>(output.get());
73.         if (html)
74.             html->generate(std::cout, true, argv[0]);
75.     }
76.     catch (...)
77.     {
78.         std::cout << "unexpected exception encountered\n";
79.         return EXIT_FAILURE;
80.     }
81.     return EXIT_SUCCESS;
82. }

复制代码

说明:

• Instance 返回一个单例引用
  
• addSuite 增加Suite到mainSuite_
  
• run
  
  
  
  • 起首根据命令行返回Test::Output
    
  • 然后调用mainSuite_运行测试用例
    
  • 最后如果类型是Output是Test::HtmlOutput类型，则将结果输出到尺度输出std::cout.
    
  
  

4 使用

4.1 主函数

1. #include "testapp.h"
3. int main(int argc, char *argv[])
4. {
5.     try
6.     {
7.         theTestApp.run(argc, argv);
8.     }
9.     catch(const std::exception& e)
10.     {
11.         std::cerr << e.what() << '\n';
12.     }
13.     return 0;
14. }

复制代码

主函数很简朴，不再详述。
4.2 测试用例

这里使用C++尺度库中std::mutex作为测试示例.
4.2.1 界说

1. #ifndef MUTEX_TEST_H
2. #define MUTEX_TEST_H
3. #include <cpptest/cpptest.h>
5. class MutexSuite : public Test::Suite
6. {
7. public:
8.     MutexSuite()
9.     {
10.         TEST_ADD(MutexSuite::construct)
11.         TEST_ADD(MutexSuite::lock)
12.         TEST_ADD(MutexSuite::try_lock)
13.         TEST_ADD(MutexSuite::unlock)
14.     }
16.     void construct();
17.     void lock();
18.     void try_lock();
19.     void unlock();
20. };
21. #endif

复制代码

说明：

• cpptest库尺度使用，不再详述。
  

4.2.2 实现

1. #include "mutex_test.h"
2. #include "testapp.h"
4. #include <thread>
5. #include <mutex>
7. ADD_SUITE(MutexSuite);
10. void addCount(std::mutex & mutex, int & count)
11. {
12.     mutex.lock();
13.     count++;
14.     mutex.unlock();
15. }
17. void MutexSuite::construct()
18. {
19.     std::mutex muxtex;
20.     int count = 0;
21.     std::thread threads[10];
22.     for(int i = 0; i < 10; i++)
23.         threads[i] = std::thread(addCount, std::ref(muxtex), std::ref(count));
24.     for(auto &thread : threads)
25.         thread.join();
26.     TEST_ASSERT_EQUALS(10, count)   
27. }
29. void MutexSuite::lock()
30. {
31.     std::mutex muxtex;
32.     int count = 10;
33.     std::thread threads[10];
34.     for(int i = 0; i < 10; i++)
35.         threads[i] = std::thread(addCount, std::ref(muxtex), std::ref(count));
36.     for(auto &thread : threads)
37.         thread.join();
38.     TEST_ASSERT_EQUALS(20, count)   
39. }
41. struct Function
42. {
43.     volatile int counter = 0;
44.     void add_10k_count(std::mutex & muxtex)
45.     {
46.         for(int i = 0; i < 10000; i++)
47.         {
48.             if(muxtex.try_lock())
49.             {
50.                 ++counter;
51.                 muxtex.unlock();
52.             }
53.         }
54.     }
55. };
57. void MutexSuite::try_lock()
58. {
59.     std::mutex muxtex;
60.     Function function;
61.     std::thread threads[10];
62.     for(int i = 0; i < 10; i++)
63.         threads[i] = std::thread(&Function::add_10k_count, std::ref(function), std::ref(muxtex));
64.     for(auto &thread : threads)
65.         thread.join();
66.     TEST_ASSERT_EQUALS(true, function.counter < (10 * 10000))
67.     std::cerr << "function.counter: " << function.counter << std::endl;
68. }
70. void MutexSuite::unlock()
71. {
72.     std::mutex muxtex;
73.     int count = 20;
74.     std::thread threads[10];
75.     for(int i = 0; i < 10; i++)
76.         threads[i] = std::thread(addCount, std::ref(muxtex), std::ref(count));
77.     for(auto &thread : threads)
78.         thread.join();
79.     TEST_ASSERT_EQUALS(30, count)   
80. }

复制代码

说明:

• 重点说明下文件头部宏ADD_SUITE的使用,如下所示转达给ADD_SUITE的参数正是MutexSuite,通过该界说，将MutexSuite自动添加到TestApp实例中,不必要修改main函数.
  

1. ADD_SUITE(MutexSuite);

复制代码

4.3 运行

1. $ testapp --html

复制代码

说明:

• testapp是编译出的可实行文件
  
• 参数–html 说明测试报告按网页格式输出.
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。