439 lines
17 KiB
Python
439 lines
17 KiB
Python
# -*- coding: utf-8 -*-
|
|
import unittest
|
|
|
|
from mongoengine import *
|
|
from mongoengine import signals
|
|
|
|
signal_output = []
|
|
|
|
|
|
class SignalTests(unittest.TestCase):
|
|
"""
|
|
Testing signals before/after saving and deleting.
|
|
"""
|
|
|
|
def get_signal_output(self, fn, *args, **kwargs):
|
|
# Flush any existing signal output
|
|
global signal_output
|
|
signal_output = []
|
|
fn(*args, **kwargs)
|
|
return signal_output
|
|
|
|
def setUp(self):
|
|
connect(db='mongoenginetest')
|
|
|
|
class Author(Document):
|
|
# Make the id deterministic for easier testing
|
|
id = SequenceField(primary_key=True)
|
|
name = StringField()
|
|
|
|
def __unicode__(self):
|
|
return self.name
|
|
|
|
@classmethod
|
|
def pre_init(cls, sender, document, *args, **kwargs):
|
|
signal_output.append('pre_init signal, %s' % cls.__name__)
|
|
signal_output.append(kwargs['values'])
|
|
|
|
@classmethod
|
|
def post_init(cls, sender, document, **kwargs):
|
|
signal_output.append('post_init signal, %s, document._created = %s' % (document, document._created))
|
|
|
|
@classmethod
|
|
def pre_save(cls, sender, document, **kwargs):
|
|
signal_output.append('pre_save signal, %s' % document)
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def pre_save_post_validation(cls, sender, document, **kwargs):
|
|
signal_output.append('pre_save_post_validation signal, %s' % document)
|
|
if kwargs.pop('created', False):
|
|
signal_output.append('Is created')
|
|
else:
|
|
signal_output.append('Is updated')
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def post_save(cls, sender, document, **kwargs):
|
|
dirty_keys = document._delta()[0].keys() + document._delta()[1].keys()
|
|
signal_output.append('post_save signal, %s' % document)
|
|
signal_output.append('post_save dirty keys, %s' % dirty_keys)
|
|
if kwargs.pop('created', False):
|
|
signal_output.append('Is created')
|
|
else:
|
|
signal_output.append('Is updated')
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def pre_delete(cls, sender, document, **kwargs):
|
|
signal_output.append('pre_delete signal, %s' % document)
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def post_delete(cls, sender, document, **kwargs):
|
|
signal_output.append('post_delete signal, %s' % document)
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def pre_bulk_insert(cls, sender, documents, **kwargs):
|
|
signal_output.append('pre_bulk_insert signal, %s' % documents)
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def post_bulk_insert(cls, sender, documents, **kwargs):
|
|
signal_output.append('post_bulk_insert signal, %s' % documents)
|
|
if kwargs.pop('loaded', False):
|
|
signal_output.append('Is loaded')
|
|
else:
|
|
signal_output.append('Not loaded')
|
|
signal_output.append(kwargs)
|
|
|
|
self.Author = Author
|
|
Author.drop_collection()
|
|
Author.id.set_next_value(0)
|
|
|
|
class Another(Document):
|
|
|
|
name = StringField()
|
|
|
|
def __unicode__(self):
|
|
return self.name
|
|
|
|
@classmethod
|
|
def pre_delete(cls, sender, document, **kwargs):
|
|
signal_output.append('pre_delete signal, %s' % document)
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def post_delete(cls, sender, document, **kwargs):
|
|
signal_output.append('post_delete signal, %s' % document)
|
|
signal_output.append(kwargs)
|
|
|
|
self.Another = Another
|
|
Another.drop_collection()
|
|
|
|
class ExplicitId(Document):
|
|
id = IntField(primary_key=True)
|
|
|
|
@classmethod
|
|
def post_save(cls, sender, document, **kwargs):
|
|
if 'created' in kwargs:
|
|
if kwargs['created']:
|
|
signal_output.append('Is created')
|
|
else:
|
|
signal_output.append('Is updated')
|
|
|
|
self.ExplicitId = ExplicitId
|
|
ExplicitId.drop_collection()
|
|
|
|
class Post(Document):
|
|
title = StringField()
|
|
content = StringField()
|
|
active = BooleanField(default=False)
|
|
|
|
def __unicode__(self):
|
|
return self.title
|
|
|
|
@classmethod
|
|
def pre_bulk_insert(cls, sender, documents, **kwargs):
|
|
signal_output.append('pre_bulk_insert signal, %s' %
|
|
[(doc, {'active': documents[n].active})
|
|
for n, doc in enumerate(documents)])
|
|
|
|
# make changes here, this is just an example -
|
|
# it could be anything that needs pre-validation or looks-ups before bulk bulk inserting
|
|
for document in documents:
|
|
if not document.active:
|
|
document.active = True
|
|
signal_output.append(kwargs)
|
|
|
|
@classmethod
|
|
def post_bulk_insert(cls, sender, documents, **kwargs):
|
|
signal_output.append('post_bulk_insert signal, %s' %
|
|
[(doc, {'active': documents[n].active})
|
|
for n, doc in enumerate(documents)])
|
|
if kwargs.pop('loaded', False):
|
|
signal_output.append('Is loaded')
|
|
else:
|
|
signal_output.append('Not loaded')
|
|
signal_output.append(kwargs)
|
|
|
|
self.Post = Post
|
|
Post.drop_collection()
|
|
|
|
# Save up the number of connected signals so that we can check at the
|
|
# end that all the signals we register get properly unregistered
|
|
self.pre_signals = (
|
|
len(signals.pre_init.receivers),
|
|
len(signals.post_init.receivers),
|
|
len(signals.pre_save.receivers),
|
|
len(signals.pre_save_post_validation.receivers),
|
|
len(signals.post_save.receivers),
|
|
len(signals.pre_delete.receivers),
|
|
len(signals.post_delete.receivers),
|
|
len(signals.pre_bulk_insert.receivers),
|
|
len(signals.post_bulk_insert.receivers),
|
|
)
|
|
|
|
signals.pre_init.connect(Author.pre_init, sender=Author)
|
|
signals.post_init.connect(Author.post_init, sender=Author)
|
|
signals.pre_save.connect(Author.pre_save, sender=Author)
|
|
signals.pre_save_post_validation.connect(Author.pre_save_post_validation, sender=Author)
|
|
signals.post_save.connect(Author.post_save, sender=Author)
|
|
signals.pre_delete.connect(Author.pre_delete, sender=Author)
|
|
signals.post_delete.connect(Author.post_delete, sender=Author)
|
|
signals.pre_bulk_insert.connect(Author.pre_bulk_insert, sender=Author)
|
|
signals.post_bulk_insert.connect(Author.post_bulk_insert, sender=Author)
|
|
|
|
signals.pre_delete.connect(Another.pre_delete, sender=Another)
|
|
signals.post_delete.connect(Another.post_delete, sender=Another)
|
|
|
|
signals.post_save.connect(ExplicitId.post_save, sender=ExplicitId)
|
|
|
|
signals.pre_bulk_insert.connect(Post.pre_bulk_insert, sender=Post)
|
|
signals.post_bulk_insert.connect(Post.post_bulk_insert, sender=Post)
|
|
|
|
def tearDown(self):
|
|
signals.pre_init.disconnect(self.Author.pre_init)
|
|
signals.post_init.disconnect(self.Author.post_init)
|
|
signals.post_delete.disconnect(self.Author.post_delete)
|
|
signals.pre_delete.disconnect(self.Author.pre_delete)
|
|
signals.post_save.disconnect(self.Author.post_save)
|
|
signals.pre_save_post_validation.disconnect(self.Author.pre_save_post_validation)
|
|
signals.pre_save.disconnect(self.Author.pre_save)
|
|
signals.pre_bulk_insert.disconnect(self.Author.pre_bulk_insert)
|
|
signals.post_bulk_insert.disconnect(self.Author.post_bulk_insert)
|
|
|
|
signals.post_delete.disconnect(self.Another.post_delete)
|
|
signals.pre_delete.disconnect(self.Another.pre_delete)
|
|
|
|
signals.post_save.disconnect(self.ExplicitId.post_save)
|
|
|
|
signals.pre_bulk_insert.disconnect(self.Post.pre_bulk_insert)
|
|
signals.post_bulk_insert.disconnect(self.Post.post_bulk_insert)
|
|
|
|
# Check that all our signals got disconnected properly.
|
|
post_signals = (
|
|
len(signals.pre_init.receivers),
|
|
len(signals.post_init.receivers),
|
|
len(signals.pre_save.receivers),
|
|
len(signals.pre_save_post_validation.receivers),
|
|
len(signals.post_save.receivers),
|
|
len(signals.pre_delete.receivers),
|
|
len(signals.post_delete.receivers),
|
|
len(signals.pre_bulk_insert.receivers),
|
|
len(signals.post_bulk_insert.receivers),
|
|
)
|
|
|
|
self.ExplicitId.objects.delete()
|
|
|
|
# Note that there is a chance that the following assert fails in case
|
|
# some receivers (eventually created in other tests)
|
|
# gets garbage collected (https://pythonhosted.org/blinker/#blinker.base.Signal.connect)
|
|
self.assertEqual(self.pre_signals, post_signals)
|
|
|
|
def test_model_signals(self):
|
|
""" Model saves should throw some signals. """
|
|
|
|
def create_author():
|
|
self.Author(name='Bill Shakespeare')
|
|
|
|
def bulk_create_author_with_load():
|
|
a1 = self.Author(name='Bill Shakespeare')
|
|
self.Author.objects.insert([a1], load_bulk=True)
|
|
|
|
def bulk_create_author_without_load():
|
|
a1 = self.Author(name='Bill Shakespeare')
|
|
self.Author.objects.insert([a1], load_bulk=False)
|
|
|
|
def load_existing_author():
|
|
a = self.Author(name='Bill Shakespeare')
|
|
a.save()
|
|
self.get_signal_output(lambda: None) # eliminate signal output
|
|
a1 = self.Author.objects(name='Bill Shakespeare')[0]
|
|
|
|
self.assertEqual(self.get_signal_output(create_author), [
|
|
"pre_init signal, Author",
|
|
{'name': 'Bill Shakespeare'},
|
|
"post_init signal, Bill Shakespeare, document._created = True",
|
|
])
|
|
|
|
a1 = self.Author(name='Bill Shakespeare')
|
|
self.assertEqual(self.get_signal_output(a1.save), [
|
|
"pre_save signal, Bill Shakespeare",
|
|
{},
|
|
"pre_save_post_validation signal, Bill Shakespeare",
|
|
"Is created",
|
|
{},
|
|
"post_save signal, Bill Shakespeare",
|
|
"post_save dirty keys, ['name']",
|
|
"Is created",
|
|
{}
|
|
])
|
|
|
|
a1.reload()
|
|
a1.name = 'William Shakespeare'
|
|
self.assertEqual(self.get_signal_output(a1.save), [
|
|
"pre_save signal, William Shakespeare",
|
|
{},
|
|
"pre_save_post_validation signal, William Shakespeare",
|
|
"Is updated",
|
|
{},
|
|
"post_save signal, William Shakespeare",
|
|
"post_save dirty keys, ['name']",
|
|
"Is updated",
|
|
{}
|
|
])
|
|
|
|
self.assertEqual(self.get_signal_output(a1.delete), [
|
|
'pre_delete signal, William Shakespeare',
|
|
{},
|
|
'post_delete signal, William Shakespeare',
|
|
{}
|
|
])
|
|
|
|
self.assertEqual(self.get_signal_output(load_existing_author), [
|
|
"pre_init signal, Author",
|
|
{'id': 2, 'name': 'Bill Shakespeare'},
|
|
"post_init signal, Bill Shakespeare, document._created = False"
|
|
])
|
|
|
|
self.assertEqual(self.get_signal_output(bulk_create_author_with_load), [
|
|
'pre_init signal, Author',
|
|
{'name': 'Bill Shakespeare'},
|
|
'post_init signal, Bill Shakespeare, document._created = True',
|
|
'pre_bulk_insert signal, [<Author: Bill Shakespeare>]',
|
|
{},
|
|
'pre_init signal, Author',
|
|
{'id': 3, 'name': 'Bill Shakespeare'},
|
|
'post_init signal, Bill Shakespeare, document._created = False',
|
|
'post_bulk_insert signal, [<Author: Bill Shakespeare>]',
|
|
'Is loaded',
|
|
{}
|
|
])
|
|
|
|
self.assertEqual(self.get_signal_output(bulk_create_author_without_load), [
|
|
"pre_init signal, Author",
|
|
{'name': 'Bill Shakespeare'},
|
|
"post_init signal, Bill Shakespeare, document._created = True",
|
|
"pre_bulk_insert signal, [<Author: Bill Shakespeare>]",
|
|
{},
|
|
"post_bulk_insert signal, [<Author: Bill Shakespeare>]",
|
|
"Not loaded",
|
|
{}
|
|
])
|
|
|
|
def test_signal_kwargs(self):
|
|
""" Make sure signal_kwargs is passed to signals calls. """
|
|
|
|
def live_and_let_die():
|
|
a = self.Author(name='Bill Shakespeare')
|
|
a.save(signal_kwargs={'live': True, 'die': False})
|
|
a.delete(signal_kwargs={'live': False, 'die': True})
|
|
|
|
self.assertEqual(self.get_signal_output(live_and_let_die), [
|
|
"pre_init signal, Author",
|
|
{'name': 'Bill Shakespeare'},
|
|
"post_init signal, Bill Shakespeare, document._created = True",
|
|
"pre_save signal, Bill Shakespeare",
|
|
{'die': False, 'live': True},
|
|
"pre_save_post_validation signal, Bill Shakespeare",
|
|
"Is created",
|
|
{'die': False, 'live': True},
|
|
"post_save signal, Bill Shakespeare",
|
|
"post_save dirty keys, ['name']",
|
|
"Is created",
|
|
{'die': False, 'live': True},
|
|
'pre_delete signal, Bill Shakespeare',
|
|
{'die': True, 'live': False},
|
|
'post_delete signal, Bill Shakespeare',
|
|
{'die': True, 'live': False}
|
|
])
|
|
|
|
def bulk_create_author():
|
|
a1 = self.Author(name='Bill Shakespeare')
|
|
self.Author.objects.insert([a1], signal_kwargs={'key': True})
|
|
|
|
self.assertEqual(self.get_signal_output(bulk_create_author), [
|
|
'pre_init signal, Author',
|
|
{'name': 'Bill Shakespeare'},
|
|
'post_init signal, Bill Shakespeare, document._created = True',
|
|
'pre_bulk_insert signal, [<Author: Bill Shakespeare>]',
|
|
{'key': True},
|
|
'pre_init signal, Author',
|
|
{'id': 2, 'name': 'Bill Shakespeare'},
|
|
'post_init signal, Bill Shakespeare, document._created = False',
|
|
'post_bulk_insert signal, [<Author: Bill Shakespeare>]',
|
|
'Is loaded',
|
|
{'key': True}
|
|
])
|
|
|
|
def test_queryset_delete_signals(self):
|
|
""" Queryset delete should throw some signals. """
|
|
|
|
self.Another(name='Bill Shakespeare').save()
|
|
self.assertEqual(self.get_signal_output(self.Another.objects.delete), [
|
|
'pre_delete signal, Bill Shakespeare',
|
|
{},
|
|
'post_delete signal, Bill Shakespeare',
|
|
{}
|
|
])
|
|
|
|
def test_signals_with_explicit_doc_ids(self):
|
|
""" Model saves must have a created flag the first time."""
|
|
ei = self.ExplicitId(id=123)
|
|
# post save must received the created flag, even if there's already
|
|
# an object id present
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
# second time, it must be an update
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is updated'])
|
|
|
|
def test_signals_with_switch_collection(self):
|
|
ei = self.ExplicitId(id=123)
|
|
ei.switch_collection("explicit__1")
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
ei.switch_collection("explicit__1")
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is updated'])
|
|
|
|
ei.switch_collection("explicit__1", keep_created=False)
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
ei.switch_collection("explicit__1", keep_created=False)
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
|
|
def test_signals_with_switch_db(self):
|
|
connect('mongoenginetest')
|
|
register_connection('testdb-1', 'mongoenginetest2')
|
|
|
|
ei = self.ExplicitId(id=123)
|
|
ei.switch_db("testdb-1")
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
ei.switch_db("testdb-1")
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is updated'])
|
|
|
|
ei.switch_db("testdb-1", keep_created=False)
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
ei.switch_db("testdb-1", keep_created=False)
|
|
self.assertEqual(self.get_signal_output(ei.save), ['Is created'])
|
|
|
|
def test_signals_bulk_insert(self):
|
|
def bulk_set_active_post():
|
|
posts = [
|
|
self.Post(title='Post 1'),
|
|
self.Post(title='Post 2'),
|
|
self.Post(title='Post 3')
|
|
]
|
|
self.Post.objects.insert(posts)
|
|
|
|
results = self.get_signal_output(bulk_set_active_post)
|
|
self.assertEqual(results, [
|
|
"pre_bulk_insert signal, [(<Post: Post 1>, {'active': False}), (<Post: Post 2>, {'active': False}), (<Post: Post 3>, {'active': False})]",
|
|
{},
|
|
"post_bulk_insert signal, [(<Post: Post 1>, {'active': True}), (<Post: Post 2>, {'active': True}), (<Post: Post 3>, {'active': True})]",
|
|
'Is loaded',
|
|
{}
|
|
])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|