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