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
79 lines
3.0 KiB
C++
79 lines
3.0 KiB
C++
/*
|
|
* Copyright (C) 2020-present ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <seastar/core/future.hh>
|
|
#include <seastar/util/source_location-compat.hh>
|
|
#include <string>
|
|
#include <boost/test/unit_test.hpp>
|
|
#include <fmt/format.h>
|
|
|
|
using namespace seastar;
|
|
|
|
// Thread safe alternatives to BOOST_REQUIRE_*, BOOST_CHECK_* and BOOST_FAIL().
|
|
// Use these if instead of the BOOST provided macros if you want to use them on
|
|
// multiple shards, to avoid problems due to the BOOST versions not being thread
|
|
// safe.
|
|
|
|
namespace tests {
|
|
|
|
[[nodiscard]] bool do_check(bool condition, seastar::compat::source_location sl, std::string_view msg);
|
|
|
|
[[nodiscard]] inline bool check(bool condition, seastar::compat::source_location sl = seastar::compat::source_location::current()) {
|
|
return do_check(condition, sl, {});
|
|
}
|
|
|
|
template <typename LHS, typename RHS>
|
|
[[nodiscard]] bool check_equal(const LHS& lhs, const RHS& rhs, seastar::compat::source_location sl = seastar::compat::source_location::current()) {
|
|
const auto condition = (lhs == rhs);
|
|
return do_check(condition, sl, fmt::format("{} {}= {}", lhs, condition ? "=" : "!", rhs));
|
|
}
|
|
|
|
void do_require(bool condition, seastar::compat::source_location sl, std::string_view msg);
|
|
|
|
inline void require(bool condition, seastar::compat::source_location sl = seastar::compat::source_location::current()) {
|
|
do_require(condition, sl, {});
|
|
}
|
|
|
|
template <typename LHS, typename RHS>
|
|
void require_equal(const LHS& lhs, const RHS& rhs, seastar::compat::source_location sl = seastar::compat::source_location::current()) {
|
|
const auto condition = (lhs == rhs);
|
|
do_require(condition, sl, fmt::format("{} {}= {}", lhs, condition ? "=" : "!", rhs));
|
|
}
|
|
|
|
void fail(std::string_view msg, seastar::compat::source_location sl = seastar::compat::source_location::current());
|
|
|
|
inline std::string getenv_safe(std::string_view name) {
|
|
auto v = ::getenv(name.data());
|
|
if (!v) {
|
|
throw std::logic_error(fmt::format("Environment variable {} not set", name));
|
|
}
|
|
return std::string(v);
|
|
}
|
|
|
|
extern boost::test_tools::assertion_result has_scylla_test_env(boost::unit_test::test_unit_id);
|
|
future<bool> compare_files(std::string fa, std::string fb);
|
|
future<> touch_file(std::string name);
|
|
|
|
extern std::mutex boost_logger_mutex;
|
|
|
|
#define THREADSAFE_BOOST_CHECK( BOOST_CHECK_EXPR ) { \
|
|
std::lock_guard<std::mutex> guard(tests::boost_logger_mutex); \
|
|
BOOST_CHECK_EXPR; \
|
|
}
|
|
|
|
// Thread-safe variants of BOOST macros for unit tests
|
|
// This is required to address lack of synchronization in boost test logger, which is susceptible to races
|
|
// in multi-threaded tests. Boost's XML printer (see boost/test/utils/xml_printer.hpp) can generate
|
|
// unreadable XML files, and therefore cause failure when parsing its content.
|
|
#define THREADSAFE_BOOST_REQUIRE( P ) THREADSAFE_BOOST_CHECK(BOOST_REQUIRE( P ))
|
|
#define THREADSAFE_BOOST_REQUIRE_EQUAL( L, R ) THREADSAFE_BOOST_CHECK(BOOST_REQUIRE_EQUAL( L, R ))
|
|
|
|
}
|