aboutsummaryrefslogtreecommitdiffstats
path: root/test/http_SUITE.erl
blob: 1d6c3fc933931dabeb68555ab2d96f4fbc7ca0bf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
%% Copyright (c) 2018, Loïc Hoguin <[email protected]>
%%
%% 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(http_SUITE).
-compile(export_all).
-compile(nowarn_export_all).

-import(ct_helper, [config/2]).
-import(ct_helper, [doc/1]).
-import(ct_helper, [get_remote_pid_tcp/1]).
-import(ct_helper, [name/0]).
-import(cowboy_test, [gun_open/1]).
-import(cowboy_test, [raw_open/1]).
-import(cowboy_test, [raw_send/2]).
-import(cowboy_test, [raw_recv_head/1]).
-import(cowboy_test, [raw_recv/3]).
-import(cowboy_test, [raw_expect_recv/2]).

all() -> [{group, clear}].

groups() -> [{clear, [parallel], ct_helper:all(?MODULE)}].

init_routes(_) -> [
	{"localhost", [
		{"/", hello_h, []},
		{"/echo/:key", echo_h, []},
		{"/resp/:key[/:arg]", resp_h, []},
		{"/set_options/:key", set_options_h, []}
	]}
].

chunked_false(Config) ->
	doc("Confirm the option chunked => false disables chunked "
		"transfer-encoding for HTTP/1.1 connections."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		chunked => false
	}),
	Port = ranch:get_port(name()),
	Request = "GET /resp/stream_reply2/200 HTTP/1.1\r\nhost: localhost\r\n\r\n",
	Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
	ok = raw_send(Client, Request),
	Rest = case catch raw_recv_head(Client) of
		{'EXIT', _} -> error(closed);
		Data ->
			%% Cowboy always advertises itself as HTTP/1.1.
			{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
			{Headers, Rest1} = cow_http:parse_headers(Rest0),
			false = lists:keyfind(<<"content-length">>, 1, Headers),
			false = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
			Rest1
	end,
	Bits = 8000000 - bit_size(Rest),
	raw_expect_recv(Client, <<0:Bits>>),
	{error, closed} = raw_recv(Client, 1, 1000),
	ok.

http10_keepalive_false(Config) ->
	doc("Confirm the option http10_keepalive => false disables keep-alive "
		"completely for HTTP/1.0 connections."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		http10_keepalive => false
	}),
	Port = ranch:get_port(name()),
	Keepalive = "GET / HTTP/1.0\r\nhost: localhost\r\nConnection: keep-alive\r\n\r\n",
	Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
	ok = raw_send(Client, Keepalive),
	_ = case catch raw_recv_head(Client) of
		{'EXIT', _} -> error(closed);
		Data ->
			%% Cowboy always advertises itself as HTTP/1.1.
			{'HTTP/1.1', 200, _, Rest} = cow_http:parse_status_line(Data),
			{Headers, _} = cow_http:parse_headers(Rest),
			{_, <<"close">>} = lists:keyfind(<<"connection">>, 1, Headers)
	end,
	ok = raw_send(Client, Keepalive),
	case catch raw_recv_head(Client) of
		{'EXIT', _} -> closed;
		_ -> error(not_closed)
	end.

idle_timeout_infinity(Config) ->
	doc("Ensure the idle_timeout option accepts the infinity value."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		request_timeout => 500,
		idle_timeout => infinity
	}),
	Port = ranch:get_port(name()),
	ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
	_ = gun:post(ConnPid, "/echo/read_body",
		[{<<"content-type">>, <<"text/plain">>}]),
	#{socket := Socket} = gun:info(ConnPid),
	Pid = get_remote_pid_tcp(Socket),
	Ref = erlang:monitor(process, Pid),
	receive
		{'DOWN', Ref, process, Pid, Reason} ->
			error(Reason)
	after 1000 ->
		ok
	end.

request_timeout_infinity(Config) ->
	doc("Ensure the request_timeout option accepts the infinity value."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		idle_timeout => infinity
	}),
	Port = ranch:get_port(name()),
	ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
	#{socket := Socket} = gun:info(ConnPid),
	Pid = get_remote_pid_tcp(Socket),
	Ref = erlang:monitor(process, Pid),
	receive
		{'DOWN', Ref, process, Pid, Reason} ->
			error(Reason)
	after 1000 ->
		ok
	end.

set_options_chunked_false(Config) ->
	doc("Confirm the option chunked can be dynamically set to disable "
		"chunked transfer-encoding. This results in the closing of the "
		"connection after the current request."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		chunked => true
	}),
	Port = ranch:get_port(name()),
	Request = "GET /set_options/chunked_false HTTP/1.1\r\nhost: localhost\r\n\r\n",
	Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
	ok = raw_send(Client, Request),
	_ = case catch raw_recv_head(Client) of
		{'EXIT', _} -> error(closed);
		Data ->
			%% Cowboy always advertises itself as HTTP/1.1.
			{'HTTP/1.1', 200, _, Rest} = cow_http:parse_status_line(Data),
			{Headers, <<>>} = cow_http:parse_headers(Rest),
			false = lists:keyfind(<<"content-length">>, 1, Headers),
			false = lists:keyfind(<<"transfer-encoding">>, 1, Headers)
	end,
	raw_expect_recv(Client, <<0:8000000>>),
	{error, closed} = raw_recv(Client, 1, 1000),
	ok.

set_options_chunked_false_ignored(Config) ->
	doc("Confirm the option chunked can be dynamically set to disable "
		"chunked transfer-encoding, and that it is ignored if the "
		"response is not streamed."),
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		chunked => true
	}),
	Port = ranch:get_port(name()),
	ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
	%% We do a first request setting the option but not
	%% using chunked transfer-encoding in the response.
	StreamRef1 = gun:get(ConnPid, "/set_options/chunked_false_ignored"),
	{response, nofin, 200, _} = gun:await(ConnPid, StreamRef1),
	{ok, <<"Hello world!">>} = gun:await_body(ConnPid, StreamRef1),
	%% We then do a second request to confirm that chunked
	%% is not disabled for that second request.
	StreamRef2 = gun:get(ConnPid, "/resp/stream_reply2/200"),
	{response, nofin, 200, Headers} = gun:await(ConnPid, StreamRef2),
	{_, <<"chunked">>} = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
	ok.

set_options_idle_timeout(Config) ->
	doc("Confirm that the idle_timeout option can be dynamically "
		"set to change how long Cowboy will wait before it closes the connection."),
	%% We start with a long timeout and then cut it short.
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		idle_timeout => 60000
	}),
	Port = ranch:get_port(name()),
	ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
	_ = gun:post(ConnPid, "/set_options/idle_timeout_short",
		[{<<"content-type">>, <<"text/plain">>}]),
	#{socket := Socket} = gun:info(ConnPid),
	Pid = get_remote_pid_tcp(Socket),
	Ref = erlang:monitor(process, Pid),
	receive
		{'DOWN', Ref, process, Pid, _} ->
			ok
	after 2000 ->
		error(timeout)
	end.

set_options_idle_timeout_only_applies_to_current_request(Config) ->
	doc("Confirm that changes to the idle_timeout option only apply to the current stream."),
	%% We start with a long timeout and then cut it short.
	{ok, _} = cowboy:start_clear(name(), [{port, 0}], #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		idle_timeout => 500
	}),
	Port = ranch:get_port(name()),
	ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
	StreamRef = gun:post(ConnPid, "/set_options/idle_timeout_long",
		[{<<"content-type">>, <<"text/plain">>}]),
	#{socket := Socket} = gun:info(ConnPid),
	Pid = get_remote_pid_tcp(Socket),
	Ref = erlang:monitor(process, Pid),
	receive
		{'DOWN', Ref, process, Pid, Reason} ->
			error(Reason)
	after 2000 ->
		ok
	end,
	%% Finish the first request and start a second one to confirm
	%% the idle_timeout option is back to normal.
	gun:data(ConnPid, StreamRef, fin, <<"Hello!">>),
	{response, nofin, 200, _} = gun:await(ConnPid, StreamRef),
	{ok, <<"Hello!">>} = gun:await_body(ConnPid, StreamRef),
	_ = gun:post(ConnPid, "/echo/read_body",
		[{<<"content-type">>, <<"text/plain">>}]),
	receive
		{'DOWN', Ref, process, Pid, _} ->
			ok
	after 2000 ->
		error(timeout)
	end.

switch_protocol_flush(Config) ->
	doc("Confirm that switch_protocol does not flush unrelated messages."),
	ProtoOpts = #{
		env => #{dispatch => cowboy_router:compile(init_routes(Config))},
		stream_handlers => [switch_protocol_flush_h]
	},
	{ok, _} = cowboy:start_clear(switch_protocol_flush, [{port, 0}], ProtoOpts),
	Port = ranch:get_port(switch_protocol_flush),
	Self = self(),
	ConnPid = gun_open([{port, Port}, {type, tcp}, {protocol, http}|Config]),
	_ = gun:get(ConnPid, "/", [
		{<<"x-test-pid">>, pid_to_list(Self)}
	]),
	receive
		{Self, Events} ->
			switch_protocol_flush_h:validate(Events)
	end.