acceptor_SUITE.erl 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608
  1. %% Copyright (c) 2011-2018, Loïc Hoguin <essen@ninenines.eu>
  2. %%
  3. %% Permission to use, copy, modify, and/or distribute this software for any
  4. %% purpose with or without fee is hereby granted, provided that the above
  5. %% copyright notice and this permission notice appear in all copies.
  6. %%
  7. %% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8. %% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9. %% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  10. %% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11. %% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  12. %% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  13. %% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14. -module(acceptor_SUITE).
  15. -compile(export_all).
  16. -compile(nowarn_export_all).
  17. -dialyzer({nowarn_function, misc_wait_for_connections/1}).
  18. %% @todo Remove when specs in ssl are updated to accept local addresses.
  19. -dialyzer({nowarn_function, do_ssl_local_echo/0}).
  20. -import(ct_helper, [doc/1]).
  21. -import(ct_helper, [name/0]).
  22. %% ct.
  23. all() ->
  24. [{group, tcp}, {group, ssl}, {group, misc}, {group, supervisor}].
  25. groups() ->
  26. [{tcp, [
  27. tcp_active_echo,
  28. tcp_active_n_echo,
  29. tcp_echo,
  30. tcp_local_echo,
  31. tcp_graceful,
  32. tcp_inherit_options,
  33. tcp_max_connections,
  34. tcp_max_connections_and_beyond,
  35. tcp_max_connections_infinity,
  36. tcp_remove_connections,
  37. tcp_remove_connections_acceptor_wakeup,
  38. tcp_set_max_connections,
  39. tcp_set_max_connections_clean,
  40. tcp_getopts_capability,
  41. tcp_getstat_capability,
  42. tcp_upgrade,
  43. tcp_10_acceptors_10_listen_sockets,
  44. tcp_many_listen_sockets_no_reuseport,
  45. tcp_error_eaddrinuse,
  46. tcp_error_eacces
  47. ]}, {ssl, [
  48. ssl_accept_error,
  49. ssl_active_echo,
  50. ssl_active_n_echo,
  51. ssl_echo,
  52. ssl_local_echo,
  53. ssl_graceful,
  54. ssl_handshake,
  55. ssl_sni_echo,
  56. ssl_sni_fail,
  57. ssl_upgrade_from_tcp,
  58. ssl_getopts_capability,
  59. ssl_getstat_capability,
  60. ssl_10_acceptors_10_listen_sockets,
  61. ssl_many_listen_sockets_no_reuseport,
  62. ssl_error_eaddrinuse,
  63. ssl_error_no_cert,
  64. ssl_error_eacces
  65. ]}, {misc, [
  66. misc_bad_transport,
  67. misc_bad_transport_options,
  68. misc_repeated_remove,
  69. misc_info,
  70. misc_info_embedded,
  71. misc_opts_logger,
  72. misc_set_transport_options,
  73. misc_wait_for_connections,
  74. misc_multiple_ips_in_listen_opts
  75. ]}, {supervisor, [
  76. connection_type_supervisor,
  77. connection_type_supervisor_separate_from_connection,
  78. supervisor_10_acceptors_1_conns_sup,
  79. supervisor_9_acceptors_4_conns_sups,
  80. supervisor_10_acceptors_10_conns_sups,
  81. supervisor_1_acceptor_10_conns_sups,
  82. supervisor_changed_options_restart,
  83. supervisor_clean_child_restart,
  84. supervisor_clean_restart,
  85. supervisor_conns_alive,
  86. supervisor_embedded_ranch_server_crash,
  87. supervisor_protocol_start_link_crash,
  88. supervisor_server_recover_state,
  89. supervisor_unexpected_message
  90. ]}].
  91. %% misc.
  92. misc_bad_transport(_) ->
  93. doc("Reject invalid transport modules."),
  94. {error, {bad_transport, invalid_transport}} = ranch:start_listener(misc_bad_transport,
  95. invalid_transport, #{},
  96. echo_protocol, []),
  97. ok.
  98. misc_bad_transport_options(_) ->
  99. doc("Ignore invalid transport options."),
  100. {ok, _} = ranch:start_listener(misc_bad_transport_options,
  101. ranch_tcp, [binary, {packet, 4}, <<"garbage">>, raw, backlog],
  102. echo_protocol, []),
  103. ok.
  104. misc_info(_) ->
  105. doc("Information about listeners."),
  106. %% Open a listener with a few connections.
  107. {ok, Pid1} = ranch:start_listener({misc_info, tcp},
  108. ranch_tcp, #{num_acceptors => 1},
  109. remove_conn_and_wait_protocol, [{remove, true, 2500}]),
  110. Port1 = ranch:get_port({misc_info, tcp}),
  111. %% Open a few more listeners with different arguments.
  112. {ok, Pid2} = ranch:start_listener({misc_info, act},
  113. ranch_tcp, #{num_acceptors => 2},
  114. active_echo_protocol, {}),
  115. Port2 = ranch:get_port({misc_info, act}),
  116. ranch:set_max_connections({misc_info, act}, infinity),
  117. Opts = ct_helper:get_certs_from_ets(),
  118. {ok, Pid3} = ranch:start_listener({misc_info, ssl},
  119. ranch_ssl, #{num_acceptors => 3, socket_opts => Opts},
  120. echo_protocol, [{}]),
  121. Port3 = ranch:get_port({misc_info, ssl}),
  122. %% Open 5 connections, 3 removed from the count.
  123. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  124. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  125. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  126. receive after 250 -> ok end,
  127. ranch:set_protocol_options({misc_info, tcp}, [{remove, false, 2500}]),
  128. receive after 250 -> ok end,
  129. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  130. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  131. receive after 250 -> ok end,
  132. %% Confirm the info returned by Ranch is correct.
  133. #{
  134. {misc_info, act} := #{
  135. pid := Pid2,
  136. port := Port2,
  137. max_connections := infinity, %% Option was modified.
  138. active_connections := 0,
  139. all_connections := 0,
  140. transport := ranch_tcp,
  141. transport_options := #{num_acceptors := 2},
  142. protocol := active_echo_protocol,
  143. protocol_options := {}
  144. },
  145. {misc_info, ssl} := #{
  146. pid := Pid3,
  147. port := Port3,
  148. max_connections := 1024,
  149. active_connections := 0,
  150. all_connections := 0,
  151. transport := ranch_ssl,
  152. transport_options := #{num_acceptors := 3, socket_opts := Opts},
  153. protocol := echo_protocol,
  154. protocol_options := [{}]
  155. },
  156. {misc_info, tcp} := #{
  157. pid := Pid1,
  158. port := Port1,
  159. max_connections := 1024,
  160. active_connections := 2,
  161. all_connections := 5,
  162. transport := ranch_tcp,
  163. transport_options := #{num_acceptors := 1},
  164. protocol := remove_conn_and_wait_protocol,
  165. protocol_options := [{remove, false, 2500}] %% Option was modified.
  166. }
  167. } = ranch:info(),
  168. %% Get acceptors.
  169. [_] = ranch:procs({misc_info, tcp}, acceptors),
  170. [_, _] = ranch:procs({misc_info, act}, acceptors),
  171. [_, _, _] = ranch:procs({misc_info, ssl}, acceptors),
  172. %% Get connections.
  173. [_, _, _, _, _] = ranch:procs({misc_info, tcp}, connections),
  174. [] = ranch:procs({misc_info, act}, connections),
  175. [] = ranch:procs({misc_info, ssl}, connections),
  176. ok.
  177. misc_info_embedded(_) ->
  178. doc("Information about listeners in embedded mode."),
  179. {ok, SupPid} = embedded_sup:start_link(),
  180. %% Open a listener with a few connections.
  181. {ok, EmbeddedSupPid1} = embedded_sup:start_listener(SupPid, {misc_info_embedded, tcp},
  182. ranch_tcp, #{num_acceptors => 1},
  183. remove_conn_and_wait_protocol, [{remove, true, 2500}]),
  184. {_, Pid1, _, _} = lists:keyfind({ranch_listener_sup, {misc_info_embedded, tcp}}, 1,
  185. supervisor:which_children(EmbeddedSupPid1)),
  186. Port1 = ranch:get_port({misc_info_embedded, tcp}),
  187. %% Open a few more listeners with different arguments.
  188. {ok, EmbeddedSupPid2} = embedded_sup:start_listener(SupPid, {misc_info_embedded, act},
  189. ranch_tcp, #{num_acceptors => 2},
  190. active_echo_protocol, {}),
  191. {_, Pid2, _, _} = lists:keyfind({ranch_listener_sup, {misc_info_embedded, act}}, 1,
  192. supervisor:which_children(EmbeddedSupPid2)),
  193. Port2 = ranch:get_port({misc_info_embedded, act}),
  194. ranch:set_max_connections({misc_info_embedded, act}, infinity),
  195. Opts = ct_helper:get_certs_from_ets(),
  196. {ok, EmbeddedSupPid3} = embedded_sup:start_listener(SupPid, {misc_info_embedded, ssl},
  197. ranch_ssl, #{num_acceptors => 3, socket_opts => Opts},
  198. echo_protocol, [{}]),
  199. {_, Pid3, _, _} = lists:keyfind({ranch_listener_sup, {misc_info_embedded, ssl}}, 1,
  200. supervisor:which_children(EmbeddedSupPid3)),
  201. Port3 = ranch:get_port({misc_info_embedded, ssl}),
  202. %% Open 5 connections, 3 removed from the count.
  203. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  204. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  205. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  206. receive after 250 -> ok end,
  207. ranch:set_protocol_options({misc_info_embedded, tcp}, [{remove, false, 2500}]),
  208. receive after 250 -> ok end,
  209. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  210. {ok, _} = gen_tcp:connect("localhost", Port1, [binary, {active, false}, {packet, raw}]),
  211. receive after 250 -> ok end,
  212. %% Confirm the info returned by Ranch is correct.
  213. #{
  214. {misc_info_embedded, act} := #{
  215. pid := Pid2,
  216. port := Port2,
  217. max_connections := infinity, %% Option was modified.
  218. active_connections := 0,
  219. all_connections := 0,
  220. transport := ranch_tcp,
  221. transport_options := #{num_acceptors := 2},
  222. protocol := active_echo_protocol,
  223. protocol_options := {}
  224. },
  225. {misc_info_embedded, ssl} := #{
  226. pid := Pid3,
  227. port := Port3,
  228. max_connections := 1024,
  229. active_connections := 0,
  230. all_connections := 0,
  231. transport := ranch_ssl,
  232. transport_options := #{num_acceptors := 3, socket_opts := Opts},
  233. protocol := echo_protocol,
  234. protocol_options := [{}]
  235. },
  236. {misc_info_embedded, tcp} := #{
  237. pid := Pid1,
  238. port := Port1,
  239. max_connections := 1024,
  240. active_connections := 2,
  241. all_connections := 5,
  242. transport := ranch_tcp,
  243. transport_options := #{num_acceptors := 1},
  244. protocol := remove_conn_and_wait_protocol,
  245. protocol_options := [{remove, false, 2500}] %% Option was modified.
  246. }
  247. } = ranch:info(),
  248. %% Get acceptors.
  249. [_] = ranch:procs({misc_info_embedded, tcp}, acceptors),
  250. [_, _] = ranch:procs({misc_info_embedded, act}, acceptors),
  251. [_, _, _] = ranch:procs({misc_info_embedded, ssl}, acceptors),
  252. %% Get connections.
  253. [_, _, _, _, _] = ranch:procs({misc_info_embedded, tcp}, connections),
  254. [] = ranch:procs({misc_info_embedded, act}, connections),
  255. [] = ranch:procs({misc_info_embedded, ssl}, connections),
  256. %% Stop embedded tcp listener and ensure it is gone.
  257. ok = embedded_sup:stop_listener(SupPid, {misc_info_embedded, tcp}),
  258. timer:sleep(500),
  259. false = maps:is_key({misc_info_embedded, tcp}, ranch:info()),
  260. %% Stop embedded act listener and ensure it is gone.
  261. ok = embedded_sup:stop_listener(SupPid, {misc_info_embedded, act}),
  262. timer:sleep(500),
  263. false = maps:is_key({misc_info_embedded, act}, ranch:info()),
  264. %% Stop embedded ssl listener and ensure it is gone.
  265. ok = embedded_sup:stop_listener(SupPid, {misc_info_embedded, ssl}),
  266. timer:sleep(500),
  267. false = maps:is_key({misc_info_embedded, ssl}, ranch:info()),
  268. %% Stop embedded supervisor.
  269. embedded_sup:stop(SupPid),
  270. ok.
  271. misc_opts_logger(_) ->
  272. doc("Confirm that messages are sent via the configured logger module."),
  273. register(misc_opts_logger, self()),
  274. {ok, _} = ranch:start_listener(name(),
  275. ranch_tcp, #{logger => ?MODULE, socket_opts => [<<"garbage">>]},
  276. echo_protocol, []),
  277. receive
  278. {warning, "Transport option " ++ _, [<<"garbage">>]} ->
  279. ok
  280. after 1000 ->
  281. error(timeout)
  282. end.
  283. warning(Format, Args) ->
  284. misc_opts_logger ! {warning, Format, Args}.
  285. misc_repeated_remove(_) ->
  286. doc("Ensure repeated removal of connection does not crash the connection supervisor."),
  287. Name = name(),
  288. {ok, _} = ranch:start_listener(Name,
  289. ranch_tcp, #{},
  290. remove_conn_and_wait_protocol, [{remove, 5, 0}]),
  291. Port = ranch:get_port(Name),
  292. ConnsSups = lists:sort(ranch_server:get_connections_sups(Name)),
  293. {ok, _} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  294. timer:sleep(1000),
  295. ConnsSups = lists:sort(ranch_server:get_connections_sups(Name)),
  296. true = lists:all(fun ({_, ConnsSup}) -> erlang:is_process_alive(ConnsSup) end, ConnsSups),
  297. ok = ranch:stop_listener(Name).
  298. misc_set_transport_options(_) ->
  299. doc(""),
  300. Name = name(),
  301. {ok, ListenerSupPid} = ranch:start_listener(Name, ranch_tcp, #{max_connections => 10,
  302. handshake_timeout => 5000, shutdown => 1000, num_acceptors => 1,
  303. socket_opts => [{send_timeout, 5000}]}, echo_protocol, []),
  304. ok = ranch:set_transport_options(Name, #{max_connections => 20, handshake_timeout => 5001,
  305. num_acceptors => 2, shutdown => 1001, socket_opts => [{send_timeout, 5002}]}),
  306. ConnsSups = [ConnsSup || {_, ConnsSup} <- ranch_server:get_connections_sups(Name)],
  307. _ = [begin
  308. {State, _, _, _} = sys:get_state(ConnsSup),
  309. 20 = element(10, State),
  310. 5001 = element(9, State),
  311. 1001 = element(5, State)
  312. end || ConnsSup <- ConnsSups],
  313. ok = ranch:suspend_listener(Name),
  314. ok = ranch:resume_listener(Name),
  315. 2 = length(ranch:procs(Name, acceptors)),
  316. LSocket = do_get_listener_socket(ListenerSupPid),
  317. {ok, [{send_timeout, 5002}]} = ranch_tcp:getopts(LSocket, [send_timeout]),
  318. ok = ranch:stop_listener(Name).
  319. misc_wait_for_connections(_) ->
  320. doc("Ensure wait for connections works."),
  321. Name = name(),
  322. Self = self(),
  323. %% Ensure invalid arguments are rejected.
  324. {'EXIT', {badarg, _}} = begin catch ranch:wait_for_connections(Name, 'foo', 0) end,
  325. {'EXIT', {badarg, _}} = begin catch ranch:wait_for_connections(Name, '==', -1) end,
  326. {'EXIT', {badarg, _}} = begin catch ranch:wait_for_connections(Name, '==', 0, -1) end,
  327. {'EXIT', {badarg, _}} = begin catch ranch:wait_for_connections(Name, '<', 0) end,
  328. %% Create waiters for increasing number of connections.
  329. Pid1GT = do_create_waiter(Self, Name, '>', 0),
  330. Pid1GE = do_create_waiter(Self, Name, '>=', 1),
  331. Pid1EQ = do_create_waiter(Self, Name, '==', 1),
  332. Pid2GT = do_create_waiter(Self, Name, '>', 1),
  333. Pid2GE = do_create_waiter(Self, Name, '>=', 2),
  334. Pid2EQ = do_create_waiter(Self, Name, '==', 2),
  335. {ok, _} = ranch:start_listener(Name,
  336. ranch_tcp, #{num_acceptors => 1},
  337. echo_protocol, []),
  338. Port = ranch:get_port(Name),
  339. %% Create some connections, ensure that waiters respond.
  340. {ok, Sock1} = gen_tcp:connect("localhost", Port, []),
  341. ok = do_expect_waiter(Pid1GT),
  342. ok = do_expect_waiter(Pid1GE),
  343. ok = do_expect_waiter(Pid1EQ),
  344. ok = do_expect_waiter(undefined),
  345. {ok, Sock2} = gen_tcp:connect("localhost", Port, []),
  346. ok = do_expect_waiter(Pid2GT),
  347. ok = do_expect_waiter(Pid2GE),
  348. ok = do_expect_waiter(Pid2EQ),
  349. ok = do_expect_waiter(undefined),
  350. %% Create waiters for decreasing number of connections.
  351. Pid3LT = do_create_waiter(Self, Name, '<', 2),
  352. Pid3LE = do_create_waiter(Self, Name, '=<', 1),
  353. Pid3EQ = do_create_waiter(Self, Name, '==', 1),
  354. Pid4LT = do_create_waiter(Self, Name, '<', 1),
  355. Pid4LE = do_create_waiter(Self, Name, '=<', 0),
  356. Pid4EQ = do_create_waiter(Self, Name, '==', 0),
  357. %% Close connections, ensure that waiters respond.
  358. ok = gen_tcp:close(Sock1),
  359. ok = do_expect_waiter(Pid3LT),
  360. ok = do_expect_waiter(Pid3LE),
  361. ok = do_expect_waiter(Pid3EQ),
  362. ok = do_expect_waiter(undefined),
  363. ok = gen_tcp:close(Sock2),
  364. ok = do_expect_waiter(Pid4LT),
  365. ok = do_expect_waiter(Pid4LE),
  366. ok = do_expect_waiter(Pid4EQ),
  367. ok = do_expect_waiter(undefined),
  368. ok = ranch:stop_listener(Name),
  369. %% Make sure the listener stopped.
  370. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  371. ok.
  372. do_create_waiter(ReplyTo, Ref, Op, NumConns) ->
  373. spawn(fun () -> ok = ranch:wait_for_connections(Ref, Op, NumConns, 100),
  374. ReplyTo ! {wait_connections, self()} end).
  375. do_expect_waiter(WaiterPid) ->
  376. receive
  377. {wait_connections, _} when WaiterPid=:=undefined ->
  378. error;
  379. {wait_connections, Pid} when Pid=:=WaiterPid ->
  380. ok
  381. after 1000 ->
  382. case WaiterPid of
  383. undefined ->
  384. ok;
  385. _ ->
  386. timeout
  387. end
  388. end.
  389. misc_multiple_ips_in_listen_opts(_) ->
  390. case do_os_supports_local_sockets() of
  391. true ->
  392. do_misc_multiple_ips_in_listen_opts();
  393. false ->
  394. {skip, "No local socket support."}
  395. end.
  396. do_misc_multiple_ips_in_listen_opts() ->
  397. doc("Ensure that a listener uses the expected ip option if multiple are given."),
  398. Name = name(),
  399. SockFile1 = do_tempname(),
  400. SockFile2 = do_tempname(),
  401. Opts = [{ip, {local, SockFile1}}, {ip, {local, SockFile2}}],
  402. {ok, _} = ranch:start_listener(Name, ranch_tcp, #{socket_opts => Opts}, echo_protocol, []),
  403. {local, SockFile2} = ranch:get_addr(Name),
  404. ok = ranch:stop_listener(Name).
  405. %% ssl.
  406. ssl_accept_error(_) ->
  407. doc("Acceptor must not crash if client disconnects in the middle of SSL handshake."),
  408. Name = name(),
  409. Opts = ct_helper:get_certs_from_ets(),
  410. {ok, ListenerSup} = ranch:start_listener(Name,
  411. ranch_ssl, #{num_acceptors => 1, socket_opts => Opts},
  412. echo_protocol, []),
  413. Port = ranch:get_port(Name),
  414. ListenerSupChildren = supervisor:which_children(ListenerSup),
  415. {_, AcceptorsSup, _, _} = lists:keyfind(ranch_acceptors_sup, 1, ListenerSupChildren),
  416. [{{acceptor, _, _}, AcceptorPid, _, _}] = supervisor:which_children(AcceptorsSup),
  417. true = is_process_alive(AcceptorPid),
  418. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  419. ok = gen_tcp:close(Socket),
  420. receive after 500 -> ok end,
  421. true = is_process_alive(AcceptorPid),
  422. ok = ranch:stop_listener(Name).
  423. ssl_10_acceptors_10_listen_sockets(_) ->
  424. case do_os_supports_reuseport() of
  425. true ->
  426. ok = do_ssl_10_acceptors_10_listen_sockets();
  427. false ->
  428. {skip, "No SO_REUSEPORT support."}
  429. end.
  430. do_ssl_10_acceptors_10_listen_sockets() ->
  431. doc("Ensure that we can use 10 listen sockets across 10 acceptors with SSL."),
  432. Name = name(),
  433. Opts = ct_helper:get_certs_from_ets(),
  434. {ok, ListenerSupPid} = ranch:start_listener(Name,
  435. ranch_ssl, #{
  436. num_acceptors => 10,
  437. num_listen_sockets => 10,
  438. socket_opts => [{raw, 1, 15, <<1:32/native>>}|Opts]},
  439. echo_protocol, []),
  440. 10 = length(do_get_listener_sockets(ListenerSupPid)),
  441. ok = ranch:stop_listener(Name),
  442. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  443. ok.
  444. ssl_many_listen_sockets_no_reuseport(_) ->
  445. case do_os_supports_reuseport() of
  446. true ->
  447. ok = do_ssl_many_listen_sockets_no_reuseport();
  448. false ->
  449. {skip, "No SO_REUSEPORT support."}
  450. end.
  451. do_ssl_many_listen_sockets_no_reuseport() ->
  452. doc("Confirm that ranch:start_listener/5 fails when SO_REUSEPORT is not available with SSL."),
  453. Name = name(),
  454. Opts = ct_helper:get_certs_from_ets(),
  455. {error, eaddrinuse} = ranch:start_listener(Name,
  456. ranch_ssl, #{
  457. num_acceptors => 10,
  458. num_listen_sockets => 10,
  459. socket_opts => [{raw, 1, 15, <<0:32/native>>}|Opts]},
  460. echo_protocol, []),
  461. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  462. ok.
  463. ssl_active_echo(_) ->
  464. doc("Ensure that active mode works with SSL transport."),
  465. Name = name(),
  466. Opts = ct_helper:get_certs_from_ets(),
  467. {ok, _} = ranch:start_listener(Name,
  468. ranch_ssl, Opts,
  469. active_echo_protocol, []),
  470. Port = ranch:get_port(Name),
  471. {ok, Socket} = ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  472. ok = ssl:send(Socket, <<"SSL Ranch is working!">>),
  473. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket, 21, 1000),
  474. ok = ranch:stop_listener(Name),
  475. {error, closed} = ssl:recv(Socket, 0, 1000),
  476. %% Make sure the listener stopped.
  477. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  478. ok.
  479. ssl_active_n_echo(_) ->
  480. case application:get_key(ssl, vsn) of
  481. {ok, "9.0"++_} ->
  482. {skip, "No Active N support."};
  483. {ok, "9.1"++_} ->
  484. {skip, "No Active N support."};
  485. {ok, _} ->
  486. do_ssl_active_n_echo()
  487. end.
  488. do_ssl_active_n_echo() ->
  489. doc("Ensure that active N mode works with SSL transport."),
  490. Name = name(),
  491. Opts = ct_helper:get_certs_from_ets(),
  492. {ok, _} = ranch:start_listener(Name,
  493. ranch_ssl, Opts,
  494. batch_echo_protocol, [{batch_size, 3}]),
  495. Port = ranch:get_port(Name),
  496. {ok, Socket} = ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  497. ok = ssl:send(Socket, <<"One">>),
  498. {ok, <<"OK">>} = ssl:recv(Socket, 2, 1000),
  499. ok = ssl:send(Socket, <<"Two">>),
  500. {ok, <<"OK">>} = ssl:recv(Socket, 2, 1000),
  501. ok = ssl:send(Socket, <<"Three">>),
  502. {ok, <<"OK">>} = ssl:recv(Socket, 2, 1000),
  503. {ok, <<"OneTwoThree">>} = ssl:recv(Socket, 11, 1000),
  504. ok = ranch:stop_listener(Name),
  505. {error, closed} = ssl:recv(Socket, 0, 1000),
  506. %% Make sure the listener stopped.
  507. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  508. ok.
  509. ssl_echo(_) ->
  510. doc("Ensure that passive mode works with SSL transport."),
  511. Name = name(),
  512. Opts = ct_helper:get_certs_from_ets(),
  513. {ok, _} = ranch:start_listener(Name,
  514. ranch_ssl, Opts,
  515. echo_protocol, []),
  516. Port = ranch:get_port(Name),
  517. {ok, Socket} = ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  518. ok = ssl:send(Socket, <<"SSL Ranch is working!">>),
  519. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket, 21, 1000),
  520. ok = ranch:stop_listener(Name),
  521. {error, closed} = ssl:recv(Socket, 0, 1000),
  522. %% Make sure the listener stopped.
  523. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  524. ok.
  525. ssl_handshake(_) ->
  526. doc("Ensure that multiple steps handshake works with SSL transport."),
  527. Name = name(),
  528. {CaCert1, Cert1, Key1} = ct_helper:make_certs(),
  529. {CaCert2, Cert2, Key2} = ct_helper:make_certs(),
  530. Opts1 = [{cert, Cert1}, {key, Key1}, {cacerts, [CaCert1]}, {verify, verify_peer}],
  531. Opts2 = [{cert, Cert2}, {key, Key2}, {cacerts, [CaCert2]}, {verify, verify_peer}],
  532. DefaultOpts = ct_helper:get_certs_from_ets(),
  533. {ok, _} = ranch:start_listener(Name,
  534. ranch_ssl, [{handshake, hello}|DefaultOpts],
  535. handshake_protocol, #{"ranch1" => Opts1, "ranch2" => Opts2}),
  536. Port = ranch:get_port(Name),
  537. {ok, Socket1} = ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw},
  538. {server_name_indication, "ranch1"}], 5000),
  539. {ok, Cert1} = ssl:peercert(Socket1),
  540. ok = ssl:send(Socket1, <<"SSL Ranch is working!">>),
  541. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket1, 21, 1000),
  542. {ok, Socket2} = ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw},
  543. {server_name_indication, "ranch2"}], 5000),
  544. {ok, Cert2} = ssl:peercert(Socket2),
  545. ok = ssl:send(Socket2, <<"SSL Ranch is working!">>),
  546. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket2, 21, 1000),
  547. ok = ranch:stop_listener(Name),
  548. {error, closed} = ssl:recv(Socket1, 0, 1000),
  549. {error, closed} = ssl:recv(Socket2, 0, 1000),
  550. %% Make sure the listener stopped.
  551. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  552. ok.
  553. ssl_local_echo(_) ->
  554. case do_os_supports_local_sockets() of
  555. true ->
  556. do_ssl_local_echo();
  557. false ->
  558. {skip, "No local socket support."}
  559. end.
  560. do_ssl_local_echo() ->
  561. doc("Ensure that listening on a local socket works with SSL transport."),
  562. SockFile = do_tempname(),
  563. try
  564. Name = name(),
  565. Opts = ct_helper:get_certs_from_ets(),
  566. {ok, _} = ranch:start_listener(Name,
  567. ranch_ssl, #{socket_opts => [{ip, {local, SockFile}}|Opts]},
  568. echo_protocol, []),
  569. undefined = ranch:get_port(Name),
  570. {ok, Socket} = ssl:connect({local, SockFile}, 0, [binary, {active, false}, {packet, raw}]),
  571. ok = ssl:send(Socket, <<"SSL Ranch is working!">>),
  572. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket, 21, 1000),
  573. ok = ranch:stop_listener(Name),
  574. {error, closed} = ssl:recv(Socket, 0, 1000),
  575. %% Make sure the listener stopped.
  576. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  577. ok
  578. after
  579. file:delete(SockFile)
  580. end.
  581. ssl_sni_echo(_) ->
  582. doc("Ensure that SNI works with SSL transport."),
  583. Name = name(),
  584. Opts = ct_helper:get_certs_from_ets(),
  585. {ok, _} = ranch:start_listener(Name,
  586. ranch_ssl, [{sni_hosts, [{"localhost", Opts}]}],
  587. echo_protocol, []),
  588. Port = ranch:get_port(Name),
  589. %% We stick to TLS 1.2 because there seems to be a bug in OTP-23.0rc2
  590. %% that leads to a malformed_handshake_data error.
  591. {ok, Socket} = ssl:connect("localhost", Port,
  592. [binary, {active, false}, {packet, raw}, {versions, ['tlsv1.2']}]),
  593. ok = ssl:send(Socket, <<"SSL Ranch is working!">>),
  594. {ok, <<"SSL Ranch is working!">>} = ssl:recv(Socket, 21, 1000),
  595. ok = ranch:stop_listener(Name),
  596. {error, closed} = ssl:recv(Socket, 0, 1000),
  597. %% Make sure the listener stopped.
  598. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  599. ok.
  600. ssl_sni_fail(_) ->
  601. doc("Ensure that connection fails when host is not in SNI list."),
  602. Name = name(),
  603. Opts = ct_helper:get_certs_from_ets(),
  604. {ok, _} = ranch:start_listener(Name,
  605. ranch_ssl, [{sni_hosts, [{"pouet", Opts}]}],
  606. echo_protocol, []),
  607. Port = ranch:get_port(Name),
  608. %% We stick to TLS 1.2 because there seems to be a bug in OTP-23.0rc2
  609. %% that leads to a malformed_handshake_data error.
  610. {error, _} = ssl:connect("localhost", Port,
  611. [binary, {active, false}, {packet, raw}, {versions, ['tlsv1.2']}]),
  612. ok = ranch:stop_listener(Name),
  613. %% Make sure the listener stopped.
  614. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  615. ok.
  616. ssl_upgrade_from_tcp(_) ->
  617. doc("Ensure a TCP socket can be upgraded to SSL"),
  618. Name = name(),
  619. {ok, _} = ranch:start_listener(Name,
  620. ranch_tcp, #{},
  621. ssl_upgrade_protocol, []),
  622. Port = ranch:get_port(Name),
  623. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  624. ok = gen_tcp:send(Socket, <<"ECHO Before upgrading to SSL">>),
  625. {ok, <<"Before upgrading to SSL">>} = gen_tcp:recv(Socket, 23, 1000),
  626. ok = gen_tcp:send(Socket, <<"UPGRADE">>),
  627. {ok, <<"READY">>} = gen_tcp:recv(Socket, 5, 1000),
  628. {ok, SslSocket} = ssl:connect(Socket, [{verify, verify_none}], 5000),
  629. ok = ssl:send(SslSocket, <<"ECHO After upgrading to SSL">>),
  630. {ok, <<"After upgrading to SSL">>} = ssl:recv(SslSocket, 22, 1000),
  631. ok = ranch:stop_listener(Name),
  632. {error, closed} = ssl:recv(SslSocket, 0, 1000),
  633. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  634. ok.
  635. ssl_graceful(_) ->
  636. doc("Ensure suspending and resuming of listeners does not kill active connections."),
  637. Name = name(),
  638. Opts = ct_helper:get_certs_from_ets(),
  639. {ok, _} = ranch:start_listener(Name,
  640. ranch_ssl, Opts,
  641. echo_protocol, []),
  642. Port = ranch:get_port(Name),
  643. %% Make sure connections with a fresh listener work.
  644. running = ranch:get_status(Name),
  645. {ok, Socket1} = ssl:connect("localhost", Port,
  646. [binary, {active, false}, {packet, raw}]),
  647. ok = ssl:send(Socket1, <<"SSL with fresh listener">>),
  648. {ok, <<"SSL with fresh listener">>} = ssl:recv(Socket1, 23, 1000),
  649. %% Suspend listener, make sure established connections keep running.
  650. ok = ranch:suspend_listener(Name),
  651. suspended = ranch:get_status(Name),
  652. ok = ssl:send(Socket1, <<"SSL with suspended listener">>),
  653. {ok, <<"SSL with suspended listener">>} = ssl:recv(Socket1, 27, 1000),
  654. %% Make sure new connections are refused on the suspended listener.
  655. {error, econnrefused} = ssl:connect("localhost", Port,
  656. [binary, {active, false}, {packet, raw}]),
  657. %% Make sure transport options can be changed when listener is suspended.
  658. ok = ranch:set_transport_options(Name, #{socket_opts => [{port, Port}|Opts]}),
  659. %% Resume listener, make sure connections can be established again.
  660. ok = ranch:resume_listener(Name),
  661. running = ranch:get_status(Name),
  662. {ok, Socket2} = ssl:connect("localhost", Port,
  663. [binary, {active, false}, {packet, raw}]),
  664. ok = ssl:send(Socket2, <<"SSL with resumed listener">>),
  665. {ok, <<"SSL with resumed listener">>} = ssl:recv(Socket2, 25, 1000),
  666. ok = ranch:stop_listener(Name),
  667. {error, closed} = ssl:recv(Socket1, 0, 1000),
  668. {error, closed} = ssl:recv(Socket2, 0, 1000),
  669. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  670. ok.
  671. ssl_getopts_capability(_) ->
  672. doc("Ensure getopts/2 capability."),
  673. Name=name(),
  674. Opts=ct_helper:get_certs_from_ets(),
  675. {ok, _} = ranch:start_listener(Name,
  676. ranch_ssl, Opts,
  677. transport_capabilities_protocol, []),
  678. Port=ranch:get_port(Name),
  679. {ok, Socket}=ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  680. ok=ssl:send(Socket, <<"getopts/2">>),
  681. {ok, <<"OK">>}=ssl:recv(Socket, 0, 1000),
  682. ok=ranch:stop_listener(Name),
  683. {error, closed}=ssl:recv(Socket, 0, 1000),
  684. {'EXIT', _}=begin catch ranch:get_port(Name) end,
  685. ok.
  686. ssl_getstat_capability(_) ->
  687. doc("Ensure getstat/1,2 capability."),
  688. Name=name(),
  689. Opts=ct_helper:get_certs_from_ets(),
  690. {ok, _} = ranch:start_listener(Name,
  691. ranch_ssl, Opts,
  692. transport_capabilities_protocol, []),
  693. Port=ranch:get_port(Name),
  694. {ok, Socket}=ssl:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  695. ok=ssl:send(Socket, <<"getstat/1">>),
  696. {ok, <<"OK">>}=ssl:recv(Socket, 0, 1000),
  697. ok=ssl:send(Socket, <<"getstat/2">>),
  698. {ok, <<"OK">>}=ssl:recv(Socket, 0, 1000),
  699. ok=ranch:stop_listener(Name),
  700. {error, closed}=ssl:recv(Socket, 0, 1000),
  701. {'EXIT', _}=begin catch ranch:get_port(Name) end,
  702. ok.
  703. ssl_error_eaddrinuse(_) ->
  704. doc("Ensure that failure due to an eaddrinuse returns a compact readable error."),
  705. Name = name(),
  706. Opts = ct_helper:get_certs_from_ets(),
  707. {ok, _} = ranch:start_listener(Name,
  708. ranch_ssl, Opts,
  709. active_echo_protocol, []),
  710. Port = ranch:get_port(Name),
  711. {error, eaddrinuse} = ranch:start_listener({Name, fails},
  712. ranch_ssl, [{port, Port}|Opts],
  713. active_echo_protocol, []),
  714. ok = ranch:stop_listener(Name),
  715. %% Make sure the listener stopped.
  716. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  717. ok.
  718. ssl_error_no_cert(_) ->
  719. doc("Ensure that failure due to missing certificate returns a compact readable error."),
  720. {error, no_cert} = ranch:start_listener(name(),
  721. ranch_ssl, #{},
  722. active_echo_protocol, []),
  723. ok.
  724. ssl_error_eacces(_) ->
  725. case os:type() of
  726. {win32, nt} ->
  727. {skip, "No privileged ports."};
  728. {unix, darwin} ->
  729. {skip, "No privileged ports."};
  730. _ ->
  731. doc("Ensure that failure due to an eacces returns a compact readable error."),
  732. Name = name(),
  733. Opts = ct_helper:get_certs_from_ets(),
  734. {error, eacces} = ranch:start_listener(Name,
  735. ranch_ssl, [{port, 283}|Opts],
  736. active_echo_protocol, []),
  737. ok
  738. end.
  739. %% tcp.
  740. tcp_10_acceptors_10_listen_sockets(_) ->
  741. case do_os_supports_reuseport() of
  742. true ->
  743. ok = do_tcp_10_acceptors_10_listen_sockets();
  744. false ->
  745. {skip, "No SO_REUSEPORT support."}
  746. end.
  747. do_tcp_10_acceptors_10_listen_sockets() ->
  748. doc("Ensure that we can use 10 listen sockets across 10 acceptors with TCP."),
  749. Name = name(),
  750. {ok, ListenerSupPid} = ranch:start_listener(Name,
  751. ranch_tcp, #{
  752. num_acceptors => 10,
  753. num_listen_sockets => 10,
  754. socket_opts => [{raw, 1, 15, <<1:32/native>>}]},
  755. echo_protocol, []),
  756. 10 = length(do_get_listener_sockets(ListenerSupPid)),
  757. ok = ranch:stop_listener(Name),
  758. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  759. ok.
  760. tcp_many_listen_sockets_no_reuseport(_) ->
  761. case do_os_supports_reuseport() of
  762. true ->
  763. ok = do_tcp_many_listen_sockets_no_reuseport();
  764. false ->
  765. {skip, "No SO_REUSEPORT support."}
  766. end.
  767. do_tcp_many_listen_sockets_no_reuseport() ->
  768. doc("Confirm that ranch:start_listener/5 fails when SO_REUSEPORT is not available with TCP."),
  769. Name = name(),
  770. {error, eaddrinuse} = ranch:start_listener(Name,
  771. ranch_tcp, #{
  772. num_acceptors => 10,
  773. num_listen_sockets => 10,
  774. socket_opts => [{raw, 1, 15, <<0:32/native>>}]},
  775. echo_protocol, []),
  776. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  777. ok.
  778. tcp_active_echo(_) ->
  779. doc("Ensure that active mode works with TCP transport."),
  780. Name = name(),
  781. {ok, _} = ranch:start_listener(Name,
  782. ranch_tcp, #{},
  783. active_echo_protocol, []),
  784. Port = ranch:get_port(Name),
  785. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  786. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  787. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  788. ok = ranch:stop_listener(Name),
  789. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  790. %% Make sure the listener stopped.
  791. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  792. ok.
  793. tcp_active_n_echo(_) ->
  794. doc("Ensure that active N mode works with TCP transport."),
  795. Name = name(),
  796. {ok, _} = ranch:start_listener(Name,
  797. ranch_tcp, #{},
  798. batch_echo_protocol, [{batch_size, 3}]),
  799. Port = ranch:get_port(Name),
  800. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  801. ok = gen_tcp:send(Socket, <<"One">>),
  802. {ok, <<"OK">>} = gen_tcp:recv(Socket, 2, 1000),
  803. ok = gen_tcp:send(Socket, <<"Two">>),
  804. {ok, <<"OK">>} = gen_tcp:recv(Socket, 2, 1000),
  805. ok = gen_tcp:send(Socket, <<"Three">>),
  806. {ok, <<"OK">>} = gen_tcp:recv(Socket, 2, 1000),
  807. {ok, <<"OneTwoThree">>} = gen_tcp:recv(Socket, 11, 1000),
  808. ok = ranch:stop_listener(Name),
  809. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  810. %% Make sure the listener stopped.
  811. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  812. ok.
  813. tcp_echo(_) ->
  814. doc("Ensure that passive mode works with TCP transport."),
  815. Name = name(),
  816. {ok, _} = ranch:start_listener(Name,
  817. ranch_tcp, #{},
  818. echo_protocol, []),
  819. Port = ranch:get_port(Name),
  820. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  821. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  822. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  823. ok = ranch:stop_listener(Name),
  824. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  825. %% Make sure the listener stopped.
  826. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  827. ok.
  828. tcp_local_echo(_) ->
  829. case do_os_supports_local_sockets() of
  830. true ->
  831. do_tcp_local_echo();
  832. false ->
  833. {skip, "No local socket support."}
  834. end.
  835. do_tcp_local_echo() ->
  836. doc("Ensure that listening on a local socket works with TCP transport."),
  837. SockFile = do_tempname(),
  838. try
  839. Name = name(),
  840. {ok, _} = ranch:start_listener(Name,
  841. ranch_tcp, #{socket_opts => [{ip, {local, SockFile}}]},
  842. echo_protocol, []),
  843. undefined = ranch:get_port(Name),
  844. {ok, Socket} = gen_tcp:connect({local, SockFile}, 0, [binary, {active, false}, {packet, raw}]),
  845. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  846. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  847. ok = ranch:stop_listener(Name),
  848. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  849. %% Make sure the listener stopped.
  850. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  851. ok
  852. after
  853. file:delete(SockFile)
  854. end.
  855. tcp_graceful(_) ->
  856. doc("Ensure suspending and resuming of listeners does not kill active connections."),
  857. Name = name(),
  858. {ok, _} = ranch:start_listener(Name,
  859. ranch_tcp, #{},
  860. echo_protocol, []),
  861. Port = ranch:get_port(Name),
  862. %% Make sure connections with a fresh listener work.
  863. running = ranch:get_status(Name),
  864. {ok, Socket1} = gen_tcp:connect("localhost", Port,
  865. [binary, {active, false}, {packet, raw}]),
  866. ok = gen_tcp:send(Socket1, <<"TCP with fresh listener">>),
  867. {ok, <<"TCP with fresh listener">>} = gen_tcp:recv(Socket1, 23, 1000),
  868. %% Suspend listener, make sure established connections keep running.
  869. ok = ranch:suspend_listener(Name),
  870. suspended = ranch:get_status(Name),
  871. ok = gen_tcp:send(Socket1, <<"TCP with suspended listener">>),
  872. {ok, <<"TCP with suspended listener">>} = gen_tcp:recv(Socket1, 27, 1000),
  873. %% Make sure new connections are refused on the suspended listener.
  874. {error, econnrefused} = gen_tcp:connect("localhost", Port,
  875. [binary, {active, false}, {packet, raw}]),
  876. %% Make sure transport options can be changed when listener is suspended.
  877. ok = ranch:set_transport_options(Name, [{port, Port}]),
  878. %% Resume listener, make sure connections can be established again.
  879. ok = ranch:resume_listener(Name),
  880. running = ranch:get_status(Name),
  881. {ok, Socket2} = gen_tcp:connect("localhost", Port,
  882. [binary, {active, false}, {packet, raw}]),
  883. ok = gen_tcp:send(Socket2, <<"TCP with resumed listener">>),
  884. {ok, <<"TCP with resumed listener">>} = gen_tcp:recv(Socket2, 25, 1000),
  885. ok = ranch:stop_listener(Name),
  886. {error, closed} = gen_tcp:recv(Socket1, 0, 1000),
  887. {error, closed} = gen_tcp:recv(Socket2, 0, 1000),
  888. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  889. ok.
  890. tcp_inherit_options(_) ->
  891. doc("Ensure TCP options are inherited in the protocol."),
  892. Name = name(),
  893. Opts = [{nodelay, false}, {send_timeout_close, false}],
  894. {ok, _} = ranch:start_listener(Name,
  895. ranch_tcp, Opts,
  896. check_tcp_options, [{pid, self()} | Opts]),
  897. Port = ranch:get_port(Name),
  898. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, true}, {packet, raw}]),
  899. receive checked -> ok after 1000 -> error(timeout) end,
  900. ok = gen_tcp:close(Socket),
  901. ok = ranch:stop_listener(Name).
  902. tcp_max_connections(_) ->
  903. doc("Ensure the max_connections option actually limits connections."),
  904. Name = name(),
  905. {ok, _} = ranch:start_listener(Name,
  906. ranch_tcp, #{max_connections => 10, num_acceptors => 1},
  907. notify_and_wait_protocol, #{pid => self()}),
  908. Port = ranch:get_port(Name),
  909. ok = connect_loop(Port, 11, 150),
  910. 10 = ranch_server:count_connections(Name),
  911. {10, Pids1} = receive_loop(connected, 400),
  912. ok = terminate_loop(stop, Pids1),
  913. {1, Pids2} = receive_loop(connected, 1000),
  914. ok = terminate_loop(stop, Pids2),
  915. ok = ranch:stop_listener(Name).
  916. tcp_max_connections_and_beyond(_) ->
  917. doc("Ensure the max_connections option works when connections are removed from the count."),
  918. Name = name(),
  919. {ok, _} = ranch:start_listener(Name,
  920. ranch_tcp, #{max_connections => 10, num_acceptors => 1},
  921. remove_conn_and_wait_protocol, [{remove, true, 2500}]),
  922. Port = ranch:get_port(Name),
  923. ok = connect_loop(Port, 10, 0),
  924. receive after 250 -> ok end,
  925. 0 = ranch_server:count_connections(Name),
  926. 10 = length(do_conns_which_children(Name)),
  927. Counts = do_conns_count_children(Name),
  928. {_, 1} = lists:keyfind(specs, 1, Counts),
  929. {_, 0} = lists:keyfind(supervisors, 1, Counts),
  930. {_, 10} = lists:keyfind(active, 1, Counts),
  931. {_, 10} = lists:keyfind(workers, 1, Counts),
  932. ranch:set_protocol_options(Name, [{remove, false, 2500}]),
  933. receive after 250 -> ok end,
  934. ok = connect_loop(Port, 10, 0),
  935. receive after 250 -> ok end,
  936. 10 = ranch_server:count_connections(Name),
  937. 20 = length(do_conns_which_children(Name)),
  938. Counts2 = do_conns_count_children(Name),
  939. {_, 20} = lists:keyfind(active, 1, Counts2),
  940. {_, 20} = lists:keyfind(workers, 1, Counts2),
  941. ok = ranch:stop_listener(Name).
  942. tcp_max_connections_infinity(_) ->
  943. doc("Set the max_connections option from 10 to infinity and back to 10."),
  944. Name = name(),
  945. {ok, _} = ranch:start_listener(Name,
  946. ranch_tcp, #{max_connections => 10, num_acceptors => 1},
  947. notify_and_wait_protocol, #{pid => self()}),
  948. Port = ranch:get_port(Name),
  949. ok = connect_loop(Port, 20, 0),
  950. 10 = ranch_server:count_connections(Name),
  951. {10, Pids1} = receive_loop(connected, 1000),
  952. 10 = ranch_server:count_connections(Name),
  953. 10 = ranch:get_max_connections(Name),
  954. ranch:set_max_connections(Name, infinity),
  955. receive after 250 -> ok end,
  956. 20 = ranch_server:count_connections(Name),
  957. infinity = ranch:get_max_connections(Name),
  958. ranch:set_max_connections(Name, 10),
  959. 20 = ranch_server:count_connections(Name),
  960. {10, Pids2} = receive_loop(connected, 1000),
  961. ok = terminate_loop(stop, Pids1 ++ Pids2),
  962. ok = ranch:stop_listener(Name).
  963. tcp_remove_connections(_) ->
  964. doc("Ensure that removed connections are only removed once."),
  965. Name = name(),
  966. {ok, _} = ranch:start_listener(Name,
  967. ranch_tcp, #{},
  968. remove_conn_and_wait_protocol, [{remove, true, 0}]),
  969. Port = ranch:get_port(Name),
  970. ok = connect_loop(Port, 10, 0),
  971. receive after 250 -> ok end,
  972. 0 = ranch_server:count_connections(Name),
  973. ok = ranch:stop_listener(Name).
  974. tcp_remove_connections_acceptor_wakeup(_) ->
  975. doc("Ensure that removed connections wake up acceptors."),
  976. Name = name(),
  977. {ok, _} = ranch:start_listener(Name,
  978. ranch_tcp, #{max_connections => 1, num_acceptors => 1},
  979. remove_conn_and_wait_protocol, [{remove, true, infinity}]),
  980. Port = ranch:get_port(Name),
  981. ConnectOptions = [binary, {active, false}],
  982. Localhost = "localhost",
  983. {ok, Socket1} = gen_tcp:connect(Localhost, Port, ConnectOptions),
  984. {ok, Socket2} = gen_tcp:connect(Localhost, Port, ConnectOptions),
  985. {ok, Socket3} = gen_tcp:connect(Localhost, Port, ConnectOptions),
  986. ok = gen_tcp:send(Socket3, <<"bye">>),
  987. true = maps:get(all_connections, ranch:info(Name)) >= 2,
  988. ok = gen_tcp:send(Socket1, <<"bye">>),
  989. ok = gen_tcp:send(Socket2, <<"bye">>),
  990. ok = ranch:stop_listener(Name).
  991. tcp_set_max_connections(_) ->
  992. doc("Ensure that changing the max_connections option to a larger value allows for more connections."),
  993. Name = name(),
  994. {ok, _} = ranch:start_listener(Name,
  995. ranch_tcp, #{max_connections => 10, num_acceptors => 1},
  996. notify_and_wait_protocol, #{pid => self()}),
  997. Port = ranch:get_port(Name),
  998. ok = connect_loop(Port, 20, 0),
  999. 10 = ranch_server:count_connections(Name),
  1000. {10, Pids1} = receive_loop(connected, 1000),
  1001. 10 = ranch:get_max_connections(Name),
  1002. ranch:set_max_connections(Name, 20),
  1003. {10, Pids2} = receive_loop(connected, 1000),
  1004. 20 = ranch:get_max_connections(Name),
  1005. ok = terminate_loop(stop, Pids1 ++ Pids2),
  1006. ok = ranch:stop_listener(Name).
  1007. tcp_set_max_connections_clean(Config) ->
  1008. case code:is_module_native(?MODULE) of
  1009. true -> doc("This test uses tracing and is not compatible with native code.");
  1010. false -> do_tcp_set_max_connections_clean(Config)
  1011. end.
  1012. do_tcp_set_max_connections_clean(_) ->
  1013. doc("Ensure that setting max_connections does not crash any process."),
  1014. Name = name(),
  1015. {ok, ListSupPid} = ranch:start_listener(Name,
  1016. ranch_tcp, #{max_connections => 4},
  1017. notify_and_wait_protocol, #{pid => self()}),
  1018. Children = supervisor:which_children(ListSupPid),
  1019. {_, AccSupPid, _, _} = lists:keyfind(ranch_acceptors_sup, 1, Children),
  1020. 1 = erlang:trace(ListSupPid, true, [procs]),
  1021. 1 = erlang:trace(AccSupPid, true, [procs]),
  1022. Port = ranch:get_port(Name),
  1023. N = 20,
  1024. ok = connect_loop(Port, N*5, 0),
  1025. %% Randomly set max_connections.
  1026. [spawn(ranch, set_max_connections, [Name, Max]) ||
  1027. Max <- lists:flatten(lists:duplicate(N, [6, 4, 8, infinity]))],
  1028. receive
  1029. {trace, _, spawn, _, _} ->
  1030. error(dirty_set_max_connections)
  1031. after
  1032. 2000 -> ok
  1033. end,
  1034. _ = erlang:trace(all, false, [all]),
  1035. ok = clean_traces(),
  1036. ok = ranch:stop_listener(Name).
  1037. tcp_getopts_capability(_) ->
  1038. doc("Ensure getopts/2 capability."),
  1039. Name=name(),
  1040. {ok, _}=ranch:start_listener(Name,
  1041. ranch_tcp, #{},
  1042. transport_capabilities_protocol, []),
  1043. Port=ranch:get_port(Name),
  1044. {ok, Socket}=gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  1045. ok=gen_tcp:send(Socket, <<"getopts/2">>),
  1046. {ok, <<"OK">>}=gen_tcp:recv(Socket, 0, 1000),
  1047. ok=ranch:stop_listener(Name),
  1048. {error, closed}=gen_tcp:recv(Socket, 0, 1000),
  1049. {'EXIT', _}=begin catch ranch:get_port(Name) end,
  1050. ok.
  1051. tcp_getstat_capability(_) ->
  1052. doc("Ensure getstat/1,2 capability."),
  1053. Name=name(),
  1054. {ok, _}=ranch:start_listener(Name,
  1055. ranch_tcp, #{},
  1056. transport_capabilities_protocol, []),
  1057. Port=ranch:get_port(Name),
  1058. {ok, Socket}=gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  1059. ok=gen_tcp:send(Socket, <<"getstat/1">>),
  1060. {ok, <<"OK">>}=gen_tcp:recv(Socket, 0, 1000),
  1061. ok=gen_tcp:send(Socket, <<"getstat/2">>),
  1062. {ok, <<"OK">>}=gen_tcp:recv(Socket, 0, 1000),
  1063. ok=ranch:stop_listener(Name),
  1064. {error, closed}=gen_tcp:recv(Socket, 0, 1000),
  1065. {'EXIT', _}=begin catch ranch:get_port(Name) end,
  1066. ok.
  1067. tcp_upgrade(_) ->
  1068. doc("Ensure that protocol options can be updated."),
  1069. Name = name(),
  1070. {ok, _} = ranch:start_listener(Name,
  1071. ranch_tcp, #{},
  1072. notify_and_wait_protocol, #{pid => self()}),
  1073. Port = ranch:get_port(Name),
  1074. ok = connect_loop(Port, 1, 0),
  1075. {1, Pids1} = receive_loop(connected, 1000),
  1076. ranch:set_protocol_options(Name, #{msg => upgraded, pid => self()}),
  1077. ok = connect_loop(Port, 1, 0),
  1078. {1, Pids2} = receive_loop(upgraded, 1000),
  1079. ok = terminate_loop(stop, Pids1 ++ Pids2),
  1080. ok = ranch:stop_listener(Name).
  1081. tcp_error_eaddrinuse(_) ->
  1082. doc("Ensure that failure due to an eaddrinuse returns a compact readable error."),
  1083. Name = name(),
  1084. {ok, _} = ranch:start_listener(Name,
  1085. ranch_tcp, #{},
  1086. active_echo_protocol, []),
  1087. Port = ranch:get_port(Name),
  1088. {error, eaddrinuse} = ranch:start_listener({Name, fails},
  1089. ranch_tcp, [{port, Port}],
  1090. active_echo_protocol, []),
  1091. ok = ranch:stop_listener(Name),
  1092. %% Make sure the listener stopped.
  1093. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1094. ok.
  1095. tcp_error_eacces(_) ->
  1096. case os:type() of
  1097. {win32, nt} ->
  1098. {skip, "No privileged ports."};
  1099. {unix, darwin} ->
  1100. {skip, "No privileged ports."};
  1101. _ ->
  1102. doc("Ensure that failure due to an eacces returns a compact readable error."),
  1103. Name = name(),
  1104. {error, eacces} = ranch:start_listener(Name,
  1105. ranch_tcp, [{port, 283}],
  1106. active_echo_protocol, []),
  1107. ok
  1108. end.
  1109. %% Supervisor tests
  1110. connection_type_supervisor(_) ->
  1111. doc("The supervisor connection type must be reflected in the specifications."),
  1112. Name = name(),
  1113. {ok, _} = ranch:start_listener(Name,
  1114. ranch_tcp, #{connection_type => supervisor},
  1115. echo_protocol, []),
  1116. Port = ranch:get_port(Name),
  1117. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  1118. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  1119. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  1120. [{echo_protocol, _, supervisor, [echo_protocol]}] = do_conns_which_children(Name),
  1121. ok = ranch:stop_listener(Name),
  1122. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  1123. %% Make sure the listener stopped.
  1124. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1125. ok.
  1126. connection_type_supervisor_separate_from_connection(_) ->
  1127. doc("The supervisor connection type allows separate supervised and connection processes."),
  1128. Name = name(),
  1129. {ok, _} = ranch:start_listener(Name,
  1130. ranch_tcp, #{connection_type => supervisor},
  1131. supervisor_separate, []),
  1132. Port = ranch:get_port(Name),
  1133. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  1134. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  1135. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  1136. [{supervisor_separate, _, supervisor, [supervisor_separate]}] = do_conns_which_children(Name),
  1137. ok = ranch:stop_listener(Name),
  1138. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  1139. %% Make sure the listener stopped.
  1140. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1141. ok.
  1142. supervisor_10_acceptors_1_conns_sup(_) ->
  1143. doc("Ensure that using 10 acceptors and 1 connection supervisor works."),
  1144. ok = do_supervisor_n_acceptors_m_conns_sups(10, 1).
  1145. supervisor_9_acceptors_4_conns_sups(_) ->
  1146. doc("Ensure that using 9 acceptors and 4 connection supervisors works."),
  1147. ok = do_supervisor_n_acceptors_m_conns_sups(9, 4).
  1148. supervisor_10_acceptors_10_conns_sups(_) ->
  1149. doc("Ensure that using 10 acceptors and 10 connection supervisors works."),
  1150. ok = do_supervisor_n_acceptors_m_conns_sups(10, 10).
  1151. supervisor_1_acceptor_10_conns_sups(_) ->
  1152. doc("Ensure that using 1 acceptor and 10 connection supervisors works."),
  1153. ok = do_supervisor_n_acceptors_m_conns_sups(1, 10).
  1154. do_supervisor_n_acceptors_m_conns_sups(NumAcceptors, NumConnsSups) ->
  1155. Name = name(),
  1156. {ok, Pid} = ranch:start_listener(Name,
  1157. ranch_tcp, #{num_conns_sups => NumConnsSups, num_acceptors => NumAcceptors},
  1158. notify_and_wait_protocol, #{pid => self()}),
  1159. Port = ranch:get_port(Name),
  1160. ConnsSups = [ConnsSup || {_, ConnsSup} <- ranch_server:get_connections_sups(Name)],
  1161. NumConnsSups = length(ConnsSups),
  1162. {ranch_acceptors_sup, AcceptorsSup, supervisor, _} =
  1163. lists:keyfind(ranch_acceptors_sup, 1, supervisor:which_children(Pid)),
  1164. AcceptorIds = [AcceptorId ||
  1165. {{acceptor, _, AcceptorId}, _, worker, _} <- supervisor:which_children(AcceptorsSup)],
  1166. NumAcceptors = length(AcceptorIds),
  1167. AcceptorConnsSups0 = [ranch_server:get_connections_sup(Name, AcceptorId) ||
  1168. AcceptorId <- AcceptorIds],
  1169. AcceptorConnsSups1 = lists:usort(AcceptorConnsSups0),
  1170. if
  1171. NumAcceptors > NumConnsSups ->
  1172. NumConnsSups = length(AcceptorConnsSups1),
  1173. [] = ConnsSups -- AcceptorConnsSups1;
  1174. NumAcceptors < NumConnsSups ->
  1175. NumAcceptors = length(AcceptorConnsSups1),
  1176. [] = AcceptorConnsSups1 -- ConnsSups;
  1177. NumAcceptors =:= NumConnsSups ->
  1178. NumConnsSups = length(AcceptorConnsSups1),
  1179. NumAcceptors = length(AcceptorConnsSups1),
  1180. [] = ConnsSups -- AcceptorConnsSups1,
  1181. [] = AcceptorConnsSups1 -- ConnsSups
  1182. end,
  1183. ok = connect_loop(Port, 100, 0),
  1184. {100, Pids} = receive_loop(connected, 1000),
  1185. 100 = ranch_server:count_connections(Name),
  1186. ok = terminate_loop(stop, Pids),
  1187. ok = ranch:stop_listener(Name),
  1188. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1189. ok.
  1190. supervisor_changed_options_restart(_) ->
  1191. doc("Ensure that a listener is restarted with changed transport options."),
  1192. Name = name(),
  1193. %% Start a listener using send_timeout as option change marker.
  1194. {ok, ListenerSupPid1} = ranch:start_listener(Name,
  1195. ranch_tcp, [{send_timeout, 300000}],
  1196. echo_protocol, []),
  1197. %% Ensure send_timeout is really set to initial value.
  1198. {ok, [{send_timeout, 300000}]}
  1199. = inet:getopts(do_get_listener_socket(ListenerSupPid1), [send_timeout]),
  1200. %% Change send_timeout option.
  1201. ok = ranch:suspend_listener(Name),
  1202. ok = ranch:set_transport_options(Name, [{send_timeout, 300001}]),
  1203. ok = ranch:resume_listener(Name),
  1204. %% Ensure send_timeout is really set to the changed value.
  1205. {ok, [{send_timeout, 300001}]}
  1206. = inet:getopts(do_get_listener_socket(ListenerSupPid1), [send_timeout]),
  1207. %% Crash the listener_sup process, allow a short time for restart to succeed.
  1208. %% We silence the expected log events coming from the relevant supervisors.
  1209. ListenerChilds = [ChildPid || {_, ChildPid, _, _} <- supervisor:which_children(ListenerSupPid1)],
  1210. FilterFun = fun (#{meta := #{pid := EventPid}}, _) ->
  1211. case lists:member(EventPid, ListenerChilds) of
  1212. true -> stop;
  1213. false -> ignore
  1214. end
  1215. end,
  1216. ok = logger:add_primary_filter(?MODULE, {FilterFun, undefined}),
  1217. try
  1218. exit(ListenerSupPid1, kill),
  1219. timer:sleep(1000)
  1220. after
  1221. ok = logger:remove_primary_filter(?MODULE)
  1222. end,
  1223. %% Obtain pid of restarted listener_sup process.
  1224. [ListenerSupPid2] = [Pid || {{ranch_listener_sup, Ref}, Pid, supervisor, _}
  1225. <- supervisor:which_children(ranch_sup), Ref =:= Name],
  1226. %% Ensure send_timeout is still set to the changed value.
  1227. {ok, [{send_timeout, 300001}]}
  1228. = inet:getopts(do_get_listener_socket(ListenerSupPid2), [send_timeout]),
  1229. ok = ranch:stop_listener(Name),
  1230. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1231. ok.
  1232. supervisor_clean_child_restart(Config) ->
  1233. case code:is_module_native(?MODULE) of
  1234. true -> doc("This test uses tracing and is not compatible with native code.");
  1235. false -> do_supervisor_clean_child_restart(Config)
  1236. end.
  1237. do_supervisor_clean_child_restart(_) ->
  1238. doc("Verify that only the relevant parts of the supervision tree restarted "
  1239. "when the listening socket is closed."),
  1240. Name = name(),
  1241. %% Trace socket allocations.
  1242. {module, ranch_tcp} = code:ensure_loaded(ranch_tcp),
  1243. _ = erlang:trace(new, true, [call]),
  1244. 1 = erlang:trace_pattern({ranch_tcp, listen, 1},
  1245. [{'_', [], [{return_trace}]}], [global]),
  1246. {ok, Pid} = ranch:start_listener(Name,
  1247. ranch_tcp, #{num_acceptors => 1},
  1248. echo_protocol, []),
  1249. %% Trace supervisor spawns.
  1250. 1 = erlang:trace(Pid, true, [procs, set_on_spawn]),
  1251. ConnsSups = ranch_server:get_connections_sups(Name),
  1252. %% Manually shut the listening socket down.
  1253. LSocket = receive
  1254. {trace, _, return_from, {ranch_tcp, listen, 1}, {ok, Socket}} ->
  1255. Socket
  1256. after 0 ->
  1257. error(lsocket_unknown)
  1258. end,
  1259. ok = gen_tcp:close(LSocket),
  1260. receive after 1000 -> ok end,
  1261. %% Verify that supervisor and its first two children are alive.
  1262. true = is_process_alive(Pid),
  1263. true = lists:all(fun erlang:is_process_alive/1, [ConnsSup || {_, ConnsSup} <- ConnsSups]),
  1264. %% Check that acceptors_sup is restarted properly.
  1265. AccSupPid = receive {trace, Pid, spawn, Pid1, _} -> Pid1 end,
  1266. receive {trace, AccSupPid, spawn, _, _} -> ok end,
  1267. %% No more traces then.
  1268. receive
  1269. {trace, _, spawn, _, _} -> error(invalid_restart)
  1270. after 1000 -> ok end,
  1271. %% Verify that children still registered right.
  1272. ConnsSups = ranch_server:get_connections_sups(Name),
  1273. _ = erlang:trace_pattern({ranch_tcp, listen, 1}, false, []),
  1274. _ = erlang:trace(all, false, [all]),
  1275. ok = clean_traces(),
  1276. ok = ranch:stop_listener(Name).
  1277. supervisor_clean_restart(Config) ->
  1278. case code:is_module_native(?MODULE) of
  1279. true -> doc("This test uses tracing and is not compatible with native code.");
  1280. false -> do_supervisor_clean_restart(Config)
  1281. end.
  1282. do_supervisor_clean_restart(_) ->
  1283. doc("Verify that killing ranch_conns_sup does not crash everything "
  1284. "and that it restarts properly."),
  1285. Name = name(),
  1286. NumAcc = 4,
  1287. {ok, Pid} = ranch:start_listener(Name,
  1288. ranch_tcp, #{num_acceptors => NumAcc},
  1289. echo_protocol, []),
  1290. %% Trace supervisor spawns.
  1291. 1 = erlang:trace(Pid, true, [procs, set_on_spawn]),
  1292. {_, ConnsSupSup0, _, _} = lists:keyfind(ranch_conns_sup_sup, 1, supervisor:which_children(Pid)),
  1293. exit(ConnsSupSup0, kill),
  1294. receive after 1000 -> ok end,
  1295. %% Verify that supervisor is alive
  1296. true = is_process_alive(Pid),
  1297. %% ...but children are dead.
  1298. false = is_process_alive(ConnsSupSup0),
  1299. %% Receive traces from newly started children
  1300. ConnsSupSup = receive {trace, Pid, spawn, Pid2, _} -> Pid2 end,
  1301. [receive {trace, ConnsSupSup, spawn, _Pid, _} -> ok end ||
  1302. _ <- lists:seq(1, NumAcc)],
  1303. AccSupPid = receive {trace, Pid, spawn, Pid3, _} -> Pid3 end,
  1304. %% ...and its acceptors.
  1305. [receive {trace, AccSupPid, spawn, _Pid, _} -> ok end ||
  1306. _ <- lists:seq(1, NumAcc)],
  1307. %% No more traces then.
  1308. receive
  1309. {trace, EPid, spawn, _, _} when EPid == Pid; EPid == AccSupPid ->
  1310. error(invalid_restart)
  1311. after 1000 -> ok end,
  1312. %% Verify that new children registered themselves properly.
  1313. _ = erlang:trace(all, false, [all]),
  1314. ok = clean_traces(),
  1315. ok = ranch:stop_listener(Name).
  1316. supervisor_conns_alive(Config) ->
  1317. case code:is_module_native(?MODULE) of
  1318. true -> doc("This test uses tracing and is not compatible with native code.");
  1319. false -> do_supervisor_conns_alive(Config)
  1320. end.
  1321. do_supervisor_conns_alive(_) ->
  1322. doc("Ensure that active connections stay open when the listening socket gets closed."),
  1323. Name = name(),
  1324. {module, ranch_tcp} = code:ensure_loaded(ranch_tcp),
  1325. _ = erlang:trace(new, true, [call]),
  1326. 1 = erlang:trace_pattern({ranch_tcp, listen, 1},
  1327. [{'_', [], [{return_trace}]}], [global]),
  1328. {ok, _} = ranch:start_listener(Name,
  1329. ranch_tcp, #{},
  1330. remove_conn_and_wait_protocol, [{remove, false, 2500}]),
  1331. %% Get the listener socket
  1332. LSocket = receive
  1333. {trace, _, return_from, {ranch_tcp, listen, 1}, {ok, S}} ->
  1334. S
  1335. after 500 ->
  1336. error(lsocket_unknown)
  1337. end,
  1338. TcpPort = ranch:get_port(Name),
  1339. {ok, Socket} = gen_tcp:connect("localhost", TcpPort,
  1340. [binary, {active, true}, {packet, raw}]),
  1341. receive after 500 -> ok end,
  1342. %% Shut the socket down
  1343. ok = gen_tcp:close(LSocket),
  1344. %% Assert that client is still viable.
  1345. receive {tcp_closed, _} -> error(closed) after 1500 -> ok end,
  1346. ok = gen_tcp:send(Socket, <<"poke">>),
  1347. receive {tcp_closed, _} -> ok end,
  1348. _ = erlang:trace(all, false, [all]),
  1349. ok = clean_traces(),
  1350. ok = ranch:stop_listener(Name).
  1351. supervisor_embedded_ranch_server_crash(_) ->
  1352. doc("Ensure that restarting ranch_server also restarts embedded listeners."),
  1353. Name = name(),
  1354. {ok, SupPid} = embedded_sup:start_link(),
  1355. {ok, EmbeddedSupPid} = embedded_sup:start_listener(SupPid, Name,
  1356. ranch_tcp, #{},
  1357. echo_protocol, []),
  1358. [{{ranch_listener_sup, Name}, ListenerPid, supervisor, _},
  1359. {ranch_server_proxy, ProxyPid, worker, _}] = supervisor:which_children(EmbeddedSupPid),
  1360. ProxyMonitor = monitor(process, ProxyPid),
  1361. ListenerMonitor = monitor(process, ListenerPid),
  1362. ok = supervisor:terminate_child(ranch_sup, ranch_server),
  1363. receive {'DOWN', ProxyMonitor, process, ProxyPid, shutdown} -> ok after 1000 -> exit(timeout) end,
  1364. receive {'DOWN', ListenerMonitor, process, ListenerPid, shutdown} -> ok after 1000 -> exit(timeout) end,
  1365. {ok, _} = supervisor:restart_child(ranch_sup, ranch_server),
  1366. receive after 1000 -> ok end,
  1367. [{{ranch_listener_sup, Name}, _, supervisor, _},
  1368. {ranch_server_proxy, _, worker, _}] = supervisor:which_children(EmbeddedSupPid),
  1369. embedded_sup:stop_listener(SupPid, Name),
  1370. embedded_sup:stop(SupPid),
  1371. ok.
  1372. supervisor_protocol_start_link_crash(_) ->
  1373. doc("Ensure a protocol start crash does not kill all connections."),
  1374. Name = name(),
  1375. {ok, _} = ranch:start_listener(Name,
  1376. ranch_tcp, #{},
  1377. crash_protocol, []),
  1378. ConnsSups = ranch_server:get_connections_sups(Name),
  1379. Port = ranch:get_port(Name),
  1380. {ok, _} = gen_tcp:connect("localhost", Port, [binary, {active, true}, {packet, raw}]),
  1381. receive after 500 -> ok end,
  1382. ConnsSups = ranch_server:get_connections_sups(Name),
  1383. ok = ranch:stop_listener(Name).
  1384. supervisor_server_recover_state(Config) ->
  1385. case code:is_module_native(?MODULE) of
  1386. true -> doc("This test uses tracing and is not compatible with native code.");
  1387. false -> do_supervisor_server_recover_state(Config)
  1388. end.
  1389. do_supervisor_server_recover_state(_) ->
  1390. doc("Ensure that when ranch_server crashes and restarts, it recovers "
  1391. "its state and continues monitoring the same processes."),
  1392. Name = name(),
  1393. _ = erlang:trace(new, true, [call]),
  1394. 1 = erlang:trace_pattern({ranch_server, init, 1},
  1395. [{'_', [], [{return_trace}]}], [global]),
  1396. {ok, _} = ranch:start_listener(Name,
  1397. ranch_tcp, #{},
  1398. echo_protocol, []),
  1399. ConnsSups = ranch_server:get_connections_sups(Name),
  1400. ServerPid = erlang:whereis(ranch_server),
  1401. {monitors, Monitors} = erlang:process_info(ServerPid, monitors),
  1402. erlang:exit(ServerPid, kill),
  1403. receive
  1404. {trace, ServerPid2, return_from, {ranch_server, init, 1}, _Result} ->
  1405. {monitors, Monitors2} = erlang:process_info(ServerPid2, monitors),
  1406. %% Check that ranch_server is monitoring the same processes.
  1407. true = (lists:usort(Monitors) == lists:usort(Monitors2))
  1408. after
  1409. 1000 ->
  1410. error(timeout)
  1411. end,
  1412. ConnsSups = ranch_server:get_connections_sups(Name),
  1413. ok = ranch:stop_listener(Name),
  1414. %% Check ranch_server has removed the ranch_conns_sup.
  1415. [] = (catch ranch_server:get_connections_sups(Name)),
  1416. _ = erlang:trace(all, false, [all]),
  1417. ok = clean_traces().
  1418. supervisor_unexpected_message(_) ->
  1419. doc("Ensure the connections supervisor stays alive when it receives "
  1420. "an unexpected message."),
  1421. Name = name(),
  1422. {ok, _} = ranch:start_listener(Name,
  1423. ranch_tcp, #{},
  1424. echo_protocol, []),
  1425. Port = ranch:get_port(Name),
  1426. {ok, Socket} = gen_tcp:connect("localhost", Port, [binary, {active, false}, {packet, raw}]),
  1427. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  1428. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  1429. %% Send the unexpected message to all ranch_conns_sups.
  1430. _ = [ConnSup ! hello || {_, ConnSup} <- ranch_server:get_connections_sups(Name)],
  1431. %% Connection is still up.
  1432. ok = gen_tcp:send(Socket, <<"TCP Ranch is working!">>),
  1433. {ok, <<"TCP Ranch is working!">>} = gen_tcp:recv(Socket, 21, 1000),
  1434. ok = ranch:stop_listener(Name),
  1435. {error, closed} = gen_tcp:recv(Socket, 0, 1000),
  1436. %% Make sure the listener stopped.
  1437. {'EXIT', _} = begin catch ranch:get_port(Name) end,
  1438. ok.
  1439. %% Utility functions.
  1440. connect_loop(_, 0, _) ->
  1441. ok;
  1442. connect_loop(Port, N, Sleep) ->
  1443. {ok, _} = gen_tcp:connect("localhost", Port,
  1444. [binary, {active, false}, {packet, raw}]),
  1445. receive after Sleep -> ok end,
  1446. connect_loop(Port, N - 1, Sleep).
  1447. receive_loop(Message, Timeout) ->
  1448. receive_loop(Message, Timeout, 0, []).
  1449. receive_loop(Message, Timeout, N, Acc) ->
  1450. receive {Pid, Message} ->
  1451. receive_loop(Message, Timeout, N + 1, [Pid|Acc])
  1452. after Timeout ->
  1453. {N, Acc}
  1454. end.
  1455. terminate_loop(_, []) ->
  1456. ok;
  1457. terminate_loop(Message, [Pid|Pids]) ->
  1458. Pid ! Message,
  1459. terminate_loop(Message, Pids).
  1460. clean_traces() ->
  1461. receive
  1462. {trace, _, _, _} ->
  1463. clean_traces();
  1464. {trace, _, _, _, _} ->
  1465. clean_traces()
  1466. after 0 ->
  1467. ok
  1468. end.
  1469. do_get_listener_socket(ListenerSupPid) ->
  1470. [LSocket] = do_get_listener_sockets(ListenerSupPid),
  1471. LSocket.
  1472. do_get_listener_sockets(ListenerSupPid) ->
  1473. [AcceptorsSupPid] = [Pid || {ranch_acceptors_sup, Pid, supervisor, _}
  1474. <- supervisor:which_children(ListenerSupPid)],
  1475. {links, Links} = erlang:process_info(AcceptorsSupPid, links),
  1476. [P || P <- Links, is_port(P)].
  1477. do_conns_which_children(Name) ->
  1478. Conns = [supervisor:which_children(ConnsSup) ||
  1479. {_, ConnsSup} <- ranch_server:get_connections_sups(Name)],
  1480. lists:flatten(Conns).
  1481. do_conns_count_children(Name) ->
  1482. lists:foldl(
  1483. fun
  1484. (Stats, undefined) ->
  1485. Stats;
  1486. (Stats, Acc) ->
  1487. lists:zipwith(
  1488. fun ({K, V1}, {K, V2}) -> {K, V1+V2} end,
  1489. Acc,
  1490. Stats
  1491. )
  1492. end,
  1493. undefined,
  1494. [supervisor:count_children(ConnsSup) ||
  1495. {_, ConnsSup} <- ranch_server:get_connections_sups(Name)]
  1496. ).
  1497. do_os_supports_reuseport() ->
  1498. case {os:type(), os:version()} of
  1499. {{unix, linux}, {Major, _, _}} when Major > 3 -> true;
  1500. {{unix, linux}, {3, Minor, _}} when Minor >= 9 -> true;
  1501. _ -> false
  1502. end.
  1503. do_os_supports_local_sockets() ->
  1504. case os:type() of
  1505. {unix, _} -> true;
  1506. _ -> false
  1507. end.
  1508. do_tempname() ->
  1509. list_to_binary(lists:droplast(os:cmd("mktemp -u"))).