Question

我想启用Boost.Test输出到的记录 stdout / sterr和日志文件。

但是，我还想让stdout日志记录在HumanReadableFormat中，只有文件输出是XML格式。

生成报告文件似乎已得到解决here。（official docs）

选择格式可以在various ways中完成，但似乎有人坚持使用HRF或XML？

理由：

在Jenkins服务器上运行测试时，xUnit plugin requires 日志 XML输出（而不是报告 XML输出 - log_level与report_level）。

但是，正在进行的日志输出（以HRF为单位）非常有价值，而测试正在服务器上运行，以检测悬挂测试或快速手动检查当前测试的位置。所以我想要一个正在进行的测试HRF日志，最后我需要一个包含Boost.Test <TestLog>...</TestLog>输出的XML文件（不是<TestResult>输出）。

请注意我们通过Boost.Test运行单元和集成测试，因此其中一些是长时间运行的。

Answer 1

我已经完成了:-)经过大量的试验和错误，我设法找到了一个体面的方法，让Boost.Test框架本身完成实际的输出工作，并仍然将XML输出发送到文件

关键是要了解Boost.Test中可以自定义的输出和方式：

有两个日志区域，Test-Log和Test-Result，只有Test-Log很有用，因为测试结果，即使在最高细节级别也只是一个摘要
Boost.Test仅支持一个单输出流用于输出，因此替换该输出不会立即提供帮助，尽管一个可以使用boost::iostream并且一个tee_filter写入stdout和一个文件。
上面没有帮助，因为Boost.Test也只使用一个 sinlge日志格式化程序（unit_test_log_formatter）所以即使你可以将输出分成两个流，你仍然有你只有一种格式的问题。
但是，可以通过boost::unit_test::unit_test_log.set_formatter设置日志格式化程序，这正是我正在做的事情。

我在HRF格式化程序和XML格式化程序上提供了一个瘦包装器，其中HRF格式化程序只记录到默认流，XML格式化程序写入自定义XML文件。

它似乎运行良好，但使用风险自负，因为这是一个非常新的并且尚未在所有套件上运行。

#pragma once

// Copyright (c) 2014
// This file is distributed under the 
// Boost Software License - Version 1.0 - August 17th, 2003
// (See http://www.boost.org/LICENSE_1_0.txt )

#include <boost/test/unit_test_log_formatter.hpp>
#include <boost/test/output/compiler_log_formatter.hpp>
#include <boost/test/output/xml_log_formatter.hpp>
#include <fstream>

namespace boost { 
namespace unit_test { 
namespace output {

//! Log formatter for Boost.Test that outputs the logging output *both*
//! to the standard HRF formatter (normal output stream ~ cout) *and*
//! also to the XML formatter, but the XML is written to a report file.
//!
//! Usage: 
//! // Call in init_unit_test_suite: (this will override the --log_format parameter)
//! boost::unit_test::unit_test_log.set_formatter(
//!   new boost::unit_test::output::dual_log_formatter(L"filename.xml")
//! );
//!
//! Note: Calling `boost::unit_test::unit_test_log.set_stream(...)` will change the stream for
//!       the HRF formatter used here.
//!
//! Note: Implemented in boost::unit_test::output for symmetry with existing formatter classes
//!
class dual_log_formatter : public unit_test_log_formatter {
public:
    // Formatter interface
    void log_start(std::ostream& os, counter_t test_cases_amount) override {
        hrf_logger.log_start(os, test_cases_amount);
        xml_logger.log_start(xml_file, test_cases_amount);
    }
    void log_finish(std::ostream& os) override {
        hrf_logger.log_finish(os);
        xml_logger.log_finish(xml_file);
    }
    void log_build_info(std::ostream& os) override {
        hrf_logger.log_build_info(os);
        xml_logger.log_build_info(xml_file);
    }

    void test_unit_start(std::ostream& os, test_unit const& tu) override {
        hrf_logger.test_unit_start(os, tu);
        xml_logger.test_unit_start(xml_file, tu);
    }

    void test_unit_finish(std::ostream& os, test_unit const& tu, unsigned long elapsed) override {
        hrf_logger.test_unit_finish(os, tu, elapsed);
        xml_logger.test_unit_finish(xml_file, tu, elapsed);
    }

    void test_unit_skipped(std::ostream& os, test_unit const& tu) override {
        hrf_logger.test_unit_skipped(os, tu);
        xml_logger.test_unit_skipped(xml_file, tu);
    }

    void log_exception(std::ostream& os, log_checkpoint_data const& checkpoint_data, execution_exception const& ex) override {
        hrf_logger.log_exception(os, checkpoint_data, ex);
        xml_logger.log_exception(xml_file, checkpoint_data, ex);
    }

    void log_entry_start(std::ostream& os, log_entry_data const& entry_data, log_entry_types let) override {
        hrf_logger.log_entry_start(os, entry_data, let);
        xml_logger.log_entry_start(xml_file, entry_data, let);
    }
    using unit_test_log_formatter::log_entry_value; // bring base class functions into overload set
    void log_entry_value(std::ostream& os, const_string value) override {
        hrf_logger.log_entry_value(os, value);
        xml_logger.log_entry_value(xml_file, value);
    }
    void log_entry_finish(std::ostream& os) override {
        hrf_logger.log_entry_finish(os);
        xml_logger.log_entry_finish(xml_file);
    }

    dual_log_formatter(const wchar_t* xmlFilename) { // Note: Use char* on non-MSVC compilers
        xml_file.open(xmlFilename);
    }

private:
    std::ofstream xml_file;
    compiler_log_formatter hrf_logger;
    xml_log_formatter xml_logger;
};

}
}
}

如何将Boost.Test输出记录到HRF中的stdout和XML中的文件？

1 个答案: