modify schema to show many to many as list of nested models, check openapi generation in tests

This commit is contained in:
collerek
2020-10-27 17:55:41 +01:00
parent d3091c404f
commit 82e3eb94ae
10 changed files with 178 additions and 137 deletions

View File

@ -15,10 +15,10 @@ class Child(ormar.Model):
metadata = metadata
database = database
id: ormar.Integer(name='child_id', primary_key=True)
first_name: ormar.String(name='fname', max_length=100)
last_name: ormar.String(name='lname', max_length=100)
born_year: ormar.Integer(name='year_born', nullable=True)
id: ormar.Integer(name="child_id", primary_key=True)
first_name: ormar.String(name="fname", max_length=100)
last_name: ormar.String(name="lname", max_length=100)
born_year: ormar.Integer(name="year_born", nullable=True)
class ArtistChildren(ormar.Model):
@ -34,10 +34,10 @@ class Artist(ormar.Model):
metadata = metadata
database = database
id: ormar.Integer(name='artist_id', primary_key=True)
first_name: ormar.String(name='fname', max_length=100)
last_name: ormar.String(name='lname', max_length=100)
born_year: ormar.Integer(name='year')
id: ormar.Integer(name="artist_id", primary_key=True)
first_name: ormar.String(name="fname", max_length=100)
last_name: ormar.String(name="lname", max_length=100)
born_year: ormar.Integer(name="year")
children: ormar.ManyToMany(Child, through=ArtistChildren)
@ -47,9 +47,9 @@ class Album(ormar.Model):
metadata = metadata
database = database
id: ormar.Integer(name='album_id', primary_key=True)
name: ormar.String(name='album_name', max_length=100)
artist: ormar.ForeignKey(Artist, name='artist_id')
id: ormar.Integer(name="album_id", primary_key=True)
name: ormar.String(name="album_name", max_length=100)
artist: ormar.ForeignKey(Artist, name="artist_id")
@pytest.fixture(autouse=True, scope="module")
@ -62,70 +62,87 @@ def create_test_database():
def test_table_structure():
assert 'album_id' in [x.name for x in Album.Meta.table.columns]
assert 'album_name' in [x.name for x in Album.Meta.table.columns]
assert 'fname' in [x.name for x in Artist.Meta.table.columns]
assert 'lname' in [x.name for x in Artist.Meta.table.columns]
assert 'year' in [x.name for x in Artist.Meta.table.columns]
assert "album_id" in [x.name for x in Album.Meta.table.columns]
assert "album_name" in [x.name for x in Album.Meta.table.columns]
assert "fname" in [x.name for x in Artist.Meta.table.columns]
assert "lname" in [x.name for x in Artist.Meta.table.columns]
assert "year" in [x.name for x in Artist.Meta.table.columns]
@pytest.mark.asyncio
async def test_working_with_aliases():
async with database:
async with database.transaction(force_rollback=True):
artist = await Artist.objects.create(first_name='Ted', last_name='Mosbey', born_year=1975)
artist = await Artist.objects.create(
first_name="Ted", last_name="Mosbey", born_year=1975
)
await Album.objects.create(name="Aunt Robin", artist=artist)
await artist.children.create(first_name='Son', last_name='1', born_year=1990)
await artist.children.create(first_name='Son', last_name='2', born_year=1995)
await artist.children.create(
first_name="Son", last_name="1", born_year=1990
)
await artist.children.create(
first_name="Son", last_name="2", born_year=1995
)
album = await Album.objects.select_related('artist').first()
assert album.artist.last_name == 'Mosbey'
album = await Album.objects.select_related("artist").first()
assert album.artist.last_name == "Mosbey"
assert album.artist.id is not None
assert album.artist.first_name == 'Ted'
assert album.artist.first_name == "Ted"
assert album.artist.born_year == 1975
assert album.name == 'Aunt Robin'
assert album.name == "Aunt Robin"
artist = await Artist.objects.select_related('children').get()
artist = await Artist.objects.select_related("children").get()
assert len(artist.children) == 2
assert artist.children[0].first_name == 'Son'
assert artist.children[1].last_name == '2'
assert artist.children[0].first_name == "Son"
assert artist.children[1].last_name == "2"
await artist.update(last_name='Bundy')
await artist.update(last_name="Bundy")
await Artist.objects.filter(pk=artist.pk).update(born_year=1974)
artist = await Artist.objects.select_related('children').get()
assert artist.last_name == 'Bundy'
artist = await Artist.objects.select_related("children").get()
assert artist.last_name == "Bundy"
assert artist.born_year == 1974
artist = await Artist.objects.select_related('children').fields(
['first_name', 'last_name', 'born_year', 'child__first_name', 'child__last_name']).get()
artist = (
await Artist.objects.select_related("children")
.fields(
[
"first_name",
"last_name",
"born_year",
"child__first_name",
"child__last_name",
]
)
.get()
)
assert artist.children[0].born_year is None
@pytest.mark.asyncio
async def test_bulk_operations_and_fields():
async with database:
d1 = Child(first_name='Daughter', last_name='1', born_year=1990)
d2 = Child(first_name='Daughter', last_name='2', born_year=1991)
d1 = Child(first_name="Daughter", last_name="1", born_year=1990)
d2 = Child(first_name="Daughter", last_name="2", born_year=1991)
await Child.objects.bulk_create([d1, d2])
children = await Child.objects.filter(first_name='Daughter').all()
children = await Child.objects.filter(first_name="Daughter").all()
assert len(children) == 2
assert children[0].last_name == '1'
assert children[0].last_name == "1"
for child in children:
child.born_year = child.born_year - 100
await Child.objects.bulk_update(children)
children = await Child.objects.filter(first_name='Daughter').all()
children = await Child.objects.filter(first_name="Daughter").all()
assert len(children) == 2
assert children[0].born_year == 1890
children = await Child.objects.fields(['first_name', 'last_name']).all()
children = await Child.objects.fields(["first_name", "last_name"]).all()
assert len(children) == 2
for child in children:
assert child.born_year is None
@ -140,17 +157,21 @@ async def test_bulk_operations_and_fields():
async def test_working_with_aliases_get_or_create():
async with database:
async with database.transaction(force_rollback=True):
artist = await Artist.objects.get_or_create(first_name='Teddy', last_name='Bear', born_year=2020)
artist = await Artist.objects.get_or_create(
first_name="Teddy", last_name="Bear", born_year=2020
)
assert artist.pk is not None
artist2 = await Artist.objects.get_or_create(first_name='Teddy', last_name='Bear', born_year=2020)
artist2 = await Artist.objects.get_or_create(
first_name="Teddy", last_name="Bear", born_year=2020
)
assert artist == artist2
art3 = artist2.dict()
art3['born_year'] = 2019
art3["born_year"] = 2019
await Artist.objects.update_or_create(**art3)
artist3 = await Artist.objects.get(last_name='Bear')
artist3 = await Artist.objects.get(last_name="Bear")
assert artist3.born_year == 2019
artists = await Artist.objects.all()

View File

@ -44,7 +44,7 @@ class Category(ormar.Model):
class ItemsXCategories(ormar.Model):
class Meta(LocalMeta):
tablename = 'items_x_categories'
tablename = "items_x_categories"
class Item(ormar.Model):
@ -96,9 +96,7 @@ def test_all_endpoints():
response = client.post("/categories/", json={"name": "test cat2"})
category2 = response.json()
response = client.post(
"/items/", json={"name": "test", "id": 1}
)
response = client.post("/items/", json={"name": "test", "id": 1})
item = Item(**response.json())
assert item.pk is not None
@ -107,7 +105,7 @@ def test_all_endpoints():
)
item = Item(**response.json())
assert len(item.categories) == 1
assert item.categories[0].name == 'test cat'
assert item.categories[0].name == "test cat"
client.post(
"/items/add_category/", json={"item": item.dict(), "category": category2}
@ -117,9 +115,21 @@ def test_all_endpoints():
items = [Item(**item) for item in response.json()]
assert items[0] == item
assert len(items[0].categories) == 2
assert items[0].categories[0].name == 'test cat'
assert items[0].categories[1].name == 'test cat2'
assert items[0].categories[0].name == "test cat"
assert items[0].categories[1].name == "test cat2"
response = client.get("/docs/")
assert response.status_code == 200
assert b'<title>FastAPI - Swagger UI</title>' in response.content
assert b"<title>FastAPI - Swagger UI</title>" in response.content
def test_schema_modification():
schema = Item.schema()
assert schema["properties"]["categories"]["type"] == "array"
assert schema["properties"]["categories"]["title"] == "Categories"
def test_schema_gen():
schema = app.openapi()
assert "Category" in schema["components"]["schemas"]
assert "Item" in schema["components"]["schemas"]

View File

@ -437,4 +437,3 @@ async def test_start_and_end_filters():
users = await User.objects.filter(name__endswith="igo").all()
assert len(users) == 2

View File

@ -119,9 +119,7 @@ def test_all_endpoints():
items = response.json()
assert len(items) == 0
client.post(
"/items/", json={"name": "test_2", "id": 2, "category": category}
)
client.post("/items/", json={"name": "test_2", "id": 2, "category": category})
response = client.get("/items/")
items = response.json()
assert len(items) == 1
@ -132,4 +130,3 @@ def test_all_endpoints():
response = client.get("/docs/")
assert response.status_code == 200