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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
| | # -*- encoding: binary -*-
$stderr.sync = $stdout.sync = true
require "test/unit"
require "date"
require "stringio"
require "rack"
require "clogger"
class TestClogger < Test::Unit::TestCase
include Clogger::Format
def setup
@req = {
"REQUEST_METHOD" => "GET",
"HTTP_VERSION" => "HTTP/1.0",
"HTTP_USER_AGENT" => 'echo and socat \o/',
"PATH_INFO" => "/hello",
"QUERY_STRING" => "goodbye=true",
"rack.errors" => $stderr,
"rack.input" => File.open('/dev/null', 'rb'),
"REMOTE_ADDR" => 'home',
}
end
def test_init_basic
Clogger.new(lambda { |env| [ 0, {}, [] ] })
end
def test_init_noargs
assert_raise(ArgumentError) { Clogger.new }
end
def test_init_stderr
cl = Clogger.new(lambda { |env| [ 0, {}, [] ] }, :logger => $stderr)
assert_kind_of(Integer, cl.fileno)
assert_equal $stderr.fileno, cl.fileno
end
def test_init_stringio
cl = Clogger.new(lambda { |env| [ 0, {}, [] ] }, :logger => StringIO.new)
assert_nil cl.fileno
end
def test_write_stringio
start = DateTime.now - 1
str = StringIO.new
cl = Clogger.new(lambda { |env| [ "302 Found", {}, [] ] }, :logger => str)
status, headers, body = cl.call(@req)
assert_equal("302 Found", status)
assert_equal({}, headers)
body.each { |part| assert false }
str = str.string
r = %r{\Ahome - - \[[^\]]+\] "GET /hello\?goodbye=true HTTP/1.0" 302 -\n\z}
assert_match r, str
%r{\[([^\]]+)\]} =~ str
tmp = nil
assert_nothing_raised {
tmp = DateTime.strptime($1, "%d/%b/%Y:%H:%M:%S %z")
}
assert tmp >= start
assert tmp <= DateTime.now
end
def test_clen_stringio
start = DateTime.now - 1
str = StringIO.new
app = lambda { |env| [ 301, {'Content-Length' => '5'}, ['abcde'] ] }
format = Common.dup
assert format.gsub!(/response_length/, 'sent_http_content_length')
cl = Clogger.new(app, :logger => str, :format => format)
status, headers, body = cl.call(@req)
assert_equal(301, status)
assert_equal({'Content-Length' => '5'}, headers)
body.each { |part| assert_equal('abcde', part) }
str = str.string
r = %r{\Ahome - - \[[^\]]+\] "GET /hello\?goodbye=true HTTP/1.0" 301 5\n\z}
assert_match r, str
%r{\[([^\]]+)\]} =~ str
tmp = nil
assert_nothing_raised {
tmp = DateTime.strptime($1, "%d/%b/%Y:%H:%M:%S %z")
}
assert tmp >= start
assert tmp <= DateTime.now
end
def test_compile_ambiguous
cl = Clogger.new(nil, :logger => $stderr)
ary = nil
cl.instance_eval {
ary = compile_format(
'$remote_addr $$$$pid' \
"\n")
}
expect = [
[ Clogger::OP_REQUEST, "REMOTE_ADDR" ],
[ Clogger::OP_LITERAL, " " ],
[ Clogger::OP_LITERAL, "$$$" ],
[ Clogger::OP_SPECIAL, Clogger::SPECIAL_VARS[:pid] ],
[ Clogger::OP_LITERAL, "\n" ],
]
assert_equal expect, ary
end
def test_compile_auto_newline
cl = Clogger.new(nil, :logger => $stderr)
ary = nil
cl.instance_eval { ary = compile_format('$remote_addr $request') }
expect = [
[ Clogger::OP_REQUEST, "REMOTE_ADDR" ],
[ Clogger::OP_LITERAL, " " ],
[ Clogger::OP_SPECIAL, Clogger::SPECIAL_VARS[:request] ],
[ Clogger::OP_LITERAL, "\n" ],
]
assert_equal expect, ary
end
def test_big_log
str = StringIO.new
fmt = '$remote_addr $pid $remote_user [$time_local] ' \
'"$request" $status $body_bytes_sent "$http_referer" ' \
'"$http_user_agent" "$http_cookie" $request_time $http_host'
app = lambda { |env| [ 302, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => fmt)
cookie = "foo=bar#{'f' * 256}".freeze
req = {
'HTTP_HOST' => 'example.com:12345',
'HTTP_COOKIE' => cookie,
}
req = @req.merge(req)
cl.call(req).last.each { |part| part }
str = str.string
assert(str.size > 128)
assert_match %r["echo and socat \\o/" "#{cookie}" \d+\.\d{3}], str
assert_match %r["#{cookie}" \d+\.\d{3} example\.com:12345\n\z], str
end
def test_compile
cl = Clogger.new(nil, :logger => $stderr)
ary = nil
cl.instance_eval {
ary = compile_format(
'$remote_addr - $remote_user [$time_local] ' \
'"$request" $status $body_bytes_sent "$http_referer" ' \
'"$http_user_agent" "$http_cookie" $request_time ' \
'$env{rack.url_scheme}' \
"\n")
}
expect = [
[ Clogger::OP_REQUEST, "REMOTE_ADDR" ],
[ Clogger::OP_LITERAL, " - " ],
[ Clogger::OP_REQUEST, "REMOTE_USER" ],
[ Clogger::OP_LITERAL, " [" ],
[ Clogger::OP_TIME_LOCAL, '%d/%b/%Y:%H:%M:%S %z' ],
[ Clogger::OP_LITERAL, "] \"" ],
[ Clogger::OP_SPECIAL, Clogger::SPECIAL_VARS[:request] ],
[ Clogger::OP_LITERAL, "\" "],
[ Clogger::OP_SPECIAL, Clogger::SPECIAL_VARS[:status] ],
[ Clogger::OP_LITERAL, " "],
[ Clogger::OP_SPECIAL, Clogger::SPECIAL_VARS[:body_bytes_sent] ],
[ Clogger::OP_LITERAL, " \"" ],
[ Clogger::OP_REQUEST, "HTTP_REFERER" ],
[ Clogger::OP_LITERAL, "\" \"" ],
[ Clogger::OP_REQUEST, "HTTP_USER_AGENT" ],
[ Clogger::OP_LITERAL, "\" \"" ],
[ Clogger::OP_REQUEST, "HTTP_COOKIE" ],
[ Clogger::OP_LITERAL, "\" " ],
[ Clogger::OP_REQUEST_TIME, '%d.%03d', 1000 ],
[ Clogger::OP_LITERAL, " " ],
[ Clogger::OP_REQUEST, "rack.url_scheme" ],
[ Clogger::OP_LITERAL, "\n" ],
]
assert_equal expect, ary
end
def test_eval
current = Thread.current.to_s
str = StringIO.new
app = lambda { |env| [ 302, {}, [] ] }
cl = Clogger.new(app,
:logger => str,
:format => "-$e{Thread.current}-\n")
status, headers, body = cl.call(@req)
assert_equal "-#{current}-\n", str.string
end
def test_pid
str = StringIO.new
app = lambda { |env| [ 302, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => "[$pid]\n")
status, headers, body = cl.call(@req)
assert_equal "[#$$]\n", str.string
end
def test_rack_xff
str = StringIO.new
app = lambda { |env| [ 302, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => "$ip")
req = @req.merge("HTTP_X_FORWARDED_FOR" => '192.168.1.1')
status, headers, body = cl.call(req)
assert_equal "192.168.1.1\n", str.string
str.rewind
str.truncate(0)
status, headers, body = cl.call(@req)
assert_equal "home\n", str.string
str.rewind
str.truncate(0)
end
def test_rack_1_0
start = DateTime.now - 1
str = StringIO.new
app = lambda { |env| [ 200, {'Content-Length'=>'0'}, %w(a b c)] }
cl = Clogger.new(app, :logger => str, :format => Rack_1_0)
status, headers, body = cl.call(@req)
tmp = []
body.each { |s| tmp << s }
assert_equal %w(a b c), tmp
str = str.string
assert_match %r[" 200 3 \d+\.\d{4}\n\z], str
tmp = nil
%r{\[(\d+/\w+/\d+ \d+:\d+:\d+)\]} =~ str
assert $1
assert_nothing_raised { tmp = DateTime.strptime($1, "%d/%b/%Y %H:%M:%S") }
assert tmp >= start
assert tmp <= DateTime.now
end
def test_msec
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$msec')
status, header, bodies = cl.call(@req)
assert_match %r(\A\d+\.\d{3}\n\z), str.string
end
def test_usec
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$usec')
status, header, bodies = cl.call(@req)
assert_match %r(\A\d+\.\d{6}\n\z), str.string
end
def test_time_0
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$time{0}')
status, header, bodies = cl.call(@req)
assert_match %r(\A\d+\n\z), str.string
end
def test_time_1
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$time{1}')
status, header, bodies = cl.call(@req)
assert_match %r(\A\d+\.\d\n\z), str.string
end
def test_request_length
str = StringIO.new
input = StringIO.new('.....')
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$request_length')
status, header, bodies = cl.call(@req.merge('rack.input' => input))
assert_equal "5\n", str.string
end
def test_response_length_0
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$response_length')
status, header, bodies = cl.call(@req)
bodies.each { |part| part }
assert_equal "-\n", str.string
end
def test_combined
start = DateTime.now - 1
str = StringIO.new
app = lambda { |env| [ 200, {'Content-Length'=>'3'}, %w(a b c)] }
cl = Clogger.new(app, :logger => str, :format => Combined)
status, headers, body = cl.call(@req)
tmp = []
body.each { |s| tmp << s }
assert_equal %w(a b c), tmp
str = str.string
assert_match %r[" 200 3 "-" "echo and socat \\o/"\n\z], str
tmp = nil
%r{\[(\d+/\w+/\d+:\d+:\d+:\d+ .+)\]} =~ str
assert $1
assert_nothing_raised {
tmp = DateTime.strptime($1, "%d/%b/%Y:%H:%M:%S %z")
}
assert tmp >= start
assert tmp <= DateTime.now
end
def test_rack_errors_fallback
err = StringIO.new
app = lambda { |env| [ 200, {'Content-Length'=>'3'}, %w(a b c)] }
cl = Clogger.new(app, :format => '$pid')
req = @req.merge('rack.errors' => err)
status, headers, body = cl.call(req)
assert_equal "#$$\n", err.string
end
def test_body_close
s_body = StringIO.new(%w(a b c).join("\n"))
app = lambda { |env| [ 200, {'Content-Length'=>'5'}, s_body] }
cl = Clogger.new(app, :logger => [], :format => '$pid')
status, headers, body = cl.call(@req)
assert ! s_body.closed?
assert_nothing_raised { body.close }
assert s_body.closed?
end
def test_escape
str = StringIO.new
app = lambda { |env| [ 200, {'Content-Length'=>'5'}, [] ] }
cl = Clogger.new(app,
:logger => str,
:format => '$http_user_agent "$request"')
bad = {
'HTTP_USER_AGENT' => '"asdf"',
'QUERY_STRING' => 'sdf=bar"',
'PATH_INFO' => '/"<>"',
}
status, headers, body = cl.call(@req.merge(bad))
expect = '\x22asdf\x22 "GET /\x22<>\x22?sdf=bar\x22 HTTP/1.0"' << "\n"
assert_equal expect, str.string
end
# rack allows repeated headers with "\n":
# { 'Set-Cookie' => "a\nb" } =>
# Set-Cookie: a
# Set-Cookie: b
def test_escape_header_newlines
str = StringIO.new
app = lambda { |env| [302, { 'Set-Cookie' => "a\nb" }, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$sent_http_set_cookie')
cl.call(@req)
assert_equal "a\\x0Ab\n", str.string
end
def test_request_uri_fallback
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$request_uri')
status, headers, body = cl.call(@req)
assert_equal "/hello?goodbye=true\n", str.string
end
def test_request_uri_set
str = StringIO.new
app = lambda { |env| [ 200, {}, [] ] }
cl = Clogger.new(app, :logger => str, :format => '$request_uri')
status, headers, body = cl.call(@req.merge("REQUEST_URI" => '/zzz'))
assert_equal "/zzz\n", str.string
end
def test_cookies
str = StringIO.new
app = lambda { |env|
req = Rack::Request.new(env).cookies
[ 302, {}, [] ]
}
cl = Clogger.new(app,
:format => '$cookie_foo $cookie_quux',
:logger => str)
req = @req.merge('HTTP_COOKIE' => "foo=bar;quux=h&m")
status, headers, body = cl.call(req)
assert_equal "bar h&m\n", str.string
end
def test_bogus_app_response
str = StringIO.new
app = lambda { |env| 302 }
cl = Clogger.new(app, :logger => str)
assert_raise(TypeError) { cl.call(@req) }
str = str.string
e = Regexp.quote " \"GET /hello?goodbye=true HTTP/1.0\" 500 -"
assert_match %r{#{e}$}m, str
end
def test_broken_header_response
str = StringIO.new
app = lambda { |env| [302, [ %w(a) ], []] }
cl = Clogger.new(app, :logger => str, :format => '$sent_http_set_cookie')
assert_raise(TypeError) { cl.call(@req) }
end
def test_http_09_request
str = StringIO.new
app = lambda { |env| [302, [ %w(a) ], []] }
cl = Clogger.new(app, :logger => str, :format => '$request')
req = @req.dup
req.delete 'HTTP_VERSION'
cl.call(req)
assert_equal "GET /hello?goodbye=true\n", str.string
end
end
|