Adding upstream version 0.5.1.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
303fa6e9d8
commit
97e6d74bac
GPG key ID:
FBB4F0E80A80222F
110 changed files with 12006 additions and 0 deletions
271
tests/util/test_util.py
Normal file
271
tests/util/test_util.py
Normal file
|
|
@ -0,0 +1,271 @@
|
|||
import logging
|
||||
from typing import Callable, Generic, TypeVar
|
||||
|
||||
import pytest
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from openapi_pydantic import (
|
||||
Info,
|
||||
MediaType,
|
||||
OpenAPI,
|
||||
Operation,
|
||||
PathItem,
|
||||
Reference,
|
||||
RequestBody,
|
||||
Response,
|
||||
)
|
||||
from openapi_pydantic.compat import PYDANTIC_V2
|
||||
from openapi_pydantic.util import PydanticSchema, construct_open_api_with_schema_class
|
||||
|
||||
|
||||
def test_construct_open_api_with_schema_class_1() -> None:
|
||||
open_api = construct_base_open_api_1()
|
||||
result_open_api_1 = construct_open_api_with_schema_class(open_api)
|
||||
result_open_api_2 = construct_open_api_with_schema_class(
|
||||
open_api, [PingRequest, PingResponse]
|
||||
)
|
||||
assert result_open_api_1.components == result_open_api_2.components
|
||||
assert result_open_api_1 == result_open_api_2
|
||||
|
||||
dump_json = getattr(result_open_api_1, "model_dump_json" if PYDANTIC_V2 else "json")
|
||||
open_api_json = dump_json(by_alias=True, exclude_none=True, indent=2)
|
||||
logging.debug(open_api_json)
|
||||
|
||||
|
||||
def test_construct_open_api_with_schema_class_2() -> None:
|
||||
open_api_1 = construct_base_open_api_1()
|
||||
open_api_2 = construct_base_open_api_2()
|
||||
result_open_api_1 = construct_open_api_with_schema_class(open_api_1)
|
||||
result_open_api_2 = construct_open_api_with_schema_class(
|
||||
open_api_2, [PingRequest, PingResponse]
|
||||
)
|
||||
assert result_open_api_1 == result_open_api_2
|
||||
|
||||
|
||||
def test_construct_open_api_with_schema_class_3() -> None:
|
||||
open_api_3 = construct_base_open_api_3()
|
||||
|
||||
result_with_alias_1 = construct_open_api_with_schema_class(open_api_3)
|
||||
assert result_with_alias_1.components is not None
|
||||
assert result_with_alias_1.components.schemas is not None
|
||||
schema_with_alias = result_with_alias_1.components.schemas["PongResponse"]
|
||||
assert schema_with_alias.properties is not None
|
||||
assert "pong_foo" in schema_with_alias.properties
|
||||
assert "pong_bar" in schema_with_alias.properties
|
||||
|
||||
result_with_alias_2 = construct_open_api_with_schema_class(
|
||||
open_api_3, by_alias=True
|
||||
)
|
||||
assert result_with_alias_1 == result_with_alias_2
|
||||
|
||||
result_without_alias = construct_open_api_with_schema_class(
|
||||
open_api_3, by_alias=False
|
||||
)
|
||||
assert result_without_alias.components is not None
|
||||
assert result_without_alias.components.schemas is not None
|
||||
schema_without_alias = result_without_alias.components.schemas["PongResponse"]
|
||||
assert schema_without_alias.properties is not None
|
||||
assert "resp_foo" in schema_without_alias.properties
|
||||
assert "resp_bar" in schema_without_alias.properties
|
||||
|
||||
|
||||
@pytest.mark.skipif(PYDANTIC_V2, reason="generic type for Pydantic V1")
|
||||
def test_construct_open_api_with_schema_class_4_generic_response_v1() -> None:
|
||||
DataT = TypeVar("DataT")
|
||||
from pydantic.v1.generics import GenericModel
|
||||
|
||||
class GenericResponse(GenericModel, Generic[DataT]):
|
||||
msg: str = Field(description="message of the generic response")
|
||||
data: DataT = Field(description="data value of the generic response")
|
||||
|
||||
open_api_4 = construct_base_open_api_4_generic_response(
|
||||
GenericResponse[PongResponse]
|
||||
)
|
||||
|
||||
result = construct_open_api_with_schema_class(open_api_4)
|
||||
assert result.components is not None
|
||||
assert result.components.schemas is not None
|
||||
assert "GenericResponse_PongResponse_" in result.components.schemas
|
||||
|
||||
|
||||
@pytest.mark.skipif(not PYDANTIC_V2, reason="generic type for Pydantic V2")
|
||||
def test_construct_open_api_with_schema_class_4_generic_response_v2() -> None:
|
||||
DataT = TypeVar("DataT")
|
||||
|
||||
class GenericResponse(BaseModel, Generic[DataT]):
|
||||
msg: str = Field(description="message of the generic response")
|
||||
data: DataT = Field(description="data value of the generic response")
|
||||
|
||||
open_api_4 = construct_base_open_api_4_generic_response(
|
||||
GenericResponse[PongResponse]
|
||||
)
|
||||
|
||||
result = construct_open_api_with_schema_class(open_api_4)
|
||||
assert result.components is not None
|
||||
assert result.components.schemas is not None
|
||||
assert "GenericResponse_PongResponse_" in result.components.schemas
|
||||
|
||||
|
||||
def construct_base_open_api_1() -> OpenAPI:
|
||||
model_validate: Callable[[dict], OpenAPI] = getattr(
|
||||
OpenAPI, "model_validate" if PYDANTIC_V2 else "parse_obj"
|
||||
)
|
||||
return model_validate(
|
||||
{
|
||||
"info": {"title": "My own API", "version": "v0.0.1"},
|
||||
"paths": {
|
||||
"/ping": {
|
||||
"post": {
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": PydanticSchema(schema_class=PingRequest)
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "pong",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": PydanticSchema(
|
||||
schema_class=PingResponse
|
||||
)
|
||||
}
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def construct_base_open_api_2() -> OpenAPI:
|
||||
return OpenAPI(
|
||||
info=Info(
|
||||
title="My own API",
|
||||
version="v0.0.1",
|
||||
),
|
||||
paths={
|
||||
"/ping": PathItem(
|
||||
post=Operation(
|
||||
requestBody=RequestBody(
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=Reference(
|
||||
**{"$ref": "#/components/schemas/PingRequest"}
|
||||
)
|
||||
)
|
||||
}
|
||||
),
|
||||
responses={
|
||||
"200": Response(
|
||||
description="pong",
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=Reference(
|
||||
**{"$ref": "#/components/schemas/PingResponse"}
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
def construct_base_open_api_3() -> OpenAPI:
|
||||
return OpenAPI(
|
||||
info=Info(
|
||||
title="My own API",
|
||||
version="v0.0.1",
|
||||
),
|
||||
paths={
|
||||
"/ping": PathItem(
|
||||
post=Operation(
|
||||
requestBody=RequestBody(
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=PydanticSchema(
|
||||
schema_class=PingRequest
|
||||
)
|
||||
)
|
||||
}
|
||||
),
|
||||
responses={
|
||||
"200": Response(
|
||||
description="pong",
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=PydanticSchema(
|
||||
schema_class=PongResponse
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
def construct_base_open_api_4_generic_response(response_schema: type) -> OpenAPI:
|
||||
return OpenAPI(
|
||||
info=Info(
|
||||
title="My own API",
|
||||
version="v0.0.1",
|
||||
),
|
||||
paths={
|
||||
"/ping": PathItem(
|
||||
post=Operation(
|
||||
requestBody=RequestBody(
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=PydanticSchema(
|
||||
schema_class=PingRequest
|
||||
)
|
||||
)
|
||||
}
|
||||
),
|
||||
responses={
|
||||
"200": Response(
|
||||
description="pong",
|
||||
content={
|
||||
"application/json": MediaType(
|
||||
media_type_schema=PydanticSchema(
|
||||
schema_class=response_schema
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
)
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
class PingRequest(BaseModel):
|
||||
"""Ping Request"""
|
||||
|
||||
req_foo: str = Field(description="foo value of the request")
|
||||
req_bar: str = Field(description="bar value of the request")
|
||||
|
||||
|
||||
class PingResponse(BaseModel):
|
||||
"""Ping response"""
|
||||
|
||||
resp_foo: str = Field(description="foo value of the response")
|
||||
resp_bar: str = Field(description="bar value of the response")
|
||||
|
||||
|
||||
class PongResponse(BaseModel):
|
||||
"""Pong response"""
|
||||
|
||||
resp_foo: str = Field(alias="pong_foo", description="foo value of the response")
|
||||
resp_bar: str = Field(alias="pong_bar", description="bar value of the response")
|
||||
Loading…
Add table
Add a link
Reference in a new issue