4e6fe34501
The logger is not thread safe, so a multithreaded test can concurrently
write into the log, yielding unreadable XMLs.
Example:
boost/sstable_directory_test: failed to parse XML output '/scylladir/testlog/x86_64/release/xml/boost.sstable_directory_test.sstable_directory_shared_sstables_reshard_correctly.3.xunit.xml': not well-formed (invalid token): line 1, column 1351
The critical (today's unprotected) section is in boost/test/utils/xml_printer.hpp:
```
inline std::ostream&
operator<<( custom_printer<cdata> const& p, const_string value )
{
*p << BOOST_TEST_L( "<![CDATA[" );
print_escaped_cdata( *p, value );
return *p << BOOST_TEST_L( "]]>" );
}
```
The problem is not restricted to xml, but the unreadable xml file caused
the test to fail when trying to parse it, to present a summary.
New thread-safe variants of BOOST_REQUIRE and BOOST_REQUIRE_EQUAL are
introduced to help multithreaded tests. We'll start patching tests of
sstable_directory_test that will call BOOST_REQUIRE* from multiple
threads. Later, we can expand its usage to other tests.
Fixes #15654.
Signed-off-by: Raphael S. Carvalho <raphaelsc@scylladb.com>
Closes scylladb/scylladb#15655
104 lines
2.9 KiB
C++
104 lines
2.9 KiB
C++
/*
|
|
* Copyright (C) 2020-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
#include "test/lib/test_utils.hh"
|
|
|
|
#include <seastar/util/file.hh>
|
|
#include <boost/range/adaptor/map.hpp>
|
|
#include <boost/range/algorithm/sort.hpp>
|
|
#include <seastar/core/print.hh>
|
|
#include <seastar/util/backtrace.hh>
|
|
#include "test/lib/log.hh"
|
|
#include "test/lib/simple_schema.hh"
|
|
#include "seastarx.hh"
|
|
#include <random>
|
|
|
|
namespace tests {
|
|
|
|
namespace {
|
|
|
|
std::string format_msg(std::string_view test_function_name, bool ok, seastar::compat::source_location sl, std::string_view msg) {
|
|
return fmt::format("{}(): {} @ {}() {}:{:d}{}{}", test_function_name, ok ? "OK" : "FAIL", sl.function_name(), sl.file_name(), sl.line(), msg.empty() ? "" : ": ", msg);
|
|
}
|
|
|
|
}
|
|
|
|
bool do_check(bool condition, seastar::compat::source_location sl, std::string_view msg) {
|
|
if (condition) {
|
|
testlog.trace("{}", format_msg(__FUNCTION__, condition, sl, msg));
|
|
} else {
|
|
testlog.error("{}", format_msg(__FUNCTION__, condition, sl, msg));
|
|
}
|
|
return condition;
|
|
}
|
|
|
|
void do_require(bool condition, seastar::compat::source_location sl, std::string_view msg) {
|
|
if (condition) {
|
|
testlog.trace("{}", format_msg(__FUNCTION__, condition, sl, msg));
|
|
} else {
|
|
auto formatted_msg = format_msg(__FUNCTION__, condition, sl, msg);
|
|
testlog.error("{}", formatted_msg);
|
|
throw_with_backtrace<std::runtime_error>(std::move(formatted_msg));
|
|
}
|
|
|
|
}
|
|
|
|
void fail(std::string_view msg, seastar::compat::source_location sl) {
|
|
throw_with_backtrace<std::runtime_error>(format_msg(__FUNCTION__, false, sl, msg));
|
|
}
|
|
|
|
|
|
extern boost::test_tools::assertion_result has_scylla_test_env(boost::unit_test::test_unit_id) {
|
|
if (::getenv("SCYLLA_TEST_ENV")) {
|
|
return true;
|
|
}
|
|
|
|
testlog.info("Test environment is not configured. "
|
|
"Check test/pylib/minio_server.py for an example of how to configure the environment for it to run.");
|
|
return false;
|
|
}
|
|
|
|
}
|
|
|
|
sstring make_random_string(size_t size) {
|
|
static thread_local std::default_random_engine rng;
|
|
std::uniform_int_distribution<char> dist;
|
|
sstring str = uninitialized_string(size);
|
|
for (auto&& b : str) {
|
|
b = dist(rng);
|
|
}
|
|
return str;
|
|
}
|
|
|
|
sstring make_random_numeric_string(size_t size) {
|
|
static thread_local std::default_random_engine rng;
|
|
std::uniform_int_distribution<char> dist('0', '9');
|
|
sstring str = uninitialized_string(size);
|
|
for (auto&& b : str) {
|
|
b = dist(rng);
|
|
}
|
|
return str;
|
|
}
|
|
|
|
namespace tests {
|
|
|
|
future<bool> compare_files(std::string fa, std::string fb) {
|
|
auto cont_a = co_await util::read_entire_file_contiguous(fa);
|
|
auto cont_b = co_await util::read_entire_file_contiguous(fb);
|
|
co_return cont_a == cont_b;
|
|
}
|
|
|
|
future<> touch_file(std::string name) {
|
|
auto f = co_await open_file_dma(name, open_flags::create);
|
|
co_await f.close();
|
|
}
|
|
|
|
std::mutex boost_logger_mutex;
|
|
|
|
}
|