271 lines
9.6 KiB
Erlang
271 lines
9.6 KiB
Erlang
|
%% Copyright (c) 2018-2023, Loïc Hoguin <essen@ninenines.eu>
|
||
|
|
%%
|
||
|
|
%% Permission to use, copy, modify, and/or distribute this software for any
|
||
|
|
%% purpose with or without fee is hereby granted, provided that the above
|
||
|
|
%% copyright notice and this permission notice appear in all copies.
|
||
|
|
%%
|
||
|
|
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||
|
|
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||
|
|
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||
|
|
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||
|
|
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||
|
|
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||
|
|
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||
|
|
|
||
|
|
-module(ws_SUITE).
|
||
|
|
-compile(export_all).
|
||
|
|
-compile(nowarn_export_all).
|
||
|
|
|
||
|
|
-import(ct_helper, [config/2]).
|
||
|
|
-import(ct_helper, [doc/1]).
|
||
|
|
|
||
|
|
%% ct.
|
||
|
|
|
||
|
|
all() ->
|
||
|
|
[{group, http}, {group, http2}].
|
||
|
|
|
||
|
|
groups() ->
|
||
|
|
Tests = ct_helper:all(?MODULE),
|
||
|
|
HTTP1Tests = [
|
||
|
|
http10_upgrade_error,
|
||
|
|
http11_request_error,
|
||
|
|
http11_keepalive,
|
||
|
|
http11_keepalive_default_silence_pings
|
||
|
|
],
|
||
|
|
[
|
||
|
|
{http, [], Tests},
|
||
|
|
{http2, [], Tests -- HTTP1Tests}
|
||
|
|
].
|
||
|
|
|
||
|
|
init_per_suite(Config) ->
|
||
|
|
Routes = [
|
||
|
|
{"/", ws_echo_h, []},
|
||
|
|
{"/reject", ws_reject_h, []},
|
||
|
|
{"/subprotocol", ws_subprotocol_h, []}
|
||
|
|
],
|
||
|
|
{ok, _} = cowboy:start_clear(ws, [], #{
|
||
|
|
enable_connect_protocol => true,
|
||
|
|
env => #{dispatch => cowboy_router:compile([{'_', Routes}])}
|
||
|
|
}),
|
||
|
|
Port = ranch:get_port(ws),
|
||
|
|
[{port, Port}|Config].
|
||
|
|
|
||
|
|
end_per_suite(_) ->
|
||
|
|
cowboy:stop_listener(ws).
|
||
|
|
|
||
|
|
%% Tests.
|
||
|
|
|
||
|
|
await(Config) ->
|
||
|
|
doc("Ensure gun:await/2 can be used to receive Websocket frames."),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
Frame = {text, <<"Hello!">>},
|
||
|
|
gun:ws_send(ConnPid, StreamRef, Frame),
|
||
|
|
{ws, Frame} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
headers_normalized_upgrade(Config) ->
|
||
|
|
doc("Headers passed to ws_upgrade are normalized before being used."),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", #{
|
||
|
|
atom_header_name => <<"value">>,
|
||
|
|
"string_header_name" => <<"value">>
|
||
|
|
}),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
http10_upgrade_error(Config) ->
|
||
|
|
doc("Attempting to upgrade HTTP/1.0 to Websocket produces an error."),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
http_opts => #{version => 'HTTP/1.0'}
|
||
|
|
}),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
receive
|
||
|
|
{gun_error, ConnPid, StreamRef, {badstate, _}} ->
|
||
|
|
gun:close(ConnPid);
|
||
|
|
Msg ->
|
||
|
|
error({fail, Msg})
|
||
|
|
after 1000 ->
|
||
|
|
error(timeout)
|
||
|
|
end.
|
||
|
|
|
||
|
|
http11_keepalive(Config) ->
|
||
|
|
doc("Ensure that Gun automatically sends ping frames."),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
ws_opts => #{
|
||
|
|
keepalive => 100,
|
||
|
|
silence_pings => false
|
||
|
|
}
|
||
|
|
}),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
%% Gun sent a ping automatically, we therefore receive a pong.
|
||
|
|
{ws, pong} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
http11_keepalive_default_silence_pings(Config) ->
|
||
|
|
doc("Ensure that Gun does not forward ping/pong by default."),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
ws_opts => #{keepalive => 100}
|
||
|
|
}),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
%% Gun sent a ping automatically, but we silence ping/pong by default.
|
||
|
|
{error, timeout} = gun:await(ConnPid, StreamRef, 1000),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
http11_request_error(Config) ->
|
||
|
|
doc("Ensure that HTTP/1.1 requests are rejected while using Websocket."),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config)),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef1 = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef1),
|
||
|
|
StreamRef2 = gun:get(ConnPid, "/"),
|
||
|
|
{error, {connection_error, {badstate, _}}} = gun:await(ConnPid, StreamRef2),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
reject_upgrade(Config) ->
|
||
|
|
doc("Ensure Websocket connections can be rejected."),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/reject", []),
|
||
|
|
receive
|
||
|
|
{gun_response, ConnPid, StreamRef, nofin, 400, _} ->
|
||
|
|
{ok, <<"Upgrade rejected">>} = gun:await_body(ConnPid, StreamRef, 1000),
|
||
|
|
gun:close(ConnPid);
|
||
|
|
Msg ->
|
||
|
|
error({fail, Msg})
|
||
|
|
after 1000 ->
|
||
|
|
error(timeout)
|
||
|
|
end.
|
||
|
|
|
||
|
|
reply_to(Config) ->
|
||
|
|
doc("Ensure the reply_to request option is respected."),
|
||
|
|
Self = self(),
|
||
|
|
Frame = {text, <<"Hello!">>},
|
||
|
|
ReplyTo = spawn(fun() ->
|
||
|
|
{ConnPid, StreamRef} = receive
|
||
|
|
{C, S} when is_pid(C), is_reference(S) -> {C, S}
|
||
|
|
after 1000 ->
|
||
|
|
error(timeout)
|
||
|
|
end,
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
Self ! {self(), ready},
|
||
|
|
{ws, Frame} = gun:await(ConnPid, StreamRef),
|
||
|
|
Self ! {self(), ok}
|
||
|
|
end),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", [], #{reply_to => ReplyTo}),
|
||
|
|
ReplyTo ! {ConnPid, StreamRef},
|
||
|
|
receive {ReplyTo, ready} -> gun:ws_send(ConnPid, StreamRef, Frame) after 1000 -> error(timeout) end,
|
||
|
|
receive {ReplyTo, ok} -> gun:close(ConnPid) after 1000 -> error(timeout) end.
|
||
|
|
|
||
|
|
send_many(Config) ->
|
||
|
|
doc("Ensure we can send a list of frames in one gun:ws_send call."),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
Frame1 = {text, <<"Hello!">>},
|
||
|
|
Frame2 = {binary, <<"World!">>},
|
||
|
|
gun:ws_send(ConnPid, StreamRef, [Frame1, Frame2]),
|
||
|
|
{ws, Frame1} = gun:await(ConnPid, StreamRef),
|
||
|
|
{ws, Frame2} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
send_many_close(Config) ->
|
||
|
|
doc("Ensure we can send a list of frames in one gun:ws_send call, including a close frame."),
|
||
|
|
Protocol = config(name, config(tc_group_properties, Config)),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config), #{
|
||
|
|
protocols => [Protocol],
|
||
|
|
http2_opts => #{notify_settings_changed => true}
|
||
|
|
}),
|
||
|
|
{ok, Protocol} = gun:await_up(ConnPid),
|
||
|
|
do_await_enable_connect_protocol(Protocol, ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/", []),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
Frame1 = {text, <<"Hello!">>},
|
||
|
|
Frame2 = {binary, <<"World!">>},
|
||
|
|
gun:ws_send(ConnPid, StreamRef, [Frame1, Frame2, close]),
|
||
|
|
{ws, Frame1} = gun:await(ConnPid, StreamRef),
|
||
|
|
{ws, Frame2} = gun:await(ConnPid, StreamRef),
|
||
|
|
{ws, close} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
subprotocol_match(Config) ->
|
||
|
|
doc("Websocket subprotocol successfully negotiated."),
|
||
|
|
Protocols = [{P, gun_ws_h} || P <- [<<"dummy">>, <<"echo">>, <<"junk">>]],
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config)),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/subprotocol", [], #{
|
||
|
|
protocols => Protocols
|
||
|
|
}),
|
||
|
|
{upgrade, [<<"websocket">>], _} = gun:await(ConnPid, StreamRef),
|
||
|
|
Frame = {text, <<"Hello!">>},
|
||
|
|
gun:ws_send(ConnPid, StreamRef, Frame),
|
||
|
|
{ws, Frame} = gun:await(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
subprotocol_nomatch(Config) ->
|
||
|
|
doc("Websocket subprotocol negotiation failure."),
|
||
|
|
Protocols = [{P, gun_ws_h} || P <- [<<"dummy">>, <<"junk">>]],
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config)),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/subprotocol", [], #{
|
||
|
|
protocols => Protocols
|
||
|
|
}),
|
||
|
|
{response, nofin, 400, _} = gun:await(ConnPid, StreamRef),
|
||
|
|
{ok, <<"nomatch">>} = gun:await_body(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
subprotocol_required_but_missing(Config) ->
|
||
|
|
doc("Websocket subprotocol not negotiated but required by the server."),
|
||
|
|
{ok, ConnPid} = gun:open("localhost", config(port, Config)),
|
||
|
|
{ok, _} = gun:await_up(ConnPid),
|
||
|
|
StreamRef = gun:ws_upgrade(ConnPid, "/subprotocol", []),
|
||
|
|
{response, nofin, 400, _} = gun:await(ConnPid, StreamRef),
|
||
|
|
{ok, <<"undefined">>} = gun:await_body(ConnPid, StreamRef),
|
||
|
|
gun:close(ConnPid).
|
||
|
|
|
||
|
|
%% Internal.
|
||
|
|
|
||
|
|
do_await_enable_connect_protocol(http, _) ->
|
||
|
|
ok;
|
||
|
|
%% We cannot do a CONNECT :protocol request until the server tells us we can.
|
||
|
|
do_await_enable_connect_protocol(http2, ConnPid) ->
|
||
|
|
{notify, settings_changed, #{enable_connect_protocol := true}}
|
||
|
|
= gun:await(ConnPid, undefined), %% @todo Maybe have a gun:await/1?
|
||
|
|
ok.
|