File: parser_spec.rb

package info (click to toggle)
ruby-http-parser.rb 0.6.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 376 kB
  • sloc: java: 431; ansic: 412; ruby: 355; makefile: 20
file content (354 lines) | stat: -rw-r--r-- 10,280 bytes parent folder | download | duplicates (3)
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
if defined? Encoding
  Encoding.default_external = "UTF-8"
end

require "spec_helper"
require "json"

describe HTTP::Parser do
  before do
    @parser = HTTP::Parser.new

    @headers = nil
    @body = ""
    @started = false
    @done = false

    @parser.on_message_begin = proc{ @started = true }
    @parser.on_headers_complete = proc { |e| @headers = e }
    @parser.on_body = proc { |chunk| @body << chunk }
    @parser.on_message_complete = proc{ @done = true }
  end

  it "should have initial state" do
    expect(@parser.headers).to be_nil

    expect(@parser.http_version).to be_nil
    expect(@parser.http_method).to be_nil
    expect(@parser.status_code).to be_nil

    expect(@parser.request_url).to be_nil

    expect(@parser.header_value_type).to eq(:mixed)
  end

  it "should allow us to set the header value type" do
    [:mixed, :arrays, :strings].each do |type|
      @parser.header_value_type = type
      expect(@parser.header_value_type).to eq(type)

      parser_tmp = HTTP::Parser.new(nil, type)
      expect(parser_tmp.header_value_type).to eq(type)
    end
  end

  it "should allow us to set the default header value type" do
    [:mixed, :arrays, :strings].each do |type|
      HTTP::Parser.default_header_value_type = type

      parser = HTTP::Parser.new
      expect(parser.header_value_type).to eq(type)
    end
  end

  it "should throw an Argument Error if header value type is invalid" do
    expect(proc{ @parser.header_value_type = 'bob' }).to raise_error(ArgumentError)
  end

  it "should throw an Argument Error if default header value type is invalid" do
    expect(proc{ HTTP::Parser.default_header_value_type = 'bob' }).to raise_error(ArgumentError)
  end

  it "should implement basic api" do
    @parser <<
      "GET /test?ok=1 HTTP/1.1\r\n" +
      "User-Agent: curl/7.18.0\r\n" +
      "Host: 0.0.0.0:5000\r\n" +
      "Accept: */*\r\n" +
      "Content-Length: 5\r\n" +
      "\r\n" +
      "World"

    expect(@started).to be_truthy
    expect(@done).to be_truthy

    expect(@parser.http_major).to eq(1)
    expect(@parser.http_minor).to eq(1)
    expect(@parser.http_version).to eq([1,1])
    expect(@parser.http_method).to eq('GET')
    expect(@parser.status_code).to be_nil

    expect(@parser.request_url).to eq('/test?ok=1')

    expect(@parser.headers).to eq(@headers)
    expect(@parser.headers['User-Agent']).to eq('curl/7.18.0')
    expect(@parser.headers['Host']).to eq('0.0.0.0:5000')

    expect(@body).to eq("World")
  end

  it "should raise errors on invalid data" do
    expect(proc{ @parser << "BLAH" }).to raise_error(HTTP::Parser::Error)
  end

  it "should abort parser via callback" do
    @parser.on_headers_complete = proc { |e| @headers = e; :stop }

    data =
      "GET / HTTP/1.0\r\n" +
      "Content-Length: 5\r\n" +
      "\r\n" +
      "World"

    bytes = @parser << data

    expect(bytes).to eq(37)
    expect(data[bytes..-1]).to eq('World')

    expect(@headers).to eq({'Content-Length' => '5'})
    expect(@body).to be_empty
    expect(@done).to be_falsey
  end

  it "should reset to initial state" do
    @parser << "GET / HTTP/1.0\r\n\r\n"

    expect(@parser.http_method).to eq('GET')
    expect(@parser.http_version).to eq([1,0])

    expect(@parser.request_url).to eq('/')

    expect(@parser.reset!).to be_truthy

    expect(@parser.http_version).to be_nil
    expect(@parser.http_method).to be_nil
    expect(@parser.status_code).to be_nil

    expect(@parser.request_url).to be_nil
  end

  it "should optionally reset parser state on no-body responses" do
   expect(@parser.reset!).to be_truthy

   @head, @complete = 0, 0
   @parser.on_headers_complete = proc {|h| @head += 1; :reset }
   @parser.on_message_complete = proc { @complete += 1 }
   @parser.on_body = proc {|b| fail }

   head_response = "HTTP/1.1 200 OK\r\nContent-Length:10\r\n\r\n"

   @parser << head_response
   expect(@head).to eq(1)
   expect(@complete).to eq(1)

   @parser << head_response
   expect(@head).to eq(2)
   expect(@complete).to eq(2)
  end

  it "should retain callbacks after reset" do
    expect(@parser.reset!).to be_truthy

    @parser << "GET / HTTP/1.0\r\n\r\n"
    expect(@started).to be_truthy
    expect(@headers).to eq({})
    expect(@done).to be_truthy
  end

  it "should parse headers incrementally" do
    request =
      "GET / HTTP/1.0\r\n" +
      "Header1: value 1\r\n" +
      "Header2: value 2\r\n" +
      "\r\n"

    while chunk = request.slice!(0,2) and !chunk.empty?
      @parser << chunk
    end

    expect(@parser.headers).to eq({
      'Header1' => 'value 1',
      'Header2' => 'value 2'
    })
  end

  it "should handle multiple headers using strings" do
    @parser.header_value_type = :strings

    @parser <<
      "GET / HTTP/1.0\r\n" +
      "Set-Cookie: PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com\r\n" +
      "Set-Cookie: NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly\r\n" +
      "\r\n"

    expect(@parser.headers["Set-Cookie"]).to eq("PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com, NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly")
  end

  it "should handle multiple headers using strings" do
    @parser.header_value_type = :arrays

    @parser <<
      "GET / HTTP/1.0\r\n" +
      "Set-Cookie: PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com\r\n" +
      "Set-Cookie: NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly\r\n" +
      "\r\n"

    expect(@parser.headers["Set-Cookie"]).to eq([
        "PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com",
        "NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly"
    ])
  end

  it "should handle multiple headers using mixed" do
    @parser.header_value_type = :mixed

    @parser <<
      "GET / HTTP/1.0\r\n" +
      "Set-Cookie: PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com\r\n" +
      "Set-Cookie: NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly\r\n" +
      "\r\n"

    expect(@parser.headers["Set-Cookie"]).to eq([
        "PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com",
        "NID=46jSHxPM; path=/; domain=.bob.com; HttpOnly"
    ])
  end

  it "should handle a single cookie using mixed" do
    @parser.header_value_type = :mixed

    @parser <<
      "GET / HTTP/1.0\r\n" +
      "Set-Cookie: PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com\r\n" +
      "\r\n"

    expect(@parser.headers["Set-Cookie"]).to eq("PREF=ID=a7d2c98; expires=Fri, 05-Apr-2013 05:00:45 GMT; path=/; domain=.bob.com")
  end

  it "should support alternative api" do
    callbacks = double('callbacks')
    allow(callbacks).to receive(:on_message_begin){ @started = true }
    allow(callbacks).to receive(:on_headers_complete){ |e| @headers = e }
    allow(callbacks).to receive(:on_body){ |chunk| @body << chunk }
    allow(callbacks).to receive(:on_message_complete){ @done = true }

    @parser = HTTP::Parser.new(callbacks)
    @parser << "GET / HTTP/1.0\r\n\r\n"

    expect(@started).to be_truthy
    expect(@headers).to eq({})
    expect(@body).to eq('')
    expect(@done).to be_truthy
  end

  it "should ignore extra content beyond specified length" do
    @parser <<
      "GET / HTTP/1.0\r\n" +
      "Content-Length: 5\r\n" +
      "\r\n" +
      "hello" +
      "  \n"

    expect(@body).to eq('hello')
    expect(@done).to be_truthy
  end

  it 'sets upgrade_data if available' do
    @parser <<
      "GET /demo HTTP/1.1\r\n" +
      "Connection: Upgrade\r\n" +
      "Upgrade: WebSocket\r\n\r\n" +
      "third key data"

    expect(@parser.upgrade?).to be_truthy
    expect(@parser.upgrade_data).to eq('third key data')
  end

  it 'sets upgrade_data to blank if un-available' do
    @parser <<
      "GET /demo HTTP/1.1\r\n" +
      "Connection: Upgrade\r\n" +
      "Upgrade: WebSocket\r\n\r\n"

    expect(@parser.upgrade?).to be_truthy
    expect(@parser.upgrade_data).to eq('')
  end

  it 'should stop parsing headers when instructed' do
    request = "GET /websocket HTTP/1.1\r\n" +
      "host: localhost\r\n" +
      "connection: Upgrade\r\n" +
      "upgrade: websocket\r\n" +
      "sec-websocket-key: SD6/hpYbKjQ6Sown7pBbWQ==\r\n" +
      "sec-websocket-version: 13\r\n" +
      "\r\n"

    @parser.on_headers_complete = proc { |e| :stop }
    offset = (@parser << request)
    expect(@parser.upgrade?).to be_truthy
    expect(@parser.upgrade_data).to eq('')
    expect(offset).to eq(request.length)
  end

  it "should execute on_body on requests with no content-length" do
   expect(@parser.reset!).to be_truthy

   @head, @complete, @body = 0, 0, 0
   @parser.on_headers_complete = proc {|h| @head += 1 }
   @parser.on_message_complete = proc { @complete += 1 }
   @parser.on_body = proc {|b| @body += 1 }

   head_response = "HTTP/1.1 200 OK\r\n\r\nstuff"

   @parser << head_response
   @parser << ''
   expect(@head).to eq(1)
   expect(@complete).to eq(1)
   expect(@body).to eq(1)
  end


  %w[ request response ].each do |type|
    JSON.parse(File.read(File.expand_path("../support/#{type}s.json", __FILE__))).each do |test|
      test['headers'] ||= {}
      next if !defined?(JRUBY_VERSION) and HTTP::Parser.strict? != test['strict']

      it "should parse #{type}: #{test['name']}" do
        @parser << test['raw']

        expect(@parser.http_method).to eq(test['method'])
        expect(@parser.keep_alive?).to eq(test['should_keep_alive'])

        if test.has_key?('upgrade') and test['upgrade'] != 0
          expect(@parser.upgrade?).to be_truthy
          expect(@parser.upgrade_data).to eq(test['upgrade'])
        end

        fields = %w[
          http_major
          http_minor
        ]

        if test['type'] == 'HTTP_REQUEST'
          fields += %w[
            request_url
          ]
        else
          fields += %w[
            status_code
          ]
        end

        fields.each do |field|
          expect(@parser.send(field)).to eq(test[field])
        end

        expect(@headers.size).to eq(test['num_headers'])
        expect(@headers).to eq(test['headers'])

        expect(@body).to eq(test['body'])
        expect(@body.size).to eq(test['body_size']) if test['body_size']
      end
    end
  end
end