使用 BOOST.Test 在文件中生成测试报告的更好方法是什么？

Question

我知道默认情况下报告会定向到标准错误，因此必须将其重定向到文件。 我的问题是我们应该在全球固定装置中执行此操作吗？这似乎对我不起作用。

这就是我尝试过的 -

struct MyConfig
{
 MyConfig()
  : testReport("fileName.log")
  {
    if(!testReport.fail())
     original = std::cerr.rdbuf(testReport.rdbuf());
  }
  ~MyConfig()
    {        
        cerr.rdbuf(original);        
        testReport.close();
    }
    ofstream testReport;
    streambuf* original;

 };

 BOOST_GLOBAL_FIXTURE(MyConfig);

运行测试后，仅在控制台上报告输出，尽管使用给定名称创建了 0kb 文件。

Answer 1

使用 Boost 1.44.0（可能还有更高版本），您需要以下代码来创建一个全局固定装置，该全局固定装置将测试程序的输出重定向到以包含测试的主测试套件命名的文件（请参阅 Boost文档）

#include <boost/test/unit_test.hpp>
#include <string>
#include <fstream>

struct LogToFile
{
    LogToFile()
    {
        std::string logFileName(boost::unit_test::framework::master_test_suite().p_name);
        logFileName.append(".xml");
        logFile.open(logFileName.c_str());
        boost::unit_test::unit_test_log.set_stream(logFile);
    }
    ~LogToFile()
    {
        boost::unit_test::unit_test_log.test_finish();
        logFile.close();
        boost::unit_test::unit_test_log.set_stream(std::cout);
    }
    std::ofstream logFile;
};

BOOST_GLOBAL_FIXTURE(LogToFile);

在此示例中 logFile 不是静态成员，如 Steve Townsend 因为将 logFile 声明为静态成员导致错误生成的 XML 和访问固定结构的方式不是线程安全的。

但是，Boost 1.44.0 中似乎存在一个错误，如果 logFile 不是固定结构的静态成员，也会导致生成不正确的 XML 输出（可能与我提到的错误相同）前）。
要解决此问题，请使用 logFile << 行“” <<在析构函数中关闭文件流之前需要 std::flush; 以生成有效的 XML。
感谢@Wracky（下面的评论）我替换了行 logFile << “” << std::flush; 和 boost::unit_test::unit_test_log.test_finish(); 这是比手动编写标签更干净的解决方案。

注意：测试使用以下参数运行：--output_format=XML --log_level=all --report_level=no。
这样就可以通过 xUnit 插件 使用生成的 XML 文件持续集成服务器 Jenkins。

Answer 2

为了完整性：

如果您不愿意，则不必自己重定向输入。
您还可以通过命令行参数指定日志文件：

C:\MyTest.exe --log_sink=fileName.log

我花了一段时间才找到。希望这有帮助！

Answer 3

您可以尝试这个替代方案，改编自此处，据称适用于 Boost 1.34.1。这似乎更符合 Boost 的意图 - 请参阅结果流重写器的用法。

//
// run_tests.cc
//

#define BOOST_AUTO_TEST_MAIN

#include <iostream>
#include <fstream>
#include <cassert>
#include <boost/test/auto_unit_test.hpp>
#include <boost/test/results_reporter.hpp>

std::ofstream ReportRedirector::out;

struct ReportRedirector
{
    ReportRedirector()
    {
        out.open("fileName.log");
        assert( out.is_open() );
        boost::unit_test::results_reporter::set_stream(out);
    }
private:
    static std::ofstream out;
};

BOOST_GLOBAL_FIXTURE(ReportRedirector)