add check for spec_str

Author: David Andersson

open_alchemy/build/__init__.py

@@ -159,7 +159,16 @@ def calculate_version(*, spec: typing.Any, schemas: types.Schemas) -> TVersion:
 
 @dataclasses.dataclass
 class TSpecInfo:
-    """Information about the spec."""
+    """
+    Information about the spec.
+
+    Attrs:
+        version: Unique identifier for this instance.
+        spec_str: The string representation.
+        title: A name describing the spec.
+        description: More detailed summary of the spec.
+
+    """
 
     version: TVersion
     spec_str: TSpecStr
@@ -169,7 +178,7 @@ class TSpecInfo:
 
 def calculate_spec_info(*, schemas: types.Schemas, spec: typing.Any) -> TSpecInfo:
     """
-    Calculate the information about the spec.
+    Calculate information about the spec.
 
     Args:
         schemas: The schemas from the spec.

tests/open_alchemy/test_build.py

@@ -121,7 +121,7 @@ def test_generate_spec_str(schemas, version, title, description, expected_spec_s
 @pytest.mark.build
 def test_calculate_spec_info_version():
     """
-    GIVEN spec with version
+    GIVEN spec
     WHEN calculate_spec_info is called with the spec
     THEN the version is returned.
     """
@@ -133,6 +133,24 @@ def test_calculate_spec_info_version():
     assert spec_info.version == "63581fa2bdc5cef14183"
 
 
+@pytest.mark.build
+def test_calculate_spec_info_spec_str():
+    """
+    GIVEN spec
+    WHEN calculate_spec_info is called with the spec
+    THEN the string representation of it is returned.
+    """
+    spec = {}
+    schemas = {}
+
+    spec_info = build.calculate_spec_info(spec=spec, schemas=schemas)
+
+    assert (
+        spec_info.spec_str
+        == '{"info":{"version":"63581fa2bdc5cef14183"},"components":{"schemas":{}}}'
+    )
+
+
 @pytest.mark.parametrize(
     "info, expected_title",
     [