LogMessageTest Class Reference

Test fixture to be able to check the contents and types of emitted log messages in detail. More...

#include <Fixtures.h>

Inheritance diagram for LogMessageTest:

Protected Member Functions
void	SetUp () override
	Add a log message interceptor.
void	TearDown () override
	And try to reset logging system to default.
void	expectMessage (LogConfig::ELogLevel level=LogConfig::c_Error, int count=1, bool strict=false)
	check if there is a certain number of log messages of a given level
void	expectMessageContent (LogConfig::ELogLevel level, const std::string &message)
	check the content of the last log message against the given values
void	expectMessageVariables (std::map< std::string, std::string > &&variables, bool strict=false)
	check if the last message emitted contains the given variables and their values.
void	expectErrorWithVariables (std::map< std::string, std::string > &&variables, bool strict=false)
	Expect an error with variables: This is a shorthand to check that there is exactly one error message present and that it contains the given variables.
void	clearMessages ()
	clear the list of save log messages

Protected Attributes
std::vector< LogMessage >	m_messages
	list of log messages

Detailed Description

Test fixture to be able to check the contents and types of emitted log messages in detail.

In contrast to EXPECT_B2ERROR() and others defined here this test fixture will keep a copy of every message emitted and all messages can be expected in detail. There are a few convenient members to check for message counts and message contents.

Definition at line 23 of file Fixtures.h.

Member Function Documentation

clearMessages()

void clearMessages ( )

inlineprotected

clear the list of save log messages

Definition at line 62 of file Fixtures.h.

    {
      m_messages.clear();
    }

expectErrorWithVariables()

void expectErrorWithVariables ( std::map< std::string, std::string > &&  variables, bool  strict = false  )

protected

Expect an error with variables: This is a shorthand to check that there is exactly one error message present and that it contains the given variables.

This also clears the list of messages for convenience so after each call which is supposed to create an error this function can be called to handle the error message and afterwards the list of messages will be clean again for the next test.

This is a shorthand to just call expectMessage(), expectMessageVariables() and clearMessages()

Parameters

variables	map of name->value mapping for all expected variables
strict	if true also fail the test if there's any other variable in the message

Definition at line 75 of file Fixtures.cc.

  {
    expectMessage(LogConfig::c_Error, 1, true);
    expectMessageVariables(std::move(variables), strict);
    clearMessages();
  }

expectMessage()

void expectMessage ( LogConfig::ELogLevel  level = LogConfig::c_Error, int  count = 1, bool  strict = false  )

protected

check if there is a certain number of log messages of a given level

Parameters

level	which log level to check for
count	how many message should be expected
strict	if true don't allow any other messages: the total number of messages must be equal to count and all need to have severity level

Definition at line 47 of file Fixtures.cc.

  {
    int messages = std::count_if(m_messages.begin(), m_messages.end(), [level](const LogMessage & m) {
      return m.getLogLevel() == level;
    });
    EXPECT_EQ(count, messages) << "Expected " << count << " messages of loglevel " << LogConfig::logLevelToString(level)
                               << ", found " << messages;
    if (strict) {
      EXPECT_EQ(messages, m_messages.size());
    }
  }

expectMessageContent()

void expectMessageContent ( LogConfig::ELogLevel  level, const std::string &  message  )

protected

check the content of the last log message against the given values

Parameters

level	log level we expect for the message
message	expected string content of the message.

Definition at line 82 of file Fixtures.cc.

  {
    ASSERT_FALSE(m_messages.empty()) << "No message available to check";
    const auto& msg = m_messages.back();
    EXPECT_EQ(msg.getLogLevel(), level);
    EXPECT_EQ(msg.getMessage(), message);
  }

expectMessageVariables()

void expectMessageVariables ( std::map< std::string, std::string > &&  variables, bool  strict = false  )

protected

check if the last message emitted contains the given variables and their values.

Parameters

variables	map of name->value mapping for all expected variables
strict	if true also fail the test if there's any other variable in the message

Definition at line 59 of file Fixtures.cc.

  {
    ASSERT_FALSE(m_messages.empty()) << "No message available to check";
    const auto& msg = m_messages.back();
    for (const auto& var : msg.getLogVariables()) {
      if (auto it = variables.find(var.getName()); it != variables.end()) {
        EXPECT_EQ(it->second, var.getValue());
        variables.erase(it);
      } else {
        EXPECT_FALSE(strict) << "extra variable: " << var.getName() << std::endl;
      }
    }
    EXPECT_TRUE(variables.empty()) << "Some requested log variables were not present in the log message: "
                                   << boost::algorithm::join(variables | boost::adaptors::map_keys, ", ");
  }

SetUp()

void SetUp ( )

overrideprotected

Add a log message interceptor.

Definition at line 33 of file Fixtures.cc.

  {
    m_messages.clear();
    LogSystem::Instance().resetLogConnections();
    LogSystem::Instance().addLogConnection(new LogInterceptor(m_messages));
    LogSystem::Instance().addLogConnection(new LogConnectionConsole(STDOUT_FILENO));
  }

TearDown()

void TearDown ( )

overrideprotected

And try to reset logging system to default.

Definition at line 42 of file Fixtures.cc.

  {
    LogSystem::Instance().resetLogging();
  }

Member Data Documentation

m_messages

std::vector<LogMessage> m_messages

protected

list of log messages

Definition at line 26 of file Fixtures.h.

---

The documentation for this class was generated from the following files:

• framework/utilities/testhelpers/include/Fixtures.h
• framework/utilities/testhelpers/src/Fixtures.cc