diff --git a/src/ipc/CMakeLists.txt b/src/ipc/CMakeLists.txt index e9bdf0b39b1..caf1776e1fa 100644 --- a/src/ipc/CMakeLists.txt +++ b/src/ipc/CMakeLists.txt @@ -31,8 +31,8 @@ if(BUILD_TESTS) # compiler only allows importing by relative path when the importing and # imported files are underneath the same compilation source prefix, so the # source prefix must be src/ipc, not src/ipc/test/ - add_library(bitcoin_ipc_test STATIC EXCLUDE_FROM_ALL - test/ipc_test.cpp + add_library(bitcoin_ipc_test OBJECT EXCLUDE_FROM_ALL + test/ipc_tests.cpp ) target_capnp_sources(bitcoin_ipc_test ${CMAKE_CURRENT_SOURCE_DIR} test/ipc_test.capnp diff --git a/src/ipc/test/CMakeLists.txt b/src/ipc/test/CMakeLists.txt index e71bc2bc6a1..91aa2a5e512 100644 --- a/src/ipc/test/CMakeLists.txt +++ b/src/ipc/test/CMakeLists.txt @@ -2,11 +2,6 @@ # Distributed under the MIT software license, see the accompanying # file COPYING or https://opensource.org/license/mit/. -# Do not use generator expressions in test sources because the -# SOURCES property is processed to gather test suite macros. -target_sources(test_bitcoin - PRIVATE - ipc_tests.cpp -) - target_link_libraries(test_bitcoin bitcoin_ipc_test bitcoin_ipc) + +add_boost_test(${CMAKE_CURRENT_SOURCE_DIR}/ipc_tests.cpp) diff --git a/src/ipc/test/ipc_test.cpp b/src/ipc/test/ipc_test.cpp deleted file mode 100644 index d5c689501da..00000000000 --- a/src/ipc/test/ipc_test.cpp +++ /dev/null @@ -1,193 +0,0 @@ -// Copyright (c) 2023-present The Bitcoin Core developers -// Distributed under the MIT software license, see the accompanying -// file COPYING or http://www.opensource.org/licenses/mit-license.php. - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include - -#include - -static_assert(ipc::capnp::messages::MAX_MONEY == MAX_MONEY); -static_assert(ipc::capnp::messages::MAX_DOUBLE == std::numeric_limits::max()); -static_assert(ipc::capnp::messages::DEFAULT_BLOCK_RESERVED_WEIGHT == DEFAULT_BLOCK_RESERVED_WEIGHT); -static_assert(ipc::capnp::messages::DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS == DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS); - -//! Remote init class. -class TestInit : public interfaces::Init -{ -public: - std::unique_ptr makeEcho() override { return interfaces::MakeEcho(); } -}; - -//! Generate a temporary path with temp_directory_path and mkstemp -static std::string TempPath(std::string_view pattern) -{ - std::string temp{fs::PathToString(fs::path{fs::temp_directory_path()} / fs::PathFromString(std::string{pattern}))}; - temp.push_back('\0'); - int fd{mkstemp(temp.data())}; - BOOST_CHECK_GE(fd, 0); - BOOST_CHECK_EQUAL(close(fd), 0); - temp.resize(temp.size() - 1); - fs::remove(fs::PathFromString(temp)); - return temp; -} - -//! Unit test that tests execution of IPC calls without actually creating a -//! separate process. This test is primarily intended to verify behavior of type -//! conversion code that converts C++ objects to Cap'n Proto messages and vice -//! versa. -//! -//! The test creates a thread which creates a FooImplementation object (defined -//! in ipc_test.h) and a two-way pipe accepting IPC requests which call methods -//! on the object through FooInterface (defined in ipc_test.capnp). -void IpcPipeTest() -{ - // Setup: create FooImplementation object and listen for FooInterface requests - std::promise>> foo_promise; - std::thread thread([&]() { - mp::EventLoop loop("IpcPipeTest", [](bool raise, const std::string& log) { LogInfo("LOG%i: %s", raise, log); }); - auto pipe = loop.m_io_context.provider->newTwoWayPipe(); - - auto connection_client = std::make_unique(loop, kj::mv(pipe.ends[0])); - auto foo_client = std::make_unique>( - connection_client->m_rpc_system->bootstrap(mp::ServerVatId().vat_id).castAs(), - connection_client.get(), /* destroy_connection= */ true); - (void)connection_client.release(); - foo_promise.set_value(std::move(foo_client)); - - auto connection_server = std::make_unique(loop, kj::mv(pipe.ends[1]), [&](mp::Connection& connection) { - auto foo_server = kj::heap>(std::make_shared(), connection); - return capnp::Capability::Client(kj::mv(foo_server)); - }); - connection_server->onDisconnect([&] { connection_server.reset(); }); - loop.loop(); - }); - std::unique_ptr> foo{foo_promise.get_future().get()}; - - // Test: make sure arguments were sent and return value is received - BOOST_CHECK_EQUAL(foo->add(1, 2), 3); - - COutPoint txout1{Txid::FromUint256(uint256{100}), 200}; - COutPoint txout2{foo->passOutPoint(txout1)}; - BOOST_CHECK(txout1 == txout2); - - UniValue uni1{UniValue::VOBJ}; - uni1.pushKV("i", 1); - uni1.pushKV("s", "two"); - UniValue uni2{foo->passUniValue(uni1)}; - BOOST_CHECK_EQUAL(uni1.write(), uni2.write()); - - CMutableTransaction mtx; - mtx.version = 2; - mtx.nLockTime = 3; - mtx.vin.emplace_back(txout1); - mtx.vout.emplace_back(COIN, CScript()); - CTransactionRef tx1{MakeTransactionRef(mtx)}; - CTransactionRef tx2{foo->passTransaction(tx1)}; - BOOST_CHECK(*Assert(tx1) == *Assert(tx2)); - - std::vector txs1; - txs1.push_back(tx1); - txs1.push_back(nullptr); - std::vector txs2(foo->passTransactions(txs1)); - BOOST_CHECK_EQUAL(txs2.size(), 2); - BOOST_CHECK(*Assert(txs1[0]) == *Assert(txs2[0])); - BOOST_CHECK(!txs2[1]); - - std::vector vec1{'H', 'e', 'l', 'l', 'o'}; - std::vector vec2{foo->passVectorChar(vec1)}; - BOOST_CHECK_EQUAL(std::string_view(vec1.begin(), vec1.end()), std::string_view(vec2.begin(), vec2.end())); - - auto script1{CScript() << OP_11}; - auto script2{foo->passScript(script1)}; - BOOST_CHECK_EQUAL(HexStr(script1), HexStr(script2)); - - // Test cleanup: disconnect and join thread - foo.reset(); - thread.join(); -} - -//! Test ipc::Protocol connect() and serve() methods connecting over a socketpair. -void IpcSocketPairTest() -{ - int fds[2]; - BOOST_CHECK_EQUAL(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0); - std::unique_ptr init{std::make_unique()}; - std::unique_ptr protocol{ipc::capnp::MakeCapnpProtocol()}; - std::promise promise; - std::thread thread([&]() { - protocol->serve(fds[0], "test-serve", *init, [&] { promise.set_value(); }); - }); - promise.get_future().wait(); - std::unique_ptr remote_init{protocol->connect(fds[1], "test-connect")}; - std::unique_ptr remote_echo{remote_init->makeEcho()}; - BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); - remote_echo.reset(); - remote_init.reset(); - thread.join(); -} - -//! Test ipc::Process bind() and connect() methods connecting over a unix socket. -void IpcSocketTest(const fs::path& datadir) -{ - std::unique_ptr init{std::make_unique()}; - std::unique_ptr protocol{ipc::capnp::MakeCapnpProtocol()}; - std::unique_ptr process{ipc::MakeProcess()}; - - std::string invalid_bind{"invalid:"}; - BOOST_CHECK_THROW(process->bind(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); - BOOST_CHECK_THROW(process->connect(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); - - auto bind_and_listen{[&](const std::string& bind_address) { - std::string address{bind_address}; - int serve_fd = process->bind(datadir, "test_bitcoin", address); - BOOST_CHECK_GE(serve_fd, 0); - BOOST_CHECK_EQUAL(address, bind_address); - protocol->listen(serve_fd, "test-serve", *init); - }}; - - auto connect_and_test{[&](const std::string& connect_address) { - std::string address{connect_address}; - int connect_fd{process->connect(datadir, "test_bitcoin", address)}; - BOOST_CHECK_EQUAL(address, connect_address); - std::unique_ptr remote_init{protocol->connect(connect_fd, "test-connect")}; - std::unique_ptr remote_echo{remote_init->makeEcho()}; - BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); - }}; - - // Need to specify explicit socket addresses outside the data directory, because the data - // directory path is so long that the default socket address and any other - // addresses in the data directory would fail with errors like: - // Address 'unix' path '"/tmp/test_common_Bitcoin Core/ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff/test_bitcoin.sock"' exceeded maximum socket path length - std::vector addresses{ - strprintf("unix:%s", TempPath("bitcoin_sock0_XXXXXX")), - strprintf("unix:%s", TempPath("bitcoin_sock1_XXXXXX")), - }; - - // Bind and listen on multiple addresses - for (const auto& address : addresses) { - bind_and_listen(address); - } - - // Connect and test each address multiple times. - for (int i : {0, 1, 0, 0, 1}) { - connect_and_test(addresses[i]); - } -} diff --git a/src/ipc/test/ipc_test.h b/src/ipc/test/ipc_test.h index 392f2b48826..c0a81150809 100644 --- a/src/ipc/test/ipc_test.h +++ b/src/ipc/test/ipc_test.h @@ -24,8 +24,4 @@ public: CScript passScript(CScript s) { return s; } }; -void IpcPipeTest(); -void IpcSocketPairTest(); -void IpcSocketTest(const fs::path& datadir); - #endif // BITCOIN_IPC_TEST_IPC_TEST_H diff --git a/src/ipc/test/ipc_tests.cpp b/src/ipc/test/ipc_tests.cpp index ebe4b397afa..b261792058e 100644 --- a/src/ipc/test/ipc_tests.cpp +++ b/src/ipc/test/ipc_tests.cpp @@ -2,13 +2,198 @@ // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. +#include +#include +#include #include +#include +#include +#include #include - +#include #include #include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + #include +static_assert(ipc::capnp::messages::MAX_MONEY == MAX_MONEY); +static_assert(ipc::capnp::messages::MAX_DOUBLE == std::numeric_limits::max()); +static_assert(ipc::capnp::messages::DEFAULT_BLOCK_RESERVED_WEIGHT == DEFAULT_BLOCK_RESERVED_WEIGHT); +static_assert(ipc::capnp::messages::DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS == DEFAULT_COINBASE_OUTPUT_MAX_ADDITIONAL_SIGOPS); + +//! Remote init class. +class TestInit : public interfaces::Init +{ +public: + std::unique_ptr makeEcho() override { return interfaces::MakeEcho(); } +}; + +//! Generate a temporary path with temp_directory_path and mkstemp +static std::string TempPath(std::string_view pattern) +{ + std::string temp{fs::PathToString(fs::path{fs::temp_directory_path()} / fs::PathFromString(std::string{pattern}))}; + temp.push_back('\0'); + int fd{mkstemp(temp.data())}; + BOOST_CHECK_GE(fd, 0); + BOOST_CHECK_EQUAL(close(fd), 0); + temp.resize(temp.size() - 1); + fs::remove(fs::PathFromString(temp)); + return temp; +} + +//! Unit test that tests execution of IPC calls without actually creating a +//! separate process. This test is primarily intended to verify behavior of type +//! conversion code that converts C++ objects to Cap'n Proto messages and vice +//! versa. +//! +//! The test creates a thread which creates a FooImplementation object (defined +//! in ipc_test.h) and a two-way pipe accepting IPC requests which call methods +//! on the object through FooInterface (defined in ipc_test.capnp). +void IpcPipeTest() +{ + // Setup: create FooImplementation object and listen for FooInterface requests + std::promise>> foo_promise; + std::thread thread([&]() { + mp::EventLoop loop("IpcPipeTest", [](bool raise, const std::string& log) { LogInfo("LOG%i: %s", raise, log); }); + auto pipe = loop.m_io_context.provider->newTwoWayPipe(); + + auto connection_client = std::make_unique(loop, kj::mv(pipe.ends[0])); + auto foo_client = std::make_unique>( + connection_client->m_rpc_system->bootstrap(mp::ServerVatId().vat_id).castAs(), + connection_client.get(), /* destroy_connection= */ true); + (void)connection_client.release(); + foo_promise.set_value(std::move(foo_client)); + + auto connection_server = std::make_unique(loop, kj::mv(pipe.ends[1]), [&](mp::Connection& connection) { + auto foo_server = kj::heap>(std::make_shared(), connection); + return capnp::Capability::Client(kj::mv(foo_server)); + }); + connection_server->onDisconnect([&] { connection_server.reset(); }); + loop.loop(); + }); + std::unique_ptr> foo{foo_promise.get_future().get()}; + + // Test: make sure arguments were sent and return value is received + BOOST_CHECK_EQUAL(foo->add(1, 2), 3); + + COutPoint txout1{Txid::FromUint256(uint256{100}), 200}; + COutPoint txout2{foo->passOutPoint(txout1)}; + BOOST_CHECK(txout1 == txout2); + + UniValue uni1{UniValue::VOBJ}; + uni1.pushKV("i", 1); + uni1.pushKV("s", "two"); + UniValue uni2{foo->passUniValue(uni1)}; + BOOST_CHECK_EQUAL(uni1.write(), uni2.write()); + + CMutableTransaction mtx; + mtx.version = 2; + mtx.nLockTime = 3; + mtx.vin.emplace_back(txout1); + mtx.vout.emplace_back(COIN, CScript()); + CTransactionRef tx1{MakeTransactionRef(mtx)}; + CTransactionRef tx2{foo->passTransaction(tx1)}; + BOOST_CHECK(*Assert(tx1) == *Assert(tx2)); + + std::vector txs1; + txs1.push_back(tx1); + txs1.push_back(nullptr); + std::vector txs2(foo->passTransactions(txs1)); + BOOST_CHECK_EQUAL(txs2.size(), 2); + BOOST_CHECK(*Assert(txs1[0]) == *Assert(txs2[0])); + BOOST_CHECK(!txs2[1]); + + std::vector vec1{'H', 'e', 'l', 'l', 'o'}; + std::vector vec2{foo->passVectorChar(vec1)}; + BOOST_CHECK_EQUAL(std::string_view(vec1.begin(), vec1.end()), std::string_view(vec2.begin(), vec2.end())); + + auto script1{CScript() << OP_11}; + auto script2{foo->passScript(script1)}; + BOOST_CHECK_EQUAL(HexStr(script1), HexStr(script2)); + + // Test cleanup: disconnect and join thread + foo.reset(); + thread.join(); +} + +//! Test ipc::Protocol connect() and serve() methods connecting over a socketpair. +void IpcSocketPairTest() +{ + int fds[2]; + BOOST_CHECK_EQUAL(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0); + std::unique_ptr init{std::make_unique()}; + std::unique_ptr protocol{ipc::capnp::MakeCapnpProtocol()}; + std::promise promise; + std::thread thread([&]() { + protocol->serve(fds[0], "test-serve", *init, [&] { promise.set_value(); }); + }); + promise.get_future().wait(); + std::unique_ptr remote_init{protocol->connect(fds[1], "test-connect")}; + std::unique_ptr remote_echo{remote_init->makeEcho()}; + BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); + remote_echo.reset(); + remote_init.reset(); + thread.join(); +} + +//! Test ipc::Process bind() and connect() methods connecting over a unix socket. +void IpcSocketTest(const fs::path& datadir) +{ + std::unique_ptr init{std::make_unique()}; + std::unique_ptr protocol{ipc::capnp::MakeCapnpProtocol()}; + std::unique_ptr process{ipc::MakeProcess()}; + + std::string invalid_bind{"invalid:"}; + BOOST_CHECK_THROW(process->bind(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); + BOOST_CHECK_THROW(process->connect(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); + + auto bind_and_listen{[&](const std::string& bind_address) { + std::string address{bind_address}; + int serve_fd = process->bind(datadir, "test_bitcoin", address); + BOOST_CHECK_GE(serve_fd, 0); + BOOST_CHECK_EQUAL(address, bind_address); + protocol->listen(serve_fd, "test-serve", *init); + }}; + + auto connect_and_test{[&](const std::string& connect_address) { + std::string address{connect_address}; + int connect_fd{process->connect(datadir, "test_bitcoin", address)}; + BOOST_CHECK_EQUAL(address, connect_address); + std::unique_ptr remote_init{protocol->connect(connect_fd, "test-connect")}; + std::unique_ptr remote_echo{remote_init->makeEcho()}; + BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); + }}; + + // Need to specify explicit socket addresses outside the data directory, because the data + // directory path is so long that the default socket address and any other + // addresses in the data directory would fail with errors like: + // Address 'unix' path '"/tmp/test_common_Bitcoin Core/ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff/test_bitcoin.sock"' exceeded maximum socket path length + std::vector addresses{ + strprintf("unix:%s", TempPath("bitcoin_sock0_XXXXXX")), + strprintf("unix:%s", TempPath("bitcoin_sock1_XXXXXX")), + }; + + // Bind and listen on multiple addresses + for (const auto& address : addresses) { + bind_and_listen(address); + } + + // Connect and test each address multiple times. + for (int i : {0, 1, 0, 0, 1}) { + connect_and_test(addresses[i]); + } +} + BOOST_FIXTURE_TEST_SUITE(ipc_tests, BasicTestingSetup) BOOST_AUTO_TEST_CASE(ipc_tests) { diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index b5a12f7277d..41fd0526ff9 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -170,14 +170,6 @@ target_link_libraries(test_bitcoin $ ) -if(ENABLE_WALLET) - add_subdirectory(${PROJECT_SOURCE_DIR}/src/wallet/test wallet) -endif() - -if(ENABLE_IPC) - add_subdirectory(${PROJECT_SOURCE_DIR}/src/ipc/test ipc) -endif() - function(add_boost_test source_file) if(NOT EXISTS ${source_file}) return() @@ -216,6 +208,14 @@ function(add_all_test_targets) endforeach() endfunction() +if(ENABLE_WALLET) + add_subdirectory(${PROJECT_SOURCE_DIR}/src/wallet/test wallet) +endif() + +if(ENABLE_IPC) + add_subdirectory(${PROJECT_SOURCE_DIR}/src/ipc/test ipc) +endif() + add_all_test_targets() install_binary_component(test_bitcoin INTERNAL)