acceptor_SUITE.erl 60 KB

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