diff options
Diffstat (limited to 'test')
| -rw-r--r-- | test/handlers/provide_range_callback_h.erl | 4 | ||||
| -rw-r--r-- | test/handlers/ranges_provided_auto_h.erl | 27 | ||||
| -rw-r--r-- | test/rest_handler_SUITE.erl | 173 |
3 files changed, 193 insertions, 11 deletions
diff --git a/test/handlers/provide_range_callback_h.erl b/test/handlers/provide_range_callback_h.erl index f14a544..136e37e 100644 --- a/test/handlers/provide_range_callback_h.erl +++ b/test/handlers/provide_range_callback_h.erl @@ -1,4 +1,4 @@ -%% This module defines the range_satisfiable callback +%% This module defines many callbacks relevant to range requests %% and return something different depending on query string. -module(provide_range_callback_h). @@ -41,7 +41,7 @@ get_text_plain(Req, State) -> %% Simulate the callback being missing, otherwise expect true/false. get_text_plain_bytes(#{qs := <<"missing">>}, _) -> - ct_helper_error_h:ignore(cowboy_rest, set_ranged_body, 3), + ct_helper_error_h:ignore(cowboy_rest, set_ranged_body_callback, 3), no_call; get_text_plain_bytes(Req=#{range := {_, [{From=0, infinity}]}}, State) -> %% We send everything in one part. diff --git a/test/handlers/ranges_provided_auto_h.erl b/test/handlers/ranges_provided_auto_h.erl new file mode 100644 index 0000000..f7e6595 --- /dev/null +++ b/test/handlers/ranges_provided_auto_h.erl @@ -0,0 +1,27 @@ +%% This module defines the ranges_provided callback +%% which returns the auto option for bytes ranges +%% and the normal ProvideCallback that returns +%% something different depending on query string. + +-module(ranges_provided_auto_h). + +-export([init/2]). +-export([content_types_provided/2]). +-export([ranges_provided/2]). +-export([get_text_plain/2]). + +init(Req, State) -> + {cowboy_rest, Req, State}. + +content_types_provided(Req, State) -> + {[{{<<"text">>, <<"plain">>, []}, get_text_plain}], Req, State}. + +ranges_provided(Req, State) -> + {[{<<"bytes">>, auto}], Req, State}. + +get_text_plain(Req=#{qs := <<"data">>}, State) -> + {<<"This is ranged REST!">>, Req, State}; +get_text_plain(Req=#{qs := <<"sendfile">>}, State) -> + Path = code:lib_dir(cowboy) ++ "/ebin/cowboy.app", + Size = filelib:file_size(Path), + {{sendfile, 0, Size, Path}, Req, State}. diff --git a/test/rest_handler_SUITE.erl b/test/rest_handler_SUITE.erl index 6116830..58898b2 100644 --- a/test/rest_handler_SUITE.erl +++ b/test/rest_handler_SUITE.erl @@ -52,6 +52,7 @@ init_dispatch(_) -> {"/provide_range_callback", provide_range_callback_h, []}, {"/range_satisfiable", range_satisfiable_h, []}, {"/ranges_provided", ranges_provided_h, []}, + {"/ranges_provided_auto", ranges_provided_auto_h, []}, {"/rate_limited", rate_limited_h, []}, {"/stop_handler", stop_handler_h, []}, {"/switch_handler", switch_handler_h, run}, @@ -431,7 +432,15 @@ provide_range_callback_multipart(Config) -> = lists:keyfind(<<"content-type">>, 1, Headers), {ok, Body0} = gun:await_body(ConnPid, Ref), Body = do_decode(Headers, Body0), - do_provide_range_callback_multipart_body(Body, Boundary, [], <<>>). + {ContentRanges, BodyAcc} = do_provide_range_callback_multipart_body(Body, Boundary, [], <<>>), + [ + {bytes, 0, 3, 20}, + {bytes, 5, 6, 20}, + {bytes, 8, 13, 20}, + {bytes, 15, 19, 20} + ] = ContentRanges, + <<"ThisisrangedREST!">> = BodyAcc, + ok. do_provide_range_callback_multipart_body(Rest, Boundary, ContentRangesAcc, BodyAcc) -> case cow_multipart:parse_headers(Rest, Boundary) of @@ -450,14 +459,7 @@ do_provide_range_callback_multipart_body(Rest, Boundary, ContentRangesAcc, BodyA <<BodyAcc/binary, Body/binary>>) end; {done, <<>>} -> - [ - {bytes, 0, 3, 20}, - {bytes, 5, 6, 20}, - {bytes, 8, 13, 20}, - {bytes, 15, 19, 20} - ] = lists:reverse(ContentRangesAcc), - <<"ThisisrangedREST!">> = BodyAcc, - ok + {lists:reverse(ContentRangesAcc), BodyAcc} end. provide_range_callback_metadata(Config) -> @@ -598,6 +600,159 @@ ranges_provided_accept_ranges(Config) -> {_, <<"bytes, pages, chapters">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), ok. +%% @todo Probably should have options to do this automatically for auto at least. +%% +%% A server that supports range requests MAY ignore or reject a Range +%% header field that consists of more than two overlapping ranges, or a +%% set of many small ranges that are not listed in ascending order, +%% since both are indications of either a broken client or a deliberate +%% denial-of-service attack (Section 6.1). + +%% @todo Probably should have options for auto as well to join ranges that +%% are very close from each other. + +ranges_provided_auto_data(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically."), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?data", [ + {<<"accept-encoding">>, <<"gzip">>}, + {<<"range">>, <<"bytes=8-">>} + ]), + {response, nofin, 206, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + {_, <<"bytes 8-19/20">>} = lists:keyfind(<<"content-range">>, 1, Headers), + {_, <<"text/plain">>} = lists:keyfind(<<"content-type">>, 1, Headers), + {ok, <<"ranged REST!">>} = gun:await_body(ConnPid, Ref), + ok. + +ranges_provided_auto_sendfile(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically."), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?sendfile", [ + {<<"accept-encoding">>, <<"gzip">>}, + {<<"range">>, <<"bytes=8-">>} + ]), + Path = code:lib_dir(cowboy) ++ "/ebin/cowboy.app", + Size = filelib:file_size(Path), + {ok, <<_:8/binary, Body/bits>>} = file:read_file(Path), + {response, nofin, 206, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + {_, ContentRange} = lists:keyfind(<<"content-range">>, 1, Headers), + ContentRange = iolist_to_binary([ + <<"bytes 8-">>, + integer_to_binary(Size - 1), + <<"/">>, + integer_to_binary(Size) + ]), + {_, <<"text/plain">>} = lists:keyfind(<<"content-type">>, 1, Headers), + {ok, Body} = gun:await_body(ConnPid, Ref), + ok. + +ranges_provided_auto_multipart_data(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically."), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?data", [ + {<<"accept-encoding">>, <<"gzip">>}, + %% This range selects everything except the space characters. + {<<"range">>, <<"bytes=0-3, 5-6, 8-13, 15-">>} + ]), + {response, nofin, 206, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + false = lists:keyfind(<<"content-range">>, 1, Headers), + {_, <<"multipart/byteranges; boundary=", Boundary/bits>>} + = lists:keyfind(<<"content-type">>, 1, Headers), + {ok, Body0} = gun:await_body(ConnPid, Ref), + Body = do_decode(Headers, Body0), + %% We will receive the ranges in the same order as requested. + {ContentRanges, BodyAcc} = do_provide_range_callback_multipart_body(Body, Boundary, [], <<>>), + [ + {bytes, 0, 3, 20}, + {bytes, 5, 6, 20}, + {bytes, 8, 13, 20}, + {bytes, 15, 19, 20} + ] = ContentRanges, + <<"ThisisrangedREST!">> = BodyAcc, + ok. + +ranges_provided_auto_multipart_sendfile(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically."), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?sendfile", [ + {<<"accept-encoding">>, <<"gzip">>}, + %% This range selects a few random chunks of the file. + {<<"range">>, <<"bytes=50-99, 150-199, 250-299, -99">>} + ]), + Path = code:lib_dir(cowboy) ++ "/ebin/cowboy.app", + Size = filelib:file_size(Path), + Skip = Size - 399, + {ok, << + _:50/binary, Body1:50/binary, + _:50/binary, Body2:50/binary, + _:50/binary, Body3:50/binary, + _:Skip/binary, Body4/bits>>} = file:read_file(Path), + {response, nofin, 206, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + false = lists:keyfind(<<"content-range">>, 1, Headers), + {_, <<"multipart/byteranges; boundary=", Boundary/bits>>} + = lists:keyfind(<<"content-type">>, 1, Headers), + {ok, Body0} = gun:await_body(ConnPid, Ref), + Body = do_decode(Headers, Body0), + %% We will receive the ranges in the same order as requested. + {ContentRanges, BodyAcc} = do_provide_range_callback_multipart_body(Body, Boundary, [], <<>>), + LastFrom = 300 + Skip, + LastTo = Size - 1, + [ + {bytes, 50, 99, Size}, + {bytes, 150, 199, Size}, + {bytes, 250, 299, Size}, + {bytes, LastFrom, LastTo, Size} + ] = ContentRanges, + BodyAcc = <<Body1/binary, Body2/binary, Body3/binary, Body4/binary>>, + ok. + +ranges_provided_auto_not_satisfiable_data(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically. When the requested " + "range is not satisfiable a 416 range not satisfiable response " + "is expected. The content-range header will be set. (RFC7233 4.4)"), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?data", [ + {<<"accept-encoding">>, <<"gzip">>}, + {<<"range">>, <<"bytes=1000-">>} + ]), + {response, fin, 416, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + {_, <<"bytes */20">>} = lists:keyfind(<<"content-range">>, 1, Headers), + ok. + +ranges_provided_auto_not_satisfiable_sendfile(Config) -> + doc("When the unit range is bytes and the callback is 'auto' " + "Cowboy will call the normal ProvideCallback and perform " + "the range calculations automatically. When the requested " + "range is not satisfiable a 416 range not satisfiable response " + "is expected. The content-range header will be set. (RFC7233 4.4)"), + ConnPid = gun_open(Config), + Ref = gun:get(ConnPid, "/ranges_provided_auto?sendfile", [ + {<<"accept-encoding">>, <<"gzip">>}, + {<<"range">>, <<"bytes=1000-">>} + ]), + {response, fin, 416, Headers} = gun:await(ConnPid, Ref), + {_, <<"bytes">>} = lists:keyfind(<<"accept-ranges">>, 1, Headers), + Path = code:lib_dir(cowboy) ++ "/ebin/cowboy.app", + Size = filelib:file_size(Path), + ContentRange = iolist_to_binary([<<"bytes */">>, integer_to_binary(Size)]), + {_, ContentRange} = lists:keyfind(<<"content-range">>, 1, Headers), + ok. + ranges_provided_empty_accept_ranges_none(Config) -> doc("When the ranges_provided callback exists but returns an empty list " "the accept-ranges header is sent in the response with the value none. (RFC7233 2.3)"), |