tests: bubble up obx_remove_db_files, properly cleaning DB before/after tests #33

Author: loryruta

objectbox/c.py

@@ -440,6 +440,9 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 # obx_err (OBX_store* store);
 obx_store_close = c_fn_rc('obx_store_close', [OBX_store_p])
 
+# obx_err obx_remove_db_files(const const* directory);
+obx_remove_db_files = c_fn_rc('obx_remove_db_files', [ctypes.c_char_p])  # TODO provide a python wrapper
+
 # OBX_txn* (OBX_store* store);
 obx_txn_write = c_fn('obx_txn_write', OBX_txn_p, [OBX_store_p])
 

tests/common.py

@@ -7,23 +7,9 @@
 from typing import *
 from tests.model import *
 
-
 test_dir = 'testdata'
 
 
-def remove_test_dir():
-    if os.path.exists(test_dir):
-        shutil.rmtree(test_dir)
-
-
-# cleanup before and after each testcase
-@pytest.fixture(autouse=True)
-def autocleanup():
-    remove_test_dir()
-    yield  # run the test function
-    remove_test_dir()
-
-
 def load_empty_test_objectbox(db_name: str = test_dir) -> objectbox.ObjectBox:
     model = objectbox.Model()
     model.entity(TestEntity, last_property_id=IdUid(27, 1027))
@@ -32,6 +18,7 @@ def load_empty_test_objectbox(db_name: str = test_dir) -> objectbox.ObjectBox:
 
     return objectbox.Builder().model(model).directory(db_name).build()
 
+
 def load_empty_test_datetime(name: str = "") -> objectbox.ObjectBox:
     model = objectbox.Model()
     model.entity(TestEntityDatetime, last_property_id=IdUid(4, 2004))
@@ -76,15 +63,18 @@ def assert_equal_prop(actual, expected, default):
     assert actual == expected or (isinstance(
         expected, objectbox.model.Property) and actual == default)
 
+
 def assert_equal_prop_vector(actual, expected, default):
     assert (actual == np.array(expected)).all() or (isinstance(
         expected, objectbox.model.Property) and actual == default)
 
+
 # compare approx values
 def assert_equal_prop_approx(actual, expected, default):
     assert pytest.approx(actual) == expected or (isinstance(
         expected, objectbox.model.Property) and actual == default)
 
+
 def assert_equal(actual: TestEntity, expected: TestEntity):
     """Check that two TestEntity objects have the same property data"""
     assert actual.id == expected.id

tests/conftest.py

@@ -0,0 +1,21 @@
+import pytest
+from objectbox.logger import logger
+from common import *
+
+
+# Fixtures in this file are used by all files in the same directory:
+# https://docs.pytest.org/en/7.1.x/reference/fixtures.html#conftest-py-sharing-fixtures-across-multiple-files
+
+
+def _clear_test_db():
+    obx_remove_db_files(c_str(test_dir))
+
+
+@pytest.fixture(autouse=True)
+def cleanup_db():
+    """ Fixture to ensure tests starts fresh and the DB is cleaned up on success/failure. """
+    _clear_test_db()
+    try:
+        yield  # Run the test code
+    finally:
+        _clear_test_db()

tests/test_box.py

@@ -1,13 +1,7 @@
 import pytest
 import objectbox
 from tests.model import TestEntity, TestEntityDatetime, TestEntityFlex
-from tests.common import (
-    autocleanup,
-    load_empty_test_objectbox,
-    load_empty_test_datetime,
-    load_empty_test_flex,
-    assert_equal,
-)
+from tests.common import *
 import numpy as np
 from datetime import datetime
 import time

tests/test_index.py

@@ -3,10 +3,7 @@
 from objectbox.model.properties import IndexType
 import pytest
 from tests.model import TestEntity
-from tests.common import (
-    autocleanup,
-    load_empty_test_objectbox,
-)
+from tests.common import *
 
 
 # TODO tests disabled because Python indices API changed, now they actually interact with the C API

tests/test_inmemory.py

@@ -4,10 +4,11 @@
 import os.path
 import shutil
 
+
 def test_inmemory():
     # Expect path for persistent store
     db_name = "testdata_persistent"
-    ob = load_empty_test_objectbox(db_name) 
+    ob = load_empty_test_objectbox(db_name)
     box = objectbox.Box(ob, TestEntity)
     object = TestEntity()
     id = box.put(object)
@@ -20,7 +21,7 @@ def test_inmemory():
 
     # Expect no path for in-memory store
     db_name = "memory:testdata"
-    ob = load_empty_test_objectbox(db_name) 
+    ob = load_empty_test_objectbox(db_name)
     box = objectbox.Box(ob, TestEntity)
     object = TestEntity()
     id = box.put(object)

tests/test_query.py

@@ -4,7 +4,7 @@
 from objectbox.c import *
 from objectbox.query import *
 import pytest
-from tests.common import (load_empty_test_objectbox, create_test_objectbox, autocleanup)
+from tests.common import *
 from tests.model import *
 
 

tests/test_transactions.py

@@ -1,6 +1,6 @@
 import objectbox
 from tests.model import TestEntity
-from tests.common import autocleanup, load_empty_test_objectbox
+from tests.common import *
 
 
 def test_transactions():