testErrorLogger.cc

Go to the documentation of this file.

#define DEBUG // to test the debu logging

#include <utl/ErrorLogger.h>
#include <utl/Verbosity.h>

//#include <utl/Test.h>
#include <tst/Verify.h>
#include <cppunit/extensions/HelperMacros.h>

#include <string>
#include <sstream>

using namespace utl;
using namespace tst;


class testErrorLogger : public CppUnit::TestFixture {

  CPPUNIT_TEST_SUITE(testErrorLogger);

  CPPUNIT_TEST(testSeverityString);
  CPPUNIT_TEST(testStream);
  CPPUNIT_TEST(testLowLevel);
  CPPUNIT_TEST(testMacros);
  CPPUNIT_TEST(testSeverity);
  CPPUNIT_TEST(testG4Logging);
  CPPUNIT_TEST(testVerbosity);

  CPPUNIT_TEST_SUITE_END();

public:
  void
  setUp()
  {
    auto& log = ErrorLogger::GetInstance();
    log.SetMinSeverity(ErrorLogger::eDebug);
    log.SetVerbosity(utl::Verbosity::eVerbose);
    log.SetColorOutput(false);
  }

  void tearDown() { }

  void
  testSeverityString()
  {
    auto& log = ErrorLogger::GetInstance();
    CPPUNIT_ASSERT(log.GetSeverityName(ErrorLogger::eDebug) == "[DEBUG]");
    CPPUNIT_ASSERT(log.GetSeverityName(ErrorLogger::eInfo) == "[INFO]");
    CPPUNIT_ASSERT(log.GetSeverityName(ErrorLogger::eError) == "[ERROR]");
    CPPUNIT_ASSERT(log.GetSeverityName(ErrorLogger::eFatal) == "[FATAL]");
  }

  void
  testStream()
  {
    std::ostringstream a;
    ErrorLogger::GetInstance().SetStream(a);

    INFO("Hi"); const auto line = __LINE__;
    std::ostringstream b;
    b << "[INFO] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testStream: Hi\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));
  }

  void
  testLowLevel()
  {
    std::ostringstream a;
    ErrorLogger::GetInstance().SetStream(a);

    a.str("");
    utl::ErrorLogger::GetInstance().Log(utl::ErrorLogger::eInfo, "LOW", "LOWLEVEL", 0, "Hello Log terse", utl::Verbosity::eFunction, false);
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("LOW: Hello Log terse\n")));

    a.str("");
    utl::ErrorLogger::GetInstance().Log(utl::ErrorLogger::eInfo, "LOW", "LOWLEVEL", 0, "Hello Log verbose", utl::Verbosity::eVerbose, false);
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("[INFO] LOWLEVEL:0: LOW: Hello Log verbose\n")));

    a.str("");
    LOG_MESSAGE_(utl::ErrorLogger::eInfo, "Log again"); const auto line = __LINE__;
    std::ostringstream b;
    b << "[INFO] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testLowLevel: Log again\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));
  }

  void
  testMacros()
  {
    std::ostringstream a;
    std::ostringstream b;
    ErrorLogger::GetInstance().SetStream(a);
    int line = 0;

    a.str("");
    DEBUGLOG("Debug"); line = __LINE__;
    b.str("");
    b << "[DEBUG] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: Debug\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    INFO("Info"); line = __LINE__;
    b.str("");
    b << "[INFO] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: Info\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    WARNING("Warning"); line = __LINE__;
    b.str("");
    b << "[WARN] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: Warning\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    ERROR("Error"); line = __LINE__;
    b.str("");
    b << "[ERROR] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: Error\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    FATAL("Fatal"); line = __LINE__;
    b.str("");
    b << "[FATAL] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: Fatal\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    std::ostringstream info;
    info << "We are in an ostringstream!";
    INFO(info); line = __LINE__;
    b.str("");
    b << "[INFO] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: We are in an ostringstream!\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eTerse);
    INFO("A terse log message");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("A terse log message\n")));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eVerbose);
    WARNING("A verbose warning"); line = __LINE__;
    b.str("");
    b << "[WARN] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testMacros: A verbose warning\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    WARNING_TERSE("A terse warning with verbose default");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("testMacros: A terse warning with verbose default\n")));
  }

  void
  testSeverity()
  {
    std::ostringstream a;
    auto& log = ErrorLogger::GetInstance();
    log.SetStream(a);
    log.SetMinSeverity(ErrorLogger::eError);

    DEBUGLOG("debug");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("")));

    INFO("info");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("")));

    WARNING("warning");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("")));

    ERROR("error"); const auto line = __LINE__;
    std::ostringstream b;
    b << "[ERROR] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testSeverity: error\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    FATAL("fatal"); const auto line2 = __LINE__;
    b << "[FATAL] Utilities/ErrorLogger/testErrorLogger.cc:" << line2 << ": testSeverity: fatal\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));
  }

  void
  testG4Logging()
  {
    std::ostringstream a;
    ErrorLogger::GetInstance().SetStream(a);

    LOGG4COUT("Geant4 output");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("[INFO] G4COut: Geant4 output\n")));

    a.str("");
    LOGG4CERR("Geant4 error");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("[ERROR] G4CErr: Geant4 error\n")));
  }

  void
  testVerbosity()
  {
    std::ostringstream a;
    ErrorLogger::GetInstance().SetStream(a);

    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eFileInfo);
    INFO("A log message"); const auto line = __LINE__;
    std::ostringstream b;
    b << "[INFO] Utilities/ErrorLogger/testErrorLogger.cc:" << line << ": testVerbosity: A log message\n";
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), b.str()));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eSeverity);
    INFO("A log message");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("[INFO] testVerbosity: A log message\n")));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eFunction);
    INFO("A log message");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("testVerbosity: A log message\n")));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eTerse);
    INFO("A log message");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("A log message\n")));

    a.str("");
    utl::ErrorLogger::GetInstance().SetVerbosity(utl::Verbosity::eSilent);
    INFO("A log message");
    CPPUNIT_ASSERT(Verify<Equal>(a.str(), std::string("")));
  }

};


CPPUNIT_TEST_SUITE_REGISTRATION(testErrorLogger);