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

Add tests for charsets_provided

Fix cases where the q-value is 0 and where a wildcard
was sent in the accept-charset header.

Also don't send a charset in the content-type of the
response if the media type is not text.

Thanks to Philip Witty for help figuring this out.
This commit is contained in:
Loïc Hoguin 2018-11-02 13:54:19 +01:00
parent 399b6a16b4
commit e0b036fe68
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
5 changed files with 203 additions and 3 deletions

View file

@ -0,0 +1,30 @@
%% This module has a text and non-text media type,
%% but provides no charset. All requests will result
%% in a 406 not acceptable.
-module(charsets_provided_empty_h).
-export([init/2]).
-export([content_types_provided/2]).
-export([charsets_provided/2]).
-export([get_text_plain/2]).
-export([get_application_json/2]).
init(Req, Opts) ->
{cowboy_rest, Req, Opts}.
content_types_provided(Req, State) ->
{[
{{<<"text">>, <<"plain">>, []}, get_text_plain},
{{<<"application">>, <<"json">>, []}, get_application_json}
], Req, State}.
charsets_provided(Req, State) ->
{[], Req, State}.
get_text_plain(Req, State) ->
{<<"This is REST!">>, Req, State}.
get_application_json(Req, State) ->
{<<"{\"hello\": \"rest\"}">>, Req, State}.

View file

@ -0,0 +1,28 @@
%% This module has a text and non-text media type,
%% and provides two charsets.
-module(charsets_provided_h).
-export([init/2]).
-export([content_types_provided/2]).
-export([charsets_provided/2]).
-export([get_text_plain/2]).
-export([get_application_json/2]).
init(Req, Opts) ->
{cowboy_rest, Req, Opts}.
content_types_provided(Req, State) ->
{[
{{<<"text">>, <<"plain">>, []}, get_text_plain},
{{<<"application">>, <<"json">>, []}, get_application_json}
], Req, State}.
charsets_provided(Req, State) ->
{[<<"utf-8">>, <<"utf-16">>], Req, State}.
get_text_plain(Req, State) ->
{<<"This is REST!">>, Req, State}.
get_application_json(Req, State) ->
{<<"{\"hello\": \"rest\"}">>, Req, State}.

View file

@ -39,6 +39,8 @@ end_per_group(Name, _) ->
init_dispatch(_) ->
cowboy_router:compile([{'_', [
{"/", rest_hello_h, []},
{"/charsets_provided", charsets_provided_h, []},
{"/charsets_provided_empty", charsets_provided_empty_h, []},
{"/charset_in_content_types_provided",
charset_in_content_types_provided_h, []},
{"/charset_in_content_types_provided_implicit",
@ -148,6 +150,136 @@ charset_in_content_types_provided_implicit_no_callback(Config) ->
{_, <<"text/plain">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_match_text(Config) ->
doc("When the media type is text and the charsets_provided callback exists "
"and the accept-charset header was sent, the selected charset is sent "
"back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-charset">>, <<"utf-8;q=0.5, utf-16">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"text/plain; charset=utf-16">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_match_other(Config) ->
doc("When the media type is not text and the charsets_provided callback exists "
"and the accept-charset header was sent, the selected charset is not sent "
"back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"application/json">>},
{<<"accept-charset">>, <<"utf-8;q=0.5, utf-16">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"application/json">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_wildcard_text(Config) ->
doc("When the media type is text and the charsets_provided callback exists "
"and a wildcard accept-charset header was sent, the selected charset is sent "
"back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-charset">>, <<"*">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"text/plain; charset=utf-8">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_wildcard_other(Config) ->
doc("When the media type is not text and the charsets_provided callback exists "
"and a wildcard accept-charset header was sent, the selected charset is not sent "
"back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"application/json">>},
{<<"accept-charset">>, <<"*">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"application/json">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_nomatch(Config) ->
doc("Regardless of the media type negotiated, if no charset is found in the "
"accept-charset header match a charset configured in charsets_provided, "
"then a 406 not acceptable response is sent back."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-charset">>, <<"utf-8;q=0, iso-8859-1">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 406, _} = gun:await(ConnPid, Ref),
ok.
charsets_provided_noheader_text(Config) ->
doc("When the media type is text and the charsets_provided callback exists "
"but the accept-charset header was not sent, the first charset in the "
"list is selected and sent back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"text/plain; charset=utf-8">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_noheader_other(Config) ->
doc("When the media type is not text and the charsets_provided callback exists "
"but the accept-charset header was not sent, the first charset in the "
"list is selected but is not sent back in the content-type of the response."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided", [
{<<"accept">>, <<"application/json">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"application/json">>} = lists:keyfind(<<"content-type">>, 1, Headers),
ok.
charsets_provided_empty(Config) ->
doc("Regardless of the media type negotiated, if the charsets_provided "
"callback returns an empty list a 406 not acceptable response is sent back."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided_empty", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-charset">>, <<"utf-8q=0.5, utf-16">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 406, _} = gun:await(ConnPid, Ref),
ok.
charsets_provided_empty_wildcard(Config) ->
doc("Regardless of the media type negotiated, if the charsets_provided "
"callback returns an empty list a 406 not acceptable response is sent back."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided_empty", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-charset">>, <<"*">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 406, _} = gun:await(ConnPid, Ref),
ok.
charsets_provided_empty_noheader(Config) ->
doc("Regardless of the media type negotiated, if the charsets_provided "
"callback returns an empty list a 406 not acceptable response is sent back."),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/charsets_provided_empty", [
{<<"accept">>, <<"text/plain">>},
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 406, _} = gun:await(ConnPid, Ref),
ok.
provide_callback_missing(Config) ->
doc("A 500 response must be sent when the ProvideCallback can't be called."),
ConnPid = gun_open(Config),