File: test_unix_sockets.cpp

package info (click to toggle)
boost1.90 1.90.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 593,120 kB
  • sloc: cpp: 4,190,908; xml: 196,648; python: 34,618; ansic: 23,145; asm: 5,468; sh: 3,774; makefile: 1,161; perl: 1,020; sql: 728; ruby: 676; yacc: 478; java: 77; lisp: 24; csh: 6
file content (252 lines) | stat: -rw-r--r-- 6,786 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
//
// Copyright (c) 2025 Marcelo Zimbres Silva (mzimbres@gmail.com),
// Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

#include <boost/redis/connection.hpp>
#include <boost/redis/request.hpp>
#include <boost/redis/response.hpp>

#include <boost/asio/error.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/local/basic_endpoint.hpp>
#include <boost/core/lightweight_test.hpp>
#include <boost/system/error_code.hpp>

#include "common.hpp"

#include <cstddef>
#include <iostream>
#include <string>
#include <string_view>

using boost::system::error_code;
namespace net = boost::asio;
using namespace boost::redis;
using namespace std::chrono_literals;
using namespace std::string_view_literals;

namespace {

#ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS

constexpr std::string_view unix_socket_path = "/tmp/redis-socks/redis.sock";

// Executing commands using UNIX sockets works
void test_exec()
{
   // Setup
   net::io_context ioc;
   connection conn{ioc};
   auto cfg = make_test_config();
   cfg.unix_socket = unix_socket_path;
   bool run_finished = false, exec_finished = false;

   // Run the connection
   conn.async_run(cfg, {}, [&run_finished](error_code ec) {
      run_finished = true;
      BOOST_TEST_EQ(ec, net::error::operation_aborted);
   });

   // Execute a request
   request req;
   req.push("PING", "unix");
   response<std::string> res;
   conn.async_exec(req, res, [&](error_code ec, std::size_t) {
      exec_finished = true;
      BOOST_TEST_EQ(ec, error_code());
      conn.cancel();
   });

   // Run
   ioc.run_for(test_timeout);

   // Check
   BOOST_TEST(exec_finished);
   BOOST_TEST(run_finished);
   BOOST_TEST_EQ(std::get<0>(res).value(), "unix"sv);
}

// If the connection is lost when using a UNIX socket, we can reconnect
void test_reconnection()
{
   // Setup
   net::io_context ioc;
   connection conn{ioc};
   auto cfg = make_test_config();
   cfg.unix_socket = unix_socket_path;
   cfg.reconnect_wait_interval = 10ms;  // make the test run faster

   request ping_request;
   ping_request.get_config().cancel_if_not_connected = false;
   ping_request.get_config().cancel_if_unresponded = false;
   ping_request.get_config().cancel_on_connection_lost = false;
   ping_request.push("PING", "some_value");

   request quit_request;
   quit_request.push("QUIT");

   bool exec_finished = false, run_finished = false;

   // Run the connection
   conn.async_run(cfg, {}, [&](error_code ec) {
      run_finished = true;
      BOOST_TEST(ec == net::error::operation_aborted);
   });

   // The PING is the end of the callback chain
   auto ping_callback = [&](error_code ec, std::size_t) {
      exec_finished = true;
      BOOST_TEST(ec == error_code());
      conn.cancel();
   };

   auto quit_callback = [&](error_code ec, std::size_t) {
      BOOST_TEST(ec == error_code());
      conn.async_exec(ping_request, ignore, ping_callback);
   };

   conn.async_exec(quit_request, ignore, quit_callback);

   ioc.run_for(test_timeout);

   BOOST_TEST(exec_finished);
   BOOST_TEST(run_finished);
}

// We can freely switch between UNIX sockets and other transports
void test_switch_between_transports()
{
   // Setup
   net::io_context ioc;
   connection conn{ioc};
   request req;
   response<std::string> res1, res2, res3;
   req.push("PING", "hello");
   bool finished = false;

   // Create configurations for TLS and UNIX connections
   auto tcp_tls_cfg = make_test_config();
   tcp_tls_cfg.use_ssl = true;
   tcp_tls_cfg.addr.port = "6380";
   auto unix_cfg = make_test_config();
   unix_cfg.unix_socket = unix_socket_path;

   // After the last TCP/TLS run, exit
   auto on_run_tls_2 = [&](error_code ec) {
      finished = true;
      std::cout << "Run (TCP/TLS 2) finished\n";
      BOOST_TEST_EQ(ec, net::error::operation_aborted);
   };

   // After UNIX sockets, switch back to TCP/tLS
   auto on_run_unix = [&](error_code ec) {
      std::cout << "Run (UNIX) finished\n";
      BOOST_TEST_EQ(ec, net::error::operation_aborted);

      // Change to using TCP with TLS again
      conn.async_run(unix_cfg, {}, on_run_tls_2);
      conn.async_exec(req, res3, [&](error_code ec, std::size_t) {
         std::cout << "Exec 3 finished\n";
         BOOST_TEST_EQ(ec, error_code());
         BOOST_TEST_EQ(std::get<0>(res3).value(), "hello");
         conn.cancel();
      });
   };

   // After TCP/TLS, change to UNIX sockets
   auto on_run_tls_1 = [&](error_code ec) {
      std::cout << "Run (TCP/TLS 1) finished\n";
      BOOST_TEST_EQ(ec, net::error::operation_aborted);

      conn.async_run(unix_cfg, {}, on_run_unix);
      conn.async_exec(req, res2, [&](error_code ec, std::size_t) {
         std::cout << "Exec 2 finished\n";
         BOOST_TEST_EQ(ec, error_code());
         BOOST_TEST_EQ(std::get<0>(res2).value(), "hello");
         conn.cancel();
      });
   };

   // Start with TCP/TLS
   conn.async_run(tcp_tls_cfg, {}, on_run_tls_1);
   conn.async_exec(req, res1, [&](error_code ec, std::size_t) {
      std::cout << "Exec 1 finished\n";
      BOOST_TEST_EQ(ec, error_code());
      BOOST_TEST_EQ(std::get<0>(res1).value(), "hello");
      conn.cancel();
   });

   // Run the test
   ioc.run_for(test_timeout);
   BOOST_TEST(finished);
}

// Trying to enable TLS and UNIX sockets at the same time
// is an error and makes async_run exit immediately
void test_error_unix_tls()
{
   // Setup
   net::io_context ioc;
   connection conn{ioc};
   auto cfg = make_test_config();
   cfg.use_ssl = true;
   cfg.addr.port = "6380";
   cfg.unix_socket = unix_socket_path;
   bool finished = false;

   // Run the connection
   conn.async_run(cfg, {}, [&finished](error_code ec) {
      BOOST_TEST_EQ(ec, error::unix_sockets_ssl_unsupported);
      finished = true;
   });

   // Run the test
   ioc.run_for(test_timeout);
   BOOST_TEST(finished);
}

#else

// Trying to enable TLS and UNIX sockets at the same time
// is an error and makes async_run exit immediately
void test_unix_not_supported()
{
   // Setup
   net::io_context ioc;
   connection conn{ioc};
   auto cfg = make_test_config();
   cfg.unix_socket = "/some/path.sock";
   bool finished = false;

   // Run the connection
   conn.async_run(cfg, {}, [&finished](error_code ec) {
      BOOST_TEST_EQ(ec, error::unix_sockets_unsupported);
      finished = true;
   });

   // Run the test
   ioc.run_for(test_timeout);
   BOOST_TEST(finished);
}

#endif

}  // namespace

int main()
{
#ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
   test_exec();
   test_reconnection();
   test_switch_between_transports();
   test_error_unix_tls();
#else
   test_unix_not_supported();
#endif

   return boost::report_errors();
}