Log handle for saving messages for testing. More...

#include <ScopedLogStorer.hh>

Public Types
Type aliases
using	VecString = std::vector< std::string >

Public Member Functions
	ScopedLogStorer (Logger *orig, LogLevel min_level)
	Construct reference to log to temporarily replace.

	ScopedLogStorer (Logger *orig)
	Construct reference to log to temporarily replace.

	ScopedLogStorer (ScopedLogStorer &&)=default

	ScopedLogStorer (ScopedLogStorer const &)=delete

ScopedLogStorer &	operator= (ScopedLogStorer &&)=delete

ScopedLogStorer &	operator= (ScopedLogStorer const &)=delete

	~ScopedLogStorer ()
	Restore original logger on destruction.

void	operator() (LogProvenance, LogLevel lev, std::string msg)
	Save a log message.

bool	empty () const
	Whether no messages were stored.

VecString const &	messages () const
	Get saved messages.

VecString const &	levels () const
	Get corresponding log levels.

void	remove_if_contains (std::string const &s)
	Delete messages that contain a certain string.

void	print_expected () const
	Print the expected values.

void	clear ()
	Clear results.

LogLevel	level () const
	Get the minimum level being recorded.

void	level (LogLevel lev)
	Change the level to record.

int	float_digits () const
	Get the minimum level being recorded.

void	float_digits (int fd)
	Change the level to record.

Detailed Description

Log handle for saving messages for testing.

Temporarily replace the given logger with this function. This removes ANSI sequences and replaces pointer-like strings with 0x0.

You can use the CELER_LOG_SCOPED environment variable to print the captured log messages as they are written.

Messages may be written concurrently from multiple threads, but the accessors must not be called while other threads are still logging.

Todo:: The move constructor is subtly broken: the logger retains a pointer to the moved-from object, which may result in use-after-free. Break this into a shared_ptr<ScopedLogResult>, copyable ScopedLogHandler, and a generic ScopedExchange object.

Example:: ScopedLogStorer scoped_log_{&celeritas::world_logger()};

CELER_LOG(info) << "captured";

scoped_log_.print_expected();

EXPECT_TRUE(scoped_log_.empty()) << scoped_log_;

celeritas::test::ScopedLogStorer
Log handle for saving messages for testing.
Definition ScopedLogStorer.hh:51

celeritas::world_logger
Logger & world_logger()
App-level logger: print only on "main" process.
Definition corecel/io/Logger.cc:68

CELER_LOG
#define CELER_LOG(LEVEL)
Return a LogMessage object for streaming into at the given level.
Definition corecel/io/Logger.hh:45

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

Public Types