-
Notifications
You must be signed in to change notification settings - Fork 896
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GODRIVER-3286 BSON Binary vector subtype support
- Loading branch information
1 parent
c6d1369
commit 73018a5
Showing
12 changed files
with
746 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| // Copyright (C) MongoDB, Inc. 2024-present. | ||
| // | ||
| // 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 | ||
|
|
||
| package bson | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
| "encoding/json" | ||
| "fmt" | ||
| "math" | ||
| "os" | ||
| "path" | ||
| "testing" | ||
|
|
||
| "go.mongodb.org/mongo-driver/v2/internal/require" | ||
| ) | ||
|
|
||
| const bsonBinaryVectorDir = "../testdata/bson-binary-vector/" | ||
|
|
||
| type bsonBinaryVectorTests struct { | ||
| Description string `json:"description"` | ||
| TestKey string `json:"test_key"` | ||
| Tests []bsonBinaryVectorTestCase `json:"tests"` | ||
| } | ||
|
|
||
| type bsonBinaryVectorTestCase struct { | ||
| Description string `json:"description"` | ||
| Valid bool `json:"valid"` | ||
| Vector []interface{} `json:"vector"` | ||
| DtypeHex string `json:"dtype_hex"` | ||
| DtypeAlias string `json:"dtype_alias"` | ||
| Padding int `json:"padding"` | ||
| CanonicalBson string `json:"canonical_bson"` | ||
| } | ||
|
|
||
| func Test_BsonBinaryVector(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| jsonFiles, err := findJSONFilesInDir(bsonBinaryVectorDir) | ||
| require.NoErrorf(t, err, "error finding JSON files in %s: %v", bsonBinaryVectorDir, err) | ||
|
|
||
| for _, file := range jsonFiles { | ||
| filepath := path.Join(bsonBinaryVectorDir, file) | ||
| content, err := os.ReadFile(filepath) | ||
| require.NoErrorf(t, err, "reading test file %s", filepath) | ||
|
|
||
| var tests bsonBinaryVectorTests | ||
| require.NoErrorf(t, json.Unmarshal(content, &tests), "parsing test file %s", filepath) | ||
|
|
||
| t.Run(tests.Description, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| for _, test := range tests.Tests { | ||
| test := test | ||
| t.Run(test.Description, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| runBsonBinaryVectorTest(t, tests.TestKey, test) | ||
| }) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| t.Run("Insufficient vector data FLOAT32", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| val := Binary{Subtype: TypeBinaryVector} | ||
|
|
||
| for _, tc := range [][]byte{ | ||
| {Float32Vector, 0, 42}, | ||
| {Float32Vector, 0, 42, 42}, | ||
| {Float32Vector, 0, 42, 42, 42}, | ||
|
|
||
| {Float32Vector, 0, 42, 42, 42, 42, 42}, | ||
| {Float32Vector, 0, 42, 42, 42, 42, 42, 42}, | ||
| {Float32Vector, 0, 42, 42, 42, 42, 42, 42, 42}, | ||
| } { | ||
| t.Run(fmt.Sprintf("marshaling %d bytes", len(tc)-2), func(t *testing.T) { | ||
| val.Data = tc | ||
| b, err := Marshal(D{{"vector", val}}) | ||
| require.NoError(t, err, "marshaling test BSON") | ||
| var got struct { | ||
| Vector Vector[float32] | ||
| } | ||
| err = Unmarshal(b, &got) | ||
| require.ErrorContains(t, err, ErrInsufficientVectorData.Error()) | ||
| }) | ||
| } | ||
| }) | ||
|
|
||
| t.Run("Padding specified with no vector data PACKED_BIT", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("Marshaling", func(t *testing.T) { | ||
| val := BitVector{Padding: 1} | ||
| _, err := Marshal(val) | ||
| require.EqualError(t, err, ErrNonZeroVectorPadding.Error()) | ||
| }) | ||
| t.Run("Unmarshaling", func(t *testing.T) { | ||
| val := D{{"vector", Binary{Subtype: TypeBinaryVector, Data: []byte{PackedBitVector, 1}}}} | ||
| b, err := Marshal(val) | ||
| require.NoError(t, err, "marshaling test BSON") | ||
| var got struct { | ||
| Vector Vector[float32] | ||
| } | ||
| err = Unmarshal(b, &got) | ||
| require.ErrorContains(t, err, ErrNonZeroVectorPadding.Error()) | ||
| }) | ||
| }) | ||
|
|
||
| t.Run("Exceeding maximum padding PACKED_BIT", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("Marshaling", func(t *testing.T) { | ||
| val := BitVector{Padding: 8} | ||
| _, err := Marshal(val) | ||
| require.EqualError(t, err, ErrVectorPaddingTooLarge.Error()) | ||
| }) | ||
| t.Run("Unmarshaling", func(t *testing.T) { | ||
| val := D{{"vector", Binary{Subtype: TypeBinaryVector, Data: []byte{PackedBitVector, 8}}}} | ||
| b, err := Marshal(val) | ||
| require.NoError(t, err, "marshaling test BSON") | ||
| var got struct { | ||
| Vector Vector[float32] | ||
| } | ||
| err = Unmarshal(b, &got) | ||
| require.ErrorContains(t, err, ErrVectorPaddingTooLarge.Error()) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| func convertSlice[T int8 | float32 | byte](s []interface{}) []T { | ||
| v := make([]T, len(s)) | ||
| for i, e := range s { | ||
| f := math.NaN() | ||
| switch v := e.(type) { | ||
| case float64: | ||
| f = v | ||
| case string: | ||
| if v == "inf" { | ||
| f = math.Inf(0) | ||
| } else if v == "-inf" { | ||
| f = math.Inf(-1) | ||
| } | ||
| } | ||
| v[i] = T(f) | ||
| } | ||
| return v | ||
| } | ||
|
|
||
| func runBsonBinaryVectorTest(t *testing.T, testKey string, test bsonBinaryVectorTestCase) { | ||
| if !test.Valid { | ||
| t.Skipf("skip invalid case %s", test.Description) | ||
| } | ||
|
|
||
| var testVector interface{} | ||
| switch alias := test.DtypeHex; alias { | ||
| case "0x03": | ||
| testVector = map[string]Vector[int8]{ | ||
| testKey: {convertSlice[int8](test.Vector)}, | ||
| } | ||
| case "0x27": | ||
| testVector = map[string]Vector[float32]{ | ||
| testKey: {convertSlice[float32](test.Vector)}, | ||
| } | ||
| case "0x10": | ||
| testVector = map[string]BitVector{ | ||
| testKey: { | ||
| Padding: uint8(test.Padding), | ||
| Data: convertSlice[byte](test.Vector), | ||
| }, | ||
| } | ||
| default: | ||
| t.Fatalf("unsupported vector type: %s", alias) | ||
| } | ||
|
|
||
| testBSON, err := hex.DecodeString(test.CanonicalBson) | ||
| require.NoError(t, err, "decoding canonical BSON") | ||
|
|
||
| t.Run("Unmarshaling", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| var got interface{} | ||
| switch alias := test.DtypeHex; alias { | ||
| case "0x03": | ||
| got = make(map[string]Vector[int8]) | ||
| case "0x27": | ||
| got = make(map[string]Vector[float32]) | ||
| case "0x10": | ||
| got = make(map[string]BitVector) | ||
| default: | ||
| t.Fatalf("unsupported type: %s", alias) | ||
| } | ||
| err := Unmarshal(testBSON, got) | ||
| require.NoError(t, err) | ||
| require.Equal(t, testVector, got) | ||
| }) | ||
|
|
||
| t.Run("Marshaling", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| got, err := Marshal(testVector) | ||
| require.NoError(t, err) | ||
| require.Equal(t, testBSON, got) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.