[BCF] New BCF XML handler with better performances (#2355)

BREAKING CHANGE: incompatible methods and objects with previous version.

closes #2321

src/bcf/tests/v3/test_bcf_xml.py

@@ -0,0 +1,129 @@
+"""BCF XML tests."""
+import uuid
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+import pytest
+
+import bcf.v3.model as mdl
+from bcf.v3.bcfxml import BcfXml
+from bcf.v3.topic import TopicHandler
+from bcf.v3.visinfo import (
+    VisualizationInfoHandler,
+    build_camera_from_vectors,
+    build_components,
+)
+from bcf.xml_parser import XmlParserSerializer
+
+
+@pytest.fixture()
+def build_sample(xml_handler: XmlParserSerializer) -> tuple[BcfXml, TopicHandler]:
+    ext = mdl.Extensions(topic_types=mdl.ExtensionsTopicTypes(topic_type=["Test type"]))
+    bcf = BcfXml.create_new("Test project", extensions=ext, xml_handler=xml_handler)
+    orig_th = bcf.add_topic("Test topic", "Test message", "Test author", "Test type")
+    return bcf, orig_th
+
+
+def test_bcf_roundtrip(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            assert parsed == bcf
+            parsed_th = parsed.topics[orig_th.guid]
+            assert parsed_th == orig_th
+
+
+def test_bcf_edit_saveas(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            modified_path = Path(tmp_dir) / "edited.bcf"
+            parsed.save(modified_path)
+            with BcfXml.load(modified_path, xml_handler=xml_handler) as modified_parsed:
+                assert modified_parsed == bcf
+                parsed_th = modified_parsed.topics[orig_th.guid]
+                assert parsed_th.markup != orig_th.markup
+                assert parsed_th.markup == parsed.topics[orig_th.guid].markup
+                assert parsed_th.viewpoints == orig_th.viewpoints
+                assert parsed_th.bim_snippet == orig_th.bim_snippet
+
+
+def test_bcf_edit(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            parsed.save()
+            with BcfXml.load(file_path, xml_handler=xml_handler) as modified_parsed:
+                assert modified_parsed == bcf
+                assert len(modified_parsed.topics) == 1
+                parsed_th = modified_parsed.topics[orig_th.guid]
+                assert parsed_th.markup != orig_th.markup
+                assert parsed_th.markup == parsed.topics[orig_th.guid].markup
+                assert parsed_th.viewpoints == orig_th.viewpoints
+                assert parsed_th.bim_snippet == orig_th.bim_snippet
+
+
+def test_save_no_filename(build_sample) -> None:
+    bcf, _ = build_sample
+    with pytest.raises(ValueError):
+        bcf.save()
+
+
+def test_load_no_filename() -> None:
+    with pytest.raises(ValueError):
+        BcfXml.load("")
+
+
+def test_save_keep_open(build_sample) -> None:
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path, keep_open=True)
+        assert bcf._zip_file is not None
+        bcf._zip_file.close()
+
+
+# image = PIL.Image.new('RGB', size=(100, 100))
+# file = BinaryIO()
+# image.save(file)
+
+
+def test_massive_bcf(xml_handler) -> None:
+    ext = mdl.Extensions(topic_types=mdl.ExtensionsTopicTypes(topic_type=["Test type"]))
+    bcf = BcfXml.create_new("Test project", extensions=ext, xml_handler=xml_handler)
+    for i in range(100):
+        th = bcf.add_topic(f"Topic {i:04}", f"Message {i:04}", "Test author", "Test type")
+        vi = mdl.VisualizationInfo(
+            guid=str(uuid.uuid4()),
+            components=build_components(str(uuid.uuid4())),
+            perspective_camera=build_camera_from_vectors([i, 0, 0], [0, 1, 0], [0, 0, 1]),
+        )
+        vh = VisualizationInfoHandler(visualization_info=vi, xml_handler=xml_handler)
+        th.add_visinfo_handler(vh)
+    assert len(bcf.topics) == 100
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+
+
+def test_equality_with_wrong_object() -> None:
+    with pytest.raises(TypeError):
+        build_sample[0] == "Wrong object"
+
+
+def test_topic_equality_with_wrong_object() -> None:
+    with pytest.raises(TypeError):
+        build_sample[1] == "Wrong object"