forked from mongodb/mongo-ruby-driver
/
bson_test.rb
608 lines (507 loc) · 16.1 KB
/
bson_test.rb
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
# encoding:utf-8
require './test/test_helper'
require 'complex'
require 'bigdecimal'
require 'rational'
begin
require 'active_support/core_ext'
Time.zone = "Pacific Time (US & Canada)"
Zone = Time.zone.now
rescue LoadError
warn 'Mocking time with zone'
module ActiveSupport
class TimeWithZone
def initialize(utc_time, zone)
end
end
end
Zone = ActiveSupport::TimeWithZone.new(Time.now.utc, 'EST')
end
class BSONTest < Test::Unit::TestCase
include BSON
def setup
@encoder = BSON::BSON_CODER
end
def assert_doc_pass(doc, options={})
bson = @encoder.serialize(doc)
if options[:debug]
puts "DEBUGGING DOC:"
p bson.to_a
puts "DESERIALIZES TO:"
end
assert_equal @encoder.serialize(doc).to_a, bson.to_a
assert_equal doc, @encoder.deserialize(bson)
end
def test_require_hash
assert_raise_error InvalidDocument, "takes a Hash" do
BSON.serialize('foo')
end
assert_raise_error InvalidDocument, "takes a Hash" do
BSON.serialize(Object.new)
end
assert_raise_error InvalidDocument, "takes a Hash" do
BSON.serialize(Set.new)
end
end
def test_string
doc = {'doc' => 'hello, world'}
assert_doc_pass(doc)
end
def test_valid_utf8_string
doc = {'doc' => 'aé'}
assert_doc_pass(doc)
end
def test_valid_utf8_key
doc = {'aé' => 'hello'}
assert_doc_pass(doc)
end
def test_limit_max_bson_size
doc = {'name' => 'a' * BSON_CODER.max_bson_size}
assert_raise InvalidDocument do
assert @encoder.serialize(doc)
end
end
def test_max_bson_size
assert BSON_CODER.max_bson_size >= BSON::DEFAULT_MAX_BSON_SIZE
end
def test_update_max_bson_size
require 'ostruct'
mock_conn = OpenStruct.new
size = 7 * 1024 * 1024
mock_conn.max_bson_size = size
assert_equal size, BSON_CODER.update_max_bson_size(mock_conn)
assert_equal size, BSON_CODER.max_bson_size
end
def test_round_trip
doc = {'doc' => 123}
@encoder.deserialize(@encoder.serialize(doc))
end
# In 1.8 we test that other string encodings raise an exception.
# In 1.9 we test that they get auto-converted.
if RUBY_VERSION < '1.9'
if ! RUBY_PLATFORM =~ /java/
require 'iconv'
def test_non_utf8_string
string = Iconv.conv('iso-8859-1', 'utf-8', 'aé')
doc = {'doc' => string}
assert_doc_pass(doc)
assert_raise InvalidStringEncoding do
@encoder.serialize(doc)
end
end
def test_non_utf8_key
key = Iconv.conv('iso-8859-1', 'utf-8', 'aé')
doc = {key => 'hello'}
assert_raise InvalidStringEncoding do
@encoder.serialize(doc)
end
end
end
else
def test_non_utf8_string
bson = BSON::BSON_CODER.serialize({'str' => 'aé'.encode('iso-8859-1')})
result = BSON::BSON_CODER.deserialize(bson)['str']
assert_equal 'aé', result
assert_equal 'UTF-8', result.encoding.name
end
def test_non_utf8_key
bson = BSON::BSON_CODER.serialize({'aé'.encode('iso-8859-1') => 'hello'})
assert_equal 'hello', BSON::BSON_CODER.deserialize(bson)['aé']
end
# Based on a test from sqlite3-ruby
def test_default_internal_is_honored
before_enc = Encoding.default_internal
str = "壁に耳あり、障子に目あり"
bson = BSON::BSON_CODER.serialize("x" => str)
Encoding.default_internal = 'EUC-JP'
out = BSON::BSON_CODER.deserialize(bson)["x"]
assert_equal Encoding.default_internal, out.encoding
assert_equal str.encode('EUC-JP'), out
assert_equal str, out.encode(str.encoding)
ensure
Encoding.default_internal = before_enc
end
end
def test_code
doc = {'$where' => Code.new('this.a.b < this.b')}
assert_doc_pass(doc)
end
def test_code_with_symbol
assert_raise_error ArgumentError, "BSON::Code must be in the form of a String" do
Code.new(:fubar)
end
end
def test_code_with_scope
doc = {'$where' => Code.new('this.a.b < this.b', {'foo' => 1})}
assert_doc_pass(doc)
end
def test_double
doc = {'doc' => 41.25}
assert_doc_pass(doc)
end
def test_int
doc = {'doc' => 42}
assert_doc_pass(doc)
doc = {"doc" => -5600}
assert_doc_pass(doc)
doc = {"doc" => 2147483647}
assert_doc_pass(doc)
doc = {"doc" => -2147483648}
assert_doc_pass(doc)
end
def test_ordered_hash
doc = BSON::OrderedHash.new
doc["b"] = 1
doc["a"] = 2
doc["c"] = 3
doc["d"] = 4
assert_doc_pass(doc)
end
def test_object
doc = {'doc' => {'age' => 42, 'name' => 'Spongebob', 'shoe_size' => 9.5}}
assert_doc_pass(doc)
end
def test_embedded_document_with_nil
doc = {'doc' => {'age' => 42, 'name' => nil, 'shoe_size' => 9.5}}
assert_doc_pass(doc)
end
def test_embedded_document_with_date
doc = {'doc' => {'age' => 42, 'date' => Time.now.utc, 'shoe_size' => 9.5}}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
assert doc['doc']
assert_equal 42, doc['doc']['age']
assert_equal 9.5, doc['doc']['shoe_size']
assert_in_delta Time.now, doc['doc']['date'], 1
end
def test_oid
doc = {'doc' => ObjectId.new}
assert_doc_pass(doc)
end
def test_array
doc = {'doc' => [1, 2, 'a', 'b']}
assert_doc_pass(doc)
end
def test_array_keys
doc = {'doc' => [1, 2, 'a', 'b']}
bson = @encoder.serialize(doc).to_a
assert_equal 48, bson[14]
assert_equal 49, bson[21]
assert_equal 50, bson[28]
assert_equal 51, bson[37]
end
def test_regex
doc = {'doc' => /foobar/i}
assert_doc_pass(doc)
end
def test_boolean
doc = {'doc' => true}
assert_doc_pass(doc)
end
def test_date
doc = {'date' => Time.now}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
# Mongo only stores up to the millisecond
assert_in_delta doc['date'], doc2['date'], 0.001
end
def test_date_returns_as_utc
doc = {'date' => Time.now}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
assert doc2['date'].utc?
end
def test_date_before_epoch
begin
doc = {'date' => Time.utc(1600)}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
# Mongo only stores up to the millisecond
assert_in_delta doc['date'], doc2['date'], 2
rescue ArgumentError
# some versions of Ruby won't let you create pre-epoch Time instances
#
# TODO figure out how that will work if somebady has saved data
# w/ early dates already and is just querying for it.
end
end
def test_exeption_on_using_unsupported_date_class
[DateTime.now, Date.today, Zone].each do |invalid_date|
doc = {:date => invalid_date}
begin
bson = BSON::BSON_CODER.serialize(doc)
rescue => e
ensure
if !invalid_date.is_a? Time
assert_equal InvalidDocument, e.class
assert_match /UTC Time/, e.message
end
end
end
end
def test_dbref
oid = ObjectId.new
doc = {}
doc['dbref'] = DBRef.new('namespace', oid)
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
# Java doesn't deserialize to DBRefs
if RUBY_PLATFORM =~ /java/
assert_equal 'namespace', doc2['dbref']['$ns']
assert_equal oid, doc2['dbref']['$id']
else
assert_equal 'namespace', doc2['dbref'].namespace
assert_equal oid, doc2['dbref'].object_id
end
end
def test_symbol
doc = {'sym' => :foo}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
assert_equal :foo, doc2['sym']
end
def test_binary
bin = Binary.new
'binstring'.each_byte { |b| bin.put(b) }
doc = {'bin' => bin}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
bin2 = doc2['bin']
assert_kind_of Binary, bin2
assert_equal 'binstring', bin2.to_s
assert_equal Binary::SUBTYPE_BYTES, bin2.subtype
end
def test_binary_with_string
b = Binary.new('somebinarystring')
doc = {'bin' => b}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
bin2 = doc2['bin']
assert_kind_of Binary, bin2
assert_equal 'somebinarystring', bin2.to_s
assert_equal Binary::SUBTYPE_BYTES, bin2.subtype
end
def test_binary_type
bin = Binary.new([1, 2, 3, 4, 5], Binary::SUBTYPE_USER_DEFINED)
doc = {'bin' => bin}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
bin2 = doc2['bin']
assert_kind_of Binary, bin2
assert_equal [1, 2, 3, 4, 5], bin2.to_a
assert_equal Binary::SUBTYPE_USER_DEFINED, bin2.subtype
end
# Java doesn't support binary subtype 0 yet
if !(RUBY_PLATFORM =~ /java/)
def test_binary_subtype_0
bin = Binary.new([1, 2, 3, 4, 5], Binary::SUBTYPE_SIMPLE)
doc = {'bin' => bin}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
bin2 = doc2['bin']
assert_kind_of Binary, bin2
assert_equal [1, 2, 3, 4, 5], bin2.to_a
assert_equal Binary::SUBTYPE_SIMPLE, bin2.subtype
end
end
def test_binary_byte_buffer
bb = Binary.new
5.times { |i| bb.put(i + 1) }
doc = {'bin' => bb}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
bin2 = doc2['bin']
assert_kind_of Binary, bin2
assert_equal [1, 2, 3, 4, 5], bin2.to_a
assert_equal Binary::SUBTYPE_BYTES, bin2.subtype
end
def test_put_id_first
val = BSON::OrderedHash.new
val['not_id'] = 1
val['_id'] = 2
roundtrip = @encoder.deserialize(@encoder.serialize(val, false, true).to_s)
assert_kind_of BSON::OrderedHash, roundtrip
assert_equal '_id', roundtrip.keys.first
val = {'a' => 'foo', 'b' => 'bar', :_id => 42, 'z' => 'hello'}
roundtrip = @encoder.deserialize(@encoder.serialize(val, false, true).to_s)
assert_kind_of BSON::OrderedHash, roundtrip
assert_equal '_id', roundtrip.keys.first
end
def test_nil_id
doc = {"_id" => nil}
assert_doc_pass(doc)
end
if !(RUBY_PLATFORM =~ /java/)
def test_timestamp
val = {"test" => [4, 20]}
assert_equal val, @encoder.deserialize([0x13, 0x00, 0x00, 0x00,
0x11, 0x74, 0x65, 0x73,
0x74, 0x00, 0x04, 0x00,
0x00, 0x00, 0x14, 0x00,
0x00, 0x00, 0x00])
end
end
def test_overflow
doc = {"x" => 2**75}
assert_raise RangeError do
bson = @encoder.serialize(doc)
end
doc = {"x" => 9223372036854775}
assert_doc_pass(doc)
doc = {"x" => 9223372036854775807}
assert_doc_pass(doc)
doc["x"] = doc["x"] + 1
assert_raise RangeError do
bson = @encoder.serialize(doc)
end
doc = {"x" => -9223372036854775}
assert_doc_pass(doc)
doc = {"x" => -9223372036854775808}
assert_doc_pass(doc)
doc["x"] = doc["x"] - 1
assert_raise RangeError do
bson = BSON::BSON_CODER.serialize(doc)
end
end
def test_invalid_numeric_types
[BigDecimal.new("1.0"), Complex(0, 1), Rational(2, 3)].each do |type|
doc = {"x" => type}
begin
@encoder.serialize(doc)
rescue => e
ensure
assert_equal InvalidDocument, e.class
assert_match /Cannot serialize/, e.message
end
end
end
def test_do_not_change_original_object
val = BSON::OrderedHash.new
val['not_id'] = 1
val['_id'] = 2
assert val.keys.include?('_id')
@encoder.serialize(val)
assert val.keys.include?('_id')
val = {'a' => 'foo', 'b' => 'bar', :_id => 42, 'z' => 'hello'}
assert val.keys.include?(:_id)
@encoder.serialize(val)
assert val.keys.include?(:_id)
end
# note we only test for _id here because in the general case we will
# write duplicates for :key and "key". _id is a special case because
# we call has_key? to check for it's existence rather than just iterating
# over it like we do for the rest of the keys. thus, things like
# HashWithIndifferentAccess can cause problems for _id but not for other
# keys. rather than require rails to test with HWIA directly, we do this
# somewhat hacky test.
#
# Note that the driver only eliminates duplicate ids when move_id is true.
def test_no_duplicate_id
dup = {"_id" => "foo", :_id => "foo"}
one = {"_id" => "foo"}
assert_equal @encoder.serialize(one, false, true).to_a, @encoder.serialize(dup, false, true).to_a
end
def test_duplicate_keys
#dup = {"_foo" => "foo", :_foo => "foo"}
#one = {"_foo" => "foo"}
#assert_equal @encoder.serialize(one).to_a, @encoder.serialize(dup).to_a
warn "Pending test for duplicate keys"
end
def test_no_duplicate_id_when_moving_id
dup = {"_id" => "foo", :_id => "foo"}
one = {:_id => "foo"}
assert_equal @encoder.serialize(one, false, true).to_s, @encoder.serialize(dup, false, true).to_s
end
def test_null_character
doc = {"a" => "\x00"}
assert_doc_pass(doc)
assert_raise InvalidDocument do
@encoder.serialize({"\x00" => "a"})
end
assert_raise InvalidDocument do
@encoder.serialize({"a" => (Regexp.compile "ab\x00c")})
end
end
def test_max_key
doc = {"a" => MaxKey.new}
assert_doc_pass(doc)
end
def test_min_key
doc = {"a" => MinKey.new}
assert_doc_pass(doc)
end
def test_invalid_object
o = Object.new
assert_raise InvalidDocument do
@encoder.serialize({:foo => o})
end
assert_raise InvalidDocument do
@encoder.serialize({:foo => Date.today})
end
end
def test_move_id
a = BSON::OrderedHash.new
a['text'] = 'abc'
a['key'] = 'abc'
a['_id'] = 1
assert_equal ")\000\000\000\020_id\000\001\000\000\000\002text" +
"\000\004\000\000\000abc\000\002key\000\004\000\000\000abc\000\000",
@encoder.serialize(a, false, true).to_s
assert_equal ")\000\000\000\002text\000\004\000\000\000abc\000\002key" +
"\000\004\000\000\000abc\000\020_id\000\001\000\000\000\000",
@encoder.serialize(a, false, false).to_s
end
def test_move_id_with_nested_doc
b = BSON::OrderedHash.new
b['text'] = 'abc'
b['_id'] = 2
c = BSON::OrderedHash.new
c['text'] = 'abc'
c['hash'] = b
c['_id'] = 3
assert_equal ">\000\000\000\020_id\000\003\000\000\000\002text" +
"\000\004\000\000\000abc\000\003hash\000\034\000\000" +
"\000\002text\000\004\000\000\000abc\000\020_id\000\002\000\000\000\000\000",
@encoder.serialize(c, false, true).to_s
# Java doesn't support this. Isn't actually necessary.
if !(RUBY_PLATFORM =~ /java/)
assert_equal ">\000\000\000\002text\000\004\000\000\000abc\000\003hash" +
"\000\034\000\000\000\002text\000\004\000\000\000abc\000\020_id" +
"\000\002\000\000\000\000\020_id\000\003\000\000\000\000",
@encoder.serialize(c, false, false).to_s
end
end
def test_invalid_key_names
assert @encoder.serialize({"hello" => "world"}, true)
assert @encoder.serialize({"hello" => {"hello" => "world"}}, true)
assert @encoder.serialize({"he$llo" => "world"}, true)
assert @encoder.serialize({"hello" => {"hell$o" => "world"}}, true)
assert_raise BSON::InvalidDocument do
@encoder.serialize({"he\0llo" => "world"}, true)
end
assert_raise_error BSON::InvalidKeyName, "$hello" do
@encoder.serialize({"$hello" => "world"}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hello" => {"$hello" => "world"}}, true)
end
assert_raise_error BSON::InvalidKeyName, ".hello" do
@encoder.serialize({".hello" => "world"}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hello" => {".hello" => "world"}}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hello." => "world"}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hello" => {"hello." => "world"}}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hel.lo" => "world"}, true)
end
assert_raise BSON::InvalidKeyName do
@encoder.serialize({"hello" => {"hel.lo" => "world"}}, true)
end
end
end