forked from celeritas-project/celeritas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ScopedLogStorer.hh
96 lines (80 loc) · 2.64 KB
/
ScopedLogStorer.hh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
//----------------------------------*-C++-*----------------------------------//
// Copyright 2023-2024 UT-Battelle, LLC, and other Celeritas developers.
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: (Apache-2.0 OR MIT)
//---------------------------------------------------------------------------//
//! \file corecel/ScopedLogStorer.hh
//---------------------------------------------------------------------------//
#pragma once
#include <memory>
#include <ostream>
#include <string>
#include <vector>
#include "corecel/io/LoggerTypes.hh"
namespace celeritas
{
class Logger;
namespace test
{
//---------------------------------------------------------------------------//
/*!
* 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.
*
* \code
ScopedLogStorer scoped_log_{&celeritas::world_logger()};
CELER_LOG(info) << "captured";
scoped_log_.print_expected();
EXPECT_TRUE(scoped_log_.empty()) << scoped_log_;
\endcode
*/
class ScopedLogStorer
{
public:
//!@{
//! \name Type aliases
using VecString = std::vector<std::string>;
//!@}
public:
// Construct reference to log to temporarily replace
ScopedLogStorer(Logger* orig, LogLevel min_level);
// Construct reference with default level
explicit ScopedLogStorer(Logger* orig);
//!@{
//! Disallow move/copy
ScopedLogStorer(ScopedLogStorer const&) = delete;
ScopedLogStorer(ScopedLogStorer&&) = delete;
ScopedLogStorer& operator=(ScopedLogStorer const&) = delete;
ScopedLogStorer& operator=(ScopedLogStorer&&) = delete;
//!@}
// Restore original logger on destruction
~ScopedLogStorer();
// Save a log message
void operator()(LogProvenance, LogLevel lev, std::string msg);
//! Whether no messages were stored
bool empty() const { return messages_.empty(); }
//! Get saved messages
VecString const& messages() const { return messages_; }
//! Get corresponding log levels
VecString const& levels() const { return levels_; }
// Print expected results to stdout
void print_expected() const;
//! Clear results
void clear()
{
messages_.clear();
levels_.clear();
}
private:
Logger* logger_;
std::unique_ptr<Logger> saved_logger_;
VecString messages_;
VecString levels_;
};
// Print expected results
std::ostream& operator<<(std::ostream& os, ScopedLogStorer const& logs);
//---------------------------------------------------------------------------//
} // namespace test
} // namespace celeritas