utest::LogCaptureLogger Class Reference

#include <userver/utest/log_capture_fixture.hpp>

Detailed Description

A mocked logger that stores the log records in memory.

using GrpcCancelSleep = utest::LogCaptureFixture<
    ugrpc::tests::ServiceWithClientFixture<UnitTestServiceCancelSleep, sample::ugrpc::UnitTestServiceClient>>;
 
UTEST_F(GrpcCancelSleep, CancelByTimeoutLogging) {
    ugrpc::client::CallOptions call_options;
    call_options.SetTimeout(std::chrono::milliseconds(500));
    UEXPECT_THROW(GetClient().SayHello({}, std::move(call_options)), ugrpc::client::DeadlineExceededError);
 
    // Make sure server logs are written.
    GetServer().StopServing();
 
    // Check logs via utest::LogCaptureFixture :
    EXPECT_THAT(GetLogCapture().Filter("", {{"error_msg", "Call is interrupted"}}), testing::SizeIs(1))
        << GetLogCapture().GetAll();
}

See also

utest::LogCaptureFixture

Definition at line 101 of file log_capture_fixture.hpp.

Public Member Functions
	LogCaptureLogger (logging::Format format=logging::Format::kRaw)
logging::TextLoggerPtr	GetLogger () const
std::vector< LogRecord >	GetAll () const
std::vector< LogRecord >	Filter (std::string_view text_substring, utils::span< const std::pair< std::string_view, std::string_view > > tag_substrings={}) const
std::vector< LogRecord >	Filter (utils::function_ref< bool(const LogRecord &)> predicate) const
void	Clear () noexcept
	Discards the collected logs.
template<typename T>
std::string	ToStringViaLogging (const T &value)
	Logs value as-if using LOG_*, then extracts the log text.

Member Function Documentation

Filter() [1/2]

std::vector< LogRecord > utest::LogCaptureLogger::Filter	(	std::string_view	text_substring,
		utils::span< const std::pair< std::string_view, std::string_view > >	tag_substrings = {} ) const

Returns

logs filtered by (optional) text substring and (optional) tags substrings.

See also

GetSingleLog

Filter() [2/2]

std::vector< LogRecord > utest::LogCaptureLogger::Filter

(

utils::function_ref< bool(const LogRecord &)>

predicate

)

const

Returns

logs filtered by an arbitrary predicate.

See also

GetSingleLog

GetAll()

std::vector< LogRecord > utest::LogCaptureLogger::GetAll

(

)

const

Returns

all collected logs.

See also

GetSingleLog

GetLogger()

logging::TextLoggerPtr utest::LogCaptureLogger::GetLogger

(

)

const

Returns

the mocked logger.

ToStringViaLogging()

template<typename T>

std::string utest::LogCaptureLogger::ToStringViaLogging ( const T & value )

inline

Logs value as-if using LOG_*, then extracts the log text.

Definition at line 128 of file log_capture_fixture.hpp.

---

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

• userver/utest/log_capture_fixture.hpp