acceptor_SUITE.erl 59 KB

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