1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
# Copyright 2009-present 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.
"""Tests for the dbref module."""
from __future__ import annotations
import pickle
import sys
from typing import Any
sys.path[0:0] = [""]
from copy import deepcopy
from test import unittest
from bson import decode, encode
from bson.dbref import DBRef
from bson.objectid import ObjectId
class TestDBRef(unittest.TestCase):
def test_creation(self):
a = ObjectId()
self.assertRaises(TypeError, DBRef)
self.assertRaises(TypeError, DBRef, "coll")
self.assertRaises(TypeError, DBRef, 4, a)
self.assertRaises(TypeError, DBRef, 1.5, a)
self.assertRaises(TypeError, DBRef, a, a)
self.assertRaises(TypeError, DBRef, None, a)
self.assertRaises(TypeError, DBRef, "coll", a, 5)
self.assertTrue(DBRef("coll", a))
self.assertTrue(DBRef("coll", 5))
self.assertTrue(DBRef("coll", 5, "database"))
def test_read_only(self):
a = DBRef("coll", ObjectId())
def foo():
a.collection = "blah" # type: ignore[misc]
def bar():
a.id = "aoeu" # type: ignore[misc]
self.assertEqual("coll", a.collection)
a.id
self.assertEqual(None, a.database)
self.assertRaises(AttributeError, foo)
self.assertRaises(AttributeError, bar)
def test_repr(self):
self.assertEqual(
repr(DBRef("coll", ObjectId("1234567890abcdef12345678"))),
"DBRef('coll', ObjectId('1234567890abcdef12345678'))",
)
self.assertEqual(
repr(DBRef("coll", ObjectId("1234567890abcdef12345678"))),
"DBRef({}, ObjectId('1234567890abcdef12345678'))".format(repr("coll")),
)
self.assertEqual(repr(DBRef("coll", 5, foo="bar")), "DBRef('coll', 5, foo='bar')")
self.assertEqual(
repr(DBRef("coll", ObjectId("1234567890abcdef12345678"), "foo")),
"DBRef('coll', ObjectId('1234567890abcdef12345678'), 'foo')",
)
def test_equality(self):
obj_id = ObjectId("1234567890abcdef12345678")
self.assertEqual(DBRef("foo", 5), DBRef("foo", 5))
self.assertEqual(DBRef("coll", obj_id), DBRef("coll", obj_id))
self.assertNotEqual(DBRef("coll", obj_id), DBRef("coll", obj_id, "foo"))
self.assertNotEqual(DBRef("coll", obj_id), DBRef("col", obj_id))
self.assertNotEqual(DBRef("coll", obj_id), DBRef("coll", ObjectId(b"123456789011")))
self.assertNotEqual(DBRef("coll", obj_id), 4)
self.assertNotEqual(DBRef("coll", obj_id, "foo"), DBRef("coll", obj_id, "bar"))
# Explicitly test inequality
self.assertFalse(DBRef("foo", 5) != DBRef("foo", 5))
self.assertFalse(DBRef("coll", obj_id) != DBRef("coll", obj_id))
self.assertFalse(DBRef("coll", obj_id, "foo") != DBRef("coll", obj_id, "foo"))
def test_kwargs(self):
self.assertEqual(DBRef("coll", 5, foo="bar"), DBRef("coll", 5, foo="bar"))
self.assertNotEqual(DBRef("coll", 5, foo="bar"), DBRef("coll", 5))
self.assertNotEqual(DBRef("coll", 5, foo="bar"), DBRef("coll", 5, foo="baz"))
self.assertEqual("bar", DBRef("coll", 5, foo="bar").foo)
self.assertRaises(AttributeError, getattr, DBRef("coll", 5, foo="bar"), "bar")
def test_deepcopy(self):
a = DBRef("coll", "asdf", "db", x=[1])
b = deepcopy(a)
self.assertEqual(a, b)
self.assertNotEqual(id(a), id(b.x))
self.assertEqual(a.x, b.x)
self.assertNotEqual(id(a.x), id(b.x))
b.x[0] = 2
self.assertEqual(a.x, [1])
self.assertEqual(b.x, [2])
def test_pickling(self):
dbr = DBRef("coll", 5, foo="bar")
for protocol in [0, 1, 2, -1]:
pkl = pickle.dumps(dbr, protocol=protocol)
dbr2 = pickle.loads(pkl)
self.assertEqual(dbr, dbr2)
def test_dbref_hash(self):
dbref_1a = DBRef("collection", "id", "database")
dbref_1b = DBRef("collection", "id", "database")
self.assertEqual(hash(dbref_1a), hash(dbref_1b))
dbref_2a = DBRef("collection", "id", "database", custom="custom")
dbref_2b = DBRef("collection", "id", "database", custom="custom")
self.assertEqual(hash(dbref_2a), hash(dbref_2b))
self.assertNotEqual(hash(dbref_1a), hash(dbref_2a))
# https://github.com/mongodb/specifications/blob/master/source/dbref/dbref.md#test-plan
class TestDBRefSpec(unittest.TestCase):
def test_decoding_1_2_3(self):
doc: Any
for doc in [
# 1, Valid documents MUST be decoded to a DBRef:
{"$ref": "coll0", "$id": ObjectId("60a6fe9a54f4180c86309efa")},
{"$ref": "coll0", "$id": 1},
{"$ref": "coll0", "$id": None},
{"$ref": "coll0", "$id": 1, "$db": "db0"},
# 2, Valid documents with extra fields:
{"$ref": "coll0", "$id": 1, "$db": "db0", "foo": "bar"},
{"$ref": "coll0", "$id": 1, "foo": True, "bar": False},
{"$ref": "coll0", "$id": 1, "meta": {"foo": 1, "bar": 2}},
{"$ref": "coll0", "$id": 1, "$foo": "bar"},
{"$ref": "coll0", "$id": 1, "foo.bar": 0},
# 3, Valid documents with out of order fields:
{"$id": 1, "$ref": "coll0"},
{"$db": "db0", "$ref": "coll0", "$id": 1},
{"foo": 1, "$id": 1, "$ref": "coll0"},
{"foo": 1, "$ref": "coll0", "$id": 1, "$db": "db0"},
{"foo": 1, "$ref": "coll0", "$id": 1, "$db": "db0", "bar": 1},
]:
with self.subTest(doc=doc):
decoded = decode(encode({"dbref": doc}))
dbref = decoded["dbref"]
self.assertIsInstance(dbref, DBRef)
self.assertEqual(dbref.collection, doc["$ref"])
self.assertEqual(dbref.id, doc["$id"])
self.assertEqual(dbref.database, doc.get("$db"))
for extra in set(doc.keys()) - {"$ref", "$id", "$db"}:
self.assertEqual(getattr(dbref, extra), doc[extra])
def test_decoding_4_5(self):
for doc in [
# 4, Documents missing required fields MUST NOT be decoded to a
# DBRef:
{"$ref": "coll0"},
{"$id": ObjectId("60a6fe9a54f4180c86309efa")},
{"$db": "db0"},
# 5, Documents with invalid types for $ref or $db MUST NOT be
# decoded to a DBRef
{"$ref": True, "$id": 1},
{"$ref": "coll0", "$id": 1, "$db": 1},
]:
with self.subTest(doc=doc):
decoded = decode(encode({"dbref": doc}))
dbref = decoded["dbref"]
self.assertIsInstance(dbref, dict)
def test_encoding_1_2(self):
doc: Any
for doc in [
# 1, Encoding DBRefs with basic fields:
{"$ref": "coll0", "$id": ObjectId("60a6fe9a54f4180c86309efa")},
{"$ref": "coll0", "$id": 1},
{"$ref": "coll0", "$id": None},
{"$ref": "coll0", "$id": 1, "$db": "db0"},
# 2, Encoding DBRefs with extra, optional fields:
{"$ref": "coll0", "$id": 1, "$db": "db0", "foo": "bar"},
{"$ref": "coll0", "$id": 1, "foo": True, "bar": False},
{"$ref": "coll0", "$id": 1, "meta": {"foo": 1, "bar": 2}},
{"$ref": "coll0", "$id": 1, "$foo": "bar"},
{"$ref": "coll0", "$id": 1, "foo.bar": 0},
]:
with self.subTest(doc=doc):
# Decode the test input to a DBRef via a BSON roundtrip.
encoded_doc = encode({"dbref": doc})
decoded = decode(encoded_doc)
dbref = decoded["dbref"]
self.assertIsInstance(dbref, DBRef)
# Encode the DBRef.
encoded_dbref = encode(decoded)
self.assertEqual(encoded_dbref, encoded_doc)
# Ensure extra fields are present.
for extra in set(doc.keys()) - {"$ref", "$id", "$db"}:
self.assertEqual(getattr(dbref, extra), doc[extra])
def test_encoding_3(self):
for doc in [
# 3, Encoding DBRefs re-orders any out of order fields during
# decoding:
{"$id": 1, "$ref": "coll0"},
{"$db": "db0", "$ref": "coll0", "$id": 1},
{"foo": 1, "$id": 1, "$ref": "coll0"},
{"foo": 1, "$ref": "coll0", "$id": 1, "$db": "db0"},
{"foo": 1, "$ref": "coll0", "$id": 1, "$db": "db0", "bar": 1},
]:
with self.subTest(doc=doc):
# Decode the test input to a DBRef via a BSON roundtrip.
encoded_doc = encode({"dbref": doc})
decoded = decode(encoded_doc)
dbref = decoded["dbref"]
self.assertIsInstance(dbref, DBRef)
# Encode the DBRef.
encoded_dbref = encode(decoded)
# BSON does not match because DBRef fields are reordered.
self.assertNotEqual(encoded_dbref, encoded_doc)
self.assertEqual(decode(encoded_dbref), decode(encoded_doc))
# Ensure extra fields are present.
for extra in set(doc.keys()) - {"$ref", "$id", "$db"}:
self.assertEqual(getattr(dbref, extra), doc[extra])
if __name__ == "__main__":
unittest.main()
|
