Finder exception

Author: p1c2u

openapi_core/contrib/flask/handlers.py

@@ -3,13 +3,16 @@
 from flask.json import dumps
 
 from openapi_core.schema.media_types.exceptions import InvalidContentType
-from openapi_core.schema.servers.exceptions import InvalidServer
+from openapi_core.templating.paths.exceptions import (
+    OperationNotFound, PathNotFound,
+)
 
 
 class FlaskOpenAPIErrorsHandler(object):
 
     OPENAPI_ERROR_STATUS = {
-        InvalidServer: 500,
+        OperationNotFound: 500,
+        PathNotFound: 500,
         InvalidContentType: 415,
     }
 

openapi_core/templating/paths/exceptions.py

@@ -0,0 +1,27 @@
+import attr
+
+from openapi_core.exceptions import OpenAPIError
+
+
+class PathError(OpenAPIError):
+    """Path error"""
+
+
+@attr.s(hash=True)
+class PathNotFound(PathError):
+    """Find path error"""
+    path_pattern = attr.ib()
+
+    def __str__(self):
+        return "Path not found for {0}".format(self.path_pattern)
+
+
+@attr.s(hash=True)
+class OperationNotFound(PathError):
+    """Find path operation error"""
+    path_pattern = attr.ib()
+    operation = attr.ib()
+
+    def __str__(self):
+        return "Operation {0} not found for {0}".format(
+            self.operation, self.path_pattern)

openapi_core/templating/paths/finders.py

@@ -1,4 +1,10 @@
 """OpenAPI core templating paths finders module"""
+from openapi_core.schema.operations.exceptions import InvalidOperation
+from openapi_core.schema.paths.exceptions import InvalidPath
+from openapi_core.schema.servers.exceptions import InvalidServer
+from openapi_core.templating.paths.exceptions import (
+    PathNotFound, OperationNotFound,
+)
 from openapi_core.templating.paths.util import get_operation_pattern
 
 
@@ -8,16 +14,22 @@ def __init__(self, spec):
         self.spec = spec
 
     def find(self, request):
-        operation_pattern = self._get_operation_pattern(request)
-
-        path = self.spec[operation_pattern]
-        path_variables = {}
-        operation = self.spec.get_operation(operation_pattern, request.method)
-        servers = path.servers or operation.servers or self.spec.servers
-        server = servers[0]
-        server_variables = {}
-
-        return path, operation, server, path_variables, server_variables
+        try:
+            operation_pattern = self._get_operation_pattern(request)
+
+            path = self.spec[operation_pattern]
+            path_variables = {}
+            operation = self.spec.get_operation(
+                operation_pattern, request.method)
+            servers = path.servers or operation.servers or self.spec.servers
+            server = servers[0]
+            server_variables = {}
+        except (InvalidServer, InvalidPath):
+            raise PathNotFound(request.full_url_pattern)
+        except InvalidOperation:
+            raise OperationNotFound(request.full_url_pattern, request.method)
+        else:
+            return path, operation, server, path_variables, server_variables
 
     def _get_operation_pattern(self, request):
         server = self.spec.get_server(request.full_url_pattern)

openapi_core/validation/request/validators.py

@@ -5,14 +5,12 @@
 from openapi_core.casting.schemas.exceptions import CastError
 from openapi_core.deserializing.exceptions import DeserializeError
 from openapi_core.schema.media_types.exceptions import InvalidContentType
-from openapi_core.schema.operations.exceptions import InvalidOperation
 from openapi_core.schema.parameters.exceptions import (
     MissingRequiredParameter, MissingParameter,
 )
-from openapi_core.schema.paths.exceptions import InvalidPath
 from openapi_core.schema.request_bodies.exceptions import MissingRequestBody
-from openapi_core.schema.servers.exceptions import InvalidServer
 from openapi_core.security.exceptions import SecurityError
+from openapi_core.templating.paths.exceptions import PathError
 from openapi_core.unmarshalling.schemas.enums import UnmarshalContext
 from openapi_core.unmarshalling.schemas.exceptions import (
     UnmarshalError, ValidateError,
@@ -30,7 +28,7 @@ def validate(self, request):
         try:
             path, operation, _, _, _ = self._find_path(request)
         # don't process if operation errors
-        except (InvalidServer, InvalidPath, InvalidOperation) as exc:
+        except PathError as exc:
             return RequestValidationResult([exc, ], None, None, None)
 
         try:
@@ -53,7 +51,7 @@ def validate(self, request):
     def _validate_parameters(self, request):
         try:
             path, operation, _, _, _ = self._find_path(request)
-        except (InvalidServer, InvalidPath, InvalidOperation) as exc:
+        except PathError as exc:
             return RequestValidationResult([exc, ], None, None)
 
         params, params_errors = self._get_parameters(
@@ -67,7 +65,7 @@ def _validate_parameters(self, request):
     def _validate_body(self, request):
         try:
             _, operation, _, _, _ = self._find_path(request)
-        except (InvalidServer, InvalidOperation) as exc:
+        except PathError as exc:
             return RequestValidationResult([exc, ], None, None)
 
         body, body_errors = self._get_body(request, operation)

openapi_core/validation/response/validators.py

@@ -1,13 +1,11 @@
 """OpenAPI core validation response validators module"""
 from openapi_core.casting.schemas.exceptions import CastError
 from openapi_core.deserializing.exceptions import DeserializeError
-from openapi_core.schema.operations.exceptions import InvalidOperation
 from openapi_core.schema.media_types.exceptions import InvalidContentType
-from openapi_core.schema.paths.exceptions import InvalidPath
 from openapi_core.schema.responses.exceptions import (
     InvalidResponse, MissingResponseContent,
 )
-from openapi_core.schema.servers.exceptions import InvalidServer
+from openapi_core.templating.paths.exceptions import PathError
 from openapi_core.unmarshalling.schemas.enums import UnmarshalContext
 from openapi_core.unmarshalling.schemas.exceptions import (
     UnmarshalError, ValidateError,
@@ -22,7 +20,7 @@ def validate(self, request, response):
         try:
             _, operation, _, _, _ = self._find_path(request)
         # don't process if operation errors
-        except (InvalidServer, InvalidPath, InvalidOperation) as exc:
+        except PathError as exc:
             return ResponseValidationResult([exc, ], None, None)
 
         try:
@@ -47,7 +45,7 @@ def _validate_data(self, request, response):
         try:
             _, operation, _, _, _ = self._find_path(request)
         # don't process if operation errors
-        except (InvalidServer, InvalidPath, InvalidOperation) as exc:
+        except PathError as exc:
             return ResponseValidationResult([exc, ], None, None)
 
         try:

requirements.txt

@@ -4,3 +4,4 @@ lazy-object-proxy
 strict_rfc3339
 isodate
 attrs
+parse==1.14.0

setup.cfg

@@ -30,6 +30,7 @@ install_requires =
     isodate
     attrs
     werkzeug
+    parse
     backports.functools-lru-cache; python_version<"3.0"
     backports.functools-partialmethod; python_version<"3.0"
 tests_require =

tests/integration/contrib/flask/test_flask_decorator.py

@@ -80,12 +80,12 @@ def test_server_error(self, client):
             'errors': [
                 {
                     'class': (
-                        "<class 'openapi_core.schema.servers.exceptions."
-                        "InvalidServer'>"
+                        "<class 'openapi_core.templating.paths.exceptions."
+                        "PathNotFound'>"
                     ),
                     'status': 500,
                     'title': (
-                        'Invalid request server '
+                        'Path not found for '
                         'https://localhost/browse/{id}/'
                     ),
                 }

tests/integration/contrib/flask/test_flask_views.py

@@ -68,12 +68,12 @@ def test_server_error(self, client):
             'errors': [
                 {
                     'class': (
-                        "<class 'openapi_core.schema.servers.exceptions."
-                        "InvalidServer'>"
+                        "<class 'openapi_core.templating.paths.exceptions."
+                        "PathNotFound'>"
                     ),
                     'status': 500,
                     'title': (
-                        'Invalid request server '
+                        'Path not found for '
                         'https://localhost/browse/{id}/'
                     ),
                 }

tests/integration/validation/test_minimal.py

@@ -1,8 +1,9 @@
 import pytest
 
-from openapi_core.schema.operations.exceptions import InvalidOperation
-from openapi_core.schema.paths.exceptions import InvalidPath
 from openapi_core.shortcuts import create_spec
+from openapi_core.templating.paths.exceptions import (
+    PathNotFound, OperationNotFound,
+)
 from openapi_core.testing import MockRequest
 from openapi_core.validation.request.validators import RequestValidator
 
@@ -45,7 +46,7 @@ def test_invalid_operation(self, factory, server, spec_path):
         result = validator.validate(request)
 
         assert len(result.errors) == 1
-        assert isinstance(result.errors[0], InvalidOperation)
+        assert isinstance(result.errors[0], OperationNotFound)
         assert result.body is None
         assert result.parameters is None
 
@@ -60,6 +61,6 @@ def test_invalid_path(self, factory, server, spec_path):
         result = validator.validate(request)
 
         assert len(result.errors) == 1
-        assert isinstance(result.errors[0], InvalidPath)
+        assert isinstance(result.errors[0], PathNotFound)
         assert result.body is None
         assert result.parameters is None

tests/integration/validation/test_petstore.py

@@ -16,10 +16,10 @@
     MissingRequiredParameter,
 )
 from openapi_core.schema.schemas.enums import SchemaType
-from openapi_core.schema.servers.exceptions import InvalidServer
 from openapi_core.shortcuts import (
     create_spec, validate_parameters, validate_body,
 )
+from openapi_core.templating.paths.exceptions import PathNotFound
 from openapi_core.testing import MockRequest, MockResponse
 from openapi_core.unmarshalling.schemas.exceptions import InvalidSchemaValue
 from openapi_core.validation.request.datatypes import RequestParameters
@@ -748,10 +748,10 @@ def test_post_pets_raises_invalid_server_error(self, spec):
             headers=headers, cookies=cookies,
         )
 
-        with pytest.raises(InvalidServer):
+        with pytest.raises(PathNotFound):
             validate_parameters(spec, request)
 
-        with pytest.raises(InvalidServer):
+        with pytest.raises(PathNotFound):
             validate_body(spec, request)
 
     def test_get_pet(self, spec, response_validator):

tests/integration/validation/test_validators.py

@@ -9,15 +9,15 @@
     InvalidContentType,
 )
 from openapi_core.extensions.models.models import BaseModel
-from openapi_core.schema.operations.exceptions import InvalidOperation
 from openapi_core.schema.parameters.exceptions import MissingRequiredParameter
-from openapi_core.schema.paths.exceptions import InvalidPath
 from openapi_core.schema.request_bodies.exceptions import MissingRequestBody
 from openapi_core.schema.responses.exceptions import (
     MissingResponseContent, InvalidResponse,
 )
-from openapi_core.schema.servers.exceptions import InvalidServer
 from openapi_core.shortcuts import create_spec
+from openapi_core.templating.paths.exceptions import (
+    PathNotFound, OperationNotFound,
+)
 from openapi_core.testing import MockRequest, MockResponse
 from openapi_core.unmarshalling.schemas.exceptions import InvalidSchemaValue
 from openapi_core.validation.exceptions import InvalidSecurity
@@ -56,7 +56,7 @@ def test_request_server_error(self, validator):
         result = validator.validate(request)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == InvalidServer
+        assert type(result.errors[0]) == PathNotFound
         assert result.body is None
         assert result.parameters is None
 
@@ -66,7 +66,7 @@ def test_invalid_path(self, validator):
         result = validator.validate(request)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == InvalidPath
+        assert type(result.errors[0]) == PathNotFound
         assert result.body is None
         assert result.parameters is None
 
@@ -76,7 +76,7 @@ def test_invalid_operation(self, validator):
         result = validator.validate(request)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == InvalidOperation
+        assert type(result.errors[0]) == OperationNotFound
         assert result.body is None
         assert result.parameters is None
 
@@ -428,18 +428,18 @@ def test_invalid_server(self, validator):
         result = validator.validate(request, response)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == InvalidServer
+        assert type(result.errors[0]) == PathNotFound
         assert result.data is None
         assert result.headers is None
 
     def test_invalid_operation(self, validator):
-        request = MockRequest(self.host_url, 'get', '/v1')
+        request = MockRequest(self.host_url, 'patch', '/v1/pets')
         response = MockResponse('Not Found', status_code=404)
 
         result = validator.validate(request, response)
 
         assert len(result.errors) == 1
-        assert type(result.errors[0]) == InvalidPath
+        assert type(result.errors[0]) == OperationNotFound
         assert result.data is None
         assert result.headers is None