test: close store after tests (add test_store fixture) #59

Author: loryruta

tests/conftest.py

@@ -12,3 +12,10 @@ def cleanup_db():
     # Not needed: every test clears the DB on start, without deleting it on exit (not necessary)
     # Also, here we have no information regarding the DB path being used (although usually is "testdata")
     pass
+
+
+@pytest.fixture
+def test_store():
+    store = create_test_store()
+    yield store
+    store.close()

tests/test_basics.py

@@ -30,4 +30,5 @@ def test_version():
 
 
 def test_open():
-    create_test_store()
+    store = create_test_store()
+    store.close()

tests/test_box.py

@@ -8,9 +8,8 @@
 from math import floor
 
 
-def test_box_basics():
-    store = create_test_store()
-    box = store.box(TestEntity)
+def test_box_basics(test_store):
+    box = test_store.box(TestEntity)
 
     assert box.is_empty()
     assert box.count() == 0
@@ -94,12 +93,9 @@ def test_box_basics():
     assert box.get(object.id) is None
     assert box.get(1) is None
 
-    store.close()
 
-
-def test_box_bulk():
-    store = create_test_store()
-    box = store.box(TestEntity)
+def test_box_bulk(test_store):
+    box = test_store.box(TestEntity)
 
     box.put(TestEntity(str="first"))
 
@@ -130,12 +126,9 @@ def test_box_bulk():
     assert removed == 4
     assert box.count() == 0
 
-    store.close()
-
 
-def test_datetime():
-    store = create_test_store()
-    box = store.box(TestEntityDatetime)
+def test_datetime(test_store):
+    box = test_store.box(TestEntityDatetime)
 
     assert box.is_empty()
     assert box.count() == 0
@@ -185,12 +178,9 @@ def test_datetime():
     assert box.get(object.id) is None
     assert box.get(1) is None
 
-    store.close()
-
 
-def test_datetime_special_values():
-    store = create_test_store()
-    box = store.box(TestEntityDatetime)
+def test_datetime_special_values(test_store):
+    box = test_store.box(TestEntityDatetime)
     assert box.is_empty()
 
     object = TestEntityDatetime()
@@ -216,16 +206,15 @@ def test_datetime_special_values():
     assert read.date_nano == datetime.fromtimestamp(1.0, timezone.utc)
 
 
-def test_flex():
+def test_flex(test_store):
     def test_put_get(object: TestEntity, box: objectbox.Box, property):
         object.flex = property
         id = box.put(object)
         assert id == object.id
         read = box.get(object.id)
         assert read.flex == object.flex
 
-    store = create_test_store()
-    box = store.box(TestEntity)
+    box = test_store.box(TestEntity)
     object = TestEntity()
 
     # Put an empty object
@@ -262,13 +251,9 @@ def test_put_get(object: TestEntity, box: objectbox.Box, property):
     # Update to list inside dict
     test_put_get(object, box, {"a": 1, "b": [1, 2, 3]})
 
-    store.close()
-
-
-def test_flex_values():
-    store = create_test_store()
 
-    box = store.box(TestEntityFlex)
+def test_flex_values(test_store):
+    box = test_store.box(TestEntityFlex)
 
     # Test empty object
     obj_id = box.put(TestEntityFlex())

tests/test_deprecated.py

@@ -20,6 +20,7 @@ def test_deprecated_ObjectBox():
         ob = ObjectBox(c_store)
     box = objectbox.Box(ob, TestEntity)
     assert box.count() == 0
+    ob.close()  # TODO The store shall be closed even if the test fails
 
 
 def test_deprecated_Builder():
@@ -29,3 +30,4 @@ def test_deprecated_Builder():
     model = tests.common.create_default_model()
     with pytest.deprecated_call():
         ob = objectbox.Builder().model(model).directory("testdata").build()
+    ob.close()

tests/test_hnsw.py

@@ -34,10 +34,10 @@ def _test_random_points(
 
     points = np.random.rand(num_points, 2).astype(np.float32)
 
-    store = create_test_store()
+    test_store = create_test_store()
 
     # Init and seed DB
-    box = store.box(VectorEntity)
+    box = test_store.box(VectorEntity)
 
     print(f"Seeding DB with {num_points} points...")
     objects = []
@@ -77,6 +77,8 @@ def _test_random_points(
 
     print(f"Done!")
 
+    test_store.close()
+
 
 def test_random_points():
 
@@ -89,14 +91,8 @@ def test_random_points():
     _test_random_points(num_points=100, num_query_points=10, seed=14, distance_type=distance_type, min_score=min_score)
     _test_random_points(num_points=100, num_query_points=10, seed=15, distance_type=distance_type, min_score=min_score)
 
-    # TODO: Cosine and Dot Product may result in 0 score
-
-
-def _test_combined_nn_search(distance_type: VectorDistanceType = VectorDistanceType.EUCLIDEAN):
-
-    store = create_test_store()
-
-    box = store.box(VectorEntity)
+def _test_combined_nn_search(test_store: Store, distance_type: VectorDistanceType = VectorDistanceType.EUCLIDEAN):
+    box = test_store.box(VectorEntity)
 
     vector_field_name = "vector_"+distance_type.name.lower()
 
@@ -203,8 +199,8 @@ def _test_combined_nn_search(distance_type: VectorDistanceType = VectorDistanceT
     assert len(numpy_result) == 0
 
 
-def test_combined_nn_search():
+def test_combined_nn_search(test_store):
     """ Tests NN search combined with regular query conditions, offset and limit. """
     distance_type = VectorDistanceType.EUCLIDEAN
-    _test_combined_nn_search(distance_type)
+    _test_combined_nn_search(test_store, distance_type)
     # TODO: Cosine, DotProduct  diverges see below

tests/test_idsync.py

@@ -21,21 +21,29 @@ def __init__(self):
         self.model_path = 'test.json'
         if path.exists(self.model_path):
             os.remove(self.model_path)
-        self.model = None
+        self._model = None
         self.db_path = 'testdb'
         Store.remove_db_files(self.db_path)
+        self._store = None  # Last created store
 
     def sync(self, model: Model) -> bool:
         """ Returns True if changes were made and the model JSON was written. """
-        self.model = model
-        return sync_model(self.model, self.model_path)
+        self._model = model
+        return sync_model(self._model, self.model_path)
 
     def json(self):
         return json.load(open(self.model_path))
 
-    def store(self):
-        assert self.model is not None
-        return Store(model=self.model, directory=self.db_path)
+    def create_store(self):
+        assert self._model is not None, "Model must be set before creating store"
+        if self._store is not None:
+            self._store.close()
+        self._store = Store(model=self._model, directory=self.db_path)
+        return self._store
+
+    def close(self):
+        if self._store is not None:
+            self._store.close()
 
 
 def reset_ids(entity: _Entity):
@@ -48,7 +56,9 @@ def reset_ids(entity: _Entity):
 
 @pytest.fixture
 def env():
-    return _TestEnv()
+    env_ = _TestEnv()
+    yield env_
+    env_.close()
 
 
 def test_empty_model(env):
@@ -136,13 +146,11 @@ class MyEntity:
     entity_ids = str(MyEntity._iduid)
 
     # create new database and populate with two objects
-    store = env.store()
+    store = env.create_store()
     entityBox = store.box(MyEntity)
     entityBox.put(MyEntity(name="foo"),MyEntity(name="bar"))
     assert entityBox.count() == 2
     del entityBox
-    store.close()
-    del store
 
     # recreate model using existing model json and open existing database 
     model = Model()
@@ -156,7 +164,7 @@ class MyEntity:
     assert str(model.entities[0]._iduid) == entity_ids
 
     # open existing database 
-    store = env.store()
+    store = env.create_store()
     entityBox = store.box(MyEntity)
     assert entityBox.count() == 2
 
@@ -169,12 +177,10 @@ class MyEntity1:
     model.entity(MyEntity1)
     env.sync(model)
     e0_iduid = IdUid(MyEntity1._id, MyEntity1._uid)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity1)
     box.put( MyEntity1(name="foo"), MyEntity1(name="bar"))
     assert box.count() == 2
-    store.close()
-    del store
 
     @Entity()
     class MyEntity2:
@@ -188,7 +194,7 @@ class MyEntity2:
     assert str(model.entities[0]._iduid) == "0:0"
     env.sync(model)
     assert model.entities[0]._iduid == e0_iduid
-    store = env.store()
+    store = env.create_store()
     box1 = store.box(MyEntity1)
     assert box1.count() == 2
     box2 = store.box(MyEntity2)
@@ -209,24 +215,21 @@ class MyEntity2:
     model.entity(MyEntity1)
     model.entity(MyEntity2)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box1 = store.box(MyEntity1)
     box1.put( MyEntity1(name="foo"), MyEntity1(name="bar"))
     box2 = store.box(MyEntity2)
     box2.put( MyEntity2(name="foo"), MyEntity2(name="bar"))
     assert box1.count() == 2
     assert box2.count() == 2
 
-    store.close()
-    del store
-
     # Re-create a model without MyEntity2 
 
     model = Model()
     reset_ids(MyEntity1)
     model.entity(MyEntity1)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box1 = store.box(MyEntity1)
     assert box1.count() == 2
 
@@ -248,13 +251,11 @@ class MyEntity:
     assert uid != 0
     # Debug: print("UID: "+ str(uid))
 
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity)
     box.put(MyEntity(name="foo"),MyEntity(name="bar"))
     assert box.count() == 2
     del box
-    store.close()
-    del store
 
     @Entity(uid=uid)
     class MyRenamedEntity:
@@ -264,7 +265,7 @@ class MyRenamedEntity:
     model = Model()
     model.entity(MyRenamedEntity)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyRenamedEntity)
     assert box.count() == 2
 
@@ -316,12 +317,10 @@ class MyEntity:
     model = Model()
     model.entity(MyEntity)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity)
     box.put( MyEntity(name="foo"), MyEntity(name="bar"))
     del box
-    store.close()
-    del store
 
     @Entity()
     class MyEntity:
@@ -332,7 +331,7 @@ class MyEntity:
     model = Model()
     model.entity(MyEntity)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity)
 
     assert box.count() == 2
@@ -348,12 +347,10 @@ class MyEntity:
     model = Model()
     model.entity(MyEntity)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity)
     box.put( MyEntity(name="foo"), MyEntity(name="bar"))
     del box
-    store.close()
-    del store
 
     @Entity()
     class MyEntity:
@@ -363,7 +360,7 @@ class MyEntity:
     model = Model()
     model.entity(MyEntity)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(MyEntity)
     assert box.count() == 2
 
@@ -377,7 +374,7 @@ class EntityA:
     model = Model()
     model.entity(EntityA)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
     box = store.box(EntityA)
     box.put(EntityA(name="Luca"))
     assert box.count() == 1
@@ -390,8 +387,6 @@ class EntityA:
     print(f"Entity.name ID/UID: {name.iduid}")
 
     del box  # Close store
-    store.close()
-    del store
 
     # *** Rename ***
 
@@ -403,7 +398,7 @@ class EntityA:
     model = Model()
     model.entity(EntityA)
     env.sync(model)
-    store = env.store()
+    store = env.create_store()
 
     # Check ID/UID(s) are preserved after renaming
     entity2_iduid = EntityA._iduid