Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[BUG/CLN] Move verify function to the test package
  • Loading branch information
Leguark committed May 25, 2025
commit e19a3a5e93ccda1da28c3fa122fe9212edae267e
46 changes: 0 additions & 46 deletions gempy/modules/serialization/save_load.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import re

from typing import Literal

import warnings

from ...core.data import GeoModel
Expand Down Expand Up @@ -159,47 +157,3 @@ def _validate_serialization(original_model, model_deserialized):
assert deserialized___str__ == original_model___str__


def verify_model_serialization(model: GeoModel, verify_moment: Literal["before", "after"], file_name: str):
"""
Verifies the serialization and deserialization process of a GeoModel instance
by ensuring the serialized JSON and binary data match during either the
initial or post-process phase, based on the specified verification moment.

Args:
model: The GeoModel instance to be verified.
verify_moment: A literal value specifying whether to verify the model
before or after the deserialization process. Accepts "before"
or "after" as valid inputs.
file_name: The filename to associate with the verification process for
logging or output purposes.

Raises:
ValueError: If `verify_moment` is not set to "before" or "after".
"""
model_json = model.model_dump_json(by_alias=True, indent=4)

# Compress the binary data
zlib = require_zlib()
compressed_binary = zlib.compress(model.structural_frame.input_tables_binary)

binary_file = _to_binary(model_json, compressed_binary)


original_model = model
original_model.meta.creation_date = "<DATE_IGNORED>"

from verify_helper import verify_json
if verify_moment == "before":
verify_json(
item=original_model.model_dump_json(by_alias=True, indent=4),
name=file_name
)
elif verify_moment == "after":
model_deserialized = _deserialize_binary_file(binary_file)
model_deserialized.meta.creation_date = "<DATE_IGNORED>"
verify_json(
item=model_deserialized.model_dump_json(by_alias=True, indent=4),
name=file_name
)
else:
raise ValueError("Invalid model parameter")
2 changes: 1 addition & 1 deletion test/test_modules/_geophysics_TO_UPDATE/test_gravity.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Importing auxiliary libraries
import numpy as np

from gempy.modules.serialization.save_load import verify_model_serialization
from test.verify_helper import verify_model_serialization


def test_gravity():
Expand Down
2 changes: 1 addition & 1 deletion test/test_modules/test_faults/test_finite_faults.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import gempy as gp
import gempy_viewer as gpv
from gempy.core.data.enumerators import ExampleModel
from gempy.modules.serialization.save_load import verify_model_serialization
from test.verify_helper import verify_model_serialization
from gempy_viewer.optional_dependencies import require_pyvista
from test.conftest import TEST_SPEED, TestSpeed

Expand Down
2 changes: 1 addition & 1 deletion test/test_modules/test_grids/test_custom_grid.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import numpy as np
import pytest

from gempy.modules.serialization.save_load import verify_model_serialization
from test.verify_helper import verify_model_serialization
from test.conftest import TEST_SPEED, TestSpeed
import gempy as gp
from gempy.core.data.enumerators import ExampleModel
Expand Down
2 changes: 1 addition & 1 deletion test/test_modules/test_grids/test_grids_sections.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import gempy as gp
import gempy_viewer as gpv
from gempy.core.data.enumerators import ExampleModel
from gempy.modules.serialization.save_load import verify_model_serialization
from test.verify_helper import verify_model_serialization

from test.conftest import TEST_SPEED, TestSpeed

Expand Down
53 changes: 52 additions & 1 deletion test/verify_helper.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from typing import Literal

import subprocess

import numpy as np
Expand All @@ -8,6 +10,10 @@
from approvaltests.namer import NamerFactory
from approvaltests.reporters import GenericDiffReporter, GenericDiffReporterConfig

from gempy.core.data import GeoModel
from gempy.modules.serialization.save_load import _to_binary, _deserialize_binary_file
from gempy.optional_dependencies import require_zlib


class WSLWindowsDiffReporter(GenericDiffReporter):
def get_command(self, received, approved):
Expand Down Expand Up @@ -94,4 +100,49 @@ def get_default_extension(self) -> str:

def write(self, received, received_path: str) -> None:
with open(received_path, "w", encoding="utf-8") as f:
json.dump(received, f, indent=2, ensure_ascii=False)
json.dump(received, f, indent=2, ensure_ascii=False)


def verify_model_serialization(model: GeoModel, verify_moment: Literal["before", "after"], file_name: str):
"""
Verifies the serialization and deserialization process of a GeoModel instance
by ensuring the serialized JSON and binary data match during either the
initial or post-process phase, based on the specified verification moment.

Args:
model: The GeoModel instance to be verified.
verify_moment: A literal value specifying whether to verify the model
before or after the deserialization process. Accepts "before"
or "after" as valid inputs.
file_name: The filename to associate with the verification process for
logging or output purposes.

Raises:
ValueError: If `verify_moment` is not set to "before" or "after".
"""
model_json = model.model_dump_json(by_alias=True, indent=4)

# Compress the binary data
zlib = require_zlib()
compressed_binary = zlib.compress(model.structural_frame.input_tables_binary)

binary_file = _to_binary(model_json, compressed_binary)


original_model = model
original_model.meta.creation_date = "<DATE_IGNORED>"

if verify_moment == "before":
verify_json(
item=original_model.model_dump_json(by_alias=True, indent=4),
name=file_name
)
elif verify_moment == "after":
model_deserialized = _deserialize_binary_file(binary_file)
model_deserialized.meta.creation_date = "<DATE_IGNORED>"
verify_json(
item=model_deserialized.model_dump_json(by_alias=True, indent=4),
name=file_name
)
else:
raise ValueError("Invalid model parameter")