%% Copyright (c) 2017, 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, set_env}|cowboy_test:common_all()].
groups() ->
Common = ct_helper:all(?MODULE)
-- [restart_gracefully, set_env, set_env_missing],
[
{app, [], [restart_gracefully]},
{set_env, [parallel], [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(set_env, Config) ->
Config;
init_per_group(Name, Config) ->
cowboy_test:init_common_groups(Name, Config, ?MODULE).
end_per_group(set_env, _) ->
ok;
end_per_group(Name, _) ->
cowboy:stop_listener(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.
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.
