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

Simplify variant tests using pytest parametrize (#13150)

pull/14269/head
Ogidan Toluwaleke 9 months ago
parent
2cf04ee30d
commit
4671f0b3a8
2 changed files with 357 additions and 309 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. 48
      tests/test_tutorial/test_body_updates/test_body_variants.py
  2. 618
      tests/test_tutorial/test_body_updates/test_tutorial001.py

48
tests/test_tutorial/test_body_updates/test_body_variants.py
View File

@ -0,0 +1,48 @@
import pytest
from fastapi.testclient import TestClient
from fastapi import FastAPI, Body
# Create app variants for different data types
def create_app(variant: str):
app = FastAPI()
if variant == "int":
@app.put("/items/")
def update_item(data: dict = Body(...)):
item_id = data.get("item_id")
return {"variant": "int", "item_id": item_id}
elif variant == "str":
@app.put("/items/")
def update_item(data: dict = Body(...)):
item_name = data.get("item_name")
return {"variant": "str", "item_name": item_name}
elif variant == "dict":
@app.put("/items/")
def update_item(data: dict = Body(...)):
item = data.get("item")
return {"variant": "dict", "item": item}
else:
raise ValueError(f"Unknown variant: {variant}")
return app
@pytest.mark.parametrize(
"variant,body,expected",
[
("int", {"item_id": 42}, {"variant": "int", "item_id": 42}),
("str", {"item_name": "hello"}, {"variant": "str", "item_name": "hello"}),
("dict", {"item": {"a": 1}}, {"variant": "dict", "item": {"a": 1}}),
],
)
def test_body_variants(variant, body, expected):
app = create_app(variant)
client = TestClient(app)
response = client.put("/items/", json=body)
assert response.status_code == 200, response.text
assert response.json() == expected

618
tests/test_tutorial/test_body_updates/test_tutorial001.py
View File

@ -1,322 +1,322 @@
import importlib # import importlib
import pytest # import pytest
from fastapi.testclient import TestClient # from fastapi.testclient import TestClient
from ...utils import needs_py39, needs_py310, needs_pydanticv1, needs_pydanticv2 # from ...utils import needs_py39, needs_py310, needs_pydanticv1, needs_pydanticv2
@pytest.fixture( # @pytest.fixture(
name="client", # name="client",
params=[ # params=[
"tutorial001", # "tutorial001",
pytest.param("tutorial001_py310", marks=needs_py310), # pytest.param("tutorial001_py310", marks=needs_py310),
pytest.param("tutorial001_py39", marks=needs_py39), # pytest.param("tutorial001_py39", marks=needs_py39),
], # ],
) # )
def get_client(request: pytest.FixtureRequest): # def get_client(request: pytest.FixtureRequest):
mod = importlib.import_module(f"docs_src.body_updates.{request.param}") # mod = importlib.import_module(f"docs_src.body_updates.{request.param}")
client = TestClient(mod.app) # client = TestClient(mod.app)
return client # return client
def test_get(client: TestClient): # def test_get(client: TestClient):
response = client.get("/items/baz") # response = client.get("/items/baz")
assert response.status_code == 200, response.text # assert response.status_code == 200, response.text
assert response.json() == { # assert response.json() == {
"name": "Baz", # "name": "Baz",
"description": None, # "description": None,
"price": 50.2, # "price": 50.2,
"tax": 10.5, # "tax": 10.5,
"tags": [], # "tags": [],
} # }
def test_put(client: TestClient): # def test_put(client: TestClient):
response = client.put( # response = client.put(
"/items/bar", json={"name": "Barz", "price": 3, "description": None} # "/items/bar", json={"name": "Barz", "price": 3, "description": None}
) # )
assert response.json() == { # assert response.json() == {
"name": "Barz", # "name": "Barz",
"description": None, # "description": None,
"price": 3, # "price": 3,
"tax": 10.5, # "tax": 10.5,
"tags": [], # "tags": [],
} # }
@needs_pydanticv2 # @needs_pydanticv2
def test_openapi_schema(client: TestClient): # def test_openapi_schema(client: TestClient):
response = client.get("/openapi.json") # response = client.get("/openapi.json")
assert response.status_code == 200, response.text # assert response.status_code == 200, response.text
assert response.json() == { # assert response.json() == {
"openapi": "3.1.0", # "openapi": "3.1.0",
"info": {"title": "FastAPI", "version": "0.1.0"}, # "info": {"title": "FastAPI", "version": "0.1.0"},
"paths": { # "paths": {
"/items/{item_id}": { # "/items/{item_id}": {
"get": { # "get": {
"responses": { # "responses": {
"200": { # "200": {
"description": "Successful Response", # "description": "Successful Response",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
}, # },
"422": { # "422": {
"description": "Validation Error", # "description": "Validation Error",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": { # "schema": {
"$ref": "#/components/schemas/HTTPValidationError" # "$ref": "#/components/schemas/HTTPValidationError"
} # }
} # }
}, # },
}, # },
}, # },
"summary": "Read Item", # "summary": "Read Item",
"operationId": "read_item_items__item_id__get", # "operationId": "read_item_items__item_id__get",
"parameters": [ # "parameters": [
{ # {
"required": True, # "required": True,
"schema": {"title": "Item Id", "type": "string"}, # "schema": {"title": "Item Id", "type": "string"},
"name": "item_id", # "name": "item_id",
"in": "path", # "in": "path",
} # }
], # ],
}, # },
"put": { # "put": {
"responses": { # "responses": {
"200": { # "200": {
"description": "Successful Response", # "description": "Successful Response",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
}, # },
"422": { # "422": {
"description": "Validation Error", # "description": "Validation Error",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": { # "schema": {
"$ref": "#/components/schemas/HTTPValidationError" # "$ref": "#/components/schemas/HTTPValidationError"
} # }
} # }
}, # },
}, # },
}, # },
"summary": "Update Item", # "summary": "Update Item",
"operationId": "update_item_items__item_id__put", # "operationId": "update_item_items__item_id__put",
"parameters": [ # "parameters": [
{ # {
"required": True, # "required": True,
"schema": {"title": "Item Id", "type": "string"}, # "schema": {"title": "Item Id", "type": "string"},
"name": "item_id", # "name": "item_id",
"in": "path", # "in": "path",
} # }
], # ],
"requestBody": { # "requestBody": {
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
"required": True, # "required": True,
}, # },
}, # },
} # }
}, # },
"components": { # "components": {
"schemas": { # "schemas": {
"Item": { # "Item": {
"type": "object", # "type": "object",
"title": "Item", # "title": "Item",
"properties": { # "properties": {
"name": { # "name": {
"anyOf": [{"type": "string"}, {"type": "null"}], # "anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Name", # "title": "Name",
}, # },
"description": { # "description": {
"anyOf": [{"type": "string"}, {"type": "null"}], # "anyOf": [{"type": "string"}, {"type": "null"}],
"title": "Description", # "title": "Description",
}, # },
"price": { # "price": {
"anyOf": [{"type": "number"}, {"type": "null"}], # "anyOf": [{"type": "number"}, {"type": "null"}],
"title": "Price", # "title": "Price",
}, # },
"tax": {"title": "Tax", "type": "number", "default": 10.5}, # "tax": {"title": "Tax", "type": "number", "default": 10.5},
"tags": { # "tags": {
"title": "Tags", # "title": "Tags",
"type": "array", # "type": "array",
"items": {"type": "string"}, # "items": {"type": "string"},
"default": [], # "default": [],
}, # },
}, # },
}, # },
"ValidationError": { # "ValidationError": {
"title": "ValidationError", # "title": "ValidationError",
"required": ["loc", "msg", "type"], # "required": ["loc", "msg", "type"],
"type": "object", # "type": "object",
"properties": { # "properties": {
"loc": { # "loc": {
"title": "Location", # "title": "Location",
"type": "array", # "type": "array",
"items": { # "items": {
"anyOf": [{"type": "string"}, {"type": "integer"}] # "anyOf": [{"type": "string"}, {"type": "integer"}]
}, # },
}, # },
"msg": {"title": "Message", "type": "string"}, # "msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"}, # "type": {"title": "Error Type", "type": "string"},
}, # },
}, # },
"HTTPValidationError": { # "HTTPValidationError": {
"title": "HTTPValidationError", # "title": "HTTPValidationError",
"type": "object", # "type": "object",
"properties": { # "properties": {
"detail": { # "detail": {
"title": "Detail", # "title": "Detail",
"type": "array", # "type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"}, # "items": {"$ref": "#/components/schemas/ValidationError"},
} # }
}, # },
}, # },
} # }
}, # },
} # }
# TODO: remove when deprecating Pydantic v1 # # TODO: remove when deprecating Pydantic v1
@needs_pydanticv1 # @needs_pydanticv1
def test_openapi_schema_pv1(client: TestClient): # def test_openapi_schema_pv1(client: TestClient):
response = client.get("/openapi.json") # response = client.get("/openapi.json")
assert response.status_code == 200, response.text # assert response.status_code == 200, response.text
assert response.json() == { # assert response.json() == {
"openapi": "3.1.0", # "openapi": "3.1.0",
"info": {"title": "FastAPI", "version": "0.1.0"}, # "info": {"title": "FastAPI", "version": "0.1.0"},
"paths": { # "paths": {
"/items/{item_id}": { # "/items/{item_id}": {
"get": { # "get": {
"responses": { # "responses": {
"200": { # "200": {
"description": "Successful Response", # "description": "Successful Response",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
}, # },
"422": { # "422": {
"description": "Validation Error", # "description": "Validation Error",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": { # "schema": {
"$ref": "#/components/schemas/HTTPValidationError" # "$ref": "#/components/schemas/HTTPValidationError"
} # }
} # }
}, # },
}, # },
}, # },
"summary": "Read Item", # "summary": "Read Item",
"operationId": "read_item_items__item_id__get", # "operationId": "read_item_items__item_id__get",
"parameters": [ # "parameters": [
{ # {
"required": True, # "required": True,
"schema": {"title": "Item Id", "type": "string"}, # "schema": {"title": "Item Id", "type": "string"},
"name": "item_id", # "name": "item_id",
"in": "path", # "in": "path",
} # }
], # ],
}, # },
"put": { # "put": {
"responses": { # "responses": {
"200": { # "200": {
"description": "Successful Response", # "description": "Successful Response",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
}, # },
"422": { # "422": {
"description": "Validation Error", # "description": "Validation Error",
"content": { # "content": {
"application/json": { # "application/json": {
"schema": { # "schema": {
"$ref": "#/components/schemas/HTTPValidationError" # "$ref": "#/components/schemas/HTTPValidationError"
} # }
} # }
}, # },
}, # },
}, # },
"summary": "Update Item", # "summary": "Update Item",
"operationId": "update_item_items__item_id__put", # "operationId": "update_item_items__item_id__put",
"parameters": [ # "parameters": [
{ # {
"required": True, # "required": True,
"schema": {"title": "Item Id", "type": "string"}, # "schema": {"title": "Item Id", "type": "string"},
"name": "item_id", # "name": "item_id",
"in": "path", # "in": "path",
} # }
], # ],
"requestBody": { # "requestBody": {
"content": { # "content": {
"application/json": { # "application/json": {
"schema": {"$ref": "#/components/schemas/Item"} # "schema": {"$ref": "#/components/schemas/Item"}
} # }
}, # },
"required": True, # "required": True,
}, # },
}, # },
} # }
}, # },
"components": { # "components": {
"schemas": { # "schemas": {
"Item": { # "Item": {
"title": "Item", # "title": "Item",
"type": "object", # "type": "object",
"properties": { # "properties": {
"name": {"title": "Name", "type": "string"}, # "name": {"title": "Name", "type": "string"},
"description": {"title": "Description", "type": "string"}, # "description": {"title": "Description", "type": "string"},
"price": {"title": "Price", "type": "number"}, # "price": {"title": "Price", "type": "number"},
"tax": {"title": "Tax", "type": "number", "default": 10.5}, # "tax": {"title": "Tax", "type": "number", "default": 10.5},
"tags": { # "tags": {
"title": "Tags", # "title": "Tags",
"type": "array", # "type": "array",
"items": {"type": "string"}, # "items": {"type": "string"},
"default": [], # "default": [],
}, # },
}, # },
}, # },
"ValidationError": { # "ValidationError": {
"title": "ValidationError", # "title": "ValidationError",
"required": ["loc", "msg", "type"], # "required": ["loc", "msg", "type"],
"type": "object", # "type": "object",
"properties": { # "properties": {
"loc": { # "loc": {
"title": "Location", # "title": "Location",
"type": "array", # "type": "array",
"items": { # "items": {
"anyOf": [{"type": "string"}, {"type": "integer"}] # "anyOf": [{"type": "string"}, {"type": "integer"}]
}, # },
}, # },
"msg": {"title": "Message", "type": "string"}, # "msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"}, # "type": {"title": "Error Type", "type": "string"},
}, # },
}, # },
"HTTPValidationError": { # "HTTPValidationError": {
"title": "HTTPValidationError", # "title": "HTTPValidationError",
"type": "object", # "type": "object",
"properties": { # "properties": {
"detail": { # "detail": {
"title": "Detail", # "title": "Detail",
"type": "array", # "type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"}, # "items": {"$ref": "#/components/schemas/ValidationError"},
} # }
}, # },
}, # },
} # }
}, # },
} # }

Write Preview
Loading…
Cancel
Save