1022567176

Committed 02 Oct 2023 07:50AM UTC coverage: 80.127% (+2.5%) from 77.645%

Build # 1022567176

Build Type

push

gitlab-ci

Committed by

kacf

Commit Message

chore: Centralize selection of `std::filesystem` library.

Signed-off-by: Kristian Amlie <kristian.amlie@northern.tech>

Run Details

6447 of 8046 relevant lines covered (80.13%)

9912.21 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.57

/common/log/platform/boost/boost_log.cpp

// Copyright 2023 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

#include <common/log.hpp>


#include <boost/smart_ptr/shared_ptr.hpp>
#include <boost/core/null_deleter.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/log/common.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/attributes.hpp>
#include <boost/log/sinks.hpp>
#include <boost/log/sources/logger.hpp>
#include <boost/log/utility/manipulators/add_value.hpp>
#include <boost/log/attributes/scoped_attribute.hpp>
#include <boost/log/support/date_time.hpp>

#include <string>
#include <fstream>
#include <common/error.hpp>
#include <common/expected.hpp>

namespace mender {
namespace common {
namespace log {

namespace logging = boost::log;
namespace expr = boost::log::expressions;
namespace sinks = boost::log::sinks;
namespace attrs = boost::log::attributes;
namespace src = boost::log::sources;

namespace error = mender::common::error;
namespace expected = mender::common::expected;

using namespace std;


const LogErrorCategoryClass LogErrorCategory;

const char *LogErrorCategoryClass::name() const noexcept {
        return "LogErrorCategory";
}

string LogErrorCategoryClass::message(int code) const {
        switch (code) {
        case NoError:
                return "Success";
        case InvalidLogLevelError:
                return "Invalid log level given";
        case LogFileError:
                return "Bad log file";
        default:
                return "Unknown";
        }
}

error::Error MakeError(LogErrorCode code, const string &msg) {
        return error::Error(error_condition(code, LogErrorCategory), msg);
}

ExpectedLogLevel StringToLogLevel(const string &level_str) {
        if (level_str == "fatal") {
                return ExpectedLogLevel(LogLevel::Fatal);
        } else if (level_str == "error") {
                return ExpectedLogLevel(LogLevel::Error);
        } else if (level_str == "warning") {
                return ExpectedLogLevel(LogLevel::Warning);
        } else if (level_str == "info") {
                return ExpectedLogLevel(LogLevel::Info);
        } else if (level_str == "debug") {
                return ExpectedLogLevel(LogLevel::Debug);
        } else if (level_str == "trace") {
                return ExpectedLogLevel(LogLevel::Trace);
        } else {
                return ExpectedLogLevel(expected::unexpected(MakeError(
                        LogErrorCode::InvalidLogLevelError, "'" + level_str + "' is not a valid log level")));
        }
}

static void LogfmtFormatter(logging::record_view const &rec, logging::formatting_ostream &strm) {
        strm << "record_id=" << logging::extract<unsigned int>("RecordID", rec) << " ";

        auto level = logging::extract<LogLevel>("Severity", rec);
        if (level) {
                std::string lvl = ToStringLogLevel(level.get());
                strm << "severity=" << lvl << " ";
        }

        auto val = logging::extract<boost::posix_time::ptime>("TimeStamp", rec);
        if (val) {
                strm << "time=\"" << val.get() << "\" ";
        }

        auto name = logging::extract<std::string>("Name", rec);
        if (name) {
                strm << "name=\"" << name.get() << "\" ";
        }

        for (auto f : rec.attribute_values()) {
                auto field = logging::extract<LogField>(f.first.string(), rec);
                if (field) {
                        strm << field.get().key << "=\"" << field.get().value << "\" ";
                }
        }

        strm << "msg=\"" << rec[expr::smessage] << "\" ";
}

static void SetupLoggerSinks() {
        typedef sinks::synchronous_sink<sinks::text_ostream_backend> text_sink;
        boost::shared_ptr<text_sink> sink(new text_sink);

        {
                text_sink::locked_backend_ptr pBackend = sink->locked_backend();
                boost::shared_ptr<std::ostream> pStream(&std::clog, boost::null_deleter());
                pBackend->add_stream(pStream);
        }

        sink->set_formatter(&LogfmtFormatter);

        logging::core::get()->add_sink(sink);
}

static void SetupLoggerAttributes() {
        attrs::counter<unsigned int> RecordID(1);
        logging::core::get()->add_global_attribute("RecordID", RecordID);

        attrs::local_clock TimeStamp;
        logging::core::get()->add_global_attribute("TimeStamp", TimeStamp);
}

Logger::Logger(const string &name) :
        Logger {name, global_logger_.Level()} {
}

Logger::Logger(const string &name, LogLevel level) :
        logger_ {new src::severity_logger<LogLevel>},
        name_ {name},
        level_ {level} {
        this->logger_->add_attribute("Name", attrs::constant<std::string>(name));
}

void Logger::Log_(LogLevel level, const string &message) {
        BOOST_LOG_SEV(*this->logger_, level) << message;
}

void Logger::SetLevel(LogLevel level) {
        this->level_ = level;
}

LogLevel Logger::Level() {
        return this->level_;
}

void Logger::AddField(const LogField &field) {
        this->logger_->add_attribute(field.key, attrs::constant<LogField>(field));
        return;
}

Logger Setup() {
        SetupLoggerSinks();
        SetupLoggerAttributes();
#ifdef NDEBUG
        return Logger("Global", LogLevel::Info);
#else
        return Logger("Global", LogLevel::Debug);
#endif
}

Logger global_logger_ = Setup();

void SetLevel(LogLevel level) {
        global_logger_.SetLevel(level);
}

error::Error SetupFileLogging(const string &log_file_path, bool exclusive) {
        typedef sinks::synchronous_sink<sinks::text_ostream_backend> text_sink;
        boost::shared_ptr<text_sink> sink = boost::make_shared<text_sink>();

        // Add a stream to write log to
        auto log_stream = boost::make_shared<std::ofstream>();
        errno = 0;
        log_stream->open(log_file_path);
        if (!(*log_stream.get())) {
                auto io_errno = errno;
                return MakeError(
                        LogErrorCode::LogFileError,
                        "Failed to open '" + log_file_path + "' for logging: " + strerror(io_errno));
        }
        sink->set_formatter(&LogfmtFormatter);

        sink->locked_backend()->add_stream(log_stream);
        sink->locked_backend()->auto_flush(true);

        if (exclusive) {
                logging::core::get()->remove_all_sinks();
        }

        // Register the sink in the logging core
        logging::core::get()->add_sink(sink);

        return error::NoError;
}

LogLevel Level() {
        return global_logger_.Level();
}

void Log_(LogLevel level, const string message) {
        global_logger_.Log(level, message);
}

void Fatal(const string &message) {
        global_logger_.Log(LogLevel::Fatal, message);
        std::abort();
}
void Error(const string &message) {
        return global_logger_.Log(LogLevel::Error, message);
}
void Warning(const string &message) {
        return global_logger_.Log(LogLevel::Warning, message);
}
void Info(const string &message) {
        return global_logger_.Log(LogLevel::Info, message);
}
void Debug(const string &message) {
        return global_logger_.Log(LogLevel::Debug, message);
}
void Trace(const string &message) {
        return global_logger_.Log(LogLevel::Trace, message);
}


} // namespace log
} // namespace common
} // namespace mender

1	// Copyright 2023 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14
15	#include <common/log.hpp>
16
17
18	#include <boost/smart_ptr/shared_ptr.hpp>
19	#include <boost/core/null_deleter.hpp>
20	#include <boost/date_time/posix_time/posix_time.hpp>
21	#include <boost/log/common.hpp>
22	#include <boost/log/expressions.hpp>
23	#include <boost/log/attributes.hpp>
24	#include <boost/log/sinks.hpp>
25	#include <boost/log/sources/logger.hpp>
26	#include <boost/log/utility/manipulators/add_value.hpp>
27	#include <boost/log/attributes/scoped_attribute.hpp>
28	#include <boost/log/support/date_time.hpp>
29
30	#include <string>
31	#include <fstream>
32	#include <common/error.hpp>
33	#include <common/expected.hpp>
34
35	namespace mender {
36	namespace common {
37	namespace log {
38
39	namespace logging = boost::log;
40	namespace expr = boost::log::expressions;
41	namespace sinks = boost::log::sinks;
42	namespace attrs = boost::log::attributes;
43	namespace src = boost::log::sources;
44
45	namespace error = mender::common::error;
46	namespace expected = mender::common::expected;
47
48	using namespace std;
49
50
51	const LogErrorCategoryClass LogErrorCategory;
52
53	const char *LogErrorCategoryClass::name() const noexcept {	×
54	return "LogErrorCategory";	×
55	}
56
57	string LogErrorCategoryClass::message(int code) const {	×
58	switch (code) {	×
59	case NoError:
60	return "Success";	×
61	case InvalidLogLevelError:
62	return "Invalid log level given";	×
63	case LogFileError:
64	return "Bad log file";	×
65	default:
66	return "Unknown";	×
67	}
68	}
69
70	error::Error MakeError(LogErrorCode code, const string &msg) {	1✔
71	return error::Error(error_condition(code, LogErrorCategory), msg);	2✔
72	}
73
74	ExpectedLogLevel StringToLogLevel(const string &level_str) {	101✔
75	if (level_str == "fatal") {	101✔
76	return ExpectedLogLevel(LogLevel::Fatal);
77	} else if (level_str == "error") {	101✔
78	return ExpectedLogLevel(LogLevel::Error);
79	} else if (level_str == "warning") {	101✔
80	return ExpectedLogLevel(LogLevel::Warning);
81	} else if (level_str == "info") {	101✔
82	return ExpectedLogLevel(LogLevel::Info);
83	} else if (level_str == "debug") {	×
84	return ExpectedLogLevel(LogLevel::Debug);
85	} else if (level_str == "trace") {	×
86	return ExpectedLogLevel(LogLevel::Trace);
87	} else {
88	return ExpectedLogLevel(expected::unexpected(MakeError(	×
89	LogErrorCode::InvalidLogLevelError, "'" + level_str + "' is not a valid log level")));	×
90	}
91	}
92
93	static void LogfmtFormatter(logging::record_view const &rec, logging::formatting_ostream &strm) {	75,473✔
94	strm << "record_id=" << logging::extract<unsigned int>("RecordID", rec) << " ";	75,473✔
95
96	auto level = logging::extract<LogLevel>("Severity", rec);	75,473✔
97	if (level) {	75,473✔
98	std::string lvl = ToStringLogLevel(level.get());	75,473✔
99	strm << "severity=" << lvl << " ";	75,473✔
100	}
101
102	auto val = logging::extract<boost::posix_time::ptime>("TimeStamp", rec);	75,473✔
103	if (val) {	75,473✔
104	strm << "time=\"" << val.get() << "\" ";	150,946✔
105	}
106
107	auto name = logging::extract<std::string>("Name", rec);	75,473✔
108	if (name) {	75,473✔
109	strm << "name=\"" << name.get() << "\" ";	75,473✔
110	}
111
112	for (auto f : rec.attribute_values()) {	463,484✔
113	auto field = logging::extract<LogField>(f.first.string(), rec);	388,011✔
114	if (field) {	388,011✔
115	strm << field.get().key << "=\"" << field.get().value << "\" ";	10,646✔
116	}
117	}
118
119	strm << "msg=\"" << rec[expr::smessage] << "\" ";	75,473✔
120	}	75,473✔
121
122	static void SetupLoggerSinks() {	527✔
123	typedef sinks::synchronous_sink<sinks::text_ostream_backend> text_sink;
124	boost::shared_ptr<text_sink> sink(new text_sink);	527✔
125
126	{
127	text_sink::locked_backend_ptr pBackend = sink->locked_backend();	527✔
128	boost::shared_ptr<std::ostream> pStream(&std::clog, boost::null_deleter());	527✔
129	pBackend->add_stream(pStream);	527✔
130	}
131
132	sink->set_formatter(&LogfmtFormatter);	527✔
133
134	logging::core::get()->add_sink(sink);	1,581✔
135	}	527✔
136
137	static void SetupLoggerAttributes() {	527✔
138	attrs::counter<unsigned int> RecordID(1);	527✔
139	logging::core::get()->add_global_attribute("RecordID", RecordID);	527✔
140
141	attrs::local_clock TimeStamp;	527✔
142	logging::core::get()->add_global_attribute("TimeStamp", TimeStamp);	527✔
143	}	527✔
144
145	Logger::Logger(const string &name) :	2,570✔
146	Logger {name, global_logger_.Level()} {	2,570✔
147	}	2,570✔
148
149	Logger::Logger(const string &name, LogLevel level) :	3,098✔
150	logger_ {new src::severity_logger<LogLevel>},	×
151	name_ {name},
152	level_ {level} {	6,196✔
153	this->logger_->add_attribute("Name", attrs::constant<std::string>(name));	3,098✔
154	}	3,098✔
155
156	void Logger::Log_(LogLevel level, const string &message) {	75,472✔
157	BOOST_LOG_SEV(*this->logger_, level) << message;	150,941✔
158	}	75,472✔
159
160	void Logger::SetLevel(LogLevel level) {	686✔
161	this->level_ = level;	1,300✔
162	}	686✔
163
164	LogLevel Logger::Level() {	875✔
165	return this->level_;	2,570✔
166	}
167
168	void Logger::AddField(const LogField &field) {	687✔
169	this->logger_->add_attribute(field.key, attrs::constant<LogField>(field));	687✔
170	return;	687✔
171	}
172
173	Logger Setup() {	527✔
174	SetupLoggerSinks();	527✔
175	SetupLoggerAttributes();	527✔
176	#ifdef NDEBUG
177	return Logger("Global", LogLevel::Info);	1,054✔
178	#else
179	return Logger("Global", LogLevel::Debug);
180	#endif
181	}
182
183	Logger global_logger_ = Setup();
184
185	void SetLevel(LogLevel level) {	614✔
186	global_logger_.SetLevel(level);
187	}	614✔
188
189	error::Error SetupFileLogging(const string &log_file_path, bool exclusive) {	2✔
190	typedef sinks::synchronous_sink<sinks::text_ostream_backend> text_sink;
191	boost::shared_ptr<text_sink> sink = boost::make_shared<text_sink>();	2✔
192
193	// Add a stream to write log to
194	auto log_stream = boost::make_shared<std::ofstream>();	2✔
195	errno = 0;	2✔
196	log_stream->open(log_file_path);	2✔
197	if (!(*log_stream.get())) {	2✔
198	auto io_errno = errno;	1✔
199	return MakeError(
200	LogErrorCode::LogFileError,
201	"Failed to open '" + log_file_path + "' for logging: " + strerror(io_errno));	2✔
202	}
203	sink->set_formatter(&LogfmtFormatter);	1✔
204
205	sink->locked_backend()->add_stream(log_stream);	2✔
206	sink->locked_backend()->auto_flush(true);	1✔
207
208	if (exclusive) {	1✔
209	logging::core::get()->remove_all_sinks();	2✔
210	}
211
212	// Register the sink in the logging core
213	logging::core::get()->add_sink(sink);	3✔
214
215	return error::NoError;	1✔
216	}
217
218	LogLevel Level() {	7✔
219	return global_logger_.Level();	7✔
220	}
221
222	void Log_(LogLevel level, const string message) {	×
223	global_logger_.Log(level, message);	×
224	}	×
225
226	void Fatal(const string &message) {	×
227	global_logger_.Log(LogLevel::Fatal, message);	×
228	std::abort();	×
229	}
230	void Error(const string &message) {	182✔
231	return global_logger_.Log(LogLevel::Error, message);	182✔
232	}
233	void Warning(const string &message) {	357✔
234	return global_logger_.Log(LogLevel::Warning, message);	357✔
235	}
236	void Info(const string &message) {	1,978✔
237	return global_logger_.Log(LogLevel::Info, message);	1,978✔
238	}
239	void Debug(const string &message) {	3,764✔
240	return global_logger_.Log(LogLevel::Debug, message);	3,764✔
241	}
242	void Trace(const string &message) {	62,476✔
243	return global_logger_.Log(LogLevel::Trace, message);	62,476✔
244	}
245
246
247	} // namespace log
248	} // namespace common
249	} // namespace mender

mendersoftware / mender / 1022567176

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous