bson 4.7.0 → 4.9.0

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,8 +13,9 @@
 # limitations under the License.
 
 CURRENT_PATH = File.expand_path(File.dirname(__FILE__))
-DRIVER_COMMON_BSON_TESTS = Dir.glob("#{CURRENT_PATH}/support/driver-spec-tests/**/*.json")
-BSON_CORPUS_TESTS = Dir.glob("#{CURRENT_PATH}/support/corpus-tests/*.json")
+DRIVER_COMMON_BSON_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/decimal128/*.json").sort
+BSON_CORPUS_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/corpus/*.json").sort
+BSON_CORPUS_LEGACY_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/corpus_legacy/*.json").sort
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
@@ -54,3 +55,9 @@ class AlternateIO < StringIO
     super.chr
   end
 end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

data/spec/{bson/driver_bson_spec.rb → spec_tests/common_driver_spec.rb}

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'runners/common_driver'
 
 describe 'Driver common bson tests' do
 

data/spec/{bson/corpus_spec.rb → spec_tests/corpus_legacy_spec.rb}

@@ -1,13 +1,14 @@
 require 'spec_helper'
+require 'runners/corpus_legacy'
 
-describe 'Driver BSON Corpus spec tests' do
+describe 'Driver BSON Corpus Legacy spec tests' do
 
-  BSON_CORPUS_TESTS.each do |path|
+  BSON_CORPUS_LEGACY_TESTS.each do |path|
     basename = File.basename(path)
     # All of the tests in the failures subdir are failing apparently
     #basename = path.sub(/.*corpus-tests\//, '')
 
-    spec = BSON::Corpus::Spec.new(path)
+    spec = BSON::CorpusLegacy::Spec.new(path)
 
     context("(#{basename}): #{spec.description}") do
 
@@ -29,7 +30,6 @@ describe 'Driver BSON Corpus spec tests' do
           context 'when the document can be represented as extended json', if: test.test_extjson? do
 
             it 'decodes from the given bson, then encodes the document as extended json correctly' do
-              skip 'The extended json in this test case does not match' unless (test.extjson_from_bson == test.correct_extjson)
               expect(test.extjson_from_bson).to eq(test.correct_extjson)
               expect(test.extjson_from_bson[test.test_key]).to eq(test.correct_extjson[test.test_key])
             end

data/spec/spec_tests/corpus_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'runners/corpus'
+
+describe 'BSON Corpus spec tests' do
+
+  BSON_CORPUS_TESTS.each do |path|
+    basename = File.basename(path)
+    # All of the tests in the failures subdir are failing apparently
+    #basename = path.sub(/.*corpus-tests\//, '')
+
+    spec = BSON::Corpus::Spec.new(path)
+
+    context("(#{basename}): #{spec.description}") do
+
+      spec.valid_tests&.each do |test|
+
+        context("valid: #{test.description}") do
+
+          let(:decoded_canonical_bson) do
+            BSON::Document.from_bson(BSON::ByteBuffer.new(test.canonical_bson), mode: :bson)
+          end
+
+          it 'round-trips canonical bson' do
+            decoded_canonical_bson.to_bson.to_s.should == test.canonical_bson
+          end
+
+=begin
+          it 'converts bson to canonical extended json' do
+            pending
+            raise NotImplementedError
+          end
+=end
+
+          it 'converts bson to canonical extended json' do
+            decoded_canonical_bson.as_extended_json.should == test.canonical_extjson_doc
+          end
+
+          if test.relaxed_extjson
+            it 'converts bson to relaxed extended json' do
+              decoded_canonical_bson.as_extended_json(mode: :relaxed).should == test.relaxed_extjson_doc
+            end
+
+            let(:parsed_relaxed_extjson) do
+              BSON::ExtJSON.parse_obj(test.relaxed_extjson_doc, mode: :bson)
+            end
+
+            let(:round_tripped_relaxed_extjson) do
+              parsed_relaxed_extjson.as_extended_json(mode: :relaxed)
+            end
+
+            # Relaxed extended json may parse into something other than the
+            # canonical bson. For example, relaxed extjson representation for
+            # a small int64 is a number that would serialize to an int32.
+            # But round-tripping extended json back to extjson should produce
+            # the same representation we started with.
+            it 'round-trips relaxed extended json' do
+              round_tripped_relaxed_extjson.should == test.relaxed_extjson_doc
+            end
+          end
+
+          if test.degenerate_bson
+
+            let(:decoded_degenerate_bson) do
+              BSON::Document.from_bson(BSON::ByteBuffer.new(test.degenerate_bson), mode: :relaxed)
+            end
+
+            it 'round-trips degenerate bson to canonical bson' do
+              decoded_degenerate_bson.to_bson.to_s.should == test.canonical_bson
+            end
+          end
+
+          let(:parsed_canonical_extjson) do
+            BSON::ExtJSON.parse_obj(test.canonical_extjson_doc, mode: :bson)
+          end
+
+          unless test.lossy?
+            it 'converts canonical extended json to bson' do
+              parsed_canonical_extjson.to_bson.to_s.should == test.canonical_bson
+            end
+          end
+
+        end
+      end
+
+      spec.decode_error_tests&.each do |test|
+
+        context("decode error: #{test.description}") do
+
+          let(:decoded_bson) do
+            BSON::Document.from_bson(BSON::ByteBuffer.new(test.bson), mode: :bson)
+          end
+
+          # Until bson-ruby gets an exception hierarchy, we can only rescue
+          # the basic Exception here.
+          # https://jira.mongodb.org/browse/RUBY-1806
+          it 'raises an exception' do
+            expect do
+              decoded_bson
+            end.to raise_error(Exception)
+          end
+        end
+      end
+
+      spec.parse_error_tests&.each do |test|
+
+        context("parse error: #{test.description}") do
+
+          let(:parsed_extjson) do
+            BSON::ExtJSON.parse(test.string, mode: :bson)
+          end
+
+          # Until bson-ruby gets an exception hierarchy, we can only rescue
+          # the basic Exception here.
+          # https://jira.mongodb.org/browse/RUBY-1806
+          it 'raises an exception' do
+            expect do
+              parsed_extjson
+            end.to raise_error(Exception)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_tests/data/corpus/README.md

@@ -0,0 +1,15 @@
+There are the following deliberate changes made to the corpus tests in Ruby:
+
+1. In double.js, Ruby appears to offer less precision than the spec tests
+demand:
+
+    irb(main):001:0> -1.23456789012345677E+18
+    => -1.2345678901234568e+18
+
+Because of this, -1.23456789012345677E+18 was changed to -1.2345678901234568e+18.
+The "e" was lowercased as well. Both the precision reduction and the lowercasing
+of "e" changes are also present in the Python driver, which appears to be
+affected by the same precision limitation.
+
+2. In datetime.js, the millisecond component of iso8601 serialization of
+timestamps is always present, even if it is zero.

data/spec/spec_tests/data/corpus/array.json

@@ -0,0 +1,49 @@
+{
+    "description": "Array",
+    "bson_type": "0x04",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Empty",
+            "canonical_bson": "0D000000046100050000000000",
+            "canonical_extjson": "{\"a\" : []}"
+        },
+        {
+            "description": "Single Element Array",
+            "canonical_bson": "140000000461000C0000001030000A0000000000",
+            "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
+        },
+        {
+            "description": "Single Element Array with index set incorrectly to empty string",
+            "degenerate_bson": "130000000461000B00000010000A0000000000",
+            "canonical_bson": "140000000461000C0000001030000A0000000000",
+            "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
+        },
+        {
+            "description": "Single Element Array with index set incorrectly to ab",
+            "degenerate_bson": "150000000461000D000000106162000A0000000000",
+            "canonical_bson": "140000000461000C0000001030000A0000000000",
+            "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}]}"
+        },
+        {
+            "description": "Multi Element Array with duplicate indexes",
+            "degenerate_bson": "1b000000046100130000001030000a000000103000140000000000",
+            "canonical_bson": "1b000000046100130000001030000a000000103100140000000000",
+            "canonical_extjson": "{\"a\" : [{\"$numberInt\": \"10\"}, {\"$numberInt\": \"20\"}]}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "Array length too long: eats outer terminator",
+            "bson": "140000000461000D0000001030000A0000000000"
+        },
+        {
+            "description": "Array length too short: leaks terminator",
+            "bson": "140000000461000B0000001030000A0000000000"
+        },
+        {
+            "description": "Invalid Array: bad string length in field",
+            "bson": "1A00000004666F6F00100000000230000500000062617A000000"
+        }
+    ]
+}

data/spec/spec_tests/data/corpus/binary.json

@@ -0,0 +1,85 @@
+{
+    "description": "Binary type",
+    "bson_type": "0x05",
+    "test_key": "x",
+    "valid": [
+        {
+            "description": "subtype 0x00 (Zero-length)",
+            "canonical_bson": "0D000000057800000000000000",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"\", \"subType\" : \"00\"}}}"
+        },
+        {
+            "description": "subtype 0x00 (Zero-length, keys reversed)",
+            "canonical_bson": "0D000000057800000000000000",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"\", \"subType\" : \"00\"}}}",
+            "degenerate_extjson": "{\"x\" : { \"$binary\" : {\"subType\" : \"00\", \"base64\" : \"\"}}}"
+        },
+        {
+            "description": "subtype 0x00",
+            "canonical_bson": "0F0000000578000200000000FFFF00",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"//8=\", \"subType\" : \"00\"}}}"
+        },
+        {
+            "description": "subtype 0x01",
+            "canonical_bson": "0F0000000578000200000001FFFF00",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"//8=\", \"subType\" : \"01\"}}}"
+        },
+        {
+            "description": "subtype 0x02",
+            "canonical_bson": "13000000057800060000000202000000FFFF00",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"//8=\", \"subType\" : \"02\"}}}"
+        },
+        {
+            "description": "subtype 0x03",
+            "canonical_bson": "1D000000057800100000000373FFD26444B34C6990E8E7D1DFC035D400",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"c//SZESzTGmQ6OfR38A11A==\", \"subType\" : \"03\"}}}"
+        },
+        {
+            "description": "subtype 0x04",
+            "canonical_bson": "1D000000057800100000000473FFD26444B34C6990E8E7D1DFC035D400",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"c//SZESzTGmQ6OfR38A11A==\", \"subType\" : \"04\"}}}"
+        },
+        {
+            "description": "subtype 0x05",
+            "canonical_bson": "1D000000057800100000000573FFD26444B34C6990E8E7D1DFC035D400",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"c//SZESzTGmQ6OfR38A11A==\", \"subType\" : \"05\"}}}"
+        },
+        {
+            "description": "subtype 0x80",
+            "canonical_bson": "0F0000000578000200000080FFFF00",
+            "canonical_extjson": "{\"x\" : { \"$binary\" : {\"base64\" : \"//8=\", \"subType\" : \"80\"}}}"
+        },
+        {
+            "description": "$type query operator (conflicts with legacy $binary form with $type field)",
+            "canonical_bson": "1F000000037800170000000224747970650007000000737472696E67000000",
+            "canonical_extjson": "{\"x\" : { \"$type\" : \"string\"}}"
+        },
+        {
+            "description": "$type query operator (conflicts with legacy $binary form with $type field)",
+            "canonical_bson": "180000000378001000000010247479706500020000000000",
+            "canonical_extjson": "{\"x\" : { \"$type\" : {\"$numberInt\": \"2\"}}}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "Length longer than document",
+            "bson": "1D000000057800FF0000000573FFD26444B34C6990E8E7D1DFC035D400"
+        },
+        {
+            "description": "Negative length",
+            "bson": "0D000000057800FFFFFFFF0000"
+        },
+        {
+            "description": "subtype 0x02 length too long ",
+            "bson": "13000000057800060000000203000000FFFF00"
+        },
+        {
+            "description": "subtype 0x02 length too short",
+            "bson": "13000000057800060000000201000000FFFF00"
+        },
+        {
+            "description": "subtype 0x02 length negative one",
+            "bson": "130000000578000600000002FFFFFFFFFFFF00"
+        }
+    ]
+}

data/spec/spec_tests/data/corpus/boolean.json

@@ -0,0 +1,27 @@
+{
+    "description": "Boolean",
+    "bson_type": "0x08",
+    "test_key": "b",
+    "valid": [
+        {
+            "description": "True",
+            "canonical_bson": "090000000862000100",
+            "canonical_extjson": "{\"b\" : true}"
+        },
+        {
+            "description": "False",
+            "canonical_bson": "090000000862000000",
+            "canonical_extjson": "{\"b\" : false}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "Invalid boolean value of 2",
+            "bson": "090000000862000200"
+        },
+        {
+            "description": "Invalid boolean value of -1",
+            "bson": "09000000086200FF00"
+        }
+    ]
+}

data/spec/spec_tests/data/corpus/code.json

@@ -0,0 +1,67 @@
+{
+    "description": "Javascript Code",
+    "bson_type": "0x0D",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Empty string",
+            "canonical_bson": "0D0000000D6100010000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"\"}}"
+        },
+        {
+            "description": "Single character",
+            "canonical_bson": "0E0000000D610002000000620000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"b\"}}"
+        },
+        {
+            "description": "Multi-character",
+            "canonical_bson": "190000000D61000D0000006162616261626162616261620000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"abababababab\"}}"
+        },
+        {
+            "description": "two-byte UTF-8 (\u00e9)",
+            "canonical_bson": "190000000261000D000000C3A9C3A9C3A9C3A9C3A9C3A90000",
+            "canonical_extjson": "{\"a\" : \"\\u00e9\\u00e9\\u00e9\\u00e9\\u00e9\\u00e9\"}"
+        },
+        {
+            "description": "three-byte UTF-8 (\u2606)",
+            "canonical_bson": "190000000261000D000000E29886E29886E29886E298860000",
+            "canonical_extjson": "{\"a\" : \"\\u2606\\u2606\\u2606\\u2606\"}"
+        },
+        {
+            "description": "Embedded nulls",
+            "canonical_bson": "190000000261000D0000006162006261620062616261620000",
+            "canonical_extjson": "{\"a\" : \"ab\\u0000bab\\u0000babab\"}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "bad code string length: 0 (but no 0x00 either)",
+            "bson": "0C0000000261000000000000"
+        },
+        {
+            "description": "bad code string length: -1",
+            "bson": "0C000000026100FFFFFFFF00"
+        },
+        {
+            "description": "bad code string length: eats terminator",
+            "bson": "10000000026100050000006200620000"
+        },
+        {
+            "description": "bad code string length: longer than rest of document",
+            "bson": "120000000200FFFFFF00666F6F6261720000"
+        },
+        {
+            "description": "code string is not null-terminated",
+            "bson": "1000000002610004000000616263FF00"
+        },
+        {
+            "description": "empty code string, but extra null",
+            "bson": "0E00000002610001000000000000"
+        },
+        {
+            "description": "invalid UTF-8",
+            "bson": "0E00000002610002000000E90000"
+        }
+    ]
+}

data/spec/spec_tests/data/corpus/code_w_scope.json

@@ -0,0 +1,78 @@
+{
+    "description": "Javascript Code with Scope",
+    "bson_type": "0x0F",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Empty code string, empty scope",
+            "canonical_bson": "160000000F61000E0000000100000000050000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"\", \"$scope\" : {}}}"
+        },
+        {
+            "description": "Non-empty code string, empty scope",
+            "canonical_bson": "1A0000000F610012000000050000006162636400050000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"abcd\", \"$scope\" : {}}}"
+        },
+        {
+            "description": "Empty code string, non-empty scope",
+            "canonical_bson": "1D0000000F61001500000001000000000C000000107800010000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"\", \"$scope\" : {\"x\" : {\"$numberInt\": \"1\"}}}}"
+        },
+        {
+            "description": "Non-empty code string and non-empty scope",
+            "canonical_bson": "210000000F6100190000000500000061626364000C000000107800010000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"abcd\", \"$scope\" : {\"x\" : {\"$numberInt\": \"1\"}}}}"
+        },
+        {
+            "description": "Unicode and embedded null in code string, empty scope",
+            "canonical_bson": "1A0000000F61001200000005000000C3A9006400050000000000",
+            "canonical_extjson": "{\"a\" : {\"$code\" : \"\\u00e9\\u0000d\", \"$scope\" : {}}}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "field length zero",
+            "bson": "280000000F6100000000000500000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "field length negative",
+            "bson": "280000000F6100FFFFFFFF0500000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "field length too short (less than minimum size)",
+            "bson": "160000000F61000D0000000100000000050000000000"
+        },
+        {
+            "description": "field length too short (truncates scope)",
+            "bson": "280000000F61001F0000000500000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "field length too long (clips outer doc)",
+            "bson": "280000000F6100210000000500000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "field length too long (longer than outer doc)",
+            "bson": "280000000F6100FF0000000500000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "bad code string: length too short",
+            "bson": "280000000F6100200000000400000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "bad code string: length too long (clips scope)",
+            "bson": "280000000F6100200000000600000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "bad code string: negative length",
+            "bson": "280000000F610020000000FFFFFFFF61626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "bad code string: length longer than field",
+            "bson": "280000000F610020000000FF00000061626364001300000010780001000000107900010000000000"
+        },
+        {
+            "description": "bad scope doc (field has bad string length)",
+            "bson": "1C0000000F001500000001000000000C000000020000000000000000"
+        }
+    ]
+}