♻️Fix settings library tests (#6605)

Author: sanderegg

packages/common-library/requirements/_base.in

@@ -3,4 +3,6 @@
 #
 --constraint ../../../requirements/constraints.txt
 
+orjson
 pydantic
+pydantic-extra-types

packages/common-library/requirements/_base.txt

@@ -1,11 +1,18 @@
 annotated-types==0.7.0
     # via pydantic
+orjson==3.10.10
+    # via
+    #   -c requirements/../../../requirements/constraints.txt
+    #   -r requirements/_base.in
 pydantic==2.9.2
     # via
     #   -c requirements/../../../requirements/constraints.txt
     #   -r requirements/_base.in
+    #   pydantic-extra-types
 pydantic-core==2.23.4
     # via pydantic
+pydantic-extra-types==2.9.0
+    # via -r requirements/_base.in
 typing-extensions==4.12.2
     # via
     #   pydantic

packages/models-library/src/models_library/utils/json_serialization.py renamed to packages/common-library/src/common_library/json_serialization.py

@@ -0,0 +1,97 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
+import json
+from copy import deepcopy
+from typing import Annotated, Any, TypeAlias
+from uuid import uuid4
+
+import pytest
+from common_library.json_serialization import (
+    JsonNamespace,
+    SeparatorTuple,
+    json_dumps,
+    json_loads,
+)
+from faker import Faker
+from pydantic import Field, TypeAdapter
+from pydantic.json import pydantic_encoder
+
+
+@pytest.fixture
+def fake_data_dict(faker: Faker) -> dict[str, Any]:
+    data = {
+        "uuid_as_UUID": faker.uuid4(cast_to=None),
+        "uuid_as_str": faker.uuid4(),
+        "int": faker.pyint(),
+        "float": faker.pyfloat(),
+        "str": faker.pystr(),
+        "dict": faker.pydict(),
+        "list": faker.pylist(),
+    }
+    data["object"] = deepcopy(data)
+    return data
+
+
+def test_json_dump_variants():
+
+    uuid_obj = uuid4()
+
+    with pytest.raises(TypeError) as exc_info:
+        json.dumps(uuid_obj)
+
+    assert str(exc_info.value) == "Object of type UUID is not JSON serializable"
+
+    assert json_dumps(uuid_obj) == json.dumps(str(uuid_obj))
+
+
+def test_serialized_non_str_dict_keys():
+    # tests orjson.OPT_NON_STR_KEYS option
+
+    # if a dict has a key of a type other than str it will NOT raise
+    json_dumps({1: "foo"})
+
+
+ConstrainedFloat: TypeAlias = Annotated[float, Field(ge=0.0, le=1.0)]
+
+
+def test_serialized_constraint_floats():
+    # test extension of ENCODERS_BY_TYPE used in pydantic_encoder
+
+    json_dumps({"value": 1.0})
+
+    # TypeError: Type is not JSON serializable: ProgressPercent
+    json_dumps({"value": TypeAdapter(ConstrainedFloat).validate_python(1.0)})
+
+
+def _expected_json_dumps(obj: Any, default=pydantic_encoder, **json_dumps_kwargs):
+    if "indent" not in json_dumps_kwargs:
+        json_dumps_kwargs.setdefault(
+            "separators",
+            SeparatorTuple(item_separator=",", key_separator=":"),  # compact separators
+        )
+    return json.dumps(obj, default=default, **json_dumps_kwargs)
+
+
+@pytest.mark.parametrize(
+    "kwargs",
+    [
+        pytest.param({}, id="no-kw"),
+        pytest.param({"sort_keys": True}, id="sort_keys-kw"),
+        pytest.param(
+            {"separators": (",", ":")}, id="default_separators-kw"
+        ),  # NOTE: e.g. engineio.packet has `self.json.dumps(self.data, separators=(',', ':'))`
+        pytest.param(
+            {"indent": 2}, id="indent-kw"
+        ),  # NOTE: only one-to-one with indent=2
+    ],
+)
+def test_compatiblity_with_json_interface(
+    fake_data_dict: dict[str, Any], kwargs: dict[str, Any]
+):
+    orjson_dump = JsonNamespace.dumps(fake_data_dict, **kwargs)
+    json_dump = _expected_json_dumps(fake_data_dict, **kwargs)
+
+    # NOTE: cannot compare dumps directly because orjson compacts it more
+    assert json_loads(orjson_dump) == json_loads(json_dump)

packages/common-library/tests/test_json_serialization.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 from typing import Any, Literal, TypeAlias
 
+from common_library.json_serialization import json_dumps
 from pydantic import (
     BaseModel,
     ByteSize,
@@ -23,7 +24,6 @@
 from .generics import ListModel
 from .service_settings_nat_rule import NATRule
 from .services_resources import DEFAULT_SINGLE_SERVICE_NAME
-from .utils.json_serialization import json_dumps
 
 _BaseConfig = ConfigDict(
     extra="forbid", arbitrary_types_allowed=True, ignored_types=(cached_property,)

packages/models-library/src/models_library/service_settings_labels.py

@@ -10,7 +10,7 @@
 from types import GeneratorType
 from typing import Any, Callable, Union
 
-from models_library.utils.json_serialization import ENCODERS_BY_TYPE
+from common_library.json_serialization import ENCODERS_BY_TYPE
 from pydantic import BaseModel
 from pydantic_core import PydanticUndefined, PydanticUndefinedType
 from typing_extensions import Annotated, Doc

packages/models-library/src/models_library/utils/_original_fastapi_encoders.py

@@ -8,7 +8,7 @@
 from json.decoder import JSONDecodeError
 from typing import Any, TypeAlias
 
-from .json_serialization import json_dumps
+from common_library.json_serialization import json_dumps
 
 LabelsAnnotationsDict: TypeAlias = dict[str, str]
 

packages/models-library/src/models_library/utils/labels_annotations.py

@@ -1,10 +1,9 @@
 from typing import Any, NamedTuple, TypeAlias, cast
 
 from common_library.errors_classes import OsparcErrorMixin
-
+from common_library.json_serialization import json_dumps, json_loads
 from pydantic import StrictBool, StrictFloat, StrictInt
 
-from .json_serialization import json_dumps, json_loads
 from .string_substitution import (
     SubstitutionsDict,
     TextTemplate,

packages/models-library/src/models_library/utils/specs_substitution.py

@@ -3,43 +3,14 @@
 # pylint: disable=unused-variable
 
 
-import json
 from copy import deepcopy
 from typing import Any
 from uuid import uuid4
 
 import pytest
+from common_library.json_serialization import json_dumps, json_loads
 from faker import Faker
-from models_library.api_schemas_long_running_tasks.base import ProgressPercent
 from models_library.utils.fastapi_encoders import jsonable_encoder
-from models_library.utils.json_serialization import (
-    JsonNamespace,
-    SeparatorTuple,
-    json_dumps,
-    json_loads,
-)
-from pydantic.json import pydantic_encoder
-
-
-def _expected_json_dumps(obj: Any, default=pydantic_encoder, **json_dumps_kwargs):
-    if "indent" not in json_dumps_kwargs:
-        json_dumps_kwargs.setdefault(
-            "separators",
-            SeparatorTuple(item_separator=",", key_separator=":"),  # compact separators
-        )
-    return json.dumps(obj, default=default, **json_dumps_kwargs)
-
-
-def test_json_dump_variants():
-
-    uuid_obj = uuid4()
-
-    with pytest.raises(TypeError) as exc_info:
-        json.dumps(uuid_obj)
-
-    assert str(exc_info.value) == "Object of type UUID is not JSON serializable"
-
-    assert json_dumps(uuid_obj) == json.dumps(str(uuid_obj))
 
 
 @pytest.fixture
@@ -75,42 +46,3 @@ def test_serialization_of_nested_dicts(fake_data_dict: dict[str, Any]):
 
     dump = json_dumps(obj)
     assert json_loads(dump) == jsonable_encoder(obj)
-
-
-@pytest.mark.parametrize(
-    "kwargs",
-    [
-        pytest.param({}, id="no-kw"),
-        pytest.param({"sort_keys": True}, id="sort_keys-kw"),
-        pytest.param(
-            {"separators": (",", ":")}, id="default_separators-kw"
-        ),  # NOTE: e.g. engineio.packet has `self.json.dumps(self.data, separators=(',', ':'))`
-        pytest.param(
-            {"indent": 2}, id="indent-kw"
-        ),  # NOTE: only one-to-one with indent=2
-    ],
-)
-def test_compatiblity_with_json_interface(
-    fake_data_dict: dict[str, Any], kwargs: dict[str, Any]
-):
-    orjson_dump = JsonNamespace.dumps(fake_data_dict, **kwargs)
-    json_dump = _expected_json_dumps(fake_data_dict, **kwargs)
-
-    # NOTE: cannot compare dumps directly because orjson compacts it more
-    assert json_loads(orjson_dump) == json_loads(json_dump)
-
-
-def test_serialized_non_str_dict_keys():
-    # tests orjson.OPT_NON_STR_KEYS option
-
-    # if a dict has a key of a type other than str it will NOT raise
-    json_dumps({1: "foo"})
-
-
-def test_serialized_constraint_floats():
-    # test extension of ENCODERS_BY_TYPE used in pydantic_encoder
-
-    json_dumps({"value": 1.0})
-
-    # TypeError: Type is not JSON serializable: ProgressPercent
-    json_dumps({"value": ProgressPercent(1.0)})

packages/models-library/tests/test_utils_json_serialization.py

@@ -1,8 +1,8 @@
 import base64
 from collections.abc import Sequence
 
+from common_library.json_serialization import json_dumps
 from models_library.docker import DockerGenericTag
-from models_library.utils.json_serialization import json_dumps
 from types_aiobotocore_ec2 import EC2Client
 from types_aiobotocore_ec2.literals import InstanceStateNameType, InstanceTypeType
 from types_aiobotocore_ec2.type_defs import FilterTypeDef, InstanceTypeDef, TagTypeDef