bson 4.7.1 → 4.8.0

data/spec/{support/corpus.rb → runners/corpus_legacy.rb}

@@ -15,25 +15,19 @@
 require 'json'
 
 module BSON
-  module Corpus
+  module CorpusLegacy
 
     # Represents a test from the driver BSON Corpus.
-    #
-    # @since 4.2.0
     class Spec
 
       # The spec description.
       #
       # @return [ String ] The spec description.
-      #
-      # @since 4.2.0
       attr_reader :description
 
       # The document key of the object to test.
       #
       # @return [ String ] The document key.
-      #
-      # @since 4.2.0
       attr_reader :test_key
 
       # Instantiate the new spec.
@@ -42,8 +36,6 @@ module BSON
       #   Spec.new(file)
       #
       # @param [ String ] file The name of the json file.
-      #
-      # @since 4.2.0
       def initialize(file)
         @spec = ::JSON.parse(File.read(file))
         @valid = @spec['valid'] || []
@@ -57,13 +49,11 @@ module BSON
       # @example Get the list of valid tests.
       #   spec.valid_tests
       #
-      # @return [ Array<BSON::Corpus::Test> ] The list of valid Tests.
-      #
-      # @since 4.2.0
+      # @return [ Array<BSON::CorpusLegacy::Test> ] The list of valid Tests.
       def valid_tests
         @valid_tests ||=
           @valid.collect do |test|
-            BSON::Corpus::Test.new(self, test)
+            BSON::CorpusLegacy::Test.new(self, test)
           end
       end
 
@@ -72,13 +62,11 @@ module BSON
       # @example Get the list of invalid tests.
       #   spec.invalid_tests
       #
-      # @return [ Array<BSON::Corpus::Test> ] The list of invalid Tests.
-      #
-      # @since 4.2.0
+      # @return [ Array<BSON::CorpusLegacy::Test> ] The list of invalid Tests.
       def invalid_tests
         @invalid_tests ||=
           @invalid.collect do |test|
-            BSON::Corpus::Test.new(self, test)
+            BSON::CorpusLegacy::Test.new(self, test)
           end
       end
 
@@ -88,31 +76,23 @@ module BSON
       #   spec.klass
       #
       # @return [ Class ] The object class.
-      #
-      # @since 4.2.0
       def klass
         @klass ||= BSON.const_get(description)
       end
     end
 
     # Represents a single BSON Corpus test.
-    #
-    # @since 4.2.0
     class Test
 
       # The test description.
       #
       # @return [ String ] The test description.
-      #
-      # @since 4.2.0
       attr_reader :description
 
       # Name of a field in a valid test case extjson document that should be
       #   checked against the case's string field.
       #
       # @return [ String ] The json representation of the object.
-      #
-      # @since 4.2.0
       attr_reader :test_key
 
       # Instantiate the new Test.
@@ -122,8 +102,6 @@ module BSON
       #
       # @param [ Corpus::Spec ] spec The test specification.
       # @param [ Hash ] test The test specification.
-      #
-      # @since 4.2.0
       def initialize(spec, test)
         @spec = spec
         @description = test['description']
@@ -139,12 +117,29 @@ module BSON
       #   test.correct_bson
       #
       # @return [ String ] The correct bson bytes.
-      #
-      # @since 4.2.0
       def correct_bson
         @correct_bson ||= decode_hex(@canonical_bson || @bson)
       end
 
+      # Create a BSON::Document object from the test's bson representation
+      #
+      # @return [ BSON::Document ] The BSON::Document object
+      def document_from_bson
+        bson_bytes = decode_hex(@bson)
+        buffer = BSON::ByteBuffer.new(bson_bytes)
+        BSON::Document.from_bson(buffer)
+      end
+
+      # Create a BSON::Document object from the test's canonical bson
+      # representation
+      #
+      # @return [ BSON::Document ] The BSON::Document object
+      def document_from_canonical_bson
+        bson_bytes = decode_hex(@canonical_bson)
+        buffer = BSON::ByteBuffer.new(bson_bytes)
+        BSON::Document.from_bson(buffer)
+      end
+
       # Given the hex representation of bson, decode it into a Document,
       #   then reencoded it to bson.
       #
@@ -152,12 +147,8 @@ module BSON
       #   test.reencoded_bson
       #
       # @return [ String ] The reencoded bson bytes.
-      #
-      # @since 4.2.0
       def reencoded_bson
-        bson_bytes = decode_hex(@bson)
-        buffer = BSON::ByteBuffer.new(bson_bytes)
-        BSON::Document.from_bson(buffer).to_bson.to_s
+        document_from_bson.to_bson.to_s
       end
 
       # Given the hex representation of the canonical bson, decode it into a Document,
@@ -167,12 +158,8 @@ module BSON
       #   test.reencoded_canonical_bson
       #
       # @return [ String ] The reencoded canonical bson bytes.
-      #
-      # @since 4.2.0
       def reencoded_canonical_bson
-        bson_bytes = decode_hex(@canonical_bson)
-        buffer = BSON::ByteBuffer.new(bson_bytes)
-        BSON::Document.from_bson(buffer).to_bson.to_s
+        document_from_canonical_bson.to_bson.to_s
       end
 
       # Whether the canonical bson should be tested.
@@ -181,8 +168,6 @@ module BSON
       #   test.test_canonical_bson?
       #
       # @return [ true, false ] Whether the canonical bson should be tested.
-      #
-      # @since 4.2.0
       def test_canonical_bson?
         @canonical_bson && (@bson != @canonical_bson)
       end
@@ -193,8 +178,6 @@ module BSON
       #   test.correct_extjson
       #
       # @return [ String ] The correct extended json representation.
-      #
-      # @since 4.2.0
       def correct_extjson
         @canonical_extjson || @extjson
       end
@@ -205,8 +188,6 @@ module BSON
       #   test.test_extjson?
       #
       # @return [ true, false ] Whether the extended json should be tested.
-      #
-      # @since 4.2.0
       def test_extjson?
         !!@extjson
       end
@@ -218,12 +199,8 @@ module BSON
       #   test.extjson_from_encoded_bson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_bson
-        subject = decode_hex(@bson)
-        buffer = BSON::ByteBuffer.new(subject)
-        ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
+        as_legacy_extended_json(document_from_bson)
       end
 
       # Get the extended json representation of the decoded doc from the provided
@@ -233,12 +210,8 @@ module BSON
       #   test.extjson_from_canonical_bson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_canonical_bson
-        subject = decode_hex(@canonical_bson)
-        buffer = BSON::ByteBuffer.new(subject)
-        ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
+        as_legacy_extended_json(document_from_canonical_bson)
       end
 
       # Get the extended json representation of the decoded doc from the provided
@@ -248,15 +221,24 @@ module BSON
       #   test.extjson_from_encoded_extjson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_encoded_extjson
         doc = BSON::Document.new(@extjson)
-        ::JSON.parse(doc.to_json)
+        as_legacy_extended_json(doc)
       end
 
       private
 
+      def as_legacy_extended_json(object)
+        result = object.as_extended_json(mode: :legacy)
+        if object.respond_to?(:as_json)
+          old_result = object.as_json
+          unless result == old_result
+            raise "Serializing #{object} to legacy extended json did not match between new and old APIs"
+          end
+        end
+        result
+      end
+
       def decode_hex(obj)
         [ obj ].pack('H*')
       end

data/spec/spec_helper.rb

@@ -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"
+        }
+    ]
+}