fix ref resolver. (#36)

* fix ref resolver.

Author: flask-pro

CHANGES.md

@@ -1,3 +1,7 @@
+## Version 0.19.1
+
+* Fix ref resolver.
+
 ## Version 0.19.0
 
 * Remake loading from yaml files.

pyproject.toml

@@ -23,7 +23,7 @@ license = {file = "LICENSE"}
 name = "Flask-First"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.19.0"
+version = "0.19.1"
 
 [project.optional-dependencies]
 dev = [

src/flask_first/first/loaders/yaml_loader.py

@@ -1,4 +1,5 @@
 from collections.abc import Hashable
+from copy import deepcopy
 from functools import reduce
 from pathlib import Path
 from typing import Any
@@ -25,25 +26,27 @@ def _yaml_to_dict(path: Path) -> dict:
             s = yaml.safe_load(f)
         return s
 
-    def add_file_to_store(self, ref: str) -> None:
-        try:
-            file_path, node_path = ref.split('#/')
-        except (AttributeError, ValueError):
-            raise FirstYAMLReaderError(f'"$ref" with value <{ref}> is not valid.')
+    def add_file_to_store(self, file_path: str) -> None:
+        path_to_spec_file = Path(self.path.parent, file_path)
 
-        if file_path and file_path not in self.store:
-            path_to_spec_file = Path(self.path.parent, file_path)
+        try:
+            self.store[file_path] = self._yaml_to_dict(path_to_spec_file)
+        except FileNotFoundError:
+            raise FirstYAMLReaderError(f'No such file or directory: <{file_path}>')
 
-            try:
-                self.store[file_path] = self._yaml_to_dict(path_to_spec_file)
-            except FileNotFoundError:
-                raise FirstYAMLReaderError(f'No such file or directory: <{file_path}>')
+        return self.store[file_path]
 
     def search_file(self, obj: dict or list) -> None:
         if isinstance(obj, dict):
             ref = obj.get('$ref')
             if ref:
-                self.add_file_to_store(ref)
+                try:
+                    file_path, _ = ref.split('#/')
+                except (AttributeError, ValueError):
+                    raise FirstYAMLReaderError(f'"$ref" with value <{ref}> is not valid.')
+
+                if file_path and file_path not in self.store:
+                    self.search_file(self.add_file_to_store(file_path))
             else:
                 for _, v in obj.items():
                     self.search_file(v)
@@ -62,7 +65,9 @@ def load(self) -> 'YAMLReader':
         return self
 
 
-class Resolver:
+class RefResolver:
+    """Resolve links to various parts of the specification."""
+
     def __init__(self, yaml_reader: YAMLReader):
         self.yaml_reader = yaml_reader
         self.resolved_spec = None
@@ -74,23 +79,18 @@ def get_value_of_key_from_dict(source_dict: dict, key: Hashable) -> Any:
             return source_dict[key]
 
         try:
-            return reduce(get_value_of_key_from_dict, keys, self.yaml_reader.store[file_path])
+            return deepcopy(
+                reduce(get_value_of_key_from_dict, keys, self.yaml_reader.store[file_path])
+            )
         except KeyError:
             raise FirstResolverError(f'No such path: "{node_path}"')
 
-    def _get_schema(self, root_file_path: str, ref: str) -> Any:
-        try:
-            file_path, node_path = ref.split('#/')
-        except (AttributeError, ValueError):
-            raise FirstResolverError(
-                f'"$ref" with value <{ref}> is not valid in file <{root_file_path}>'
-            )
-
+    def _get_schema(self, root_file_name: str, file_path: str or None, node_path: str) -> Any:
         if file_path and node_path:
             obj = self._get_schema_via_local_ref(file_path, node_path)
 
         elif node_path and not file_path:
-            obj = self._get_schema_via_local_ref(root_file_path, node_path)
+            obj = self._get_schema_via_local_ref(root_file_name, node_path)
 
         else:
             raise NotImplementedError
@@ -101,7 +101,23 @@ def _resolving_all_refs(self, file_path: str, obj: Any) -> Any:
         if isinstance(obj, dict):
             ref = obj.get('$ref', ...)
             if ref is not ...:
-                obj = self._resolving_all_refs(file_path, self._get_schema(file_path, ref))
+                try:
+                    file_path_from_ref, node_path = ref.split('#/')
+                except (AttributeError, ValueError):
+                    raise FirstResolverError(
+                        f'"$ref" with value <{ref}> is not valid in file <{file_path}>'
+                    )
+
+                if file_path_from_ref:
+                    obj = self._resolving_all_refs(
+                        file_path_from_ref,
+                        self._get_schema(file_path, file_path_from_ref, node_path),
+                    )
+                else:
+                    obj = self._resolving_all_refs(
+                        file_path, self._get_schema(file_path, file_path_from_ref, node_path)
+                    )
+
             else:
                 for key, value in obj.items():
                     obj[key] = self._resolving_all_refs(file_path, value)
@@ -114,14 +130,14 @@ def _resolving_all_refs(self, file_path: str, obj: Any) -> Any:
 
         return obj
 
-    def resolving(self) -> 'Resolver':
+    def resolving(self) -> 'RefResolver':
         root_file_path = self.yaml_reader.root_file_name
         root_spec = self.yaml_reader.store[root_file_path]
         self.resolved_spec = self._resolving_all_refs(root_file_path, root_spec)
         return self
 
 
-def load_from_yaml(path: Path) -> Resolver:
+def load_from_yaml(path: Path) -> RefResolver:
     yaml_reader = YAMLReader(path).load()
-    resolved_obj = Resolver(yaml_reader).resolving()
+    resolved_obj = RefResolver(yaml_reader).resolving()
     return resolved_obj.resolved_spec

tests/first/loaders/yaml_loader/conftest.py

@@ -1,7 +1,10 @@
+from collections.abc import Iterable
 from pathlib import Path
 
 import pytest
 import yaml
+from flask import Flask
+from flask_first import First
 from openapi_spec_validator import validate as osv_validate
 from openapi_spec_validator.readers import read_from_filename
 
@@ -49,3 +52,24 @@ def create(spec: dict, validate: bool = True, file_name: str = 'openapi.yaml') -
         return spec_path
 
     return create
+
+
+@pytest.fixture()
+def fx_create_app():
+    def _create_app(path_to_spec: str, routes_functions: Iterable):
+        app = Flask('testing_app')
+        app.debug = True
+        app.config['FIRST_RESPONSE_VALIDATION'] = True
+        app.config['FIRST_DATETIME_FORMAT'] = "%Y-%m-%dT%H:%M:%S.%fZ"
+
+        first = First(path_to_spec, app, swagger_ui_path='/docs')
+        for func in routes_functions:
+            first.add_view_func(func)
+
+        app_context = app.app_context()
+        app_context.push()
+
+        with app.test_client() as test_client:
+            return test_client
+
+    return _create_app

tests/first/loaders/yaml_loader/test_loaders__yaml_loader__multiple_files.py

@@ -6,14 +6,20 @@
 
 def test_loaders__yaml__multiple__response_ref(fx_spec_minimal, fx_spec_as_file):
     endpoint_spec = {'endpoint': fx_spec_minimal['paths']['/endpoint']}
+    endpoint_spec['endpoint']['get']['responses']['200']['content']['application/json']['schema'][
+        'properties'
+    ]['message'] = {'$ref': '#/components/schemas/Message'}
+    endpoint_spec['components'] = {'schemas': {'Message': {'type': 'string'}}}
     endpoint_spec_file = fx_spec_as_file(endpoint_spec, validate=False, file_name='endpoint.yaml')
 
     fx_spec_minimal['paths']['/endpoint'] = {'$ref': f'{endpoint_spec_file.name}#/endpoint'}
     spec_file = fx_spec_as_file(fx_spec_minimal, validate=False)
     spec_obj = load_from_yaml(spec_file)
 
     assert spec_obj['paths']['/endpoint'].get('$ref') is None
-    assert spec_obj['paths']['/endpoint'] == endpoint_spec['endpoint']
+    assert spec_obj['paths']['/endpoint']['get']['responses']['200']['content']['application/json'][
+        'schema'
+    ]['properties']['message'] == {'type': 'string'}
 
 
 def test_loader__internal__multiple__non_exist_file(fx_spec_minimal, fx_spec_as_file):
@@ -25,3 +31,28 @@ def test_loader__internal__multiple__non_exist_file(fx_spec_minimal, fx_spec_as_
         load_from_yaml(spec_file)
 
     assert str(e.value) == f'No such file or directory: <{non_exist_file_name}>'
+
+
+def test_loaders__yaml__multiple__method_as_ref(fx_spec_minimal, fx_spec_as_file, fx_create_app):
+    method_spec = {'CORS': {'summary': 'CORS support'}}
+    method_spec_file = fx_spec_as_file(method_spec, validate=False, file_name='CORS.openapi.yaml')
+
+    endpoint_spec = {'endpoint': fx_spec_minimal['paths']['/endpoint']}
+    endpoint_spec['endpoint']['options'] = {'$ref': f'{method_spec_file.name}#/CORS'}
+    endpoint_spec_file = fx_spec_as_file(endpoint_spec, validate=False, file_name='endpoint.yaml')
+
+    fx_spec_minimal['paths']['/endpoint'] = {'$ref': f'{endpoint_spec_file.name}#/endpoint'}
+    spec_file = fx_spec_as_file(fx_spec_minimal, validate=False)
+    spec_obj = load_from_yaml(spec_file)
+
+    assert spec_obj['paths']['/endpoint'].get('$ref') is None
+    assert spec_obj['paths']['/endpoint']['get'] == endpoint_spec['endpoint']['get']
+    assert spec_obj['paths']['/endpoint']['options'] == method_spec['CORS']
+
+    def endpoint() -> dict:
+        return {'message': 'OK'}
+
+    test_client = fx_create_app(spec_file, [endpoint])
+    message = test_client.get('/endpoint')
+
+    assert message.json == {'message': 'OK'}

tests/first/loaders/yaml_loader/test_loaders__yaml_loader__parameters.py

@@ -0,0 +1,28 @@
+def test_loaders__yaml__multiple__parameters(fx_spec_minimal, fx_spec_as_file, fx_create_app):
+    endpoint_spec = {'endpoint': fx_spec_minimal['paths']['/endpoint']}
+    endpoint_spec['endpoint']['parameters'] = [{'$ref': '#/components/parameters/path_param'}]
+    endpoint_spec['components'] = {
+        'parameters': {
+            'path_param': {
+                'name': 'path_param',
+                'in': 'path',
+                'required': True,
+                'schema': {'type': 'string', 'enum': ['path_param']},
+            }
+        }
+    }
+    endpoint_spec_file = fx_spec_as_file(endpoint_spec, validate=False, file_name='endpoint.yaml')
+
+    fx_spec_minimal['paths']['/endpoint/{path_param}'] = {
+        '$ref': f'{endpoint_spec_file.name}#/endpoint'
+    }
+    fx_spec_minimal['paths'].pop('/endpoint')
+    spec_file = fx_spec_as_file(fx_spec_minimal, validate=False)
+
+    def endpoint(path_param) -> dict:
+        return {'message': path_param}
+
+    test_client = fx_create_app(spec_file, [endpoint])
+    message = test_client.get('/endpoint/path_param')
+
+    assert message.json == {'message': 'path_param'}