0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00

Test switch_handler against all relevant REST callbacks

This commit is contained in:
Loïc Hoguin 2018-11-05 10:01:51 +01:00
parent 8c9ad7bf07
commit 06f9f3714f
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
2 changed files with 245 additions and 10 deletions

View file

@ -1,21 +1,163 @@
-module(switch_handler_h).
-export([init/2]).
-export([allowed_methods/2]).
-export([allow_missing_post/2]).
-export([charsets_provided/2]).
-export([content_types_accepted/2]).
-export([content_types_provided/2]).
-export([delete_completed/2]).
-export([delete_resource/2]).
-export([forbidden/2]).
-export([is_authorized/2]).
-export([is_conflict/2]).
-export([known_methods/2]).
-export([languages_provided/2]).
-export([malformed_request/2]).
-export([moved_permanently/2]).
-export([moved_temporarily/2]).
-export([multiple_choices/2]).
-export([options/2]).
-export([previously_existed/2]).
-export([rate_limited/2]).
-export([resource_exists/2]).
-export([service_available/2]).
-export([uri_too_long/2]).
-export([valid_content_headers/2]).
-export([valid_entity_length/2]).
-export([accept/2]).
-export([provide/2]).
-export([info/3]).
init(Req, State) ->
{cowboy_rest, Req, State}.
content_types_provided(Req, State) ->
{[{<<"text/plain">>, provide}], Req, State}.
allowed_methods(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
provide(Req0, run) ->
allow_missing_post(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
charsets_provided(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
content_types_accepted(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
content_types_provided(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
delete_completed(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
delete_resource(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
forbidden(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
is_authorized(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
is_conflict(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
known_methods(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
languages_provided(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
malformed_request(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
moved_permanently(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
moved_temporarily(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
multiple_choices(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
options(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
previously_existed(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
rate_limited(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
resource_exists(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
service_available(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
uri_too_long(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
valid_content_headers(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
valid_entity_length(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
accept(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
provide(Req, State) ->
maybe_switch_handler(Req, State, ?FUNCTION_NAME).
maybe_switch_handler(Req=#{qs := Qs}, State, StateName) ->
case atom_to_binary(StateName, latin1) of
Qs -> do_switch_handler(Req, State);
_ -> do_default(Req, State, StateName)
end.
%% These are all the methods necessary to reach all callbacks.
do_default(Req, State, allowed_methods) ->
{[<<"GET">>, <<"POST">>, <<"PUT">>, <<"DELETE">>, <<"OPTIONS">>], Req, State};
%% We need to accept/provide media types to reach these callbacks.
do_default(Req, State, content_types_accepted) ->
{[{<<"text/plain">>, accept}], Req, State};
do_default(Req, State, content_types_provided) ->
{[{<<"text/plain">>, provide}], Req, State};
%% We need resource_exists to return false to reach these callbacks.
do_default(Req=#{qs := <<"allow_missing_post">>}, State, resource_exists) ->
{false, Req, State};
do_default(Req=#{qs := <<"moved_permanently">>}, State, resource_exists) ->
{false, Req, State};
do_default(Req=#{qs := <<"moved_temporarily">>}, State, resource_exists) ->
{false, Req, State};
do_default(Req=#{qs := <<"previously_existed">>}, State, resource_exists) ->
{false, Req, State};
%% We need previously_existed to return true to reach these callbacks.
do_default(Req=#{qs := <<"moved_permanently">>}, State, previously_existed) ->
{true, Req, State};
do_default(Req=#{qs := <<"moved_temporarily">>}, State, previously_existed) ->
{true, Req, State};
%% We need the DELETE to suceed to reach this callback.
do_default(Req=#{qs := <<"delete_completed">>}, State, delete_resource) ->
{true, Req, State};
%% We should never reach these two callbacks.
do_default(Req, State, accept) ->
{false, Req, State};
do_default(Req, State, provide) ->
{<<"This is REST!">>, Req, State};
%% Simulate the callback being missing in any other cases.
do_default(_, _, _) ->
no_call.
do_switch_handler(Req0, run) ->
Req = cowboy_req:stream_reply(200, Req0),
send_after(0),
{{switch_handler, cowboy_loop}, Req, 0};
provide(Req0, hibernate) ->
do_switch_handler(Req0, hibernate) ->
Req = cowboy_req:stream_reply(200, Req0),
send_after(0),
{{switch_handler, cowboy_loop, hibernate}, Req, 0}.

View file

@ -313,19 +313,112 @@ rate_not_limited(Config) ->
{response, nofin, 200, _} = gun:await(ConnPid, Ref),
ok.
switch_handler(Config) ->
doc("Switch REST to loop handler for streaming the response body."),
switch_handler_allowed_methods(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_allow_missing_post(Config) ->
do_req_body_switch_handler(Config, post, ?FUNCTION_NAME).
switch_handler_charsets_provided(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_content_types_accepted(Config) ->
do_req_body_switch_handler(Config, post, ?FUNCTION_NAME).
switch_handler_content_types_provided(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_delete_completed(Config) ->
do_no_body_switch_handler(Config, delete, ?FUNCTION_NAME).
switch_handler_delete_resource(Config) ->
do_no_body_switch_handler(Config, delete, ?FUNCTION_NAME).
switch_handler_forbidden(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_is_authorized(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_is_conflict(Config) ->
do_req_body_switch_handler(Config, put, ?FUNCTION_NAME).
switch_handler_known_methods(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_languages_provided(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_malformed_request(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_moved_permanently(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_moved_temporarily(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_multiple_choices(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_options(Config) ->
do_no_body_switch_handler(Config, options, ?FUNCTION_NAME).
switch_handler_previously_existed(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_rate_limited(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_resource_exists(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_service_available(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_uri_too_long(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_valid_content_headers(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_valid_entity_length(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
switch_handler_accept(Config) ->
do_req_body_switch_handler(Config, post, ?FUNCTION_NAME).
switch_handler_provide(Config) ->
do_no_body_switch_handler(Config, get, ?FUNCTION_NAME).
do_no_body_switch_handler(Config, Method, StateName0) ->
doc("Switch REST to loop handler for streaming the response body, "
"with and without options."),
"switch_handler_" ++ StateName = atom_to_list(StateName0),
do_no_body_switch_handler1(Config, Method, "/switch_handler?" ++ StateName),
do_no_body_switch_handler1(Config, Method, "/switch_handler_opts?" ++ StateName).
do_no_body_switch_handler1(Config, Method, Path) ->
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/switch_handler", [{<<"accept-encoding">>, <<"gzip">>}]),
Ref = gun:Method(ConnPid, Path, [{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{ok, Body} = gun:await_body(ConnPid, Ref),
<<"Hello\nstreamed\nworld!\n">> = do_decode(Headers, Body),
ok.
switch_handler_opts(Config) ->
doc("Switch REST to loop handler for streaming the response body; with options."),
do_req_body_switch_handler(Config, Method, StateName0) ->
doc("Switch REST to loop handler for streaming the response body, "
"with and without options."),
"switch_handler_" ++ StateName = atom_to_list(StateName0),
do_req_body_switch_handler1(Config, Method, "/switch_handler?" ++ StateName),
do_req_body_switch_handler1(Config, Method, "/switch_handler_opts?" ++ StateName).
do_req_body_switch_handler1(Config, Method, Path) ->
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/switch_handler_opts", [{<<"accept-encoding">>, <<"gzip">>}]),
Ref = gun:Method(ConnPid, Path, [
{<<"accept-encoding">>, <<"gzip">>},
{<<"content-type">>, <<"text/plain">>}
], <<"Hocus PocuSwitch!">>),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{ok, Body} = gun:await_body(ConnPid, Ref),
<<"Hello\nstreamed\nworld!\n">> = do_decode(Headers, Body),