mongo-ruby-driver/test/bson/bson_test.rb

668 lines
18 KiB
Ruby

# encoding:utf-8
require File.expand_path("../test_helper", __FILE__)
require 'set'
if RUBY_VERSION < '1.9'
silently do
require 'complex'
require 'rational'
end
end
require 'bigdecimal'
begin
require 'date'
require 'tzinfo'
require 'active_support/timezone'
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::DEFAULT_MAX_BSON_SIZE}
assert_raise InvalidDocument do
assert @encoder.serialize(doc)
end
end
def test_update_max_bson_size
require 'ostruct'
mock_conn = OpenStruct.new
size = 7 * 1024 * 1024
mock_conn.max_bson_size = size
silently do
assert_equal size, BSON_CODER.update_max_bson_size(mock_conn)
assert_equal size, BSON_CODER.max_bson_size
end
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
assert_raise BSON::InvalidStringEncoding do
BSON::BSON_CODER.serialize({'str' => 'aé'.encode('iso-8859-1')})
end
end
def test_invalid_utf8_string
str = "123\xD9"
assert !str.valid_encoding?
assert_raise BSON::InvalidStringEncoding do
BSON::BSON_CODER.serialize({'str' => str})
end
end
def test_non_utf8_key
assert_raise BSON::InvalidStringEncoding do
BSON::BSON_CODER.serialize({'aé'.encode('iso-8859-1') => 'hello'})
end
end
def test_forced_encoding_with_valid_utf8
doc = {'doc' => "\xC3\xB6".force_encoding("ISO-8859-1")}
serialized = @encoder.serialize(doc)
deserialized = @encoder.deserialize(serialized)
assert_equal(doc['doc'], deserialized['doc'].force_encoding("ISO-8859-1"))
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)
silently { 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
silently { 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 doc2['doc']
assert_equal 42, doc2['doc']['age']
assert_equal 9.5, doc2['doc']['shoe_size']
assert_in_delta Time.now, doc2['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_regex_multiline
doc = {'doc' => /foobar/m}
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_in_array
doc = {'date' => [Time.now.utc]}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
assert doc2
end
def test_date_returns_as_utc
doc = {'date' => Time.now.utc}
bson = @encoder.serialize(doc)
doc2 = @encoder.deserialize(bson)
assert doc2['date'].utc?
end
def test_date_before_epoch
if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/ then return true end
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_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_SIMPLE, bin2.subtype
end
def test_binary_with_deprecated_subtype
bin = Binary.new
'binstring'.each_byte { |b| bin.put(b) }
bin.subtype = Binary::SUBTYPE_BYTES
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_SIMPLE, 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_SIMPLE, 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]}
result = @encoder.deserialize([0x13, 0x00, 0x00, 0x00,
0x11, 0x74, 0x65, 0x73,
0x74, 0x00, 0x04, 0x00,
0x00, 0x00, 0x14, 0x00,
0x00, 0x00, 0x00])
silently do
assert_equal 4, result["test"][0]
assert_equal 20, result["test"][1]
end
end
end
def test_timestamp_type
ts = Timestamp.new(5000, 100)
doc = {:ts => ts}
bson = @encoder.serialize(doc)
assert_equal ts, @encoder.deserialize(bson)["ts"]
end
def test_overflow
doc = {"x" => 2**75}
assert_raise RangeError do
@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
@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_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 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({".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