intersect-sdk 0.8.3__tar.gz → 0.8.4__tar.gz

{intersect_sdk-0.8.3 → intersect_sdk-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: intersect-sdk
-Version: 0.8.3
+Version: 0.8.4
 Summary: Python SDK to interact with INTERSECT
 Keywords: intersect
 Author-Email: Lance Drane <dranelt@ornl.gov>, Marshall McDonnell <mcdonnellmt@ornl.gov>, Seth Hitefield <hitefieldsd@ornl.gov>, Andrew Ayres <ayresaf@ornl.gov>, Gregory Cage <cagege@ornl.gov>, Jesse McGaha <mcgahajr@ornl.gov>, Robert Smith <smithrw@ornl.gov>, Gavin Wiggins <wigginsg@ornl.gov>, Michael Brim <brimmj@ornl.gov>, Rick Archibald <archibaldrk@ornl.gov>, Addi Malviya Thakur <malviyaa@ornl.gov>

{intersect_sdk-0.8.3 → intersect_sdk-0.8.4}/pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "jsonschema[format-nongpl]>=4.21.1",
     "eval-type-backport>=0.1.3;python_version<'3.10'",
 ]
-version = "0.8.3"
+version = "0.8.4"
 
 [project.license]
 text = "BSD-3-Clause"

{intersect_sdk-0.8.3 → intersect_sdk-0.8.4}/src/intersect_sdk/_internal/schema.py

@@ -594,7 +594,7 @@ def get_schema_and_functions_from_capability_implementations(
             'messageTraits': {
                 # this is where we can define our message headers
                 'commonHeaders': {
-                    'messageHeaders': TypeAdapter(UserspaceMessageHeader).json_schema(
+                    'userspaceHeaders': TypeAdapter(UserspaceMessageHeader).json_schema(
                         ref_template='#/components/messageTraits/commonHeaders/userspaceHeaders/$defs/{model}',
                         mode='serialization',
                     ),

{intersect_sdk-0.8.3 → intersect_sdk-0.8.4}/src/intersect_sdk/version.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 from ._internal.version import strip_version_metadata
 
 # may include build metadata
-__version__ = '0.8.3'
+__version__ = '0.8.4'
 
 version_string = strip_version_metadata(__version__)
 """

{intersect_sdk-0.8.3 → intersect_sdk-0.8.4}/tests/fixtures/example_schema.json

@@ -1,6 +1,6 @@
 {
   "asyncapi": "2.6.0",
-  "x-intersect-version": "0.8.3",
+  "x-intersect-version": "0.8.4",
   "info": {
     "title": "test.test.test.test.test",
     "description": "INTERSECT schema",
@@ -943,7 +943,7 @@
     },
     "messageTraits": {
       "commonHeaders": {
-        "messageHeaders": {
+        "userspaceHeaders": {
           "$defs": {
             "IntersectDataHandler": {
               "description": "What data transfer type do you want to use for handling the request/response?\n\nDefault: MESSAGE",

intersect_sdk-0.8.4/tests/unit/test_schema_ref_resolution.py

@@ -0,0 +1,55 @@
+import json
+from pathlib import Path
+from typing import Iterable, List
+
+from referencing import Registry, Resource
+from referencing.exceptions import Unresolvable
+from referencing.jsonschema import DRAFT202012
+
+from intersect_sdk.schema import get_schema_from_capability_implementations
+from tests.fixtures.example_schema import FAKE_HIERARCHY_CONFIG, DummyCapabilityImplementation
+
+
+def get_fixture_path(fixture: str) -> Path:
+    return Path(__file__).absolute().parents[1] / 'fixtures' / fixture
+
+
+def iter_ref_values(schema: object) -> Iterable[str]:
+    if isinstance(schema, dict):
+        for key, value in schema.items():
+            if key == '$ref' and isinstance(value, str):
+                yield value
+            else:
+                yield from iter_ref_values(value)
+    elif isinstance(schema, list):
+        for item in schema:
+            yield from iter_ref_values(item)
+
+
+def assert_refs_resolve(schema: dict) -> None:
+    resource = Resource.from_contents(schema, default_specification=DRAFT202012)
+    base_uri = ''
+    resolver = Registry().with_resource(base_uri, resource).resolver(base_uri)
+    unresolved: List[str] = []
+    for ref in iter_ref_values(schema):
+        try:
+            resolver.lookup(ref)
+        except Unresolvable:
+            unresolved.append(ref)
+    assert not unresolved, f'Unresolved $ref entries: {sorted(set(unresolved))}'
+
+
+def test_fixture_schema_refs_resolve() -> None:
+    """Verifies that the generated JSON schema contains valid $ref entries."""
+    with Path.open(get_fixture_path('example_schema.json'), 'rb') as f:
+        schema = json.load(f)
+    assert_refs_resolve(schema)
+
+
+def test_generated_schema_refs_resolve() -> None:
+    """Assert that the INTERSECT-SDK can generate a schema with valid $ref entries."""
+    schema = get_schema_from_capability_implementations(
+        [DummyCapabilityImplementation],
+        FAKE_HIERARCHY_CONFIG,
+    )
+    assert_refs_resolve(schema)