Commit 5975ae7b186fda3f16d8c21185b33d47ae877601
Committed by
Sergio Oliveira
Sergio Oliveira
1 parent
9773eddc
Exists in
master
and in
30 other branches
Create structure for colab signals
Create class and methods to handle signal registration, connection and sending Signed-off-by: Lucas Kanashiro <kanashiro.duarte@gmail.com> Signed-off-by: Lucas Moura <lucas.moura128@gmail.com>
Showing
7 changed files
with
142 additions
and
0 deletions
Show diff stats
colab/settings.py
| @@ -0,0 +1,22 @@ | @@ -0,0 +1,22 @@ | ||
| 1 | +from __future__ import absolute_import | ||
| 2 | + | ||
| 3 | +import os | ||
| 4 | + | ||
| 5 | +from celery import Celery | ||
| 6 | + | ||
| 7 | +# set the default Django settings module for the 'celery' program. | ||
| 8 | +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'colab.settings') | ||
| 9 | + | ||
| 10 | +from django.conf import settings | ||
| 11 | + | ||
| 12 | +app = Celery('colab') | ||
| 13 | + | ||
| 14 | +app.config_from_object('django.conf:settings') | ||
| 15 | +app.autodiscover_tasks(lambda: settings.INSTALLED_APPS) | ||
| 16 | + | ||
| 17 | +app.conf.update( | ||
| 18 | + CELERY_RESULT_BACKEND='djcelery.backends.database:DatabaseBackend', | ||
| 19 | +) | ||
| 20 | +app.conf.update( | ||
| 21 | + CELERY_RESULT_BACKEND='djcelery.backends.cache:CacheBackend', | ||
| 22 | +) |
| @@ -0,0 +1,31 @@ | @@ -0,0 +1,31 @@ | ||
| 1 | +from django.dispatch import Signal | ||
| 2 | +import colab.signals.celery | ||
| 3 | + | ||
| 4 | +class Signals(): | ||
| 5 | + def __init__(self): | ||
| 6 | + self.registered_signals = {} | ||
| 7 | + self.signal_instances = {} | ||
| 8 | + | ||
| 9 | + | ||
| 10 | + def register_signal(self, plugin_name, list_signals): | ||
| 11 | + for signal in list_signals: | ||
| 12 | + if signal in self.registered_signals: | ||
| 13 | + if not plugin_name in self.registered_signals[signal]: | ||
| 14 | + self.registered_signals[signal].append(plugin_name) | ||
| 15 | + else: | ||
| 16 | + self.registered_signals[signal] = [] | ||
| 17 | + self.registered_signals[signal].append(plugin_name) | ||
| 18 | + self.signal_instances[signal] = Signal() | ||
| 19 | + | ||
| 20 | + | ||
| 21 | + def connect_signal(self, signal_name, sender, handling_method): | ||
| 22 | + if signal_name in self.signal_instances: | ||
| 23 | + self.signal_instances[signal_name].connect(handling_method, | ||
| 24 | + sender=sender) | ||
| 25 | + else: | ||
| 26 | + raise Exception("Signal does not exist!") | ||
| 27 | + | ||
| 28 | + | ||
| 29 | + def send(self, signal_name, sender, **kwargs): | ||
| 30 | + if signal_name in self.signal_instances: | ||
| 31 | + self.signal_instances[signal_name].send(sender=sender) |
| @@ -0,0 +1,82 @@ | @@ -0,0 +1,82 @@ | ||
| 1 | +""" | ||
| 2 | +Test Signals class. | ||
| 3 | +Objective: Test parameters, and behavior. | ||
| 4 | +""" | ||
| 5 | + | ||
| 6 | +from django.test import TestCase | ||
| 7 | +from colab.signals.signals import Signals | ||
| 8 | +from mock import patch | ||
| 9 | + | ||
| 10 | + | ||
| 11 | +class SignalsTest(TestCase): | ||
| 12 | + | ||
| 13 | + def setUp(self): | ||
| 14 | + self.list_signal = ['a', 'b', 'c'] | ||
| 15 | + self.plugin_name = 'test_signal' | ||
| 16 | + self.signals = Signals() | ||
| 17 | + | ||
| 18 | + | ||
| 19 | + def test_register_signal_(self): | ||
| 20 | + self.signals.register_signal(self.plugin_name, self.list_signal) | ||
| 21 | + | ||
| 22 | + signal_name ='a' | ||
| 23 | + signal_list = ['test_signal'] | ||
| 24 | + self.assertEqual(len(self.signals.registered_signals[signal_name]), 1) | ||
| 25 | + self.assertEqual(self.signals.registered_signals[signal_name], | ||
| 26 | + signal_list) | ||
| 27 | + | ||
| 28 | + | ||
| 29 | + def test_register_signal_already_registered(self): | ||
| 30 | + signal_name ='a' | ||
| 31 | + signal_list = ['test_signal'] | ||
| 32 | + | ||
| 33 | + self.signals.register_signal(self.plugin_name, self.list_signal) | ||
| 34 | + self.assertEqual(len(self.signals.registered_signals[signal_name]), 1) | ||
| 35 | + | ||
| 36 | + self.signals.register_signal(self.plugin_name, self.list_signal) | ||
| 37 | + self.assertEqual(len(self.signals.registered_signals[signal_name]), 1) | ||
| 38 | + self.assertEqual(self.signals.registered_signals[signal_name], | ||
| 39 | + signal_list) | ||
| 40 | + | ||
| 41 | + | ||
| 42 | + def test_connect_non_registered_signal(self): | ||
| 43 | + sender = 'Test' | ||
| 44 | + handling_method = 'Test' | ||
| 45 | + signal_name = 'Test' | ||
| 46 | + | ||
| 47 | + self.assertRaises(Exception, self.signals.connect_signal, signal_name, | ||
| 48 | + sender, handling_method) | ||
| 49 | + | ||
| 50 | + | ||
| 51 | + @patch('colab.signals.signals.Signal.connect') | ||
| 52 | + def test_connect_already_registered_signal(self, mock): | ||
| 53 | + sender = 'Test' | ||
| 54 | + handling_method = 'Test' | ||
| 55 | + signal_name = 'a' | ||
| 56 | + | ||
| 57 | + self.signals.register_signal(self.plugin_name, self.list_signal) | ||
| 58 | + | ||
| 59 | + self.signals.connect_signal(signal_name, sender, handling_method) | ||
| 60 | + args, kwargs = mock.call_args | ||
| 61 | + | ||
| 62 | + self.assertEqual(args[0], handling_method) | ||
| 63 | + self.assertEqual(kwargs['sender'], sender) | ||
| 64 | + self.assertTrue(mock.is_called) | ||
| 65 | + | ||
| 66 | + | ||
| 67 | + @patch('colab.signals.signals.Signal.send') | ||
| 68 | + def test_send_signal(self, mock): | ||
| 69 | + sender = 'Test' | ||
| 70 | + handling_method = 'Test' | ||
| 71 | + signal_name = 'a' | ||
| 72 | + | ||
| 73 | + self.signals.register_signal(self.plugin_name, self.list_signal) | ||
| 74 | + self.signals.send(signal_name, sender) | ||
| 75 | + | ||
| 76 | + args, kwargs = mock.call_args | ||
| 77 | + | ||
| 78 | + self.assertEqual(kwargs['sender'], sender) | ||
| 79 | + self.assertTrue(mock.is_called) | ||
| 80 | + | ||
| 81 | + | ||
| 82 | + |