LoggerTests.cpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file LoggerTests.cpp

// This file is part of the Acts project.
//
// Copyright (C) 2017-2018 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.


#include <boost/test/unit_test.hpp>

#include "Acts/Utilities/Logger.hpp"

#include <cstddef>
#include <fstream>
#include <memory>
#include <stdexcept>
#include <string>
#include <utility>
#include <vector>

namespace Acts {
namespace Test {

using namespace Acts::Logging;

namespace detail {
std::unique_ptr<const Logger> create_logger(const std::string& logger_name,
                                            std::ostream* logfile,
                                            Logging::Level lvl) {
  auto output = std::make_unique<LevelOutputDecorator>(
      std::make_unique<NamedOutputDecorator>(
          std::make_unique<DefaultPrintPolicy>(logfile), logger_name, 30));
  auto print = std::make_unique<DefaultFilterPolicy>(lvl);
  return std::make_unique<const Logger>(std::move(output), std::move(print));
}

std::string failure_msg(const std::string& expected, const std::string& found) {
  return std::string("'") + expected + "' != '" + found + "'";
}
}  // namespace detail

void debug_level_test(const char* output_file, Logging::Level lvl) {
  // Logs will go to this file
  std::ofstream logfile(output_file);

  // If fail-on-error is enabled, then the logger will not, and should not,
  // tolerate being set up with a coarser debug level.
  if (lvl > Logging::getFailureThreshold()) {
    BOOST_CHECK_THROW(detail::create_logger("TestLogger", &logfile, lvl),
                      std::runtime_error);
    return;
  }

  auto test = [&](std::unique_ptr<const Logger> log, const std::string& name) {
    // Set up local logger
    ACTS_LOCAL_LOGGER(std::move(log));

    // Test logging at a certain debug level
    auto test_logging = [](auto&& test_operation, Logging::Level test_lvl) {
      if (test_lvl >= Logging::getFailureThreshold()) {
        BOOST_CHECK_THROW(test_operation(), std::runtime_error);
      } else {
        test_operation();
      }
    };

    // Test logging at all debug levels
    test_logging([&] { ACTS_FATAL("fatal level"); }, FATAL);
    test_logging([&] { ACTS_ERROR("error level"); }, ERROR);
    test_logging([&] { ACTS_WARNING("warning level"); }, WARNING);
    test_logging([&] { ACTS_INFO("info level"); }, INFO);
    test_logging([&] { ACTS_DEBUG("debug level"); }, DEBUG);
    test_logging([&] { ACTS_VERBOSE("verbose level"); }, VERBOSE);
    logfile.close();

    std::string padded_name = name;
    padded_name.resize(30, ' ');

    // Compute expected output for current debug levels
    std::vector<std::string> lines{padded_name + "FATAL     fatal level",
                                   padded_name + "ERROR     error level",
                                   padded_name + "WARNING   warning level",
                                   padded_name + "INFO      info level",
                                   padded_name + "DEBUG     debug level",
                                   padded_name + "VERBOSE   verbose level"};
    lines.resize(static_cast<int>(Logging::Level::MAX) - static_cast<int>(lvl));

    // Check output
    std::ifstream infile(output_file, std::ios::in);
    size_t i = 0;
    for (std::string line; std::getline(infile, line); ++i) {
      BOOST_CHECK_EQUAL(line, lines.at(i));
    }
  };

  auto log = detail::create_logger("TestLogger", &logfile, lvl);
  BOOST_CHECK_EQUAL(log->name(), "TestLogger");
  auto copy = log->clone("TestLoggerClone");
  test(std::move(copy), "TestLoggerClone");
  BOOST_CHECK_EQUAL(log->name(), "TestLogger");

  auto copy2 = log->clone("TestLoggerClone");
  BOOST_CHECK_EQUAL(copy2->level(), log->level());

  auto copy3 = log->cloneWithSuffix("Suffix");
  BOOST_CHECK_EQUAL(log->level(), copy3->level());

  logfile = std::ofstream{output_file};  // clear output

  test(std::move(log), "TestLogger");
}

BOOST_AUTO_TEST_CASE(FATAL_test) {
  debug_level_test("fatal_log.txt", FATAL);
}

BOOST_AUTO_TEST_CASE(ERROR_test) {
  debug_level_test("error_log.txt", ERROR);
}

BOOST_AUTO_TEST_CASE(WARNING_test) {
  debug_level_test("warning_log.txt", WARNING);
}

BOOST_AUTO_TEST_CASE(INFO_test) {
  debug_level_test("info_log.txt", INFO);
}

BOOST_AUTO_TEST_CASE(DEBUG_test) {
  debug_level_test("debug_log.txt", DEBUG);
}

BOOST_AUTO_TEST_CASE(VERBOSE_test) {
  debug_level_test("verbose_log.txt", VERBOSE);
}
}  // namespace Test
}  // namespace Acts