From 805a156785a08316c768fa51c7441a750a6c9f53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 5 Nov 2018 10:30:26 +0100 Subject: Test stop against all relevant REST callbacks --- doc/src/manual/cowboy_rest.asciidoc | 4 + test/handlers/stop_handler_h.erl | 159 ++++++++++++++++++++++++++++++++++++ test/handlers/switch_handler_h.erl | 2 + test/rest_handler_SUITE.erl | 99 ++++++++++++++++++++++ 4 files changed, 264 insertions(+) create mode 100644 test/handlers/stop_handler_h.erl diff --git a/doc/src/manual/cowboy_rest.asciidoc b/doc/src/manual/cowboy_rest.asciidoc index 4babcc5..d7901fd 100644 --- a/doc/src/manual/cowboy_rest.asciidoc +++ b/doc/src/manual/cowboy_rest.asciidoc @@ -550,6 +550,10 @@ links to the different representations. If the server has a preferred representation it can send its link inside a location header. +Note that when replying manually in this callback you +should either call `cowboy_req:reply/4` or remove the +response body that Cowboy sets to avoid surprises. + === options [source,erlang] diff --git a/test/handlers/stop_handler_h.erl b/test/handlers/stop_handler_h.erl new file mode 100644 index 0000000..22abda7 --- /dev/null +++ b/test/handlers/stop_handler_h.erl @@ -0,0 +1,159 @@ +%% This module returns stop based on the query string. +%% Success is indicated via a 248 status code in the response. + +-module(stop_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]). + +init(Req, State) -> + {cowboy_rest, Req, State}. + +allowed_methods(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +allow_missing_post(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +charsets_provided(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +content_types_accepted(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +content_types_provided(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +delete_completed(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +delete_resource(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +forbidden(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +is_authorized(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +is_conflict(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +known_methods(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +languages_provided(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +malformed_request(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +moved_permanently(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +moved_temporarily(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +multiple_choices(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +options(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +previously_existed(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +rate_limited(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +resource_exists(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +service_available(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +uri_too_long(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +valid_content_headers(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +valid_entity_length(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +accept(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +provide(Req, State) -> + maybe_stop_handler(Req, State, ?FUNCTION_NAME). + +maybe_stop_handler(Req=#{qs := Qs}, State, StateName) -> + case atom_to_binary(StateName, latin1) of + Qs -> do_stop_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_stop_handler(Req0, State) -> + Req = cowboy_req:reply(<<"248 REST handler stopped!">>, #{}, <<>>, Req0), + {stop, Req, State}. diff --git a/test/handlers/switch_handler_h.erl b/test/handlers/switch_handler_h.erl index 264be68..cf656ae 100644 --- a/test/handlers/switch_handler_h.erl +++ b/test/handlers/switch_handler_h.erl @@ -1,3 +1,5 @@ +%% This module returns switch_handler based on the query string. + -module(switch_handler_h). -export([init/2]). diff --git a/test/rest_handler_SUITE.erl b/test/rest_handler_SUITE.erl index 32dbdff..fac4bbd 100644 --- a/test/rest_handler_SUITE.erl +++ b/test/rest_handler_SUITE.erl @@ -49,6 +49,7 @@ init_dispatch(_) -> charset_in_content_types_provided_implicit_no_callback_h, []}, {"/provide_callback_missing", provide_callback_missing_h, []}, {"/rate_limited", rate_limited_h, []}, + {"/stop_handler", stop_handler_h, []}, {"/switch_handler", switch_handler_h, run}, {"/switch_handler_opts", switch_handler_h, hibernate} ]}]). @@ -313,6 +314,104 @@ rate_not_limited(Config) -> {response, nofin, 200, _} = gun:await(ConnPid, Ref), ok. +stop_handler_allowed_methods(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_allow_missing_post(Config) -> + do_req_body_stop_handler(Config, post, ?FUNCTION_NAME). + +stop_handler_charsets_provided(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_content_types_accepted(Config) -> + do_req_body_stop_handler(Config, post, ?FUNCTION_NAME). + +stop_handler_content_types_provided(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_delete_completed(Config) -> + do_no_body_stop_handler(Config, delete, ?FUNCTION_NAME). + +stop_handler_delete_resource(Config) -> + do_no_body_stop_handler(Config, delete, ?FUNCTION_NAME). + +stop_handler_forbidden(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_is_authorized(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_is_conflict(Config) -> + do_req_body_stop_handler(Config, put, ?FUNCTION_NAME). + +stop_handler_known_methods(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_languages_provided(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_malformed_request(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_moved_permanently(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_moved_temporarily(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_multiple_choices(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_options(Config) -> + do_no_body_stop_handler(Config, options, ?FUNCTION_NAME). + +stop_handler_previously_existed(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_rate_limited(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_resource_exists(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_service_available(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_uri_too_long(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_valid_content_headers(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_valid_entity_length(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +stop_handler_accept(Config) -> + do_req_body_stop_handler(Config, post, ?FUNCTION_NAME). + +stop_handler_provide(Config) -> + do_no_body_stop_handler(Config, get, ?FUNCTION_NAME). + +do_no_body_stop_handler(Config, Method, StateName0) -> + doc("Send a response manually and stop the REST handler."), + ConnPid = gun_open(Config), + "stop_handler_" ++ StateName = atom_to_list(StateName0), + Ref = gun:Method(ConnPid, "/stop_handler?" ++ StateName, + [{<<"accept-encoding">>, <<"gzip">>}]), + {response, fin, 248, _} = gun:await(ConnPid, Ref), + ok. + +do_req_body_stop_handler(Config, Method, StateName0) -> + doc("Send a response manually and stop the REST handler."), + ConnPid = gun_open(Config), + "stop_handler_" ++ StateName = atom_to_list(StateName0), + Ref = gun:Method(ConnPid, "/stop_handler?" ++ StateName, [ + {<<"accept-encoding">>, <<"gzip">>}, + {<<"content-type">>, <<"text/plain">>} + ], <<"Hocus PocuSwitch!">>), + {response, fin, 248, _} = gun:await(ConnPid, Ref), + ok. + switch_handler_allowed_methods(Config) -> do_no_body_switch_handler(Config, get, ?FUNCTION_NAME). -- cgit v1.2.3