Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards


//  (C) Copyright 2016 Raffi Enficiaud.
//  Distributed under the Boost Software License, Version 1.0.
//  (See accompanying file LICENSE_1_0.txt or copy at

//  See for the library home page.
///@brief Contains the definition of the Junit log formatter (OF_JUNIT)
// ***************************************************************************


// Boost.Test
#include <boost/test/detail/global_typedef.hpp>
#include <boost/test/unit_test_log_formatter.hpp>
#include <boost/test/tree/test_unit.hpp>

//#include <boost/test/results_collector.hpp>

// STL
#include <cstddef> // std::size_t
#include <map>
#include <list>

#include <boost/test/detail/suppress_warnings.hpp>


namespace boost {
namespace unit_test {
namespace output {

  namespace junit_impl {

    // helper for the JUnit logger
    struct junit_log_helper
      struct assertion_entry {

        enum log_entry_t {

        assertion_entry() : sealed(false)

        std::string logentry_message; // the message associated to the JUnit error/entry
        std::string logentry_type; // the one that will get expanded in the final junit (failure, error)
        std::string output;        // additional information/message generated by the assertion

        log_entry_t log_entry;     // the type associated to the assertion (or error)

        bool sealed;               // indicates if the entry can accept additional information

      std::list<std::string> system_out;      // sysout: additional information
      std::list<std::string> system_err;      // syserr: additional information
      std::string skipping_reason;

      // list of failure, errors and messages (assertions message and the full log)
      std::vector< assertion_entry > assertion_entries;

      bool skipping;

      junit_log_helper(): skipping(false)

      void clear() {
          skipping = false;


// ************************************************************************** //
// **************               junit_log_formatter              ************** //
// ************************************************************************** //

/// JUnit logger class
class junit_log_formatter : public unit_test_log_formatter {

    junit_log_formatter() : m_display_build_info(false)
        // we log everything from the logger singleton point of view
        // because we need to know about all the messages/commands going to the logger
        // we decide what we put inside the logs internally
        this->m_log_level = log_successful_tests;
        m_log_level_internal = log_messages;

    // Formatter interface
    void    log_start( std::ostream&, counter_t test_cases_amount ) BOOST_OVERRIDE;
    void    log_finish( std::ostream& ) BOOST_OVERRIDE;
    void    log_build_info( std::ostream&, bool ) BOOST_OVERRIDE;

    void    test_unit_start( std::ostream&, test_unit const& tu ) BOOST_OVERRIDE;
    void    test_unit_finish( std::ostream&, test_unit const& tu, unsigned long elapsed ) BOOST_OVERRIDE;
    void    test_unit_skipped( std::ostream&, test_unit const& tu, const_string reason ) BOOST_OVERRIDE;
    void    test_unit_aborted( std::ostream& os, test_unit const& tu ) BOOST_OVERRIDE;
    void    test_unit_timed_out( std::ostream& os, test_unit const& tu) BOOST_OVERRIDE;

    void    log_exception_start( std::ostream&, log_checkpoint_data const&, execution_exception const& ex ) BOOST_OVERRIDE;
    void    log_exception_finish( std::ostream& ) BOOST_OVERRIDE;

    void    log_entry_start( std::ostream&, log_entry_data const&, log_entry_types let ) BOOST_OVERRIDE;

    using   unit_test_log_formatter::log_entry_value; // bring base class functions into overload set
    void    log_entry_value( std::ostream&, const_string value ) BOOST_OVERRIDE;
    void    log_entry_finish( std::ostream& ) BOOST_OVERRIDE;

    void    entry_context_start( std::ostream&, log_level ) BOOST_OVERRIDE;
    void    log_entry_context( std::ostream&, log_level, const_string ) BOOST_OVERRIDE;
    void    entry_context_finish( std::ostream&, log_level ) BOOST_OVERRIDE;

    //! Discards changes in the log level
    void        set_log_level(log_level ll) BOOST_OVERRIDE
        if(ll > log_successful_tests && ll < log_messages)
            ll = log_successful_tests;
        else if (ll > log_all_errors)
            ll = log_all_errors;

        this->m_log_level_internal = ll;

    //! Instead of a regular stream, returns a file name corresponding to
    //! the current master test suite. If the file already exists, adds an index
    //! to it.
    std::string  get_default_stream_description() const BOOST_OVERRIDE;

    typedef std::map<test_unit_id, junit_impl::junit_log_helper> map_trace_t;
    map_trace_t map_tests;
    junit_impl::junit_log_helper runner_log_entry;

    junit_impl::junit_log_helper& get_current_log_entry() {
            return runner_log_entry;
        map_trace_t::iterator it = map_tests.find(list_path_to_root.back());
        return (it == map_tests.end() ? runner_log_entry : it->second);

    std::list<test_unit_id> list_path_to_root;
    bool m_display_build_info;
    bool m_is_last_assertion_or_error; // true if failure, false if error

    log_level m_log_level_internal;
    friend class junit_result_helper;

} // namespace output
} // namespace unit_test
} // namespace boost

#include <boost/test/detail/enable_warnings.hpp>