mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

✅ Recreate test for form feed, for pydantic.v1 and converage

pull/14575/head
Sebastián Ramírez 7 months ago
parent
b44d6c5a52
commit
f34fcbec41
1 changed files with 149 additions and 110 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 259
      tests/test_get_model_definitions_formfeed_escape.py

259
tests/test_get_model_definitions_formfeed_escape.py
View File

@ -1,130 +1,169 @@
import pytest
from fastapi import FastAPI from fastapi import FastAPI
from pydantic import BaseModel from fastapi.testclient import TestClient
from starlette.testclient import TestClient from inline_snapshot import snapshot
from .utils import needs_pydanticv1
class Address(BaseModel):
"""
This is a public description of an Address
\f
You can't see this part of the docstring, it's private!
"""
line_1: str @pytest.fixture(
city: str name="client",
state_province: str params=[
pytest.param("pydantic-v1", marks=needs_pydanticv1),
"pydantic-v2",
],
)
def client_fixture(request: pytest.FixtureRequest) -> TestClient:
if request.param == "pydantic-v1":
from pydantic.v1 import BaseModel
else:
from pydantic import BaseModel
class Address(BaseModel):
"""
This is a public description of an Address
\f
You can't see this part of the docstring, it's private!
"""
class Facility(BaseModel): line_1: str
id: str city: str
address: Address state_province: str
class Facility(BaseModel):
id: str
address: Address
app = FastAPI() app = FastAPI()
client = TestClient(app) @app.get("/facilities/{facility_id}")
def get_facility(facility_id: str) -> Facility:
return Facility(
id=facility_id,
address=Address(line_1="123 Main St", city="Anytown", state_province="CA"),
)
client = TestClient(app)
return client
@app.get("/facilities/{facility_id}")
def get_facility(facility_id: str) -> Facility: ...
def test_get(client: TestClient):
response = client.get("/facilities/42")
assert response.status_code == 200, response.text
assert response.json() == {
"id": "42",
"address": {
"line_1": "123 Main St",
"city": "Anytown",
"state_province": "CA",
},
}
openapi_schema = {
"components": { def test_openapi_schema(client: TestClient):
"schemas": { """
"Address": { Sanity check to ensure our app's openapi schema renders as we expect
# NOTE: the description of this model shows only the public-facing text, before the `\f` in docstring """
"description": "This is a public description of an Address\n", response = client.get("/openapi.json")
"properties": { assert response.status_code == 200, response.text
"city": {"title": "City", "type": "string"}, assert response.json() == snapshot(
"line_1": {"title": "Line 1", "type": "string"}, {
"state_province": {"title": "State Province", "type": "string"}, "components": {
}, "schemas": {
"required": ["line_1", "city", "state_province"], "Address": {
"title": "Address", # NOTE: the description of this model shows only the public-facing text, before the `\f` in docstring
"type": "object", "description": "This is a public description of an Address\n",
}, "properties": {
"Facility": { "city": {"title": "City", "type": "string"},
"properties": { "line_1": {"title": "Line 1", "type": "string"},
"address": {"$ref": "#/components/schemas/Address"}, "state_province": {
"id": {"title": "Id", "type": "string"}, "title": "State Province",
}, "type": "string",
"required": ["id", "address"], },
"title": "Facility", },
"type": "object", "required": ["line_1", "city", "state_province"],
}, "title": "Address",
"HTTPValidationError": { "type": "object",
"properties": {
"detail": {
"items": {"$ref": "#/components/schemas/ValidationError"},
"title": "Detail",
"type": "array",
}
},
"title": "HTTPValidationError",
"type": "object",
},
"ValidationError": {
"properties": {
"loc": {
"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]},
"title": "Location",
"type": "array",
}, },
"msg": {"title": "Message", "type": "string"}, "Facility": {
"type": {"title": "Error Type", "type": "string"}, "properties": {
}, "address": {"$ref": "#/components/schemas/Address"},
"required": ["loc", "msg", "type"], "id": {"title": "Id", "type": "string"},
"title": "ValidationError",
"type": "object",
},
}
},
"info": {"title": "FastAPI", "version": "0.1.0"},
"openapi": "3.1.0",
"paths": {
"/facilities/{facility_id}": {
"get": {
"operationId": "get_facility_facilities__facility_id__get",
"parameters": [
{
"in": "path",
"name": "facility_id",
"required": True,
"schema": {"title": "Facility Id", "type": "string"},
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {"$ref": "#/components/schemas/Facility"}
}
}, },
"description": "Successful Response", "required": ["id", "address"],
"title": "Facility",
"type": "object",
}, },
"422": { "HTTPValidationError": {
"content": { "properties": {
"application/json": { "detail": {
"schema": { "items": {
"$ref": "#/components/schemas/HTTPValidationError" "$ref": "#/components/schemas/ValidationError"
} },
"title": "Detail",
"type": "array",
} }
}, },
"description": "Validation Error", "title": "HTTPValidationError",
"type": "object",
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [{"type": "string"}, {"type": "integer"}]
},
"title": "Location",
"type": "array",
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
"required": ["loc", "msg", "type"],
"title": "ValidationError",
"type": "object",
}, },
}, }
"summary": "Get Facility", },
} "info": {"title": "FastAPI", "version": "0.1.0"},
"openapi": "3.1.0",
"paths": {
"/facilities/{facility_id}": {
"get": {
"operationId": "get_facility_facilities__facility_id__get",
"parameters": [
{
"in": "path",
"name": "facility_id",
"required": True,
"schema": {"title": "Facility Id", "type": "string"},
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Facility"
}
}
},
"description": "Successful Response",
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error",
},
},
"summary": "Get Facility",
}
}
},
} }
}, )
}
def test_openapi_schema():
"""
Sanity check to ensure our app's openapi schema renders as we expect
"""
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == openapi_schema

Write Preview
Loading…
Cancel
Save