如何编写脚本以使用 boost::unit_test 执行自动测试？

Question

我是 C++ 中自动单元测试的新手。我按照 boost::unit_test 的指令，在 boost::unit_test 中调用函数unit_test_main 完成了一个测试方案。运行测试程序对我来说没有问题。但是，我在将参数传递给测试函数时遇到了问题。也许，下面的代码可以更好地说明我的问题：

#ifndef MAIN_CPP_
#define MAIN_CPP_



#include <string>
#include <vector>
#include <iostream>
#include <assert.h>

#include <boost/program_options.hpp>
#include <boost/test/test_tools.hpp>
#include <boost/test/execution_monitor.hpp>
#include <boost/test/unit_test.hpp>




using namespace boost::program_options;
using namespace std;
using namespace boost;
using namespace boost::unit_test;




/**
* the global test suite
*/

boost::unit_test::test_suite* get_feelfree_test_suite();
boost::unit_test::test_suite* main_global_test_suite;

/**
* name of the test suite
*/
std::string current_global_test_suite_name;

#ifdef BOOST_TEST_ALTERNATIVE_INIT_API

bool  run_global_test_suite () {
    boost::unit_test::test_suite& masterTestSuite = framework::master_test_suite();

    if(masterTestSuite.size() != 0) {
        test_unit_id formerTestSuite = masterTestSuite.get(current_global_test_suite_name);
        masterTestSuite.remove(formerTestSuite);

    }
    masterTestSuite.add(main_global_test_suite);
    current_global_test_suite_name = main_global_test_suite->p_name.get();

    return true;
}
#else
    test_suite* run_global_test_suite(int, char* []) {
    return main_global_test_suite;
}
#endif

/**
* Obtain test program options
*/
int obtain_options(char **optionLine, int argc, char** argv); 





/**
* This function is used to run the test program, and the procedure is really standard.
*/
int main( int argc, char* argv[] )
{
    try 
    {
        /**
        * Step 1. obtain options
        */
        char* optionLine[1024];
        int len ;
        len = obtain_options(optionLine, argc, argv);
        /**
        * Step 2. perform unit test based on user's options
        */
        int test_status=0; 
        main_global_test_suite =   get_feelfree_test_suite();
        test_status = unit_test_main(run_global_test_suite, len, optionLine);
        return test_status;
    } 
    catch(std::exception& e)
    {
        std::cout << e.what() << std::endl;
        return 1;
    }   
    catch (const std::string& s) 
    {
        std::cout << s << std::endl;
        return 1;
    }
    catch (...)
    {
        return 1;
    }


}
/** @} */ 


int obtain_options(char **optionLine, int argc,  char* argv[])
{
    // 1. All the options for testing the program
        options_description desc("Allowed options");
        desc.add_options()("help", "produce help message")
        ("detect_memory_leaks", value<bool>()->default_value(false), "test configuration option (option of boost framework)");
        // 2. Perform parsing 
        variables_map vm;
        store(parse_command_line(argc, argv, desc), vm);
        notify(vm);
        // 3. Illustrate the input 
        std::vector<const char*> options;
        std::string testSuiteToRun;
        if(vm.count("test_suite")){  
            testSuiteToRun = vm["test_suite"].as<string>(); 
        }
        else {
            testSuiteToRun = "main";
        }   

        options.push_back(argv[0]);
        if(vm.count("detect_memory_leaks")) {  
            bool detect = vm["detect_memory_leaks"].as<bool>();
            if(detect) {
                options.push_back("--detect_memory_leaks=1");
            }
            else {
            options.push_back("--detect_memory_leaks=0");
            }
        }
        else {
            options.push_back("--detect_memory_leaks=0");
        }

        // 4. Obtain all the parameters in the format of char** 

        assert(options.size() < 1024);
        std::copy(options.begin(), options.end(), const_cast<const char**>(optionLine));

        return options.size();

}

void Testsub(const std::string &name)
{
    cout<<"File_name: "<<name<<endl;
}
void Testabc( )
{
    std::vector<std::string > name_array;
    name_array.push_back("name 1");
    name_array.push_back("name 2");
    for(int i=0; i<name_array.size(); i++)
        Testsub(name_array[i]);
}


boost::unit_test::test_suite* get_feelfree_test_suite()
{
    test_suite* ts = BOOST_TEST_SUITE( "unit_geometric" );
    ts->add( BOOST_TEST_CASE(&Testabc) ); 
    return ts;
}


#endif

如你所见，在这个测试框架中，我要测试的主要函数是Testsub，它依赖于输入参数const std::string &name。但是，我无法通过测试套件函数 get_feelfree_test_suite 传递任何参数。因此，在这个测试程序中，我编写了另一个测试函数Testabc，其中给出了所有可能的文件测试列表并传递给Testsub。这绝对不是最好的解决方案。我想知道是否还有其他解决方案。想到了几个解决方案，但不知道是不是好的解决方案：

• 解决方案 1：尝试找出一种将参数传递给 get_feelfree_test_suite 从主函数 (int main( int argc, char* argv[])。之后，编写一个脚本来运行程序 几次。在 Windows 中，一种可能的脚本是 .bat 脚本。为了 这个解决方案，我不知道如何实现它。
• 解决方案 2：编写一个列表文件，其中所有可能的输入 给定文件测试名称，然后读取列表中的文件 程序。这更容易实现。

我还听说 Python 可以很容易地集成到测试框架中，但我对此一无所知。无论如何，我对所有可能的解决方案持开放态度，谢谢！

Answer 1

您真的需要在单独的文件中包含不同的“名称”吗？ 将它们放入您的测试套件可能会更简单。每个名称一个 BOOST_AUTO_TEST_CASE。或者一个名称数组，您可以在测试用例中对其进行迭代。

Answer 2

由于我并不真正了解所有代码的用途，因此我发布了一个最小示例，通过从命令行解析 -F file1 -F file2 等元素来完成工作（多次调用 Testsub）。它确实使用了boost::unittest 的BOOST_PARAM_TEST_CASE 宏：

#include <boost/test/parameterized_test.hpp>
//...
void Testsub(const std::string &name)
{
    cout<<"File_name: "<<name<<endl;
}
test_suite* init_unit_test_suite( int argc, char* argv[] ) 
{
  std::vector<std::string> files_to_run_local;

  for(int i = 0; i < framework::master_test_suite().argc; i++)
  {
    if(std::string(framework::master_test_suite().argv[i]) == "-F")
    {
      if(i == framework::master_test_suite().argc - 1)
      {
        std::cerr << "Error in the command line" << std::endl;
        throw boost::unit_test::framework::setup_error("Error in the command line");
      }
      files_to_run_local.push_back(framework::master_test_suite().argv[++i]);
    }
  }

  test_suite* ts = BOOST_TEST_SUITE( "unit_geometric" );
  ts->add( BOOST_PARAM_TEST_CASE( &Testsub, 
                                  files_to_run_local.begin(), 
                                  files_to_run_local.end() ) ); 

  framework::master_test_suite().add(ts);

  return 0;
}

现在，我认为您是唯一决定用于将文件列表传递给单元测试框架的方法的人。包含所有文件的文件也是一个很好的解决方案，如果要传递的列表很大，则可能是合适的，但缺点是使用中间文件来执行此操作。

但回答这个问题实际上取决于驱动您的测试的框架（cmake、shell 等）。Python/cmake 可以非常轻松地为您生成命令行或中间文件。

在所有情况下，清理方法是调用BOOST_PARAM_TEST_CASE 宏。