bson 4.1.1-java → 4.2.0-java

data/spec/support/corpus-tests/failures/symbol.json

@@ -0,0 +1,62 @@
+{
+    "description": "Symbol",
+    "bson_type": "0x0E",
+    "deprecated": true,
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Empty string",
+            "bson": "0D0000000E6100010000000000"
+        },
+        {
+            "description": "Single character",
+            "bson": "0E0000000E610002000000620000"
+        },
+        {
+            "description": "Multi-character",
+            "bson": "190000000E61000D0000006162616261626162616261620000"
+        },
+        {
+            "description": "two-byte UTF-8 (\u00e9)",
+            "bson": "190000000E61000D000000C3A9C3A9C3A9C3A9C3A9C3A90000"
+        },
+        {
+            "description": "three-byte UTF-8 (\u2606)",
+            "bson": "190000000E61000D000000E29886E29886E29886E298860000"
+        },
+        {
+            "description": "Embedded nulls",
+            "bson": "190000000E61000D0000006162006261620062616261620000"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "bad symbol length: 0 (but no 0x00 either)",
+            "bson": "0C0000000261000000000000"
+        },
+        {
+            "description": "bad symbol length: -1",
+            "bson": "0C000000026100FFFFFFFF00"
+        },
+        {
+            "description": "bad symbol length: eats terminator",
+            "bson": "10000000026100050000006200620000"
+        },
+        {
+            "description": "bad symbol length: longer than rest of document",
+            "bson": "120000000200FFFFFF00666F6F6261720000"
+        },
+        {
+            "description": "symbol is not null-terminated",
+            "bson": "1000000002610004000000616263FF00"
+        },
+        {
+            "description": "empty symbol, but extra null",
+            "bson": "0E00000002610001000000000000"
+        },
+        {
+            "description": "invalid UTF-8",
+            "bson": "0E00000002610002000000E90000"
+        }
+    ]
+}

data/spec/support/corpus-tests/failures/undefined.json

@@ -0,0 +1,13 @@
+{
+    "description": "Undefined type (deprecated)",
+    "bson_type": "0x06",
+    "deprecated": true,
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Undefined",
+            "bson": "0800000006610000",
+            "extjson": "{\"a\" : {\"$undefined\" : true}}"
+        }
+    ]
+}

data/spec/support/corpus-tests/int32.json

@@ -0,0 +1,38 @@
+{
+    "description": "Int32 type",
+    "bson_type": "0x10",
+    "test_key": "i",
+    "valid": [
+        {
+            "description": "MinValue",
+            "bson": "0C0000001069000000008000",
+            "extjson": "{\"i\" : -2147483648}"
+        },
+        {
+            "description": "MaxValue",
+            "bson": "0C000000106900FFFFFF7F00",
+            "extjson": "{\"i\" : 2147483647}"
+        },
+        {
+            "description": "-1",
+            "bson": "0C000000106900FFFFFFFF00",
+            "extjson": "{\"i\" : -1}"
+        },
+        {
+            "description": "0",
+            "bson": "0C0000001069000000000000",
+            "extjson": "{\"i\" : 0}"
+        },
+        {
+            "description": "1",
+            "bson": "0C0000001069000100000000",
+            "extjson": "{\"i\" : 1}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "Bad int32 field length",
+            "bson": "090000001061000500"
+        }
+    ]
+}

data/spec/support/corpus-tests/maxkey.json

@@ -0,0 +1,12 @@
+{
+    "description": "Maxkey type",
+    "bson_type": "0xFF",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Maxkey",
+            "bson": "080000007F610000",
+            "extjson": "{\"a\" : {\"$maxKey\" : 1}}"
+        }
+    ]
+}

data/spec/support/corpus-tests/minkey.json

@@ -0,0 +1,12 @@
+{
+    "description": "Minkey type",
+    "bson_type": "0xFF",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Minkey",
+            "bson": "08000000FF610000",
+            "extjson": "{\"a\" : {\"$minKey\" : 1}}"
+        }
+    ]
+}

data/spec/support/corpus-tests/null.json

@@ -0,0 +1,12 @@
+{
+    "description": "Null type",
+    "bson_type": "0x0A",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Null",
+            "bson": "080000000A610000",
+            "extjson": "{\"a\" : null}"
+        }
+    ]
+}

data/spec/support/corpus-tests/oid.json

@@ -0,0 +1,28 @@
+{
+    "description": "ObjectId",
+    "bson_type": "0x07",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "All zeroes",
+            "bson": "1400000007610000000000000000000000000000",
+            "extjson": "{\"a\" : {\"$oid\" : \"000000000000000000000000\"}}"
+        },
+        {
+            "description": "All ones",
+            "bson": "14000000076100FFFFFFFFFFFFFFFFFFFFFFFF00",
+            "extjson": "{\"a\" : {\"$oid\" : \"ffffffffffffffffffffffff\"}}"
+        },
+        {
+            "description": "Random",
+            "bson": "1400000007610056E1FC72E0C917E9C471416100",
+            "extjson": "{\"a\" : {\"$oid\" : \"56e1fc72e0c917e9c4714161\"}}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "OID truncated",
+            "bson": "1200000007610056E1FC72E0C917E9C471"
+        }
+    ]
+}

data/spec/support/corpus-tests/regex.json

@@ -0,0 +1,37 @@
+{
+    "description": "Regular Expression type",
+    "bson_type": "0x0B",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "empty regex with no options",
+            "bson": "0A0000000B6100000000",
+            "extjson": "{\"a\" : {\"$regex\" : \"\", \"$options\" : \"\"}}"
+        },
+        {
+            "description": "regex without options",
+            "bson": "0D0000000B6100616263000000",
+            "extjson": "{\"a\" : {\"$regex\" : \"abc\", \"$options\" : \"\"}}"
+        },
+        {
+            "description": "regex with options",
+            "bson": "0F0000000B610061626300696D0000",
+            "extjson": "{\"a\" : {\"$regex\" : \"abc\", \"$options\" : \"im\"}}"
+        },
+        {
+            "description": "regex with slash",
+            "bson": "110000000B610061622F636400696D0000",
+            "extjson": "{\"a\" : {\"$regex\" : \"ab/cd\", \"$options\" : \"im\"}}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "embedded null in pattern",
+            "bson": "0F0000000B610061006300696D0000"
+        },
+        {
+            "description": "embedded null in flags",
+            "bson": "100000000B61006162630069006D0000"
+        }
+    ]
+}

data/spec/support/corpus-tests/string.json

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

data/spec/support/corpus-tests/timestamp.json

@@ -0,0 +1,18 @@
+{
+    "description": "Timestamp type",
+    "bson_type": "0x11",
+    "test_key": "a",
+    "valid": [
+        {
+            "description": "Timestamp: (123456789, 42)",
+            "bson": "100000001161002A00000015CD5B0700",
+            "extjson": "{\"a\" : {\"$timestamp\" : {\"t\" : 123456789, \"i\" : 42}}}"
+        }
+    ],
+    "decodeErrors": [
+        {
+            "description": "Truncated timestamp field",
+            "bson": "0f0000001161002A00000015CD5B00"
+        }
+    ]
+}

data/spec/support/corpus-tests/top.json

@@ -0,0 +1,62 @@
+{
+    "description": "Top-level document validity",
+    "bson_type": "0x00",
+    "decodeErrors": [
+        {
+            "description": "An object size that's too small to even include the object size, but is a well-formed, empty object",
+            "bson": "0100000000"
+        },
+        {
+            "description": "An object size that's only enough for the object size, but is a well-formed, empty object",
+            "bson": "0400000000"
+        },
+        {
+            "description": "One object, with length shorter than size (missing EOO)",
+            "bson": "05000000"
+        },
+        {
+            "description": "One object, sized correctly, with a spot for an EOO, but the EOO is 0x01",
+            "bson": "0500000001"
+        },
+        {
+            "description": "One object, sized correctly, with a spot for an EOO, but the EOO is 0xff",
+            "bson": "05000000FF"
+        },
+        {
+            "description": "One object, sized correctly, with a spot for an EOO, but the EOO is 0x70",
+            "bson": "0500000070"
+        },
+        {
+            "description": "Byte count is zero (with non-zero input length)",
+            "bson": "00000000000000000000"
+        },
+        {
+            "description": "Stated length exceeds byte count, with truncated document",
+            "bson": "1200000002666F6F0004000000626172"
+        },
+        {
+            "description": "Stated length less than byte count, with garbage after envelope",
+            "bson": "1200000002666F6F00040000006261720000DEADBEEF"
+        },
+        {
+            "description": "Stated length exceeds byte count, with valid envelope",
+            "bson": "1300000002666F6F00040000006261720000"
+        },
+        {
+            "description": "Stated length less than byte count, with valid envelope",
+            "bson": "1100000002666F6F00040000006261720000"
+        },
+        {
+            "description": "Invalid BSON type low range",
+            "bson": "07000000000000"
+        },
+        {
+            "description": "Invalid BSON type high range",
+            "bson": "07000000800000"
+        },
+        {
+            "description": "Document truncated mid-key",
+            "bson": "1200000002666F"
+        }
+    ]
+}

data/spec/support/corpus.rb

@@ -0,0 +1,265 @@
+# Copyright (C) 2016 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+
+module BSON
+  module Corpus
+
+    # 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.
+      #
+      # @example Create the spec.
+      #   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'] || []
+        @invalid = @spec['decodeErrors'] || []
+        @description = @spec['description']
+        @test_key = @spec['test_key']
+      end
+
+      # Get a list of tests that are expected to pass.
+      #
+      # @example Get the list of valid tests.
+      #   spec.valid_tests
+      #
+      # @return [ Array<BSON::Corpus::Test> ] The list of valid Tests.
+      #
+      # @since 4.2.0
+      def valid_tests
+        @valid_tests ||=
+          @valid.collect do |test|
+            BSON::Corpus::Test.new(self, test)
+          end
+      end
+
+      # Get a list of tests that raise exceptions.
+      #
+      # @example Get the list of invalid tests.
+      #   spec.invalid_tests
+      #
+      # @return [ Array<BSON::Corpus::Test> ] The list of invalid Tests.
+      #
+      # @since 4.2.0
+      def invalid_tests
+        @invalid_tests ||=
+          @invalid.collect do |test|
+            BSON::Corpus::Test.new(self, test)
+          end
+      end
+
+      # The class of the bson object to test.
+      #
+      # @example Get the class of the object to test.
+      #   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.
+      #
+      # @example Create the test.
+      #   Test.new(test)
+      #
+      # @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']
+        @canonical_bson = test['canonical_bson']
+        @extjson = ::JSON.parse(test['extjson']) if test['extjson']
+        @bson = test['bson']
+        @test_key = spec.test_key
+      end
+
+      # The correct representation of the subject as bson.
+      #
+      # @example Get the correct representation of the subject as 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
+
+      # Given the hex representation of bson, decode it into a Document,
+      #   then reencoded it to bson.
+      #
+      # @example Decoded the bson hex representation, then reencode.
+      #   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
+      end
+
+      # Given the hex representation of the canonical bson, decode it into a Document,
+      #   then reencoded it to bson.
+      #
+      # @example Decoded the canonical bson hex representation, then reencode.
+      #   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
+      end
+
+      # Whether the canonical bson should be tested.
+      #
+      # @example Determine if the canonical bson should be tested.
+      #   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
+
+      # The correct representation of the subject as extended json.
+      #
+      # @example Get the correct representation of the subject as extended json.
+      #   test.correct_extjson
+      #
+      # @return [ String ] The correct extended json representation.
+      #
+      # @since 4.2.0
+      def correct_extjson
+        @canonical_extjson || @extjson
+      end
+
+      # Whether the extended json should be tested.
+      #
+      # @example Determine if the extended json should be tested.
+      #   test.test_extjson?
+      #
+      # @return [ true, false ] Whether the extended json should be tested.
+      #
+      # @since 4.2.0
+      def test_extjson?
+        !!@extjson
+      end
+
+      # Get the extended json representation of the decoded doc from the provided
+      #   bson hex representation.
+      #
+      # @example Get the extended json representation of the decoded doc.
+      #   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)
+      end
+
+      # Get the extended json representation of the decoded doc from the provided
+      #   canonical bson hex representation.
+      #
+      # @example Get the extended json representation of the canonical decoded doc.
+      #   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)
+      end
+
+      # Get the extended json representation of the decoded doc from the provided
+      #   extended json representation. (Verifies roundtrip)
+      #
+      # @example Get the extended json representation of the canonical decoded doc.
+      #   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)
+      end
+
+      private
+
+      def decode_hex(obj)
+        [ obj ].pack('H*')
+      end
+    end
+  end
+end