split tests into packages
This commit is contained in:
collerek
0
tests/test_signals/__init__.py
Normal file
0
tests/test_signals/__init__.py
Normal file
359
tests/test_signals/test_signals.py
Normal file
359
tests/test_signals/test_signals.py
Normal file
@ -0,0 +1,359 @@
|
||||
from typing import Optional
|
||||
|
||||
import databases
|
||||
import pydantic
|
||||
import pytest
|
||||
import sqlalchemy
|
||||
|
||||
import ormar
|
||||
from ormar import (
|
||||
post_delete,
|
||||
post_save,
|
||||
post_update,
|
||||
pre_delete,
|
||||
pre_save,
|
||||
pre_update,
|
||||
)
|
||||
from ormar.exceptions import SignalDefinitionError
|
||||
from tests.settings import DATABASE_URL
|
||||
|
||||
database = databases.Database(DATABASE_URL, force_rollback=True)
|
||||
metadata = sqlalchemy.MetaData()
|
||||
|
||||
|
||||
class AuditLog(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "audits"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
event_type: str = ormar.String(max_length=100)
|
||||
event_log: pydantic.Json = ormar.JSON()
|
||||
|
||||
|
||||
class Cover(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "covers"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
title: str = ormar.String(max_length=100)
|
||||
|
||||
|
||||
class Album(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "albums"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
name: str = ormar.String(max_length=100)
|
||||
is_best_seller: bool = ormar.Boolean(default=False)
|
||||
play_count: int = ormar.Integer(default=0)
|
||||
cover: Optional[Cover] = ormar.ForeignKey(Cover)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True, scope="module")
|
||||
def create_test_database():
|
||||
engine = sqlalchemy.create_engine(DATABASE_URL)
|
||||
metadata.drop_all(engine)
|
||||
metadata.create_all(engine)
|
||||
yield
|
||||
metadata.drop_all(engine)
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
async def cleanup():
|
||||
yield
|
||||
async with database:
|
||||
await AuditLog.objects.delete(each=True)
|
||||
|
||||
|
||||
def test_passing_not_callable():
|
||||
with pytest.raises(SignalDefinitionError):
|
||||
pre_save(Album)("wrong")
|
||||
|
||||
|
||||
def test_passing_callable_without_kwargs():
|
||||
with pytest.raises(SignalDefinitionError):
|
||||
|
||||
@pre_save(Album)
|
||||
def trigger(sender, instance): # pragma: no cover
|
||||
pass
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_signal_functions(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
@pre_save(Album)
|
||||
async def before_save(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_SAVE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@post_save(Album)
|
||||
async def after_save(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"POST_SAVE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@pre_update(Album)
|
||||
async def before_update(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_UPDATE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@post_update(Album)
|
||||
async def after_update(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"POST_UPDATE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@pre_delete(Album)
|
||||
async def before_delete(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_DELETE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@post_delete(Album)
|
||||
async def after_delete(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"POST_DELETE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
album = await Album.objects.create(name="Venice")
|
||||
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 2
|
||||
assert audits[0].event_type == "PRE_SAVE_album"
|
||||
assert audits[0].event_log.get("name") == album.name
|
||||
assert audits[1].event_type == "POST_SAVE_album"
|
||||
assert audits[1].event_log.get("id") == album.pk
|
||||
|
||||
album = await Album(name="Rome").save()
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 4
|
||||
assert audits[2].event_type == "PRE_SAVE_album"
|
||||
assert audits[2].event_log.get("name") == album.name
|
||||
assert audits[3].event_type == "POST_SAVE_album"
|
||||
assert audits[3].event_log.get("id") == album.pk
|
||||
|
||||
album.is_best_seller = True
|
||||
await album.update()
|
||||
|
||||
audits = await AuditLog.objects.filter(event_type__contains="UPDATE").all()
|
||||
assert len(audits) == 2
|
||||
assert audits[0].event_type == "PRE_UPDATE_album"
|
||||
assert audits[0].event_log.get("name") == album.name
|
||||
assert audits[1].event_type == "POST_UPDATE_album"
|
||||
assert audits[1].event_log.get("is_best_seller") == album.is_best_seller
|
||||
|
||||
album.signals.pre_update.disconnect(before_update)
|
||||
album.signals.post_update.disconnect(after_update)
|
||||
|
||||
album.is_best_seller = False
|
||||
await album.update()
|
||||
|
||||
audits = await AuditLog.objects.filter(event_type__contains="UPDATE").all()
|
||||
assert len(audits) == 2
|
||||
|
||||
await album.delete()
|
||||
audits = await AuditLog.objects.filter(event_type__contains="DELETE").all()
|
||||
assert len(audits) == 2
|
||||
assert audits[0].event_type == "PRE_DELETE_album"
|
||||
assert (
|
||||
audits[0].event_log.get("id")
|
||||
== audits[1].event_log.get("id")
|
||||
== album.id
|
||||
)
|
||||
assert audits[1].event_type == "POST_DELETE_album"
|
||||
|
||||
album.signals.pre_delete.disconnect(before_delete)
|
||||
album.signals.post_delete.disconnect(after_delete)
|
||||
album.signals.pre_save.disconnect(before_save)
|
||||
album.signals.post_save.disconnect(after_save)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_multiple_signals(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
@pre_save(Album)
|
||||
async def before_save(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_SAVE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
@pre_save(Album)
|
||||
async def before_save2(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_SAVE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
album = await Album.objects.create(name="Miami")
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 2
|
||||
assert audits[0].event_type == "PRE_SAVE_album"
|
||||
assert audits[0].event_log.get("name") == album.name
|
||||
assert audits[1].event_type == "PRE_SAVE_album"
|
||||
assert audits[1].event_log.get("name") == album.name
|
||||
|
||||
album.signals.pre_save.disconnect(before_save)
|
||||
album.signals.pre_save.disconnect(before_save2)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_static_methods_as_signals(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
class AlbumAuditor:
|
||||
event_type = "ALBUM_INSTANCE"
|
||||
|
||||
@staticmethod
|
||||
@pre_save(Album)
|
||||
async def before_save(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"{AlbumAuditor.event_type}_SAVE",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
album = await Album.objects.create(name="Colorado")
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 1
|
||||
assert audits[0].event_type == "ALBUM_INSTANCE_SAVE"
|
||||
assert audits[0].event_log.get("name") == album.name
|
||||
|
||||
album.signals.pre_save.disconnect(AlbumAuditor.before_save)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_methods_as_signals(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
class AlbumAuditor:
|
||||
def __init__(self):
|
||||
self.event_type = "ALBUM_INSTANCE"
|
||||
|
||||
async def before_save(self, sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"{self.event_type}_SAVE", event_log=instance.json()
|
||||
).save()
|
||||
|
||||
auditor = AlbumAuditor()
|
||||
pre_save(Album)(auditor.before_save)
|
||||
|
||||
album = await Album.objects.create(name="San Francisco")
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 1
|
||||
assert audits[0].event_type == "ALBUM_INSTANCE_SAVE"
|
||||
assert audits[0].event_log.get("name") == album.name
|
||||
|
||||
album.signals.pre_save.disconnect(auditor.before_save)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_multiple_senders_signal(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
@pre_save([Album, Cover])
|
||||
async def before_save(sender, instance, **kwargs):
|
||||
await AuditLog(
|
||||
event_type=f"PRE_SAVE_{sender.get_name()}",
|
||||
event_log=instance.json(),
|
||||
).save()
|
||||
|
||||
cover = await Cover(title="Blue").save()
|
||||
album = await Album.objects.create(name="San Francisco", cover=cover)
|
||||
|
||||
audits = await AuditLog.objects.all()
|
||||
assert len(audits) == 2
|
||||
assert audits[0].event_type == "PRE_SAVE_cover"
|
||||
assert audits[0].event_log.get("title") == cover.title
|
||||
assert audits[1].event_type == "PRE_SAVE_album"
|
||||
assert audits[1].event_log.get("cover") == album.cover.dict(
|
||||
exclude={"albums"}
|
||||
)
|
||||
|
||||
album.signals.pre_save.disconnect(before_save)
|
||||
cover.signals.pre_save.disconnect(before_save)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_modifing_the_instance(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
@pre_update(Album)
|
||||
async def before_update(sender, instance, **kwargs):
|
||||
if instance.play_count > 50 and not instance.is_best_seller:
|
||||
instance.is_best_seller = True
|
||||
|
||||
# here album.play_count ans is_best_seller get default values
|
||||
album = await Album.objects.create(name="Venice")
|
||||
assert not album.is_best_seller
|
||||
assert album.play_count == 0
|
||||
|
||||
album.play_count = 30
|
||||
# here a trigger is called but play_count is too low
|
||||
await album.update()
|
||||
assert not album.is_best_seller
|
||||
|
||||
album.play_count = 60
|
||||
await album.update()
|
||||
assert album.is_best_seller
|
||||
album.signals.pre_update.disconnect(before_update)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_custom_signal(cleanup):
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
async def after_update(sender, instance, **kwargs):
|
||||
if instance.play_count > 50 and not instance.is_best_seller:
|
||||
instance.is_best_seller = True
|
||||
elif instance.play_count < 50 and instance.is_best_seller:
|
||||
instance.is_best_seller = False
|
||||
await instance.update()
|
||||
|
||||
Album.Meta.signals.custom.connect(after_update)
|
||||
|
||||
# here album.play_count ans is_best_seller get default values
|
||||
album = await Album.objects.create(name="Venice")
|
||||
assert not album.is_best_seller
|
||||
assert album.play_count == 0
|
||||
|
||||
album.play_count = 30
|
||||
# here a trigger is called but play_count is too low
|
||||
await album.update()
|
||||
assert not album.is_best_seller
|
||||
|
||||
album.play_count = 60
|
||||
await album.update()
|
||||
assert not album.is_best_seller
|
||||
await Album.Meta.signals.custom.send(sender=Album, instance=album)
|
||||
assert album.is_best_seller
|
||||
|
||||
album.play_count = 30
|
||||
await album.update()
|
||||
assert album.is_best_seller
|
||||
await Album.Meta.signals.custom.send(sender=Album, instance=album)
|
||||
assert not album.is_best_seller
|
||||
|
||||
Album.Meta.signals.custom.disconnect(after_update)
|
||||
217
tests/test_signals/test_signals_for_relations.py
Normal file
217
tests/test_signals/test_signals_for_relations.py
Normal file
@ -0,0 +1,217 @@
|
||||
from typing import Optional
|
||||
|
||||
import databases
|
||||
import pytest
|
||||
import sqlalchemy
|
||||
|
||||
import ormar
|
||||
from ormar import (
|
||||
post_relation_add,
|
||||
post_relation_remove,
|
||||
pre_relation_add,
|
||||
pre_relation_remove,
|
||||
)
|
||||
import pydantic
|
||||
from tests.settings import DATABASE_URL
|
||||
|
||||
database = databases.Database(DATABASE_URL, force_rollback=True)
|
||||
metadata = sqlalchemy.MetaData()
|
||||
|
||||
|
||||
class AuditLog(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "audits"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
event_type: str = ormar.String(max_length=100)
|
||||
event_log: pydantic.Json = ormar.JSON()
|
||||
|
||||
|
||||
class Cover(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "covers"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
title: str = ormar.String(max_length=100)
|
||||
|
||||
|
||||
class Artist(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "artists"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(name="artist_id", primary_key=True)
|
||||
name: str = ormar.String(name="fname", max_length=100)
|
||||
|
||||
|
||||
class Album(ormar.Model):
|
||||
class Meta:
|
||||
tablename = "albums"
|
||||
metadata = metadata
|
||||
database = database
|
||||
|
||||
id: int = ormar.Integer(primary_key=True)
|
||||
title: str = ormar.String(max_length=100)
|
||||
cover: Optional[Cover] = ormar.ForeignKey(Cover)
|
||||
artists = ormar.ManyToMany(Artist)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True, scope="module")
|
||||
def create_test_database():
|
||||
engine = sqlalchemy.create_engine(DATABASE_URL)
|
||||
metadata.drop_all(engine)
|
||||
metadata.create_all(engine)
|
||||
yield
|
||||
metadata.drop_all(engine)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True, scope="function")
|
||||
async def cleanup():
|
||||
yield
|
||||
async with database:
|
||||
await AuditLog.objects.delete(each=True)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_relation_signal_functions():
|
||||
async with database:
|
||||
async with database.transaction(force_rollback=True):
|
||||
|
||||
@pre_relation_add([Album, Cover, Artist])
|
||||
async def before_relation_add(
|
||||
sender, instance, child, relation_name, passed_kwargs, **kwargs
|
||||
):
|
||||
await AuditLog.objects.create(
|
||||
event_type="RELATION_PRE_ADD",
|
||||
event_log=dict(
|
||||
class_affected=sender.get_name(),
|
||||
parent_id=instance.pk,
|
||||
child_id=child.pk,
|
||||
relation_name=relation_name,
|
||||
kwargs=passed_kwargs,
|
||||
),
|
||||
)
|
||||
|
||||
passed_kwargs.pop("dummy", None)
|
||||
|
||||
@post_relation_add([Album, Cover, Artist])
|
||||
async def after_relation_add(
|
||||
sender, instance, child, relation_name, passed_kwargs, **kwargs
|
||||
):
|
||||
await AuditLog.objects.create(
|
||||
event_type="RELATION_POST_ADD",
|
||||
event_log=dict(
|
||||
class_affected=sender.get_name(),
|
||||
parent_id=instance.pk,
|
||||
child_id=child.pk,
|
||||
relation_name=relation_name,
|
||||
kwargs=passed_kwargs,
|
||||
),
|
||||
)
|
||||
|
||||
@pre_relation_remove([Album, Cover, Artist])
|
||||
async def before_relation_remove(
|
||||
sender, instance, child, relation_name, **kwargs
|
||||
):
|
||||
await AuditLog.objects.create(
|
||||
event_type="RELATION_PRE_REMOVE",
|
||||
event_log=dict(
|
||||
class_affected=sender.get_name(),
|
||||
parent_id=instance.pk,
|
||||
child_id=child.pk,
|
||||
relation_name=relation_name,
|
||||
kwargs=kwargs,
|
||||
),
|
||||
)
|
||||
|
||||
@post_relation_remove([Album, Cover, Artist])
|
||||
async def after_relation_remove(
|
||||
sender, instance, child, relation_name, **kwargs
|
||||
):
|
||||
await AuditLog.objects.create(
|
||||
event_type="RELATION_POST_REMOVE",
|
||||
event_log=dict(
|
||||
class_affected=sender.get_name(),
|
||||
parent_id=instance.pk,
|
||||
child_id=child.pk,
|
||||
relation_name=relation_name,
|
||||
kwargs=kwargs,
|
||||
),
|
||||
)
|
||||
|
||||
cover = await Cover(title="New").save()
|
||||
artist = await Artist(name="Artist").save()
|
||||
album = await Album(title="New Album").save()
|
||||
|
||||
await cover.albums.add(album, index=0)
|
||||
log = await AuditLog.objects.get(event_type="RELATION_PRE_ADD")
|
||||
assert log.event_log.get("parent_id") == cover.pk
|
||||
assert log.event_log.get("child_id") == album.pk
|
||||
assert log.event_log.get("relation_name") == "albums"
|
||||
assert log.event_log.get("kwargs") == dict(index=0)
|
||||
|
||||
log2 = await AuditLog.objects.get(event_type="RELATION_POST_ADD")
|
||||
assert log2.event_log.get("parent_id") == cover.pk
|
||||
assert log2.event_log.get("child_id") == album.pk
|
||||
assert log2.event_log.get("relation_name") == "albums"
|
||||
assert log2.event_log.get("kwargs") == dict(index=0)
|
||||
|
||||
await album.artists.add(artist, dummy="test")
|
||||
|
||||
log3 = await AuditLog.objects.filter(
|
||||
event_type="RELATION_PRE_ADD", id__gt=log2.pk
|
||||
).get()
|
||||
assert log3.event_log.get("parent_id") == album.pk
|
||||
assert log3.event_log.get("child_id") == artist.pk
|
||||
assert log3.event_log.get("relation_name") == "artists"
|
||||
assert log3.event_log.get("kwargs") == dict(dummy="test")
|
||||
|
||||
log4 = await AuditLog.objects.get(
|
||||
event_type="RELATION_POST_ADD", id__gt=log3.pk
|
||||
)
|
||||
assert log4.event_log.get("parent_id") == album.pk
|
||||
assert log4.event_log.get("child_id") == artist.pk
|
||||
assert log4.event_log.get("relation_name") == "artists"
|
||||
assert log4.event_log.get("kwargs") == dict()
|
||||
|
||||
assert album.cover == cover
|
||||
assert len(album.artists) == 1
|
||||
|
||||
await cover.albums.remove(album)
|
||||
log = await AuditLog.objects.get(event_type="RELATION_PRE_REMOVE")
|
||||
assert log.event_log.get("parent_id") == cover.pk
|
||||
assert log.event_log.get("child_id") == album.pk
|
||||
assert log.event_log.get("relation_name") == "albums"
|
||||
assert log.event_log.get("kwargs") == dict()
|
||||
|
||||
log2 = await AuditLog.objects.get(event_type="RELATION_POST_REMOVE")
|
||||
assert log2.event_log.get("parent_id") == cover.pk
|
||||
assert log2.event_log.get("child_id") == album.pk
|
||||
assert log2.event_log.get("relation_name") == "albums"
|
||||
assert log2.event_log.get("kwargs") == dict()
|
||||
|
||||
await album.artists.remove(artist)
|
||||
log3 = await AuditLog.objects.filter(
|
||||
event_type="RELATION_PRE_REMOVE", id__gt=log2.pk
|
||||
).get()
|
||||
assert log3.event_log.get("parent_id") == album.pk
|
||||
assert log3.event_log.get("child_id") == artist.pk
|
||||
assert log3.event_log.get("relation_name") == "artists"
|
||||
assert log3.event_log.get("kwargs") == dict()
|
||||
|
||||
log4 = await AuditLog.objects.get(
|
||||
event_type="RELATION_POST_REMOVE", id__gt=log3.pk
|
||||
)
|
||||
assert log4.event_log.get("parent_id") == album.pk
|
||||
assert log4.event_log.get("child_id") == artist.pk
|
||||
assert log4.event_log.get("relation_name") == "artists"
|
||||
assert log4.event_log.get("kwargs") == dict()
|
||||
|
||||
await album.load_all()
|
||||
assert len(album.artists) == 0
|
||||
assert album.cover is None
|
||||
Reference in New Issue
Block a user