feat chaotic: allow non-userver tags

commit_hash:9b1cad51c0fe0d11ff96088594783942a42aec95

Author: segoon

.mapping.json

@@ -60,6 +60,7 @@
   "chaotic-openapi/chaotic_openapi/back/linter/__main__.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/back/linter/__main__.py",
   "chaotic-openapi/chaotic_openapi/back/linter/validators.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/back/linter/validators.py",
   "chaotic-openapi/chaotic_openapi/front/__init__.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/front/__init__.py",
+  "chaotic-openapi/chaotic_openapi/front/base_model.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/front/base_model.py",
   "chaotic-openapi/chaotic_openapi/front/errors.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/front/errors.py",
   "chaotic-openapi/chaotic_openapi/front/model.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/front/model.py",
   "chaotic-openapi/chaotic_openapi/front/openapi.py":"taxi/uservices/userver/chaotic-openapi/chaotic_openapi/front/openapi.py",
@@ -107,6 +108,7 @@
   "chaotic-openapi/integration_tests/clients/multiple-content-types/openapi.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/multiple-content-types/openapi.yaml",
   "chaotic-openapi/integration_tests/clients/parameters/openapi.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/parameters/openapi.yaml",
   "chaotic-openapi/integration_tests/clients/swagger/swagger.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/swagger/swagger.yaml",
+  "chaotic-openapi/integration_tests/clients/tags/openapi.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/tags/openapi.yaml",
   "chaotic-openapi/integration_tests/clients/test-middleware/openapi.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/test-middleware/openapi.yaml",
   "chaotic-openapi/integration_tests/clients/test-object/openapi.yaml":"taxi/uservices/userver/chaotic-openapi/integration_tests/clients/test-object/openapi.yaml",
   "chaotic-openapi/integration_tests/src/middleware_test.cpp":"taxi/uservices/userver/chaotic-openapi/integration_tests/src/middleware_test.cpp",

chaotic-openapi/chaotic_openapi/front/base_model.py

@@ -0,0 +1,17 @@
+from typing import Any
+from typing import List
+
+import pydantic
+
+
+class BaseModel(pydantic.BaseModel):
+    model_config = pydantic.ConfigDict(extra='allow')
+    _model_userver_tags: List[str] = []
+
+    def model_post_init(self, __context: Any) -> None:
+        if not self.__pydantic_extra__:
+            return
+        for field in self.__pydantic_extra__:
+            if field.startswith('x-taxi-') or field.startswith('x-usrv-'):
+                assert field in self._model_userver_tags, f'Field {field} is not allowed in this context'
+            # ignore any other tag

chaotic-openapi/chaotic_openapi/front/openapi.py

@@ -7,11 +7,12 @@
 
 import pydantic
 
+from . import base_model
 from . import errors
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#info-object
-class Info(pydantic.BaseModel):
+class Info(base_model.BaseModel):
     title: str
     description: Optional[str] = None
     termsOfService: Optional[str] = None
@@ -21,7 +22,7 @@ class Info(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#server-object
-class Server(pydantic.BaseModel):
+class Server(base_model.BaseModel):
     url: str
     description: Optional[str] = None
     variables: Dict[str, Any] = pydantic.Field(default_factory=dict)
@@ -42,7 +43,7 @@ class Style(str, enum.Enum):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#header-object
-class Header(pydantic.BaseModel):
+class Header(base_model.BaseModel):
     description: Optional[str] = None
     required: bool = False
     deprecated: bool = False
@@ -57,20 +58,20 @@ class Header(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#media-type-object
-class MediaType(pydantic.BaseModel):
+class MediaType(base_model.BaseModel):
     schema_: Schema = pydantic.Field(alias='schema', default=None)
     example: Any = None
     examples: Dict[str, Any] = pydantic.Field(default_factory=dict)
     # encoding: Dict[str, Encoding] = {}
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#reference-object
-class Ref(pydantic.BaseModel):
+class Ref(base_model.BaseModel):
     ref: str = pydantic.Field(alias='$ref')
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#responses-object
-class Response(pydantic.BaseModel):
+class Response(base_model.BaseModel):
     description: str
     headers: Dict[str, Union[Header, Ref]] = pydantic.Field(default_factory=dict)
     content: Dict[str, MediaType] = pydantic.Field(default_factory=dict)
@@ -85,7 +86,7 @@ class In(str, enum.Enum):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#parameter-object
-class Parameter(pydantic.BaseModel):
+class Parameter(base_model.BaseModel):
     name: str
     in_: In = pydantic.Field(alias='in')
     description: Optional[str] = None
@@ -115,7 +116,7 @@ def model_post_init(self, context: Any, /) -> None:
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#request-body-object
-class RequestBody(pydantic.BaseModel):
+class RequestBody(base_model.BaseModel):
     description: Optional[str] = None
     content: Dict[str, MediaType]
     required: bool = False
@@ -134,41 +135,41 @@ class SecurityIn(str, enum.Enum):
     cookie = 'cookie'
 
 
-class ImplicitFlow(pydantic.BaseModel):
+class ImplicitFlow(base_model.BaseModel):
     refreshUrl: Optional[str] = None
     scopes: Dict[str, str] = pydantic.Field(default_factory=dict)
     authorizationUrl: str
 
 
-class PasswordFlow(pydantic.BaseModel):
+class PasswordFlow(base_model.BaseModel):
     refreshUrl: Optional[str] = None
     scopes: Dict[str, str] = pydantic.Field(default_factory=dict)
     tokenUrl: str
 
 
-class ClientCredFlow(pydantic.BaseModel):
+class ClientCredFlow(base_model.BaseModel):
     refreshUrl: Optional[str] = None
     scopes: Dict[str, str] = pydantic.Field(default_factory=dict)
     tokenUrl: str
 
 
-class AuthCodeFlow(pydantic.BaseModel):
+class AuthCodeFlow(base_model.BaseModel):
     refreshUrl: Optional[str] = None
     scopes: Dict[str, str] = pydantic.Field(default_factory=dict)
     authorizationUrl: str
     tokenUrl: str
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#oauth-flows-object
-class OAuthFlows(pydantic.BaseModel):
+class OAuthFlows(base_model.BaseModel):
     implicit: Optional[ImplicitFlow] = None
     password: Optional[PasswordFlow] = None
     clientCredentials: Optional[ClientCredFlow] = None
     authorizationCode: Optional[AuthCodeFlow] = None
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#security-scheme-object
-class SecurityScheme(pydantic.BaseModel):
+class SecurityScheme(base_model.BaseModel):
     type: SecurityType
     description: Optional[str] = None
     name: Optional[str] = None
@@ -203,7 +204,7 @@ def model_post_init(self, context: Any, /) -> None:
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#components-object
-class Components(pydantic.BaseModel):
+class Components(base_model.BaseModel):
     schemas: Dict[str, Schema] = pydantic.Field(default_factory=dict)
     responses: Dict[str, Response] = pydantic.Field(default_factory=dict)
     parameters: Dict[str, Parameter] = pydantic.Field(default_factory=dict)
@@ -213,7 +214,7 @@ class Components(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#operation-object
-class Operation(pydantic.BaseModel):
+class Operation(base_model.BaseModel):
     tags: List[str] = pydantic.Field(default_factory=list)
     summary: Optional[str] = None
     description: str = ''
@@ -229,7 +230,7 @@ class Operation(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#path-item-object
-class Path(pydantic.BaseModel):
+class Path(base_model.BaseModel):
     summary: Optional[str] = None
     description: str = ''
 
@@ -247,7 +248,7 @@ class Path(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#schema
-class OpenApi(pydantic.BaseModel):
+class OpenApi(base_model.BaseModel):
     openapi: str = '3.0.0'
     info: Optional[Info] = None
     servers: List[Server] = pydantic.Field(default_factory=list)

chaotic-openapi/chaotic_openapi/front/swagger.py

@@ -7,15 +7,16 @@
 
 import pydantic
 
+from . import base_model
 from . import errors
 
 
-class Info(pydantic.BaseModel):
+class Info(base_model.BaseModel):
     pass
 
 
 # https://spec.openapis.org/oas/v2.0.html#reference-object
-class Ref(pydantic.BaseModel):
+class Ref(base_model.BaseModel):
     ref: str = pydantic.Field(alias='$ref')
 
 
@@ -28,7 +29,7 @@ class In(str, enum.Enum):
 
 
 # https://spec.openapis.org/oas/v2.0.html#parameter-object
-class Parameter(pydantic.BaseModel):
+class Parameter(base_model.BaseModel):
     name: str
     in_: In = pydantic.Field(alias='in')
     description: str = ''
@@ -60,7 +61,7 @@ def model_post_init(self, context: Any, /) -> None:
 
 
 # https://spec.openapis.org/oas/v2.0.html#header-object
-class Header(pydantic.BaseModel):
+class Header(base_model.BaseModel):
     description: Optional[str] = None
     type: str
     format: Optional[str] = None
@@ -82,7 +83,7 @@ def model_post_init(self, context: Any, /) -> None:
 
 
 # https://spec.openapis.org/oas/v2.0.html#response-object
-class Response(pydantic.BaseModel):
+class Response(base_model.BaseModel):
     description: str
     schema_: Schema = pydantic.Field(alias='schema', default=None)
     headers: Dict[str, Header] = pydantic.Field(default_factory=dict)
@@ -111,7 +112,7 @@ class OAuthFlow(str, enum.Enum):
 
 
 # https://spec.openapis.org/oas/v2.0.html#security-definitions-object
-class SecurityDef(pydantic.BaseModel):
+class SecurityDef(base_model.BaseModel):
     type: SecurityType
     description: Optional[str] = None
     name: Optional[str] = None
@@ -153,7 +154,7 @@ def model_post_init(self, context: Any, /) -> None:
 
 
 # https://spec.openapis.org/oas/v2.0.html#operation-object
-class Operation(pydantic.BaseModel):
+class Operation(base_model.BaseModel):
     tags: Optional[List[str]] = None
     summary: Optional[str] = None
     description: str = ''
@@ -169,7 +170,7 @@ class Operation(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v2.0.html#paths-object
-class Path(pydantic.BaseModel):
+class Path(base_model.BaseModel):
     get: Optional[Operation] = None
     post: Optional[Operation] = None
     put: Optional[Operation] = None
@@ -184,7 +185,7 @@ class Path(pydantic.BaseModel):
 
 
 # https://spec.openapis.org/oas/v2.0.html#schema
-class Swagger(pydantic.BaseModel):
+class Swagger(base_model.BaseModel):
     swagger: str = '2.0'
     info: Optional[Info] = None
     host: Optional[str] = None

chaotic-openapi/integration_tests/clients/tags/openapi.yaml

@@ -0,0 +1,19 @@
+openapi: 3.0.0
+info:
+    title: test-object client
+    version: '1.0'
+
+paths:
+    /test1:
+        x-tag: test
+        post:
+            responses:
+                '200':
+                    description: OK
+                    content:
+                        application/json:
+                            schema:
+                                type: object
+                                additionalProperties: false
+                                properties: {}
+components: {}

chaotic-openapi/tests/front/test_openapi.py

@@ -1,5 +1,7 @@
 from chaotic_openapi.front import model
+import pytest
 
+from chaotic import error
 from chaotic.front import types
 
 
@@ -356,3 +358,27 @@ def test_openapi_parameters(simple_parser):
             )
         ],
     )
+
+
+def test_unknown_usrv_tag(simple_parser):
+    expected = """
+===============================================================
+Unhandled error while processing <inline>
+Path "paths./.get", Format "openapi"
+Error:
+Assertion failed, Field x-usrv-tag is not allowed in this context
+==============================================================="""
+
+    with pytest.raises(error.BaseError, match=expected):
+        simple_parser({
+            'openapi': '3.0.0',
+            'info': {'title': '', 'version': '1.0'},
+            'paths': {
+                '/': {
+                    'get': {
+                        'x-usrv-tag': '1',
+                        'responses': {},
+                    },
+                },
+            },
+        })