aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-06-09 16:33:31 +0200
committerLoïc Hoguin <[email protected]>2016-06-09 16:33:31 +0200
commit4293a40d9e922bc00f25d6c7e328f86e102275a0 (patch)
treec8d46b36acf08fbf06990bf7cf6f67f26c28f3cf
parent5ca49fefa9006f4e9c853adf69da93f6f6bdf7bd (diff)
downloadcowboy-4293a40d9e922bc00f25d6c7e328f86e102275a0.tar.gz
cowboy-4293a40d9e922bc00f25d6c7e328f86e102275a0.tar.bz2
cowboy-4293a40d9e922bc00f25d6c7e328f86e102275a0.zip
Fix rest_hello_world example
-rw-r--r--examples/rest_hello_world/README.asciidoc230
-rw-r--r--examples/rest_hello_world/src/rest_hello_world_app.erl6
-rw-r--r--test/examples_SUITE.erl42
3 files changed, 273 insertions, 5 deletions
diff --git a/examples/rest_hello_world/README.asciidoc b/examples/rest_hello_world/README.asciidoc
index 5eb94e8..a9362f1 100644
--- a/examples/rest_hello_world/README.asciidoc
+++ b/examples/rest_hello_world/README.asciidoc
@@ -9,7 +9,7 @@ $ make run
Then point your browser to http://localhost:8080
-== Example output
+== HTTP/1.1 example output
Request HTML:
@@ -79,3 +79,231 @@ date: Fri, 28 Sep 2012 04:18:51 GMT
content-length: 0
----
+
+== HTTP/2 example output
+
+Request HTML:
+
+[source,bash]
+----
+$ nghttp -v http://localhost:8080
+[ 0.000] Connected
+[ 0.000] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
+ (dep_stream_id=0, weight=201, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
+ (dep_stream_id=0, weight=101, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
+ (dep_stream_id=0, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
+ (dep_stream_id=7, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
+ (dep_stream_id=3, weight=1, exclusive=0)
+[ 0.000] send HEADERS frame <length=38, flags=0x25, stream_id=13>
+ ; END_STREAM | END_HEADERS | PRIORITY
+ (padlen=0, dep_stream_id=11, weight=16, exclusive=0)
+ ; Open new stream
+ :method: GET
+ :path: /
+ :scheme: http
+ :authority: localhost:8080
+ accept: */*
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/1.7.1
+[ 0.000] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
+ (niv=0)
+[ 0.000] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.000] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.001] recv (stream_id=13) :status: 200
+[ 0.001] recv (stream_id=13) content-length: 136
+[ 0.001] recv (stream_id=13) content-type: text/html
+[ 0.001] recv (stream_id=13) date: Thu, 09 Jun 2016 14:28:50 GMT
+[ 0.001] recv (stream_id=13) server: Cowboy
+[ 0.001] recv (stream_id=13) vary: accept
+[ 0.001] recv HEADERS frame <length=52, flags=0x04, stream_id=13>
+ ; END_HEADERS
+ (padlen=0)
+ ; First response header
+<html>
+<head>
+ <meta charset="utf-8">
+ <title>REST Hello World!</title>
+</head>
+<body>
+ <p>REST Hello World as HTML!</p>
+</body>
+</html>[ 0.001] recv DATA frame <length=136, flags=0x01, stream_id=13>
+ ; END_STREAM
+[ 0.001] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
+----
+
+Request JSON:
+
+[source,bash]
+----
+$ nghttp -v -H "accept: application/json" http://localhost:8080
+[ 0.000] Connected
+[ 0.000] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
+ (dep_stream_id=0, weight=201, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
+ (dep_stream_id=0, weight=101, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
+ (dep_stream_id=0, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
+ (dep_stream_id=7, weight=1, exclusive=0)
+[ 0.001] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
+ (dep_stream_id=3, weight=1, exclusive=0)
+[ 0.001] send HEADERS frame <length=46, flags=0x25, stream_id=13>
+ ; END_STREAM | END_HEADERS | PRIORITY
+ (padlen=0, dep_stream_id=11, weight=16, exclusive=0)
+ ; Open new stream
+ :method: GET
+ :path: /
+ :scheme: http
+ :authority: localhost:8080
+ accept: application/json
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/1.7.1
+[ 0.001] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
+ (niv=0)
+[ 0.001] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.001] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.001] recv (stream_id=13) :status: 200
+[ 0.001] recv (stream_id=13) content-length: 24
+[ 0.001] recv (stream_id=13) content-type: application/json
+[ 0.001] recv (stream_id=13) date: Thu, 09 Jun 2016 14:29:00 GMT
+[ 0.001] recv (stream_id=13) server: Cowboy
+[ 0.001] recv (stream_id=13) vary: accept
+[ 0.001] recv HEADERS frame <length=55, flags=0x04, stream_id=13>
+ ; END_HEADERS
+ (padlen=0)
+ ; First response header
+{"rest": "Hello World!"}[ 0.002] recv DATA frame <length=24, flags=0x01, stream_id=13>
+ ; END_STREAM
+[ 0.002] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
+----
+
+Request plain text:
+
+[source,bash]
+----
+$ nghttp -v -H "accept: text/plain" http://localhost:8080
+[ 0.000] Connected
+[ 0.000] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
+ (dep_stream_id=0, weight=201, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
+ (dep_stream_id=0, weight=101, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
+ (dep_stream_id=0, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
+ (dep_stream_id=7, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
+ (dep_stream_id=3, weight=1, exclusive=0)
+[ 0.000] send HEADERS frame <length=42, flags=0x25, stream_id=13>
+ ; END_STREAM | END_HEADERS | PRIORITY
+ (padlen=0, dep_stream_id=11, weight=16, exclusive=0)
+ ; Open new stream
+ :method: GET
+ :path: /
+ :scheme: http
+ :authority: localhost:8080
+ accept: text/plain
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/1.7.1
+[ 0.000] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
+ (niv=0)
+[ 0.000] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.000] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.000] recv (stream_id=13) :status: 200
+[ 0.000] recv (stream_id=13) content-length: 25
+[ 0.000] recv (stream_id=13) content-type: text/plain
+[ 0.000] recv (stream_id=13) date: Thu, 09 Jun 2016 14:28:25 GMT
+[ 0.000] recv (stream_id=13) server: Cowboy
+[ 0.000] recv (stream_id=13) vary: accept
+[ 0.000] recv HEADERS frame <length=51, flags=0x04, stream_id=13>
+ ; END_HEADERS
+ (padlen=0)
+ ; First response header
+REST Hello World as text![ 0.000] recv DATA frame <length=25, flags=0x01, stream_id=13>
+ ; END_STREAM
+[ 0.000] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
+----
+
+Request a non acceptable content-type:
+
+[source,bash]
+----
+$ nghttp -v -H "accept: text/css" http://localhost:8080
+[ 0.000] Connected
+[ 0.000] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
+ (dep_stream_id=0, weight=201, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
+ (dep_stream_id=0, weight=101, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
+ (dep_stream_id=0, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
+ (dep_stream_id=7, weight=1, exclusive=0)
+[ 0.000] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
+ (dep_stream_id=3, weight=1, exclusive=0)
+[ 0.000] send HEADERS frame <length=41, flags=0x25, stream_id=13>
+ ; END_STREAM | END_HEADERS | PRIORITY
+ (padlen=0, dep_stream_id=11, weight=16, exclusive=0)
+ ; Open new stream
+ :method: GET
+ :path: /
+ :scheme: http
+ :authority: localhost:8080
+ accept: text/css
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/1.7.1
+[ 0.007] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
+ (niv=0)
+[ 0.007] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.007] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.021] recv (stream_id=13) :status: 406
+[ 0.021] recv (stream_id=13) content-length: 0
+[ 0.021] recv (stream_id=13) date: Thu, 09 Jun 2016 14:29:15 GMT
+[ 0.021] recv (stream_id=13) server: Cowboy
+[ 0.021] recv HEADERS frame <length=39, flags=0x04, stream_id=13>
+ ; END_HEADERS
+ (padlen=0)
+ ; First response header
+[ 0.021] recv DATA frame <length=0, flags=0x01, stream_id=13>
+ ; END_STREAM
+[ 0.021] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
+----
diff --git a/examples/rest_hello_world/src/rest_hello_world_app.erl b/examples/rest_hello_world/src/rest_hello_world_app.erl
index a662c3d..f966029 100644
--- a/examples/rest_hello_world/src/rest_hello_world_app.erl
+++ b/examples/rest_hello_world/src/rest_hello_world_app.erl
@@ -16,9 +16,9 @@ start(_Type, _Args) ->
{"/", toppage_handler, []}
]}
]),
- {ok, _} = cowboy:start_http(http, 100, [{port, 8080}], [
- {env, [{dispatch, Dispatch}]}
- ]),
+ {ok, _} = cowboy:start_clear(http, 100, [{port, 8080}], #{
+ env => #{dispatch => Dispatch}
+ }),
rest_hello_world_sup:start_link().
stop(_State) ->
diff --git a/test/examples_SUITE.erl b/test/examples_SUITE.erl
index fb95f3b..111e118 100644
--- a/test/examples_SUITE.erl
+++ b/test/examples_SUITE.erl
@@ -93,7 +93,7 @@ do_hello_world(Transport, Protocol, Config) ->
{ok, <<"Hello world!">>} = gun:await_body(ConnPid, Ref),
ok.
-%% Echo GET and POST.
+%% Echo GET.
echo_get(Config) ->
doc("GET parameter echo example."),
@@ -112,6 +112,8 @@ do_echo_get(Transport, Protocol, Config) ->
{ok, <<"this is fun">>} = gun:await_body(ConnPid, Ref),
ok.
+%% Echo POST.
+
echo_post(Config) ->
doc("POST parameter echo example."),
try
@@ -130,3 +132,41 @@ do_echo_post(Transport, Protocol, Config) ->
{response, nofin, 200, _} = gun:await(ConnPid, Ref),
{ok, <<"this is fun">>} = gun:await_body(ConnPid, Ref),
ok.
+
+%% REST Hello World.
+
+rest_hello_world(Config) ->
+ doc("REST Hello World example."),
+ try
+ do_compile_and_start(rest_hello_world),
+ do_rest_hello_world(tcp, http, Config),
+ do_rest_hello_world(tcp, http2, Config)
+ after
+ do_stop(rest_hello_world)
+ end.
+
+do_rest_hello_world(Transport, Protocol, Config) ->
+ << "<html>", _/bits >> = do_rest_hello_world_get(Transport, Protocol, undefined, Config),
+ << "REST Hello World as text!" >> = do_rest_hello_world_get(Transport, Protocol, <<"text/plain">>, Config),
+ << "{\"rest\": \"Hello World!\"}" >> = do_rest_hello_world_get(Transport, Protocol, <<"application/json">>, Config),
+ not_acceptable = do_rest_hello_world_get(Transport, Protocol, <<"text/css">>, Config),
+ ok.
+
+do_rest_hello_world_get(Transport, Protocol, Accept, Config) ->
+ Port = case Transport of
+ tcp -> 8080;
+ ssl -> 8443
+ end,
+ ConnPid = gun_open([{port, Port}, {type, Transport}, {protocol, Protocol}|Config]),
+ Headers = case Accept of
+ undefined -> [];
+ _ -> [{<<"accept">>, Accept}]
+ end,
+ Ref = gun:get(ConnPid, "/", Headers),
+ case gun:await(ConnPid, Ref) of
+ {response, nofin, 200, _} ->
+ {ok, Body} = gun:await_body(ConnPid, Ref),
+ Body;
+ {response, _, 406, _} ->
+ not_acceptable
+ end.