File: test_parser.ml

package info (click to toggle)
ocaml-cohttp 6.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,624 kB
  • sloc: ml: 13,107; makefile: 20; sh: 18; javascript: 18
file content (282 lines) | stat: -rw-r--r-- 10,206 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
open Base
module Parser = Http.Private.Parser

let req =
  "GET /wp-content/uploads/2010/03/hello-kitty-darth-vader-pink.jpg HTTP/1.1\r\n\
   Host: www.kittyhell.com   \r\n\
   User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; ja-JP-mac; \
   rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3 Pathtraq/0.9\r\n\
   Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\n\
   Accept-Language: ja,en-us;q=0.7,en;q=0.3\r\n\
   Accept-Encoding: gzip,deflate\r\n\
   Accept-Charset: Shift_JIS,utf-8;q=0.7,*;q=0.7\r\n\
   Keep-Alive: 115\r\n\
   Connection: keep-alive\r\n\
   Cookie: wp_ozh_wsa_visits=2; wp_ozh_wsa_visit_lasttime=xxxxxxxxxx; \
   __utma=xxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.x; \
   __utmz=xxxxxxxxx.xxxxxxxxxx.x.x.utmccn=(referral)|utmcsr=reader.livedoor.com|utmcct=/reader/|utmcmd=referral\r\n\
   Empty:    \r\n\
   \r\n"

let assert_req_success ~here ~expected_req ~expected_consumed ?pos ?len buf =
  let buf = String.subo ?pos ?len buf in
  let req, consumed =
    match Parser.parse_request buf with
    | Error Parser.Partial -> failwith "Unexpected partial parse"
    | Error (Parser.Msg msg) -> failwith msg
    | Ok res -> res
  in
  [%test_result: string] ~here ~message:"HTTP Method mismatch"
    ~expect:(Http.Method.to_string @@ Http.Request.meth expected_req)
    (Http.Method.to_string @@ Http.Request.meth req);
  [%test_result: string] ~here ~message:"path mismatch"
    ~expect:(Http.Request.resource expected_req)
    (Http.Request.resource req);
  [%test_result: (string * string) list] ~here ~message:"header mismatch"
    ~expect:(Http.Header.to_list @@ Http.Request.headers expected_req)
    (Http.Header.to_list @@ Http.Request.headers req);
  [%test_result: int] ~here ~expect:expected_consumed consumed

let[@warning "-3"] make_req ~headers meth resource =
  { Http.Request.headers; meth; resource; version = `HTTP_1_1 }

let req_expected =
  make_req
    ~headers:
      (Http.Header.of_list
         [
           ("Host", "www.kittyhell.com");
           ( "User-Agent",
             "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; ja-JP-mac; \
              rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3 Pathtraq/0.9" );
           ( "Accept",
             "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
           );
           ("Accept-Language", "ja,en-us;q=0.7,en;q=0.3");
           ("Accept-Encoding", "gzip,deflate");
           ("Accept-Charset", "Shift_JIS,utf-8;q=0.7,*;q=0.7");
           ("Keep-Alive", "115");
           ("Connection", "keep-alive");
           ( "Cookie",
             "wp_ozh_wsa_visits=2; wp_ozh_wsa_visit_lasttime=xxxxxxxxxx; \
              __utma=xxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.xxxxxxxxxx.x; \
              __utmz=xxxxxxxxx.xxxxxxxxxx.x.x.utmccn=(referral)|utmcsr=reader.livedoor.com|utmcct=/reader/|utmcmd=referral"
           );
           ("Empty", "");
         ])
    `GET "/wp-content/uploads/2010/03/hello-kitty-darth-vader-pink.jpg"

let parse_single_request () =
  assert_req_success
    ~here:[ [%here] ]
    ~expected_req:req_expected ~expected_consumed:718 req

let reject_headers_with_space_before_colon () =
  let req =
    "GET / HTTP/1.1\r\nHost : www.kittyhell.com\r\nKeep-Alive: 115\r\n\r\n"
  in
  match Parser.parse_request req with
  | Error (Parser.Msg msg) ->
      [%test_result: string] ~expect:"Invalid Header Key" msg
  | _ -> assert false

let more_requests =
  "GET / HTTP/1.1\r\n\
   Host: www.reddit.com\r\n\
   User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:15.0) \r\n\
  \   Gecko/20100101 Firefox/15.0.1\r\n\
   Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\n\
   Accept-Language: en-us,en;q=0.5\r\n\
   Accept-Encoding: gzip, deflate\r\n\
   Connection: keep-alive\r\n\
   \r\n\
   GET /reddit.v_EZwRzV-Ns.css HTTP/1.1\r\n\
   Host: www.redditstatic.com\r\n\
   User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:15.0) \
   Gecko/20100101 Firefox/15.0.1\r\n\
   Accept: text/css,*/*;q=0.1\r\n\
   Accept-Language: en-us,en;q=0.5\r\n\
   Accept-Encoding: gzip, deflate\r\n\
   Connection: keep-alive\r\n\
   Referer: http://www.reddit.com/\r\n\
   \r\n"

let parse_at_offset () =
  let expected_req =
    make_req
      ~headers:
        (Http.Header.of_list
           [
             ("Host", "www.redditstatic.com");
             ( "User-Agent",
               "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:15.0) \
                Gecko/20100101 Firefox/15.0.1" );
             ("Accept", "text/css,*/*;q=0.1");
             ("Accept-Language", "en-us,en;q=0.5");
             ("Accept-Encoding", "gzip, deflate");
             ("Connection", "keep-alive");
             ("Referer", "http://www.reddit.com/");
           ])
      `GET "/reddit.v_EZwRzV-Ns.css"
  in
  assert_req_success
    ~here:[ [%here] ]
    ~expected_req ~expected_consumed:315 ~pos:304 more_requests

let report_partial_parse () =
  let buf = req in
  let err =
    match Parser.parse_request ~pos:0 ~len:50 buf with
    | Error Parser.Partial -> Some "Partial"
    | Error (Parser.Msg msg) -> Some msg
    | Ok _ -> None
  in
  [%test_result: string option] ~expect:(Some "Partial") err

let validate_http_version () =
  let req =
    "GET / HTTP/1.4\r\nHost: www.kittyhell.com\r\nKeep-Alive: 115\r\n\r\n"
  in
  let buf = req in
  let err =
    match Parser.parse_request buf with
    | Error (Parser.Msg msg) -> msg
    | Error Parser.Partial -> failwith "Unexpected partial"
    | Ok _ -> assert false
  in
  [%test_result: String.Caseless.t] ~expect:"Invalid http version" err

let parse_result_notifies_start_of_body () =
  let buf =
    "POST / HTTP/1.1\r\n\
     Host: localhost:8080\r\n\
     User-Agent: curl/7.64.1\r\n\
     Accept: */*\r\n\
     Content-Length: 6\r\n\
     Content-Type: application/x-www-form-urlencoded\r\n\
     \r\n\
     foobar"
  in
  let v = Parser.parse_request buf |> Result.ok in
  let _req, count = Option.value_exn v in
  [%test_result: string] ~expect:"foobar"
    (String.sub buf ~pos:count ~len:(String.length buf - count))

let parse_proxy_get () =
  let buf =
    "GET http://example.com/foo.html HTTP/1.1\r\n\
     Host: example.com\r\n\
     Proxy-Authorization: Basic dXNlcjpwYXNz\r\n\
     \r\n\
     foobar"
  in
  let expected_req =
    make_req
      ~headers:
        (Http.Header.of_list
           [
             ("Host", "example.com");
             ("Proxy-Authorization", "Basic dXNlcjpwYXNz");
           ])
      `GET "http://example.com/foo.html"
  in
  assert_req_success ~here:[ [%here] ] ~expected_req ~expected_consumed:104 buf

open Base_quickcheck

let parse_chunk_length () =
  Test.run_exn
    (module struct
      type t = int64 [@@deriving quickcheck, sexp_of]
    end)
    ~f:(fun num ->
      let payload =
        let s = Printf.sprintf "%Lx\r\n" num in
        s
      in
      match Parser.parse_chunk_length payload with
      | Ok res ->
          [%test_eq: int64 * int] res
            (num, String.length (Printf.sprintf "%Lx" num) + 2)
      | Error (Parser.Msg _) -> ()
      | Error _ -> assert false)

let chunk_length_parse_case_insensitive () =
  let run_test num str =
    let buf = str in
    match Parser.parse_chunk_length buf with
    | Ok res ->
        [%test_eq: int64 * int] res
          (num, String.length (Printf.sprintf "%Lx" num) + 2)
    | Error (Parser.Msg _) -> ()
    | Error _ -> assert false
  in
  Test.run_exn
    (module struct
      type t = int64 [@@deriving quickcheck, sexp_of]
    end)
    ~f:(fun num ->
      let payload = Printf.sprintf "%Lx\r\n" num in
      run_test num (String.uppercase payload);
      run_test num (String.lowercase payload))

type parse_res = [ `Ok of int64 * int | `Msg of string | `Partial ]
[@@deriving sexp, compare]

let parse_chunk_lengths () =
  let run_parser buf =
    match Parser.parse_chunk_length buf with
    | Ok res -> `Ok res
    | Error Parser.Partial -> `Partial
    | Error (Parser.Msg msg) -> `Msg msg
  in
  [%test_result: parse_res] ~expect:(`Ok (2738L, 5)) (run_parser "ab2\r\n");
  [%test_result: parse_res]
    ~expect:(`Ok (4526507L, 8))
    (run_parser "4511ab\r\n");
  (* We will try to use the same chunk length, but this time with a chunk extension. This
     should not result in any change in our output. *)
  [%test_result: parse_res]
    ~expect:(`Ok (4526507L, 13))
    (run_parser "4511ab  ; a\r\n");
  [%test_result: parse_res]
    ~expect:(`Ok (4526507L, 26))
    (run_parser "4511ab; now in extension\r\n");
  [%test_result: parse_res] ~expect:(`Msg "Invalid chunk_length character 'a'")
    (run_parser "4511ab a ; now in extension\r\n");
  [%test_result: parse_res]
    ~expect:(`Ok (76861433640456465L, 17))
    (run_parser "111111111111111\r\n");
  [%test_result: parse_res] ~expect:(`Msg "Chunk size is too large")
    (run_parser "1111111111111111\r\n");
  [%test_result: parse_res] ~expect:(`Msg "Expected_newline")
    (run_parser "abc\r12");
  [%test_result: parse_res]
    ~expect:(`Msg "Invalid chunk_length character '\\n'") (run_parser "abc\n12");
  [%test_result: parse_res] ~expect:`Partial (run_parser "121");
  [%test_result: parse_res] ~expect:`Partial (run_parser "121\r")

let () =
  let open Alcotest in
  run "Parser"
    [
      ( "parse request",
        [
          test_case "single request" `Quick parse_single_request;
          test_case "parse at offset" `Quick parse_at_offset;
          test_case "reject headers with invalid character in key" `Quick
            reject_headers_with_space_before_colon;
          test_case "report partial parse" `Quick report_partial_parse;
          test_case "validate http version" `Quick validate_http_version;
          test_case "parse result notified offset of start of optional body"
            `Quick parse_result_notifies_start_of_body;
          test_case "parse a proxy GET request" `Quick parse_proxy_get;
        ] );
      ( "chunked encoding",
        [
          test_case "can parse chunk length" `Quick parse_chunk_length;
          test_case "chunk length parsing is case insensitive" `Quick
            chunk_length_parse_case_insensitive;
          test_case "parse chunk lengths" `Quick parse_chunk_lengths;
        ] );
    ]