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
|
%% Copyright (c) 2017-2024, 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(misc_SUITE).
-compile(export_all).
-compile(nowarn_export_all).
-import(ct_helper, [config/2]).
-import(ct_helper, [doc/1]).
-import(cowboy_test, [gun_open/1]).
all() ->
[{group, app}, {group, env}|cowboy_test:common_all()].
groups() ->
Common = ct_helper:all(?MODULE)
-- [restart_gracefully, get_env, set_env, set_env_missing],
[
{app, [], [restart_gracefully]},
{env, [parallel], [get_env, set_env, set_env_missing]}
|cowboy_test:common_groups(Common)].
init_per_group(Name=app, Config) ->
cowboy_test:init_http(Name, #{
env => #{dispatch => init_dispatch(Config)}
}, Config);
init_per_group(env, Config) ->
Config;
init_per_group(Name, Config) ->
cowboy_test:init_common_groups(Name, Config, ?MODULE).
end_per_group(env, _) ->
ok;
end_per_group(Name, _) ->
cowboy_test:stop_group(Name).
init_dispatch(_) ->
cowboy_router:compile([{"localhost", [
{"/", hello_h, []}
]}]).
%% Logger function silencing the expected crash.
error("Ranch listener " ++ _, [set_env_missing|_]) ->
ok;
error(Format, Args) ->
error_logger:error_msg(Format, Args).
%% Tests.
restart_gracefully(Config) ->
doc("Ensure we can process request when the cowboy application is being restarted."),
ConnPid = gun_open(Config),
%% We can do a request before stopping cowboy.
Ref1 = gun:get(ConnPid, "/"),
{response, _, 200, _} = gun:await(ConnPid, Ref1),
%% Stop the cowboy application.
ok = application:stop(cowboy),
%% We can still do a request even though cowboy is stopped.
Ref2 = gun:get(ConnPid, "/"),
{response, _, 200, _} = gun:await(ConnPid, Ref2),
%% Start the cowboy application again.
ok = application:start(cowboy),
%% Even after restarting there are no issues.
Ref3 = gun:get(ConnPid, "/"),
{response, _, 200, _} = gun:await(ConnPid, Ref3),
ok.
router_invalid_path(Config) ->
doc("Ensure a path with invalid percent-encoded characters results in a 400."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/version/path/%\\u0016\\u0016/path"),
{response, _, 400, _} = gun:await(ConnPid, Ref),
ok.
get_env(Config0) ->
doc("Ensure we can retrieve middleware environment values."),
Dispatch = init_dispatch(Config0),
_Config = cowboy_test:init_http(?FUNCTION_NAME, #{
env => #{
dispatch => Dispatch,
the_key => the_value
}
}, Config0),
try
Dispatch = cowboy:get_env(?FUNCTION_NAME, dispatch),
Dispatch = cowboy:get_env(?FUNCTION_NAME, dispatch, the_default),
the_value = cowboy:get_env(?FUNCTION_NAME, the_key),
the_value = cowboy:get_env(?FUNCTION_NAME, the_key, the_default),
{'EXIT', _} = (catch cowboy:get_env(?FUNCTION_NAME, missing_key)),
the_default = cowboy:get_env(?FUNCTION_NAME, missing_key, the_default)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_env(Config0) ->
doc("Live replace a middleware environment value."),
Config = cowboy_test:init_http(?FUNCTION_NAME, #{
env => #{dispatch => []}
}, Config0),
try
ConnPid1 = gun_open(Config),
Ref1 = gun:get(ConnPid1, "/"),
{response, _, 400, _} = gun:await(ConnPid1, Ref1),
cowboy:set_env(?FUNCTION_NAME, dispatch, init_dispatch(Config)),
%% Only new connections get the updated environment.
ConnPid2 = gun_open(Config),
Ref2 = gun:get(ConnPid2, "/"),
{response, _, 200, _} = gun:await(ConnPid2, Ref2)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_env_missing(Config0) ->
doc("Live replace a middleware environment value when env was not provided."),
Config = cowboy_test:init_http(?FUNCTION_NAME, #{
logger => ?MODULE
}, Config0),
try
ConnPid1 = gun_open(Config),
Ref1 = gun:get(ConnPid1, "/"),
{response, _, 500, _} = gun:await(ConnPid1, Ref1),
cowboy:set_env(?FUNCTION_NAME, dispatch, []),
%% Only new connections get the updated environment.
ConnPid2 = gun_open(Config),
Ref2 = gun:get(ConnPid2, "/"),
{response, _, 400, _} = gun:await(ConnPid2, Ref2)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
|
