ipc_test.cpp
1 // Copyright (c) 2023 The Bitcoin Core developers 2 // Distributed under the MIT software license, see the accompanying 3 // file COPYING or http://www.opensource.org/licenses/mit-license.php. 4 5 #include <interfaces/init.h> 6 #include <ipc/capnp/protocol.h> 7 #include <ipc/process.h> 8 #include <ipc/protocol.h> 9 #include <logging.h> 10 #include <mp/proxy-types.h> 11 #include <test/ipc_test.capnp.h> 12 #include <test/ipc_test.capnp.proxy.h> 13 #include <test/ipc_test.h> 14 #include <tinyformat.h> 15 #include <validation.h> 16 17 #include <future> 18 #include <thread> 19 #include <kj/common.h> 20 #include <kj/memory.h> 21 #include <kj/test.h> 22 #include <stdexcept> 23 24 #include <boost/test/unit_test.hpp> 25 26 //! Remote init class. 27 class TestInit : public interfaces::Init 28 { 29 public: 30 std::unique_ptr<interfaces::Echo> makeEcho() override { return interfaces::MakeEcho(); } 31 }; 32 33 //! Generate a temporary path with temp_directory_path and mkstemp 34 static std::string TempPath(std::string_view pattern) 35 { 36 std::string temp{fs::PathToString(fs::path{fs::temp_directory_path()} / fs::PathFromString(std::string{pattern}))}; 37 temp.push_back('\0'); 38 int fd{mkstemp(temp.data())}; 39 BOOST_CHECK_GE(fd, 0); 40 BOOST_CHECK_EQUAL(close(fd), 0); 41 temp.resize(temp.size() - 1); 42 fs::remove(fs::PathFromString(temp)); 43 return temp; 44 } 45 46 //! Unit test that tests execution of IPC calls without actually creating a 47 //! separate process. This test is primarily intended to verify behavior of type 48 //! conversion code that converts C++ objects to Cap'n Proto messages and vice 49 //! versa. 50 //! 51 //! The test creates a thread which creates a FooImplementation object (defined 52 //! in ipc_test.h) and a two-way pipe accepting IPC requests which call methods 53 //! on the object through FooInterface (defined in ipc_test.capnp). 54 void IpcPipeTest() 55 { 56 // Setup: create FooImplementation object and listen for FooInterface requests 57 std::promise<std::unique_ptr<mp::ProxyClient<gen::FooInterface>>> foo_promise; 58 std::thread thread([&]() { 59 mp::EventLoop loop("IpcPipeTest", [](bool raise, const std::string& log) { LogInfo("LOG%i: %s", raise, log); }); 60 auto pipe = loop.m_io_context.provider->newTwoWayPipe(); 61 62 auto connection_client = std::make_unique<mp::Connection>(loop, kj::mv(pipe.ends[0])); 63 auto foo_client = std::make_unique<mp::ProxyClient<gen::FooInterface>>( 64 connection_client->m_rpc_system->bootstrap(mp::ServerVatId().vat_id).castAs<gen::FooInterface>(), 65 connection_client.get(), /* destroy_connection= */ true); 66 connection_client.release(); 67 foo_promise.set_value(std::move(foo_client)); 68 69 auto connection_server = std::make_unique<mp::Connection>(loop, kj::mv(pipe.ends[1]), [&](mp::Connection& connection) { 70 auto foo_server = kj::heap<mp::ProxyServer<gen::FooInterface>>(std::make_shared<FooImplementation>(), connection); 71 return capnp::Capability::Client(kj::mv(foo_server)); 72 }); 73 connection_server->onDisconnect([&] { connection_server.reset(); }); 74 loop.loop(); 75 }); 76 std::unique_ptr<mp::ProxyClient<gen::FooInterface>> foo{foo_promise.get_future().get()}; 77 78 // Test: make sure arguments were sent and return value is received 79 BOOST_CHECK_EQUAL(foo->add(1, 2), 3); 80 81 COutPoint txout1{Txid::FromUint256(uint256{100}), 200}; 82 COutPoint txout2{foo->passOutPoint(txout1)}; 83 BOOST_CHECK(txout1 == txout2); 84 85 UniValue uni1{UniValue::VOBJ}; 86 uni1.pushKV("i", 1); 87 uni1.pushKV("s", "two"); 88 UniValue uni2{foo->passUniValue(uni1)}; 89 BOOST_CHECK_EQUAL(uni1.write(), uni2.write()); 90 91 CMutableTransaction mtx; 92 mtx.version = 2; 93 mtx.nLockTime = 3; 94 mtx.vin.emplace_back(txout1); 95 mtx.vout.emplace_back(COIN, CScript()); 96 CTransactionRef tx1{MakeTransactionRef(mtx)}; 97 CTransactionRef tx2{foo->passTransaction(tx1)}; 98 BOOST_CHECK(*Assert(tx1) == *Assert(tx2)); 99 100 std::vector<char> vec1{'H', 'e', 'l', 'l', 'o'}; 101 std::vector<char> vec2{foo->passVectorChar(vec1)}; 102 BOOST_CHECK_EQUAL(std::string_view(vec1.begin(), vec1.end()), std::string_view(vec2.begin(), vec2.end())); 103 104 auto script1{CScript() << OP_11}; 105 auto script2{foo->passScript(script1)}; 106 BOOST_CHECK_EQUAL(HexStr(script1), HexStr(script2)); 107 108 // Test cleanup: disconnect and join thread 109 foo.reset(); 110 thread.join(); 111 } 112 113 //! Test ipc::Protocol connect() and serve() methods connecting over a socketpair. 114 void IpcSocketPairTest() 115 { 116 int fds[2]; 117 BOOST_CHECK_EQUAL(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0); 118 std::unique_ptr<interfaces::Init> init{std::make_unique<TestInit>()}; 119 std::unique_ptr<ipc::Protocol> protocol{ipc::capnp::MakeCapnpProtocol()}; 120 std::promise<void> promise; 121 std::thread thread([&]() { 122 protocol->serve(fds[0], "test-serve", *init, [&] { promise.set_value(); }); 123 }); 124 promise.get_future().wait(); 125 std::unique_ptr<interfaces::Init> remote_init{protocol->connect(fds[1], "test-connect")}; 126 std::unique_ptr<interfaces::Echo> remote_echo{remote_init->makeEcho()}; 127 BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); 128 remote_echo.reset(); 129 remote_init.reset(); 130 thread.join(); 131 } 132 133 //! Test ipc::Process bind() and connect() methods connecting over a unix socket. 134 void IpcSocketTest(const fs::path& datadir) 135 { 136 std::unique_ptr<interfaces::Init> init{std::make_unique<TestInit>()}; 137 std::unique_ptr<ipc::Protocol> protocol{ipc::capnp::MakeCapnpProtocol()}; 138 std::unique_ptr<ipc::Process> process{ipc::MakeProcess()}; 139 140 std::string invalid_bind{"invalid:"}; 141 BOOST_CHECK_THROW(process->bind(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); 142 BOOST_CHECK_THROW(process->connect(datadir, "test_bitcoin", invalid_bind), std::invalid_argument); 143 144 auto bind_and_listen{[&](const std::string& bind_address) { 145 std::string address{bind_address}; 146 int serve_fd = process->bind(datadir, "test_bitcoin", address); 147 BOOST_CHECK_GE(serve_fd, 0); 148 BOOST_CHECK_EQUAL(address, bind_address); 149 protocol->listen(serve_fd, "test-serve", *init); 150 }}; 151 152 auto connect_and_test{[&](const std::string& connect_address) { 153 std::string address{connect_address}; 154 int connect_fd{process->connect(datadir, "test_bitcoin", address)}; 155 BOOST_CHECK_EQUAL(address, connect_address); 156 std::unique_ptr<interfaces::Init> remote_init{protocol->connect(connect_fd, "test-connect")}; 157 std::unique_ptr<interfaces::Echo> remote_echo{remote_init->makeEcho()}; 158 BOOST_CHECK_EQUAL(remote_echo->echo("echo test"), "echo test"); 159 }}; 160 161 // Need to specify explicit socket addresses outside the data directory, because the data 162 // directory path is so long that the default socket address and any other 163 // addresses in the data directory would fail with errors like: 164 // Address 'unix' path '"/tmp/test_common_Bitcoin Core/ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff/test_bitcoin.sock"' exceeded maximum socket path length 165 std::vector<std::string> addresses{ 166 strprintf("unix:%s", TempPath("bitcoin_sock0_XXXXXX")), 167 strprintf("unix:%s", TempPath("bitcoin_sock1_XXXXXX")), 168 }; 169 170 // Bind and listen on multiple addresses 171 for (const auto& address : addresses) { 172 bind_and_listen(address); 173 } 174 175 // Connect and test each address multiple times. 176 for (int i : {0, 1, 0, 0, 1}) { 177 connect_and_test(addresses[i]); 178 } 179 }